NAME
Set-LocalGroup
SYNOPSIS
Changes a local security group.SYNTAX
Set-LocalGroup [-InputObject]
[-Confirm] -Description [-WhatIf] [ ] Set-LocalGroup [-Name]
[-Confirm] -Description [-WhatIf] [ ] Set-LocalGroup [-SID]
[-Confirm] -Description [-WhatIf] [ ] DESCRIPTION
The Set-LocalGroup cmdlet changes a local security group.
PARAMETERS
-Confirm [
Prompts you for confirmation before running the cmdlet. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false] -Description
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
Specifies the security group that this cmdlet changes. To obtain a security group, use the Get-LocalGroup
cmdlet. Required? true Position? 0 Default value NoneAccept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false-Name
Specifies the name of the security group that this cmdlet changes. Required? true Position? 0 Default value NoneAccept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false-SID
Specifies the security ID (SID) of the security group that this cmdlet changes. Required? true Position? 0 Default value NoneAccept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false-WhatIf [
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] This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/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=822522Get-LocalGroup
New-LocalGroup
Remove-LocalGroup
Rename-LocalGroup