Skip to content

Latest commit

 

History

History
134 lines (90 loc) · 3.06 KB

Get-LocalGroup.md

File metadata and controls

134 lines (90 loc) · 3.06 KB
Raw
external help file Locale Module Name ms.date online version schema title
Microsoft.Powershell.LocalAccounts.dll-Help.xml
en-US
Microsoft.PowerShell.LocalAccounts
06/28/2023
2.0.0
Get-LocalGroup

Get-LocalGroup

SYNOPSIS

Gets the local security groups.

SYNTAX

Default (Default)

Get-LocalGroup [[-Name] <String[]>] [<CommonParameters>]

SecurityIdentifier

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: System.String[]
Parameter Sets: Default
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-SID

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

Type: System.Security.Principal.SecurityIdentifier[]
Parameter Sets: SecurityIdentifier
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

CommonParameters

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

INPUTS

System.String

You can pipe a string to this cmdlet.

System.Security.Principal.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.

RELATED LINKS

New-LocalGroup

Remove-LocalGroup

Rename-LocalGroup

Set-LocalGroup