< Back
Get-LocalGroup
Post
NAME Get-LocalGroup
SYNOPSIS
Gets the local security groups.
SYNTAX
Get-LocalGroup [[-Name] <String[]>] [<CommonParameters>]
Get-LocalGroup [[-SID] <SecurityIdentifier[]>] [<CommonParameters>]
DESCRIPTION
The Get-LocalGroup cmdlet gets local security groups in Security Account Manager. This cmdlet gets default built-in groups and local security
groups that you create.
PARAMETERS
-Name <String[]>
Specifies an array of names of security groups that this cmdlet gets. You can use the wildcard character.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-SID <SecurityIdentifier[]>
Specifies an array of security IDs (SIDs) of security groups that this cmdlet gets.
Required? false
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.String, System.Security.Principal.SecurityIdentifier
You can pipe a string or a SID to this cmdlet.
OUTPUTS
System.Management.Automation.SecurityAccountsManager.LocalGroup
This cmdlet returns a local group.
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 the Administrators group
PS C:\\>Get-LocalGroup -Name "Administrators"
Name Description
---- -----------
Administrators Administrators have complete and unrestricted access to the computer/domain
This command gets the local Administrators group. The command displays properties of the group in the console.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=822511
New-LocalGroup
Remove-LocalGroup
Rename-LocalGroup
Set-LocalGroup
SYNOPSIS
Gets the local security groups.
SYNTAX
Get-LocalGroup [[-Name] <String[]>] [<CommonParameters>]
Get-LocalGroup [[-SID] <SecurityIdentifier[]>] [<CommonParameters>]
DESCRIPTION
The Get-LocalGroup cmdlet gets local security groups in Security Account Manager. This cmdlet gets default built-in groups and local security
groups that you create.
PARAMETERS
-Name <String[]>
Specifies an array of names of security groups that this cmdlet gets. You can use the wildcard character.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-SID <SecurityIdentifier[]>
Specifies an array of security IDs (SIDs) of security groups that this cmdlet gets.
Required? false
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.String, System.Security.Principal.SecurityIdentifier
You can pipe a string or a SID to this cmdlet.
OUTPUTS
System.Management.Automation.SecurityAccountsManager.LocalGroup
This cmdlet returns a local group.
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 the Administrators group
PS C:\\>Get-LocalGroup -Name "Administrators"
Name Description
---- -----------
Administrators Administrators have complete and unrestricted access to the computer/domain
This command gets the local Administrators group. The command displays properties of the group in the console.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=822511
New-LocalGroup
Remove-LocalGroup
Rename-LocalGroup
Set-LocalGroup