Get-LocalGroup [[-Name] <String[]>] [<CommonParameters>]Get-LocalGroup [[-SID] <SecurityIdentifier[]>] [<CommonParameters>]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[]>
- Default value is None
- Accepts pipeline input ByPropertyName
Specifies an array of names of security groups that this cmdlet gets. You can use the wildcard character.
-SID <SecurityIdentifier[]>
- Default value is None
- Accepts pipeline input ByPropertyName
Specifies an array of security IDs (SIDs) of security groups that this cmdlet gets.
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.
Inputs
System.String, System.Security.Principal.SecurityIdentifierYou can pipe a string or a SID to this cmdlet.
Outputs
System.Management.Automation.SecurityAccountsManager.LocalGroupThis cmdlet returns a local group.
Examples
- Get the Administrators group:
PS C:\> Get-LocalGroup -Name "Administrators" Name Description ---- ----------- Administrators Administrators have complete and unrestricted access to the computer/domainThis command gets the local Administrators group. The command displays properties of the group in the console.
Additional 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.