Rename-LocalGroup
Renames a local security group.
Syntax
Rename-LocalGroup
[-InputObject] <LocalGroup>
[-NewName] <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Rename-LocalGroup
[-Name] <String>
[-NewName] <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Rename-LocalGroup
[-NewName] <String>
[-SID] <SecurityIdentifier>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Rename-LocalGroup cmdlet renames a local security group.
Note
The Microsoft.PowerShell.LocalAccounts module is not available in 32-bit PowerShell on a 64-bit system.
Examples
Example 1: Change the name of a group
PS C:\> Rename-LocalGroup -Name "SecurityGroup" -NewName "SecurityGroup04"
This command renames a security group named SecurityGroup.
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 |
-InputObject
Specifies the security group that this cmdlet renames. 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 renames.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-NewName
Specifies a new name for the security group.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SID
Specifies the security ID (SID) of a security group that this cmdlet renames.
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.
You can pipe a string to this cmdlet.
You can pipe a SID to this cmdlet.
Outputs
None
This cmdlet returns no output.
Notes
Windows PowerShell includes the following aliases for Rename-LocalGroup
:
rnlg
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
PowerShell feedback
PowerShell is an open source project. Select a link to provide feedback:
Feedback
Submit and view feedback for