Set-LocalGroup
Changes a local security group.
Syntax
InputObject
Set-LocalGroup
[-InputObject] <LocalGroup>
-Description <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Default
Set-LocalGroup
[-Name] <String>
-Description <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SecurityIdentifier
Set-LocalGroup
[-SID] <SecurityIdentifier>
-Description <String>
[-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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Description
Specifies a comment for the group. The maximum length is 48 characters.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Specifies the security group that this cmdlet changes. To obtain a security group, use the Get-LocalGroup cmdlet.
Parameter properties
| Type: | Microsoft.PowerShell.Commands.LocalGroup |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
InputObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Name
Specifies the name of the security group that this cmdlet changes.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Default
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-SID
Specifies the security ID (SID) of the security group that this cmdlet changes.
Parameter properties
| Type: | SecurityIdentifier |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SecurityIdentifier
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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.
