Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Set-NcUserPassword


NAME
Set-NcUserPassword

SYNOPSIS
Changes the password of a specified user.

SYNTAX
Set-NcUserPassword [[-UserName] <String>] [-Password <String>] [-VserverCont
ext <String>] [-Controller <NcController[]>] [-WhatIf] [-Confirm] [<CommonPa
rameters>]

Set-NcUserPassword [-Credential <PSCredential>] [-VserverContext <String>] [
-Controller <NcController[]>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Changes the password of a specified user.

If the changed password affects a controller connection in CurrentNcControll
er, the cmdlet attempts to update the credential. If a subsequent cmdlet fa
ils with an authentication error, call Connect-NcController with the new cre
dentials to ensure the credentials are updated.


PARAMETERS
-UserName <String>
The user whose password should be changed. This is mandatory when a use
r with admin role is modifying the password of another user.

Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Password <String>
New password of the user.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-VserverContext <String>
Vserver to which to direct this command. If the currently connected con
troller (as embodied by an NcController object) represents a cluster, th
ere are multiple means to address commands to one of its vservers. Eith
er set the Vserver field on the NcController object to direct all subseq
uent commands to that vserver, or supply the VserverContext parameter to
an individual cmdlet. Only cmdlets which may be invoked on vservers of
fer the VserverContext parameter.

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

-Controller <NcController[]>
A clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on e
ach controller in succession.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-WhatIf


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

-Confirm


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

-Credential <PSCredential>
A PSCredential object that may be used to specify the UserName and Passw
ord values.

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

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS



NOTES


Category: security
API: security-login-modify-password
Family: vserver

-------------- Example 1 --------------

C:\PS>Get-NcUser test* | Set-NcUserPassword -Password Netapp123


Set the password of all users matching the specified pattern.





-------------- Example 2 --------------

C:\PS>Set-NcUserPassword -VserverContext costea01 -Credential (Get-Credentia
l)


Prompt for a username and password and set that on the specified vserver.






RELATED LINKS
Get-NcUser







 Data ONTAP® PowerShell Toolkit