Set-LocalUser

Module:

Microsoft.PowerShell.LocalAccounts Module

Modifies a local user account.

Set-LocalUser
 [-Name] <String>
 [-AccountExpires <DateTime>]
 [-AccountNeverExpires]
 [-Description <String>]
 [-FullName <String>]
 [-Password <SecureString>]
 [-PasswordNeverExpires <Boolean>]
 [-UserMayChangePassword <Boolean>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Set-LocalUser
 [-InputObject] <LocalUser>
 [-AccountExpires <DateTime>]
 [-AccountNeverExpires]
 [-Description <String>]
 [-FullName <String>]
 [-Password <SecureString>]
 [-PasswordNeverExpires <Boolean>]
 [-UserMayChangePassword <Boolean>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Set-LocalUser
 [-SID] <SecurityIdentifier>
 [-AccountExpires <DateTime>]
 [-AccountNeverExpires]
 [-Description <String>]
 [-FullName <String>]
 [-Password <SecureString>]
 [-PasswordNeverExpires <Boolean>]
 [-UserMayChangePassword <Boolean>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

The Set-LocalUser cmdlet modifies a local user account. This cmdlet can reset the password of a local user account.

Set-LocalUser -Name "Admin07" -Description "Description of this account."

This command changes the description of a user account named Admin07.

$Password = Read-Host -AsSecureString
$UserAccount = Get-LocalUser -Name "User02"
$UserAccount | Set-LocalUser -Password $Password

The first command prompts you for a password by using the Read-Host cmdlet. The command stores the password as a secure string in the $Password variable.

The second command gets a user account named User02 by using Get-LocalUser. The command stores the account in the $UserAccount variable.

The third command sets the new password on the user account stored in $UserAccount.

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.

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.

This cmdlet returns no output.

Windows PowerShell includes the following aliases for Set-LocalUser:

• slu

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.