Edit

Get-LocalGroup

  • Reference
Module:
Microsoft.PowerShell.LocalAccounts

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.

Note

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

Examples

Example 1: Get the Administrators group

Get-LocalGroup -Name "Administrators"

This command gets the local Administrators group. The command displays properties of the group in the console.

Parameters

-Name

Specifies an array of names of security groups that this cmdlet gets. You can use the wildcard character.

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SID

Specifies an array of security IDs (SIDs) of security groups that this cmdlet gets.

Type:SecurityIdentifier[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

You can pipe a string to this cmdlet.

SecurityIdentifier

You can pipe a SID to this cmdlet.

Outputs

System.Management.Automation.SecurityAccountsManager.LocalGroup

This cmdlet returns a local group.

Notes

Windows PowerShell includes the following aliases for Get-LocalGroup:

  • glg

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.