NSX CLI Guide

Associated Commands:

CLI Description	Command
Activates specified local user account. Activates specified local user account.	activate user <username> password [<password>]
Add new local user. Add a new local user. By default status for newly created local user will be NOT_ACTIVATED and administrator will require to explicitly activate such users. When password is specified with command, status for created local user will be ACTIVE.	add user <username> [full-name <full-name>] [password <node-password>] [password-expiration-frequency <days>] [password-expiration-warning <days>] [password-reset-required]
Add audit user. Re-create audit user if it was removed. By default status for re-created audit user will be NOT_ACTIVATED and administrator will require to explicitly activate audit user. When password is specified with command, status for re-created audit user will be ACTIVE.	add user audit [username <username>][full-name <full-name>] [password <node-password>] [password-expiration-frequency <days>] [password-expiration-warning <days>] [password-reset-required]
Disable password expiration for the user Disable password expiration for the user.	clear user <node-all-username> password-expiration
Disable password expiration warning for the user Disable password expiration warning for the user.	clear user <node-all-username> password-expiration-warning
Deactivate local user. Deactivate account for local user. Deactivating an account is permanent, unlike an account that is temporarily locked because of too many password failures. A deactivated account has to be explicitly activated.	deactivate user <username>
Delete existing local users. Delete specified user who is configured to log into the NSX appliance. Whereas local users root and administrator are not allowed to be deleted, but local user audit is deletable on-demand. In case to recreate a deleted user, kindly check the following link here	del user <username>
Delete existing local users. Delete specified user who is configured to log into the NSX appliance. Whereas local users root and administrator are not allowed to be deleted, but local user audit is deletable on-demand. Note: Deleted users cannot be created again.	del user <username>
Delete SSH service keys from authorized_keys file for specified user Delete any SSH key with specified label from specified user's authorized_keys file. If password is not provided in the command then you are prompted to enter it. Password is required only for users root and admin.	del user <username> ssh-keys label <key-label> [password <password>]
Get number of days od details user password expiration details Get number of days the user's password is valid after a password change and number of days before user receives password expiration warning message.	get user <node-all-username> password-expiration
Get user status for specified non-root user Get user status for specified non-root user.	get user <node-all-username> status
Get SSH keys from authorized_keys file for specified user Get SSH keys from authorized_keys file for specified user.	get user <node-username> ssh-keys
Set the audit and guest user accounts password Set the password for all the active users except admin and root users. This command does not require current password for the user account. The account of the target user must be ACTIVE to reset the password of the respective user. If you do not specify the 'new password' in the command line, you will be prompted for it. Note: This command can only be executed by administrator privileged user only.	set user <active-user> password [<password>]
Set number of days the user's password is valid after a password change Set number of days the user's password is valid after a password change.	set user <node-all-username> password-expiration <password-expiration-arg>
Set number of days prior user receives warning message before password expires Set number of days prior user receives warning message before password expires. Set 0 to disable warning messages for password expiry.	set user <node-all-username> password-expiration-warning <password-expiration-warn-arg>
Set new username for specified non-root user Set new user name for the specified non-root user.	set user <node-all-username> username <new-node-username>
Set user password Set the password for the specified user. If you do not specify the password on the command line, you will be prompted for it. For details on setting passwords during installation, see the NSX Installation Guide.	set user <username> password [<password> [old-password <old-password>]]
Add SSH service key to authorized_keys file for specified user Add SSH service key to authorized_keys file for specified user. If password is not provided in the command then you are prompted to enter it. Password is required only for users root and admin.	set user <username> ssh-keys label <key-label> type <key-type> value <key-value> [password <password>]

Total commands: 18