< Back
Get-LocalGroupMember
Post
NAME Get-LocalGroupMember
SYNOPSIS
Gets members from a local group.
SYNTAX
Get-LocalGroupMember [-Group] <LocalGroup> [[-Member] <String>] [<CommonParameters>]
Get-LocalGroupMember [-Name] <String> [[-Member] <String>] [<CommonParameters>]
Get-LocalGroupMember [-SID] <SecurityIdentifier> [[-Member] <String>] [<CommonParameters>]
DESCRIPTION
The Get-LocalGroupMember cmdlet gets members from a local group.
PARAMETERS
-Group <LocalGroup>
Specifies the security group from which this cmdlet gets members.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Member <String>
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.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the security group from which this cmdlet gets members.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-SID <SecurityIdentifier>
Specifies the security ID of the security group from which this cmdlet gets members.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.Management.Automation.SecurityAccountsManager.LocalGroup, System.String, System.Security.Principal.SecurityIdentifier
You can pipe a local group, a string, or a SID to this cmdlet.
OUTPUTS
Microsoft.SecurityAccountsManager.LocalPrincipal
This cmdlet returns local principals.
NOTES
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
- Azure Active Directory 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.
Example 1: Get all members of the Administrators group
PS C:\\>Get-LocalGroupMember -Group "Administrators"
ObjectClass Name PrincipalSource
----------- ---- ---------------
User CONTOSOPC\\Administrator Local
User CONTOSOPC\\LocalAdmin Local
This command gets all the members of the local Administrators group.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=822512
Add-LocalGroupMember
New-LocalGroup
Remove-LocalGroupMember
SYNOPSIS
Gets members from a local group.
SYNTAX
Get-LocalGroupMember [-Group] <LocalGroup> [[-Member] <String>] [<CommonParameters>]
Get-LocalGroupMember [-Name] <String> [[-Member] <String>] [<CommonParameters>]
Get-LocalGroupMember [-SID] <SecurityIdentifier> [[-Member] <String>] [<CommonParameters>]
DESCRIPTION
The Get-LocalGroupMember cmdlet gets members from a local group.
PARAMETERS
-Group <LocalGroup>
Specifies the security group from which this cmdlet gets members.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Member <String>
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.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the security group from which this cmdlet gets members.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-SID <SecurityIdentifier>
Specifies the security ID of the security group from which this cmdlet gets members.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.Management.Automation.SecurityAccountsManager.LocalGroup, System.String, System.Security.Principal.SecurityIdentifier
You can pipe a local group, a string, or a SID to this cmdlet.
OUTPUTS
Microsoft.SecurityAccountsManager.LocalPrincipal
This cmdlet returns local principals.
NOTES
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
- Azure Active Directory 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.
Example 1: Get all members of the Administrators group
PS C:\\>Get-LocalGroupMember -Group "Administrators"
ObjectClass Name PrincipalSource
----------- ---- ---------------
User CONTOSOPC\\Administrator Local
User CONTOSOPC\\LocalAdmin Local
This command gets all the members of the local Administrators group.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=822512
Add-LocalGroupMember
New-LocalGroup
Remove-LocalGroupMember