Windows PowerShell command on Get-command Set-LocalUser

NAME

Set-LocalUser

SYNOPSIS

Modifies a local user account.

SYNTAX

Set-LocalUser [-InputObject] [-AccountExpires ] [-AccountNeverExpires] [-Confirm]

[-Description ] [-FullName ] [-Password ] [-PasswordNeverExpires ]

[-UserMayChangePassword ] [-WhatIf] []

Set-LocalUser [-Name] [-AccountExpires ] [-AccountNeverExpires] [-Confirm] [-Description

] [-FullName ] [-Password ] [-PasswordNeverExpires ]

[-UserMayChangePassword ] [-WhatIf] []

Set-LocalUser [-SID] [-AccountExpires ] [-AccountNeverExpires] [-Confirm]

[-Description ] [-FullName ] [-Password ] [-PasswordNeverExpires ]

[-UserMayChangePassword ] [-WhatIf] []

DESCRIPTION

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

PARAMETERS

-AccountExpires

Specifies when the user account expires. To obtain a DateTime object, use the Get-Date cmdlet.

If you do not want the account to expire, specify the AccountNeverExpires parameter. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-AccountNeverExpires []

Indicates that the account does not expire. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false

-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 user account. The maximum length is 48 characters. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-FullName

Specifies the full name for the user account. The full name differs from the user name of the user account. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-InputObject

Specifies the user account that this cmdlet changes. To obtain a user account, use the Get-LocalUser cmdlet.

Required? true Position? 0 Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

Accept wildcard characters? false

-Name

Specifies the name of the user account that this cmdlet changes. Required? true Position? 0 Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

Accept wildcard characters? false

-Password

Specifies a password for the user account. If the user account is connected to a Microsoft account, do not set a password.

You can use `Read-Host -GetCredential`, Get-Credential, or ConvertTo-SecureString to create a SecureString

object for the password.

If you omit the Password and NoPassword parameters, Set-LocalUser prompts you for the user's password.

Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-PasswordNeverExpires

Indicates whether the password expires. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false

-SID

Specifies the security ID (SID) of the user account that this cmdlet changes. Required? true Position? 0 Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

Accept wildcard characters? false

-UserMayChangePassword

Indicates that the user can change the password on the user account. Required? false Position? named Default value None Accept pipeline input? False 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.LocalUser, System.String, System.Security.Principal.SecurityIdentifier You can pipe a local user, 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 description of a user account

PS C:\>Set-LocalUser -Name "Admin07" -Description "Description of this account."

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

Example 2: Change the password on an account

PS C:\>$Password = Read-Host -AsSecureString

PS C:\> $UserAccount = Get-LocalUser -Name "User02"

PS C:\> $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.