NSX CLI Guide

Associated Commands:

CLI Description Command

Move to the bottom of the path


Move to the bottom of the path. The arrow moves to show which interface is current.
bottom

Clear security banner or message of the day


Clear the security banner or message of the day. The banner is reset to the system default banner.
clear banner

Clear bootup error message(s) after user has resolved the issues


After user has resolved issues which cause bootup error, he/she can call this CLI to clear the bootup error message.
clear bootup error message

Delete SSH service known host


Delete the specified host entry from the SSH known hosts file.
del ssh-known-host <hostname-or-ip-address-optional-port-arg>

Move down the path


Move down the path. The arrow moves to show which interface is current.
down

Display security banner or message of the day


Display the security banner or message of the day.
get banner

Show system configuration


Display configuration settings in command line syntax.
get configuration

Display controller connection


Display the controllers connected to this node.
get controllers

Display the current port or interface


Display information about the current interface.
get current

Show the datum ID(s) and span(s) for the message ID


Display the datum ID(s) and span(s) for the specified message ID.
get data <data-id-arg>

Lookup datum ID(s) for the receiver


Display datum ID(s) for the specified receiver.
get data with receiver <uuid-arg>

Get a domain object by id


Display information about the specified domain object.
get domain-object <domain-object-id>

Find all domain objects of a given type


Display domain objects of the specified type.
get domain-objects <domain-object-type>

Find all domain objects of a given type with the specified component name


Display domain objects of the specified type with the specified component name
get domain-objects <objects-type-with-component-name> <component-name>

Show the content of End User License Agreement


Show the content of End User License Agreement
get eula

Show the acceptance of End User License Agreement


Show the acceptance of End User License Agreement
get eula acceptance

Display GRUB menu timeout


Display GRUB menu timeout.
get grub menu timeout

Display system hostname


Display the system hostname.
get hostname

Get the last barrier processed by NestDb Pigeon for the specified transport node


Get the last barrier processed by NestDb Pigeon for the specified transport node.
get last processed barrier <<uuid-arg>

Get maintenance mode


Get maintenance mode status.
get maintenance-mode

Show managers


Show the current list of configured managers.
get managers

Show namespace config


Display a specific namespace config
get namespace status <string-arg>

Show all namespace configs


Display all namespace configs.
get namespaces status

Show node UUID


Show the UUID for the node.
get node-uuid

Show host UUID


Display the UUID for the host.
get node-uuid

Display registered nodes


Display the list of registered nodes.
get nodes

Display registered nodes detail


Display the list of registered nodes information in detail.
get nodes verbose

Display the parent of current port or interface


Display the parent of the current interface.
get parent

Display the path


Display the path. The arrow indicates which interface is selected. Other commands, such as get current, will display information about the selected interface.
get path

Display system version


Display the version of the NSX appliance.
get version

Enter path context mode


Enter path context mode. This mode allows you to get information about each interface that is in the path between the specified logical router port and the specified IP address.

You can get a list of logical router interfaces with the get logical-router interfaces command.

Once you are in the path context, use the path commands to navigate and get information, for example, get path, get current, up and down.

path <dpd-uuid-lrouter-port-arg> <ip46-address>

Search for a string to get its mapping


Search for a string to get its mapping
search <input-str> [resource-type <resource-type-arg>]

Set security banner or message of the day


Set the security banner or message of the day.
set banner

Set the acceptance of End User License Agreement


Set the acceptance of the end user license agreement.
set eula accepted

Set GRUB menu timeout


Set GRUB menu timeout.
set grub menu timeout <grub-menu-timeout>

Set GRUB user password


Set GRUB user password.
set grub user <grub-username> password [<grub-password>]

Set system hostname


Set the system hostname. Changing the hostname changes the command line prompt.
set hostname <hostname-arg>

Set system timezone


Set the system timezone.
set timezone <timezone-arg>

Recover search service


Execute recover of search service datastore.
start search recover

Re-sync search service


Execute full or partial re-sync of search service datastore.
start search resync <search-scope-arg>

Move up the path


Move up the path. The arrow moves to show which interface is current.
up

Verify controllers certificate


Verify controllers certificate from configuration file in the host.
verify controllers certificate

Verify managers certificate


Verify managers certificate from configuration file in the host.
verify managers certificate

Total commands: 43