Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Set-NcUser


NAME
Set-NcUser

SYNOPSIS
Modify the role associated with a user account object.

SYNTAX
Set-NcUser [-UserName] <String> -Vserver <String[]> -Application <String[]>
-AuthMethod <String> -Role <String> [-Controller <NcController[]>] [-WhatIf]
[-Confirm] [<CommonParameters>]


DESCRIPTION
Modify the role associated with a user account object.


PARAMETERS
-UserName <String>
Name of the user to be modified.

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

-Vserver <String[]>
Vserver that owns the user account.

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

-Application <String[]>
Name of the application. Possible values: 'console', 'http', 'ontapi',
'snmp', 'sp', 'ssh'.

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

-AuthMethod <String>
Authentication method for the application. Possible values: 'community'
, 'password', 'publickey', 'domain', 'nsswitch' and 'usm'.

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

-Role <String>
Name of the role.

Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
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

<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
DataONTAP.C.Types.Security.SecurityLoginAccountInfo


NOTES


Category: security
API: security-login-modify
Family: cluster

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

C:\PS>Set-NcUser vmware_admin -Vserver costea01 -Application ontapi -AuthMet
hod password -Role vsadmin


Change role of user 'vmware_admin' to 'vsadmin'.


UserName Application AuthMethod RoleName IsLocked Vserver
-------- ----------- ---------- -------- -------- -------
vmware_admin ontapi password vsadmin False costea01



RELATED LINKS
New-NcUser
Get-NcUser
Remove-NcUser







 Data ONTAP® PowerShell Toolkit