Rename-LocalUser
Renames a local user account.
Syntax
Rename-LocalUser
[-InputObject] <LocalUser>
[-NewName] <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Rename-LocalUser
[-Name] <String>
[-NewName] <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Rename-LocalUser
[-NewName] <String>
[-SID] <SecurityIdentifier>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Rename-LocalUser
cmdlet renames a local user account.
Note
The Microsoft.PowerShell.LocalAccounts module is not available in 32-bit PowerShell on a 64-bit system.
Examples
Example 1: Rename a user account
Rename-LocalUser -Name "Admin02" -NewName "AdminContoso02"
This command renames the user account named Admin02.
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 user account that this cmdlet renames. To obtain a user account, use the Get-LocalUser cmdlet.
Type: | Microsoft.PowerShell.Commands.LocalUser |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Specifies the name of the user account 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 user account.
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 user accounts 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.LocalUser
You can pipe a local user 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-LocalUser
:
rnlu
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
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for