NSX CLI Guide

Associated Commands:

CLI Description Command

Disable password expiration for the user


Disable password expiration for the user.
clear user <node-username> password-expiration

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 API account lockout period


Get the amount of time, in seconds, that an account will remain locked out of the API after exceeding the maximum number of failed authentication attempts.
get auth-policy api lockout-period

Get API account lockout reset period


In order to trigger an account lockout, all authentication failures must occur in this time window. If the reset period exprires, the failed login count is reset to zero.
get auth-policy api lockout-reset-period

Get API maximum authentication faliures


Get the number of failed API authentication attempts that are allowed before the account is locked. If set to 0, account lockout is disabled.
get auth-policy api max-auth-failures

Get CLI account lockout period


Get the amount of time, in seconds, that an account will remain locked out of the CLI after exceeding the maximum number of failed authentication attempts.
get auth-policy cli lockout-period

Get CLI maximum authentication faliures


Get the number of failed CLI authentication attempts that are allowed before the account is locked. If set to 0, account lockout is disabled.
get auth-policy cli max-auth-failures

Get minimum allowable password length


Get the minimum number of characters that passwords must have.
get auth-policy minimum-password-length

Get number of days the user's password is valid after a password change


Get number of days the user's password is valid after a password change.
get user <node-username> password-expiration

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

Get user status for specified non-root user


Get user status for specified non-root user.
get user <node-username> status

Set API account lockout period


Sets the amount of time, in seconds, that an account will remain locked out of the API after exceeding the maximum number of failed authentication attempts.
set auth-policy api lockout-period <lockout-period-arg>

Set API account lockout reset period


In order to trigger an account lockout, all authentication failures must occur in this time window. If the reset period exprires, the failed login count is reset to zero.
set auth-policy api lockout-reset-period <lockout-reset-period-arg>

Set API maximum authentication faliures


Set the number of failed API authentication attempts that are allowed before the account is locked. If set to 0, account lockout is disabled.
set auth-policy api max-auth-failures <auth-failures-arg>

Set CLI account lockout period


Sets the amount of time, in seconds, that an account will remain locked out of the CLI after exceeding the maximum number of failed authentication attempts. While the lockout period is in effect, additional authentication attempts restart the lockout period, even if a valid password is specified.
set auth-policy cli lockout-period <lockout-period-arg>

Set CLI maximum authentication faliures


Set the number of failed CLI authentication attempts that are allowed before the account is locked. If set to 0, account lockout is disabled.
set auth-policy cli max-auth-failures <auth-failures-arg>

Set minimum allowable password length


Set the minimum number of characters that passwords must have. The smallest value that can be set is 8.
set auth-policy minimum-password-length <password-length-arg>

Set auth-policy vidm properties


Set the vidm's properties.
set auth-policy vidm hostname <hostname-or-ip-address> thumbprint <vidm-host-thumbprint-arg> client-id <vidm-client-id-arg> client-secret <vidm-client-secret-arg> node-hostname <hostname-or-ip-address>

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-username> password-expiration <password-expiration-arg>

Set new username for specified non-root user


Set new user name for the specified non-root user.
set user <node-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-T 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: 22