Edit

Share via

Get-LocalGroupMember

Module:
Microsoft.PowerShell.LocalAccounts Module

Gets members from a local group.

Syntax

Default (Default) 

Get-LocalGroupMember
    [[-Member] <String>]
    [-Name] <String>
    [<CommonParameters>]

Group 

Get-LocalGroupMember
    [-Group] <LocalGroup>
    [[-Member] <String>]
    [<CommonParameters>]

SecurityIdentifier 

Get-LocalGroupMember
    [[-Member] <String>]
    [-SID] <SecurityIdentifier>
    [<CommonParameters>]

Description

The Get-LocalGroupMember cmdlet gets members from a local group.

Note

The Microsoft.PowerShell.LocalAccounts module is not available in 32-bit PowerShell on a 64-bit system.

Examples

Example 1: Get all members of the Administrators group

Get-LocalGroupMember -Group "Administrators"

This command gets all the members of the local Administrators group.

Parameters

-Group

Specifies the security group from which this cmdlet gets members.

Parameter properties

Type:Microsoft.PowerShell.Commands.LocalGroup
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Group
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-Member

Specifies a user or group that this cmdlet gets from a security group. You can specify users or groups by name or security ID (SID). Specify SID strings in S-R-I-S-S . . . format. You can use wildcard characters. If you do not specify this parameter, the cmdlet gets all members of the group.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of the security group from which this cmdlet gets members.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Default
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-SID

Specifies the security ID of the security group from which this cmdlet gets members.

Parameter properties

Type:SecurityIdentifier
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SecurityIdentifier
Position:0
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

System.Management.Automation.SecurityAccountsManager.LocalGroup

You can pipe a local group to this cmdlet.

String

You can pipe a string to this cmdlet.

SecurityIdentifier

You can pipe a SID to this cmdlet.

Outputs

Microsoft.SecurityAccountsManager.LocalPrincipal

This cmdlet returns local principals.

Notes

Windows PowerShell includes the following aliases for Get-LocalGroupMember:

  • glgm

The PrincipalSource property is a property on LocalUser, LocalGroup, and LocalPrincipal objects that describes the source of the object. The possible sources are as follows:

  • Local
  • Active Directory
  • Microsoft Entra group
  • Microsoft Account

PrincipalSource is supported only by Windows 10, Windows Server 2016, and later versions of the Windows operating system. For earlier versions, the property is blank.