< Back
Set-LocalGroup
Post
NAME Set-LocalGroup
SYNOPSIS
Changes a local security group.
SYNTAX
Set-LocalGroup [-InputObject] <LocalGroup> [-Confirm] -Description <String> [-WhatIf] [<CommonParameters>]
Set-LocalGroup [-Name] <String> [-Confirm] -Description <String> [-WhatIf] [<CommonParameters>]
Set-LocalGroup [-SID] <SecurityIdentifier> [-Confirm] -Description <String> [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-LocalGroup cmdlet changes a local security group.
PARAMETERS
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Description <String>
Specifies a comment for the group. The maximum length is 48 characters.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <LocalGroup>
Specifies the security group that this cmdlet changes. To obtain a security group, use the Get-LocalGroup cmdlet.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Name <String>
Specifies the name of the security group that this cmdlet changes.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-SID <SecurityIdentifier>
Specifies the security ID (SID) of the security group that this cmdlet changes.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.Management.Automation.SecurityAccountsManager.LocalGroup, System.String, System.Security.Principal.SecurityIdentifier
You can pipe a security group, a string, or a SID to this cmdlet.
OUTPUTS
None
This cmdlet does not generate any output.
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.
Example 1: Change a group description
PS C:\\>Set-LocalGroup -Name "SecurityGroup04" -Description "This is a sample description."
This command changes the description of a local group.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=822522
Get-LocalGroup
New-LocalGroup
Remove-LocalGroup
Rename-LocalGroup
SYNOPSIS
Changes a local security group.
SYNTAX
Set-LocalGroup [-InputObject] <LocalGroup> [-Confirm] -Description <String> [-WhatIf] [<CommonParameters>]
Set-LocalGroup [-Name] <String> [-Confirm] -Description <String> [-WhatIf] [<CommonParameters>]
Set-LocalGroup [-SID] <SecurityIdentifier> [-Confirm] -Description <String> [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-LocalGroup cmdlet changes a local security group.
PARAMETERS
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Description <String>
Specifies a comment for the group. The maximum length is 48 characters.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <LocalGroup>
Specifies the security group that this cmdlet changes. To obtain a security group, use the Get-LocalGroup cmdlet.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Name <String>
Specifies the name of the security group that this cmdlet changes.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-SID <SecurityIdentifier>
Specifies the security ID (SID) of the security group that this cmdlet changes.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.Management.Automation.SecurityAccountsManager.LocalGroup, System.String, System.Security.Principal.SecurityIdentifier
You can pipe a security group, a string, or a SID to this cmdlet.
OUTPUTS
None
This cmdlet does not generate any output.
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.
Example 1: Change a group description
PS C:\\>Set-LocalGroup -Name "SecurityGroup04" -Description "This is a sample description."
This command changes the description of a local group.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=822522
Get-LocalGroup
New-LocalGroup
Remove-LocalGroup
Rename-LocalGroup