Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: New-NcUser


NAME
New-NcUser

SYNOPSIS
Create a new user account associated with the specified application and auth
entication method.

SYNTAX
New-NcUser [-UserName] <String> -Vserver <String[]> -Application <String[]>
[-AuthMethod <String>] -Role <String> [-Password <String>] [-Controller <NcC
ontroller[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

New-NcUser -Vserver <String[]> -Application <String[]> [-AuthMethod <String>
] -Role <String> [-Credential <PSCredential>] [-Controller <NcController[]>]
[-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Create a new user account associated with the specified application and auth
entication method.


PARAMETERS
-UserName <String>
Name of the user. When creating a SNMPv1 or SNMPv2 user with 'snmp' app
lication and 'community' authentication-method, the user name is the com
munity string.

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

-Vserver <String[]>
Name of the Vserver.

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'.

Not all authentication methods are valid for an application. Valid auth
entication methods for each application are:

'password' for 'console' application.
'password', 'domain', 'nsswitch' for 'http' application.
'password', 'domain', 'nsswitch' for 'ontapi' application.
'community' for 'snmp' application (when creating SNMPv1 and SNMPv2 user
s).
'usm' and 'community' for 'snmp' application (when creating SNMPv3 users
).
'password' for 'sp' application.
'password', 'publickey', 'domain', 'nsswitch' for 'ssh' application.

Required? false
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

-Password <String>
Password for the user account. This is ignored for creating snmp users.
This is required for creating non-snmp users.

Required? false
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

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


NOTES


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

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

C:\PS>New-NcUser vmware_admin -Vserver costea01 -Application ontapi -Role ka
mino -Password Netapp123


Create a new user 'vmware_admin'.


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



RELATED LINKS
Get-NcUser
Remove-NcUser
Set-NcUser







 Data ONTAP® PowerShell Toolkit