Edit

Share via

Set-LocalGroup

  • Reference
Module:
Microsoft.PowerShell.LocalAccounts

Changes a local security group.

Syntax

Set-LocalGroup
   -Description <String>
   [-InputObject] <LocalGroup>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-LocalGroup
   -Description <String>
   [-Name] <String>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-LocalGroup
   -Description <String>
   [-SID] <SecurityIdentifier>
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-LocalGroup cmdlet changes a local security group.

Examples

Example 1: Change a group description

Set-LocalGroup -Name "SecurityGroup04" -Description "This is a sample description."

This command changes the description of a local group.

Note

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

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Specifies a comment for the group. The maximum length is 48 characters.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies the security group that this cmdlet changes. To obtain a security group, use the Get-LocalGroup cmdlet.

Type:Microsoft.PowerShell.Commands.LocalGroup
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name of the security group that this cmdlet changes.

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

-SID

Specifies the security ID (SID) of the security group that this cmdlet changes.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

System.Management.Automation.SecurityAccountsManager.LocalGroup

You can pipe a security group to this cmdlet.

String

You can pipe a string to this cmdlet.

SecurityIdentifier

You can pipe a SID to this cmdlet.

Outputs

None

This cmdlet returns no output.

Notes

Windows PowerShell includes the following aliases for Set-LocalGroup:

  • slg

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.