NSX CLI Guide
System Administration
Associated Commands:
| CLI Description | Command |
|---|---|
Backup KeyManager dataCreate a backup of an NSX KeyManager node. If you do not provide a passphrase on the command line, you will be prompted to enter one. The passphrase is used to encrypt the backup. If you forget the passphrase, you will not be able to restore the backup. Important: This backup command is one part of the backup
process. You must complete all backup and restore tasks in the
correct order. See the NSX-T Administration
Guide for information and instructions about performing backups
and restores.
|
backup node file <filename> [passphrase <passphrase>]
|
Move to the bottom of the pathMove to the bottom of the path. The arrow moves to show which interface is current. |
bottom
|
Clear auth-policy vidm enabled propertyClear the vidm service's enabled property. |
clear auth-policy vidm enabled
|
Clear auth-policy vidm lb-extern enabled propertyClear the external load balancer enabled property. |
clear auth-policy vidm lb-extern enabled
|
Clear security banner or message of the dayClear 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 issuesAfter user has resolved issues which cause bootup error, he/she can call this CLI to clear the bootup error message. |
clear bootup error message
|
Clear Cluster Virtual IPClear Cluster Virtual IP. |
clear cluster vip
|
Reset flow cache stats for all fastpath coresClear flow cache statistics for all fastpath cores. |
clear dataplane flow-cache stats
|
Clear Edge Cluster state historyClear the Edge cluster state history. |
clear edge-cluster history state
|
Clear the gateway high availability state historyClear the high availability state history for the specified gateway. Only service gateways have a high availability status. Use the get gateway command to get a list of gateways and their types. |
clear gateway <nsxa-uuid-service-router-arg> high-availability history state
|
Clear the gateway high availability state historyClear the high availability state history for the gateway in the VRF context. |
clear gateway high-availability history state
|
Clear stats for a high-availability channelClear statistics for the specified high-availability channel |
clear high-availability channel local-ip <ip-address> remote-ip <ip-address> stats
|
Clear stats for high-availability channelsClear statistics for all high-availability channels. |
clear high-availability channels stats
|
Clear the logical router high availability state historyClear the high availability state history for the logical router in the VRF context. |
clear high-availability history state
|
Clear stats for a high-availability sessionClear statistics for the specified high-availability session |
clear high-availability session local-service-id <service-id-arg> peer-service-id <service-id-arg> stats
|
Clear stats for high-availability sessionsClear statistics for all high-availability sessions. |
clear high-availability sessions stats
|
Clear NSX Intelligence flows statisticsClear NSX Intelligence flows statistics. |
clear intelligence flows stats
|
Deletes LLDP Neighbor information on all devicesDeletes LLDP Neighbor information on all devices. |
clear lldp neighbors
|
Deletes LLDP Neighbor information on given deviceDeletes LLDP Neighbor information on given device. |
clear lldp neighbors <lldp-interface-name>
|
Deletes LLDP Statistics on all devicesDeletes LLDP Statistics on all devices. |
clear lldp stats
|
Deletes LLDP Statistics on given deviceDeletes LLDP Statistics on given device. |
clear lldp stats <lldp-interface-name>
|
Clear all configured logging-serversClear all logging server configuration. |
clear logging-servers
|
Clear the logical router high availability state historyClear the high availability state history for the specified logical router. Only service routers have a high availability status. Use the get logical-routers command to get a list of logical routers and their router types. |
clear logical-router <nsxa-uuid-service-router-arg> high-availability history state
|
Clean up host stateDeletes all NSX configuration and modules from the host only. Please delete the corresponding transport node entries from NSX manager using GUI/API. |
clear management-plane
|
Clear all name serversClear all name servers from the DNS configuration. |
clear name-servers
|
Clear physical port stats by nameClear statistics for the specified physical port. |
clear physical-port <dpd-name-physical-port-arg> stats
|
Clear search domainsRemove all domain names from the DNS search list. |
clear search-domains
|
Clear http service redirect hostClear the HTTP service redirect host. |
clear service http redirect-host
|
Clear install-upgrade service enabled propertyClear the install-upgrade service's enabled property. |
clear service install-upgrade enabled
|
Clear manager service logging levelsClear the log levels of the manager service. |
clear service manager logging-level
|
Clear NTP service start on bootConfigure the NTP service to not start on boot. |
clear service ntp start-on-boot
|
Clear snmp service start on bootConfigure the snmp service to not start on boot. |
clear service snmp start-on-boot
|
Clear SSH service start on bootConfigure the SSH service to not start on boot. |
clear service ssh start-on-boot
|
Clear SSH Root login propertyDisable SSH Root login property |
clear ssh root-login
|
Disable password expiration for the userDisable password expiration for the user. |
clear user <node-username> password-expiration
|
Copy a local file to remote fileCopy a local file to a remote destination. |
copy file <existing-file-arg> url <scp-file-url-arg>
|
Copy a remote file to the local file storeCopy a remote file to the local file store. If no destination file is specified, the copied file has the same file name as the source file. You can use the file argument to specify a different destination file name. |
copy url <url> [file <filename>]
|
Copy a remote https url file with same filenameCopy a remote https url file to local file using same filename. |
copy url <url> thumbprint <thumbprint> [file <filename>]
|
Remove all other management nodes from the clusterRemove all other management nodes from the cluster. This will effectively convert a multi-node management cluster into a single node setup. The system will prompt for confirmation for this operation. It is recommended to use GSS guidance before using this command. |
deactivate cluster
|
Delete local fileDelete a local file. |
del file <existing-file-or-pattern-arg>
|
Delete the host's public cloud gateway certificateDelete the host's public cloud gateway certificate |
del gateway certificate <ip-address>
|
Delete all the host's public cloud gateway certificatesDelete all the host's public cloud gateway certificates |
del gateway certificates
|
Remove public cloud VM certificateRemove public cloud VM certificate |
del gw-controller vm-certificate <VmID>
|
Delete NSX Edge service container imageDelete NSX Edge service container image. Only images that are not in use can be deleted. |
del image <configurable-image-name> version <configurable-image-version>
|
Delete logging-serverDelete the specified logging server configuration. You can use the get logging-servers command to display the current logging server configuration. |
del logging-server <hostname-or-ip-address[:port]> proto <proto> level <level> [facility <facility>] [messageid <messageid>] [structured-data <structured-data>]
|
Delete name serverDelete the specified name server from the DNS configuration. |
del name-server <name-server-arg>
|
Delete NSX configDelete NSX config on this node without removing it as transport node from management plane. |
del nsx
|
Delete NSX from hostDestroy NSX environment on this host without removing its transport node from management plane. If there are no resources used by the NSX host switches, this command will delete the host switches and all NSX packages. If there are any resources on the host switches, the resources will first be migrated out of the NSX host switches and then the host switches and all NSX packages will be deleted. |
del nsx
|
Delete NSX config, management IP, logs and filestoreDelete NSX config on this node without removing it as transport node from management plane. Additionally clear logs, filestore and management IP from the node. |
del nsx all
|
Remove NTP serverRemove an existing NTP server. |
del ntp-server <hostname-or-ip-address>
|
Delete routeDelete the specified network route. |
del route prefix <prefix> gateway <gateway-ip> [interface <interface-name>]
|
Delete a domain nameDelete the specified domain name from the DNS search list. |
del search-domains <search-domain-arg>
|
Delete SNMP v2 Trap TargetsDelete SNMP v2 Trap Targets. |
del snmp v2-targets <hostname-or-ip-address-optional-port-arg>
|
Delete SNMP v3 Trap TargetsDelete SNMP v3 Trap Targets. |
del snmp v3-targets <hostname-or-ip-address-optional-port-arg>
|
Delete SNMP v3 UsersDelete SNMP v3 Users. |
del snmp v3-users <user-id-arg>
|
Delete SSH service known hostDelete the specified host entry from the SSH known hosts file. |
del ssh-known-host <hostname-or-ip-address-optional-port-arg>
|
Delete SSH service keys from authorized_keys file for specified userDelete 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>]
|
Deregister Edge from management planeDetach this Edge from the management plane. |
detach management-plane <hostname-or-ip-address[:port]> username <username> thumbprint <thumbprint> [password <password>]
|
Detach host from management planeDetach this hypervisor host from the management plane. You can specify any NSX Manager in the management cluster in this command. Use the API username and password for the specified NSX Manager. If you do not provide a password on the command line, you will be prompted to enter one. Get the NSX Manager thumbprint by running the |
detach management-plane <hostname-or-ip-address[:port]> username <username> thumbprint <thumbprint> [password <password>]
|
Detach node from the management planeDetach this keymanager from the management plane. You can specify any NSX Manager in the management cluster in this command. Use the API username and password for the specified NSX Manager. If you do not provide a password on the command line, you will be prompted to enter one. Get the NSX Manager thumbprint by running the |
detach management-plane <ip-address[:port]> username <username> thumbprint <thumbprint> [password <password>]
|
Detach specified node from the clusterDetach the specified node from the cluster. |
detach node <node-id-arg>
|
Detach specified node from the cluster without checking repository-ip modification errorsDetach specified node from the cluster without checking repository-ip modification errors. |
detach node <node-id-arg> ignore-repository-ip-check
|
Move down the pathMove down the path. The arrow moves to show which interface is current. |
down
|
Exit the CLIExit the VRF context mode if you are in it. Otherwise, exit the CLI. |
exit
|
Show system arp cacheDisplay the ARP table. |
get arp-table
|
Show system arp cacheDisplay the ARP table. |
get arp-table
|
Get API account lockout periodGet 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 periodIn 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 faliuresGet 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 periodGet 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 faliuresGet 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 lengthGet the minimum number of characters that passwords must have. |
get auth-policy minimum-password-length
|
Get auth-policy vidmGet the vidm's properties. |
get auth-policy vidm
|
Get bond interface statsDisplay the bond interface with the specified name. Specify the stats argument to display the statistics for the interface. |
get bond <bond name> [stats]
|
Get bond interface statsDisplay all bond interfaces. Specify the stats argument to display the statistics for the interfaces. |
get bonds [stats]
|
Display API server certificateDisplay the API server's certificate. |
get certificate api
|
Display API server certificateDisplay the API server's certificate. |
get certificate api
|
Display API server certificate thumbprintDisplay the API server's certificate thumbprint. |
get certificate api thumbprint
|
Display API server certificate thumbprintDisplay the API server's certificate thumbprint. |
get certificate api thumbprint
|
Display cluster certificateDisplay the clsuter certificate. |
get certificate cluster
|
Display cluster certificate textDisplay the cluster certificate text. |
get certificate cluster text
|
Display cluster certificate thumbprintDisplay the cluster certificate thumbprint. |
get certificate cluster thumbprint
|
Show the cgroup translationDisplay the translations for the specified container group. Optionally specify a translation type to display translations of that type. |
get cgroup <uuid> [<translation-type>]
|
Show the group translationDisplay the translations for the specified container group. Optionally specify a translation type to display translations of that type. |
get cgroup <uuid> [<translation-type>]
|
Show all existing cgroupsDisplay all container groups. |
get cgroups
(Deprecated)
|
Lookup cgroups for the IP addressDisplay container groups with the specified IP address. |
get cgroups with ip <ip46-address>
(Deprecated)
|
Lookup cgroups for the hardware addressDisplay container groups with the specified MAC address. |
get cgroups with mac <hardware-address>
(Deprecated)
|
Lookup cgroups for the network interfaceDisplay container groups with the specified network interface. |
get cgroups with vif <vif-id-arg>
(Deprecated)
|
Show status to display datetime stampShow status to display datetime stamp in command output. |
get cli-output datetime
|
Show inactivity timeoutShow inactivity timeout in seconds. |
get cli-timeout
|
Display system clockDisplay the current date and time. |
get clock
|
Get Cluster ConfigGet Cluster Config. |
get cluster config
|
Get Cluster StatusGet status of all the groups. |
get cluster status
|
Get Cluster StatusGet status of all the groups. Show leadership if there is any. |
get cluster status verbose
|
Get Cluster Virtual IPGet Cluster Virtual IP. |
get cluster vip
|
Display commands historyDisplay the commands history in command output. To show all command history set size to 0. Note:Outputs command history from version 3.2.0 and above. |
get command history
|
Show system configurationDisplay configuration settings in command line syntax. |
get configuration
|
Display controller connectionDisplay the controllers connected to this node. |
get controllers
|
Show the system CPU statusDisplay the system CPU information. |
get cpu-stats
|
Display the current port or interfaceDisplay information about the current interface. |
get current
|
Show the datum ID(s) and span(s) for the message IDDisplay the datum ID(s) and span(s) for the specified message ID. |
get data <data-id-arg>
|
Lookup datum ID(s) for the receiverDisplay datum ID(s) for the specified receiver. |
get data with receiver <uuid-arg>
|
Get dataplane configurationsDisplay Data Plane Development Kit (DPDK) configurations, which include fastpath cores, hugepage reserved, NUMA, physical port bindings, etc. |
get dataplane
|
Get the cpu stats for dataplaneDisplay data plane cpu statistics. |
get dataplane cpu stats
|
Get the list of supported devices on the systemGet the list of supported devices on the system. |
get dataplane device list
|
Check status of dynamic core featureCheck status of dynamic core feature. |
get dataplane dynamic-core
|
Get flow cache configurationDisplay the flow cache configurations. |
get dataplane flow-cache config
|
Get flow cache stats for all fastpath coresDisplay flow cache statistics for all fastpath cores. |
get dataplane flow-cache stats
|
Get flow cache stats for cores selected in coremaskDisplay the flow cache statistics for the specified fastpath cores. |
get dataplane flow-cache stats <lcore-list-all-arg>
|
Get geneve critical bit configurationDisplay geneve critical bit configurations. |
get dataplane geneve-cbit config
|
Get l2vpn pmtu message generation settingsDisplay l2vpn pmtu message generation settings. |
get dataplane l2vpn-pmtu config
|
Get the memory stats for dataplaneDisplay data plane memory statistics. |
get dataplane memory stats
|
Get dataplane perf statsDisplay data plane performance statistics. |
get dataplane perfstats <interval-arg>
|
Get dataplane pmtu learning settingsDisplay dataplane pmtu learning settings. |
get dataplane pmtu-learning config
|
Get admin and operational state of QAT crypto accelerationGet admin and operational state of QAT crypto acceleration. |
get dataplane qat
|
Calculate all nics throughput given an intervalCalculate all nics throughput given an interval |
get dataplane throughput <time>
|
Get edge config diagnosisGet edge config diagnosis |
get diagnosis config
|
Get runtime federation health check reportGet runtime federation health check report |
get diagnosis health-check
|
Check for inconsistencyCheck for any inconsistency on local edge |
get diagnosis inconsistency
|
Get diagnosis analysisGet diagnosis analysis |
get diagnosis log
|
Get number of diagnosis entriesGet number of diagnosis entries |
get diagnosis log limit <log-num>
|
Get two number of diagnosis entriesGet two number of diagnosis entries |
get diagnosis log limit <log-num> context <context-line-num>
|
Get edge logical topologyGet logical topology on edge |
get diagnosis topology
|
Get a domain object by idDisplay information about the specified domain object. |
get domain-object <domain-object-id>
|
Find all domain objects of a given typeDisplay domain objects of the specified type. |
get domain-objects <domain-object-type>
|
Find all domain objects of a given type with the specified component nameDisplay domain objects of the specified type with the specified component name |
get domain-objects <objects-type-with-component-name> <component-name>
|
Get Edge Cluster state historyDisplay the Edge cluster state history. |
get edge-cluster history state
|
Get Edge Cluster statusDisplay the Edge cluster status. |
get edge-cluster status
|
Show ENS lcore assignment modeShow the current mode of enhanced datapath lcore assignment. |
get ens lcore-assignment-mode <hs-name-arg>
|
Show the content of End User License AgreementShow the content of End User License Agreement |
get eula
|
Show the acceptance of End User License AgreementShow the acceptance of End User License Agreement |
get eula acceptance
|
List file in the filestoreDisplay information about the specified file in the filestore. |
get file <existing-file-arg>
|
Display file thumbprintDisplay the file thumbprint. |
get file <existing-file-arg> thumbprint
|
List files in the filestoreDisplay information about the files in the filestore. |
get files
|
Show the system storage capacityDisplay the file system information. |
get filesystem-stats
|
Dump the host's public cloud gateway certificateDump the host's public cloud gateway certificate |
get gateway certificate <ip-address>
|
Dump the host's public cloud gateway certificatesDump the host's public cloud gateway certificates. |
get gateway certificates
|
Dump the host's public cloud gateway connection statusDump the host's public cloud gateway connection status. |
get gateway connection status
|
Get geneve critival bitGet geneve critival bit. |
get geneve-cbit dvs <dvs-name-arg>
|
Show all existing groupsDisplay all groups. |
get groups
|
Lookup groups for the IP addressDisplay groups with the specified IP address. |
get groups with ip <ip46-address>
|
Lookup groups for the hardware addressDisplay groups with the specified MAC address. |
get groups with mac <hardware-address>
|
Lookup group for the network interfaceDisplay groups with the specified network interface. |
get groups with vif <vif-id-arg>
|
Dump public cloud gateway connectionsDump public cloud gateway connections |
get gw-controller connections
|
Get gw-controller logging levelGet gw-controller logging level. |
get gw-controller logging-level
|
Show public cloud VM certificateDisplay public cloud VM certificate |
get gw-controller vm-certificate <VmID>
|
Show public cloud VM certificatesDisplay all public cloud VM certificates |
get gw-controller vm-certificates
|
Get VM log forwarding statusGet VM log forwarding status |
get gw-controller vm-log-forwarding
|
Get VM log forwarding statusGet VM log forwarding status |
get gw-controller vm-log-forwarding <VmID>
|
Show public cloud state for all VMsDisplay public cloud VM state for all VMs |
get gw-controller vm-state
|
Show public cloud VM stateDisplay public cloud VM state for specific VM |
get gw-controller vm-state <VmID>
|
Display info for a high-availability channelDisplay information about the specified high-availability channel. |
get high-availability channel local-ip <ip-address> remote-ip <ip-address>
|
Display stats for a high-availability channelDisplay statistics for the specified high-availability channel. |
get high-availability channel local-ip <ip-address> remote-ip <ip-address> stats
|
Display info about high-availability channelsDisplay information about high-availability channels. |
get high-availability channels
|
Display high-availability channel statsDisplay statistics for the high-availability channels. |
get high-availability channels stats
|
Display the logical router high availability state historyDisplay the high availability state history for the logical router in the VRF context. |
get high-availability history state
|
Display info for a high-availability sessionDisplay information about the specified high-availability session. |
get high-availability session local-service-id <service-id-arg> peer-service-id <service-id-arg>
|
Display stats for a high-availability sessionDisplay statistics for the specified high-availability session. |
get high-availability session local-service-id <service-id-arg> peer-service-id <service-id-arg> stats
|
Display info about high-availability sessionsDisplay information about high-availability sessions. |
get high-availability sessions
|
Display info about high-availability sessions of specified channelDisplay information about high-availability sessions by remote-ip of the channel |
get high-availability sessions remote-ip <ip-address>
|
Display info about high-availability sessions of specified service-typeDisplay information about high-availability sessions by service-type. |
get high-availability sessions service-type <service-type-arg>
|
Display info about high-availability sessions of specified service-type and channelDisplay information about high-availability sessions by service-type and remote-ip of the channel |
get high-availability sessions service-type <service-type-arg> remote-ip <ip-address>
|
Display stats for high-availability sessions of specified service-typeDisplay statistics for the high-availability sessions of specified service-type. |
get high-availability sessions service-type <service-type-arg> stats
|
Display high-availability sessions that have completed synchronizationDisplays any high-availability sessions of a given type who have completed synchronization with peer |
get high-availability sessions service-type <service-type-arg> sync complete
|
Display high-availability sessions whose synchronization is ongoingDisplays any high-availability sessions of a given type who have not yet completed synchronization with peer |
get high-availability sessions service-type <service-type-arg> sync in-progress
|
Display high availability session synchronization status summaryDisplay the synchronization status of high-availability sessions of a given type on current node |
get high-availability sessions service-type <service-type-arg> sync summary
|
Display stats for high-availability sessionsDisplay statistics for the high-availability sessions. |
get high-availability sessions stats
|
Display Tunnels info on a host switchDisplay Tunnels info on the specified host switch. |
get host-switch <hs-name-arg> <bfd-cmd-type-arg>
|
Display Tunnel Detail info on a host switchDisplay Tunnel Detail info on the specified DVPort of the specified host switch. |
get host-switch <hs-name-arg> <bfd-cmd-type-arg> <local-ip-arg> <remote-ip-arg>
|
Display IPFIX setting on a DVPort of a host switchDisplay IPFIX setting on the specified DVPort of the specified host switch |
get host-switch <hs-name-arg> dvport <dvport-id-arg> ipfix setting
|
Display IPFIX stats on a DVPort of a host switchDisplay IPFIX stats on the specified DVPort of the specified host switch |
get host-switch <hs-name-arg> dvport <dvport-id-arg> ipfix stats
|
Display mcast filter mode for a Host switchDisplay the mcast filter mode for the specified host switch and dvPort |
get host-switch <hs-name-arg> dvport <dvport-id-arg> mcast-filter
|
Display mcast filter stats of the specified entryDisplay the mcast filter stata of the specified entry |
get host-switch <hs-name-arg> dvport <dvport-id-arg> mcast-filter <entry-mode-arg> <entry-group-arg>
|
Display IPFIX stats on a host switchDisplay IPFIX stats on the specified host switch |
get host-switch <hs-name-arg> ipfix stats
|
Display mcast filter mode for a host switchDisplay the mcast filter mode for the specified host switch. |
get host-switch <hs-name-arg> mcast-filter
|
Display stats of mirror on a host switchDisplay the stats of mirror on the specified host switch. |
get host-switch <hs-name-arg> mirror-session <ms-id-arg-esx>
|
Display mirror settings on a host switchDisplay the mirror settings on the specified host switch. |
get host-switch <hs-name-arg> mirror-sessions
|
Display IPFIX setting on an uplink of a host switchDisplay IPFIX setting on the specified uplink of the specified host switch |
get host-switch <hs-name-arg> uplink <uplink-arg> ipfix setting
|
Display IPFIX stats on an uplink of a host switchDisplay IPFIX stats on the specified uplink of the specified host switch |
get host-switch <hs-name-arg> uplink <uplink-arg> ipfix stats
|
Display host switch upgrade statusDisplay if host switch is getting upgraded. |
get host-switch upgrade-status
|
Display VLAN table for the host switchDisplay VLAN table for the host switch. |
get host-switch vlan-table
|
Display host switchesDisplay information about all host switches. |
get host-switches
|
Display system hostnameDisplay the system hostname. |
get hostname
|
Get hugepage info of the systemDisplay hugepage information, including total system memory, hugepage sizes supported and hugepage pools. |
get hugepage
|
Get CIF configuration by AppIDDisplay the container interface (CIF) configuration for the specified app. |
get hyperbus app-id <app-ID> cif-config
|
Get CIF configuration cache tableDisplay the container interface (CIF) configuration table. |
get hyperbus cif-table
|
Get VIF connection infoDisplay the virtual interface (VIF) connection information. |
get hyperbus connection info
|
Get VIF connection infoDisplay the virtual interface (VIF) connection information. |
get hyperbus connection info
|
Get VIF connection versionDisplay the virtual interface (VIF) connection version information. |
get hyperbus connection version
|
Get LIP IP poolDisplay the LIP allocation pool. |
get hyperbus lip ip-pool
|
Get CIF configuration by logical switch port IDDisplay the container interface (CIF) configuration for the specified logical switch port. |
get hyperbus logical-switch-port <logical-switch-port-ID> cif-config
|
Get connection info by VIF IDDisplay the connection information for the specified virtual interface (VIF). |
get hyperbus vif-id <vif-ID> connection info
|
Get LIP by VIF IDDisplay the logical IP (LIP) for the specified virtual interface (VIF). |
get hyperbus vif-id <vif-ID> lip
|
Get VIF LIP tableDisplay the VIF (virtual interface) LIP (logical IP) table. |
get hyperbus vif-lip-table
|
Get connected VIF tableDisplay the connected virtual interfaces (VIFs). For ESXi, all connected container host VIFs are displayed. For KVM, all connected container host VIFs and CIFs are displayed. |
get hyperbus vif-table
|
List all container images for given serviceList all container images for given service. |
get image <configurable-image-name>
|
List install history of container images for given serviceList install history of container images for given service. |
get image <configurable-image-name> install history
|
List all service container imagesList all service container images. |
get images
|
List install history for all service container imagesList install history for all service container images. |
get images install history
|
Display NSX Intelligence flows configurationDisplay NSX Intelligence flows configuration. |
get intelligence flows config
|
Display NSX Intelligence flows aggregation maskDisplay NSX Intelligence flows aggregation mask. |
get intelligence flows mask
|
Display NSX Intelligence flows statisticsDisplay NSX Intelligence flows statistics. |
get intelligence flows stats
|
Display NSX Intelligence flows acknowledgement statisticsDisplay NSX Intelligence flows acknowledgement statistics. |
get intelligence flows stats ack
|
Get the last barrier processed by NestDb Pigeon for the specified transport nodeGet the last barrier processed by NestDb Pigeon for the specified transport node. |
get last processed barrier <uuid-arg>
|
Display LLDP configuration on all devicesDisplay LLDP configuration on all devices. |
get lldp config
|
Displays LLDP Configuration on all devicesDisplays LLDP configuration on all devices. |
get lldp config
|
Display LLDP configuration on all devicesDisplay LLDP configuration on all devices. |
get lldp config
|
Display LLDP Configuration on given deviceDisplay LLDP configuration on given device. |
get lldp config <lldp-interface-name-esx>
|
Display LLDP configuration on given deviceDisplay LLDP configuration on given device. |
get lldp config <lldp-interface-name-kvm>
|
Displays LLDP Configuration on given deviceDisplays LLDP configuration given device. |
get lldp config <lldp-interface-name>
|
Display LLDP Neighbor information on all devicesDisplay LLDP Neighbor information on all devices. |
get lldp neighbors
|
Display LLDP Neighbor information on all devicesDisplay LLDP Neighbor information on all devices. |
get lldp neighbors
|
Displays LLDP Neighbor information on all devicesDisplays LLDP Neighbor information on all devices. |
get lldp neighbors
|
Display LLDP Neighbor information on given deviceDisplay LLDP Neighbor information on given device. |
get lldp neighbors <lldp-interface-name-esx>
|
Display LLDP Neighbor information on given deviceDisplay LLDP Neighbor information on given device. |
get lldp neighbors <lldp-interface-name-kvm>
|
Displays LLDP Neighbor information on given deviceDisplays LLDP Neighbor information on given device. |
get lldp neighbors <lldp-interface-name>
|
Displays LLDP Statistics on all devicesDisplays LLDP Statistics on all devices. |
get lldp stats
|
Displays LLDP Statistics on given deviceDisplays LLDP Statistics on given device. |
get lldp stats <lldp-interface-name>
|
Show log file contentsDisplay the contents of the specified log file. |
get log-file <log-file-arg>
|
Show log file contentsDisplay the last 10 lines of the specified log file and all new messages that are written to the log file. |
get log-file <log-file-arg> follow
|
Display all configured logging serversDisplay logging server configuration. |
get logging-servers
|
Show logical service bindingDisplay a specific logical service binding. |
get logical-service binding <uuid-string-arg>
|
Show all logical service bindingsDisplay all logical service bindings. |
get logical-service bindings
|
Display a specific logical service portDisplay information for the specified logical service port. Optionally specify an argument to display the statistics. |
get logical-service port <uuid> [stats]
|
Display the logical service portsDisplay information for all logical service ports. Optionally specify an argument to display the statistics. |
get logical-service ports [stats]
|
Show logical service stateDisplay the state of a specific logical service. |
get logical-service state <uuid-string-arg>
|
Show all logical service statesDisplay the state of all logical services. |
get logical-service states
|
Get maintenance modeGet maintenance mode status. |
get maintenance-mode
|
Get maintenance modeGet maintenance mode |
get maintenance-mode
|
Show managersShow the current list of configured managers. |
get managers
|
Show the system memory statusDisplay the system memory information. |
get memory-stats
|
Display information about a mirror sessionDisplay information about the specified mirror session. |
get mirror-session <ms-id-arg>
|
Display mirror sessionsDisplay all mirror sessions on this host. |
get mirror-sessions
|
Get all name serversGet all name servers in the DNS configuration. |
get name-servers
|
Show namespace configDisplay a specific namespace config |
get namespace status <string-arg>
|
Show all namespace configsDisplay all namespace configs. |
get namespaces status
|
Show the system network statisticsDisplay the system network statistics. |
get network-stats
|
Get central-config propertiesGet central-config properties. |
get node central-config
|
Display upgrade status of the nodeDisplay upgrade status of the node. |
get node upgrade status
|
Show host UUIDDisplay the UUID for the host. |
get node-uuid
|
Show node UUIDShow the UUID for the node. |
get node-uuid
|
Display registered nodesDisplay the list of registered nodes. |
get nodes
|
Show NTP associationsDisplay the status of the NTP system. The delay, offset and dispersion values are in seconds. |
get ntp-server associations
|
Show NTP serversDisplay all NTP servers. |
get ntp-servers
|
Display the parent of current port or interfaceDisplay the parent of the current interface. |
get parent
|
Display the pathDisplay the path. The arrow indicates which interface is selected. Other commands, such as get current, will display information about the selected interface. |
get path
|
Show physical port by nameDisplay the specified physical port. |
get physical-port <dpd-name-physical-port-arg>
|
Show physical port stats by nameDisplay statistics for the specified physical port. |
get physical-port <dpd-name-physical-port-arg> stats
|
Show physical port verbose stats by nameDisplay verbose statistics for the specified physical port. |
get physical-port <dpd-name-physical-port-arg> stats verbose
|
Show physical port xstats by nameDisplay x statistics for the specified physical port. |
get physical-port <dpd-name-physical-port-arg> xstats
|
Show physical portDisplay all physical ports. |
get physical-ports
|
Display system processesDisplay a snapshot of the system processes. |
get processes
|
Show process monitorDisplay information about processes that are running. The display is updated every few seconds. |
get processes monitor
|
Monitor system processesDisplay information about processes that are running. The display is updated every few seconds. |
get processes monitor
|
Show managed VPCs/VNETsShow managed VPCs/VNETs |
get public-cloud-manager managed-vpcs
|
Show public cloud manager statusShow public cloud manager status |
get public-cloud-manager status
|
Get the realization status for the specified transport nodeGet the realization status for the specified transport node. |
get realization-status <uuid-arg>
|
Get all connected receiversDisplay all connected receivers. |
get receivers
|
Get all search domainsGet all domain names in the DNS search list. |
get search-domains
|
Display service propertiesDisplay information about the specified service. |
get service <service-name-arg>
|
Display global logging configurationDisplay global logging configuration. |
get service controller logging-config
|
Display configuration for logger with given log levelDisplay the logging configuration for components that have the specified log level. |
get service controller logging-config logging-level <controller-logging-level-arg>
|
Display configuration for given loggerDisplay the logging configuration for the specified component. |
get service controller logging-config name <string-arg-controller>
|
Display configuration for loggers matching to given regexDisplay the logging configuration for components that match the specified pattern. The pattern can be a regular expression. |
get service controller logging-config pattern <string-arg-controller>
|
Display the controller service logging levelDisplay the log level for the controller service. |
get service controller logging-level
|
Get the dataplane service logging levelDisplay the log level of the dataplane service. |
get service dataplane logging-level
|
Get the dhcp service logging levelDisplay the log level of the dhcp service. |
get service dhcp logging-level
|
Display DHCP pool monitor configurationDisplay DHCP pool monitor configuration |
get service dhcp pool-monitor
|
Get service HyperBus metrics logging levelGet service HyperBus metrics logging level |
get service hyperbus lib-metrics logging-level
|
Get service HyperBus nestdb logging levelGet service HyperBus nestdb logging level |
get service hyperbus lib-nestdb logging-level
|
Get service HyperBus net logging levelGet service HyperBus net logging level |
get service hyperbus lib-net logging-level
|
Get service HyperBus rpc logging levelGet service HyperBus rpc logging level |
get service hyperbus lib-rpc logging-level
|
Get service HyperBus logging levelGet service HyperBus logging level |
get service hyperbus logging-level
|
Display IKE per tunnel debugging configurationDisplay IKE per tunnel debugging configuration |
get service ike debug-tunnel
|
Get the IKE service logging levelDisplay the log level of the IKE service. |
get service ike logging-level
|
Get the local-controller service logging levelDisplay the log level of the local-controller service. |
get service local-controller logging-level
|
Get local-controller service stateDisplay the state of the local controller service. |
get service local-controller state
|
Get the log level of NSX Agent service.Get service nsx-agent logging level. |
get service nsx-agent logging-level
|
Get the whole cfgagent cache tableDisplay the whole cache table in cfgagent. Optionally specify arguments to display only the local configuration, remote configuration, local L2, or remote L2 information, and remote L3 information. |
get service nsx-cfgagent cache-table [{config | l2 | l3} {local | remote | logical-switch | logical-switch-port | logical-switch-port-list | transport-node | bridge-cluster | group-relation | mirror | ipfix | profile | container}]
|
Get HyperBus vmknicsDisplay the status for HyperBus vmknic ports on this hypervisor host. |
get service nsx-cfgagent hyperbus vmknic
|
Get service cfgagent metrics logging levelGet service cfgagent metrics logging level |
get service nsx-cfgagent lib-metrics logging-level
|
Get service cfgagent nestdb logging levelGet service cfgagent nestdb logging level |
get service nsx-cfgagent lib-nestdb logging-level
|
Get service cfgagent net logging levelGet service cfgagent net logging level |
get service nsx-cfgagent lib-net logging-level
|
Get service cfgagent rpc logging levelGet service cfgagent rpc logging level |
get service nsx-cfgagent lib-rpc logging-level
|
Get service cfgagent SHA client logging levelGet service cfgagent SHA client logging level. |
get service nsx-cfgagent lib-sha logging-level
|
Get service cfgagent workflow logging levelGet service cfgagent workflow logging level. |
get service nsx-cfgagent lib-wft logging-level
|
Get service cfgagent workflow trace levelGet service cfgagent workflow trace level. |
get service nsx-cfgagent lib-wft trace-level
|
Get service cfgagent logging levelGet service cfgagent logging level. |
get service nsx-cfgagent logging-level
|
Get LS's extra configDisplay the extra config list for logical switch on this hypervisor host. |
get service nsx-cfgagent logical-switch extra-config
|
Get LSP's extra configDisplay the extra config list for logical switch port on this hypervisor host. |
get service nsx-cfgagent logical-switch-port extra-config
|
Get the log level of context-muxGet service daemon log level for context-mux. |
get service nsx-context-mux logging-level
|
Get current status of IDFW on hostGet current status of IDFW on host |
get service nsx-ctxteng idfw status
|
Get context engine protocol enable in the order TCP UDP ICMPGet context engine protocol enable in the order TCP UDP ICMP |
get service nsx-ctxteng protocol
|
Get service netopa logging levelGet service netopa logging level. |
get service nsx-netopa logging-level
|
Get service opsagent SHA client logging levelGet service opsagent SHA client logging level. |
get service nsx-opsagent lib-sha logging-level
|
Get service opsagent workflow logging levelGet service opsagent workflow logging level. |
get service nsx-opsagent lib-wft logging-level
|
Get service opsagent workflow trace levelGet service opsagent workflow trace level. |
get service nsx-opsagent lib-wft trace-level
|
Get service OpsAgent logging levelGet service OpsAgent logging level. |
get service nsx-opsagent logging-level
|
Get service nsx-proxy central logging levelGet service nsx-proxy central logging level. |
get service nsx-proxy central logging-level
|
Get service nsx-proxy metrics logging levelGet service nsx-proxy metrics logging level. |
get service nsx-proxy lib-metrics logging-level
|
Get service nsx-proxy nestdb logging levelGet service nsx-proxy nestdb logging level. |
get service nsx-proxy lib-nestdb logging-level
|
Get service nsx-proxy net logging levelGet service nsx-proxy net logging level. |
get service nsx-proxy lib-net logging-level
|
Get service nsx-proxy rpc logging levelGet service nsx-proxy rpc logging level. |
get service nsx-proxy lib-rpc logging-level
|
Get service nsx-proxy logging levelGet service nsx-proxy logging level. |
get service nsx-proxy logging-level
|
Display service propertiesDisplay information about all services. |
get services
|
Show the remote site(s) and their sync statusDisplay the remote sites along with their sync status. |
get site-replicator remote-sites
|
Get SNMP v2 configured statusIndicates whether the local SNMP agent is configured with community string(s). |
get snmp v2-configured
|
Get SNMP v2 Trap TargetsGet SNMP v2 Trap Targets. |
get snmp v2-targets
|
Get SNMP v3 configured statusIndicates whether the local SNMP agent is configured with v3 user(s). |
get snmp v3-configured
|
Get SNMP v3 Engine IDGet SNMP v3 Engine ID. |
get snmp v3-engine-id
|
Get SNMP v3 ProtocolsGet SNMP v3 Protocols auth_protocol and priv_protocol. |
get snmp v3-protocols
|
Get SNMP v3 Trap TargetsGet SNMP v3 Trap Targets. |
get snmp v3-targets
|
Get SNMP v3 User IDsGet SNMP v3 User IDs. |
get snmp v3-users
|
Show active network connectionsDisplay active network connections. |
get sockets
|
Show active network connectionsDisplay active network connections. |
get sockets
|
Show the stretched cgroup translation on both local and remote sitesDisplay both local and remote translations for the specified stretched container group. Optionally specify a translation type to display translations of that type. |
get stretched cgroup <container-id> <translation-type>
(Deprecated)
|
Show the stretched group translation on both local and remote sitesDisplay both local and remote translations for the specified stretched group. Optionally specify a translation type to display translations of that type. |
get stretched group <group-id> <translation-type>
|
Save support bundle in filestoreDisplay the contents of the tech support bundle. Specify the file argument to save the bundle to a file with the specified file name in the file store. This support bundle does not contain core or audit log files. To include those files, specify the all argument. Core files contain system information and all information stored in memory at the time of the dump (this may include confidential, sensitive or personal information such as passwords and encryption keys, if they are being processed in memory at that time). If you choose to send the support bundle to VMware, it will be processed in accordance with VMware’s standard processes and policies, to provide you with support, fix problems and improve the product and services. |
get support-bundle [file <filename> [all]]
|
Save support bundle in filestoreSaves support bundle to the specified filename in the filestore. |
get support-bundle [file <filename>]
|
Display information about a IPFIX configurationDisplay information about the specified IPFIX configuration. |
get switch-ipfix logical-switch-port <logical-port-id-arg> setting
|
Display Switch Security config for a logical portDisplays Switch Security config for a logical port. |
get switch-security config <logical-port>
|
Display Switch Security stats for a logical portDisplays Switch Security stats for a logical port. |
get switch-security stats <logical-port>
|
Get the topology of the systemDisplay the topology of the system. |
get topology
|
Display transport node agent statusDisplay agent status information for the specified transport node. |
get transport-node <uuid-arg> agent-status
|
Display the ARP table for the specified transport nodeDisplay the ARP table for the specified transport node. |
get transport-node <uuid-arg> arp-table
|
Display the MAC address table for the specified transport nodeDisplay the MAC address table for the specified transport node. |
get transport-node <uuid-arg> mac-table
|
Display routing domains joined by the specified transport nodeDisplay routing domains joined by the specified transport node. |
get transport-node <uuid-arg> routing-domain
|
Display the routing vtep table for the specified transport nodeDisplay the routing vtep table for the specified transport node. |
get transport-node <uuid-arg> routing-vtep
|
Display transport node statusDisplay status information for the specified transport node. |
get transport-node <uuid-arg> status
|
Display transport node statusDisplay status information for the specified transport node. |
get transport-node <uuid-arg> threat-status
|
Display VIF information for the specified transport nodeDisplay VIF information for the specified transport node. |
get transport-node <uuid-arg> vifs
|
Display all VTEPs for the specified transport nodeDisplay all tunnel end points for the specified transport node. |
get transport-node <uuid-arg> vtep
|
Display status of all transport nodesDisplay status information for all transport nodes. |
get transport-nodes status
|
Display progress status of last upgrade stepDisplay the status of the upgrade steps run on the node and details of last upgrade step. |
get upgrade progress-status
|
Display playbook contentsDisplay the contents of the specified playbook for the specified upgrade bundle. |
get upgrade-bundle <bundle-name-arg> playbook <playbook-file-arg>
|
List all playbooks in the filestoreDisplay all playbooks in the file store. |
get upgrade-bundle playbooks
|
Show the system uptimeDisplay the system uptime information. |
get uptime
|
Get number of days the user's password is valid after a password changeGet 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 userGet SSH keys from authorized_keys file for specified user. |
get user <node-username> ssh-keys
|
Get user status for specified non-root userGet user status for specified non-root user. |
get user <node-username> status
|
Get V2T migration configGet V2T migration config. |
get v2t-migration-config
|
Display system versionDisplay the version of the NSX appliance. |
get version
|
Display system versionDisplay the version of the NSX appliance. |
get version
|
Display VIF infoDisplay information about the sepcified VIF. You can find VIF IDs with the get transport-node <uuid> vif command or the get logical-switch <uuid> ports command (see Child-UUID where Child-EntityType is VIF). |
get vif <vif-id-arg>
|
Dump the host's network mode and tagged interfaceDump the host's network mode and tagged interface. |
get vm-network-mode
|
Get VMC migration modeGet VMC migration mode status. |
get vmc migration-mode
|
Display info about EW policy service chainDisplay information about EW policy service chain. |
get vsip-si policy-service-chains
|
Display all selected service pathsDisplay selected paths info |
get vsip-si selected-service-paths <chain_id_esx>
|
Display info about EW service chainDisplay information about EW service chain. |
get vsip-si service-chains
|
Display info about EW service path.Display information about EW service path. |
get vsip-si service-paths
|
Display all service paths in orderDisplay service paths info |
get vsip-si service-paths <chain_id_esx>
|
Display active service paths in order of path selection policyDisplay active service paths info |
get vsip-si service-paths <chain_id_esx> active
|
Display all service paths in order of path selection policyDisplay service paths info |
get vsip-si service-paths <chain_id_esx> all
|
Display service paths in maintenanceDisplay maintanence service paths info |
get vsip-si service-paths <chain_id_esx> maintenance-mode
|
Display info about EW service path with specific chain id.Display information about EW service path with specific chain id. |
get vsip-si service-paths <dpd-id-service-chain-arg>
|
Display info about service policiesDisplay information about service policies. |
get vsip-si service-policies
|
Display vswitch runtime optionsDisplay all vSwitch runtime options on this host. |
get vswitch runtime
|
Display help for specified command or list available commandsDisplay help information. See the example below. |
help
|
Install NSX Edge service container imageInstall NSX Edge service container image. |
install image <configurable-image-name> version <configurable-image-version>
|
Join this node to a NSX ClusterJoin this node to a management cluster. You must provide the API username and password of a node that is already in the cluster. On that node, you can run the get cluster config command to get the cluster ID, and run the get certificate api thumbprint command to get the thumbprint. If you do not provide a password on the command line, you will be prompted to enter one. |
join <ip-address[:port]> cluster-id <cluster-id> thumbprint <thumbprint> [token <api-token>] [username <username> [password <password>]] [force]
|
Join node to the management planeJoin this node to the management plane. |
join management-plane <hostname-or-ip-address[:port]> thumbprint <thumbprint> token <token> [node-uuid <uuid>] [replace]
|
Join host with management planeJoin this hypervisor host with the management plane. You can specify any NSX Manager in the management cluster in this command. Use the API username and password for the specified NSX Manager. If you do not provide a password on the command line, you will be prompted to enter one. Get the NSX Manager thumbprint by running the
|
join management-plane <hostname-or-ip-address[:port]> username <username> thumbprint <thumbprint> [password <password>]
|
Join node to the management planeJoin this node to the management plane. |
join management-plane <hostname-or-ip-address[:port]> username <username> thumbprint <thumbprint> [password <password>] [node-uuid <uuid>] [replace]
|
Join node with the management planeJoin this keymanager with the management plane. You can specify any NSX Manager in the management cluster in this command. Use the API username and password for the specified NSX Manager. If you do not provide a password on the command line, you will be prompted to enter one. Get the NSX Manager thumbprint by running the Specify the network interface name used for hypervisors to request keys. |
join management-plane <ip-address[:port]> username <username> thumbprint <thumbprint> [password <password>] [interface-name <interface-name>]
|
List available commandsThis command lists all available commands. |
list
|
nslookupDisplay nslookup information. |
nslookup <hostname-arg>
|
nslookupGet DNS lookup information. Note that when run on an NSX Manager, the responding server is reported as 127.0.0.1 instead of the configured name server. |
nslookup <hostname-arg>
|
Run command on registered cluster/fabric nodesRun a command on the specified cluster/fabric node. |
on <registered-node-uuid> exec [<command>]
|
Enter path context modeEnter 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 Once you are in the path context, use the path commands to navigate and get information, for example, |
path <dpd-uuid-lrouter-port-arg> <ip46-address>
|
Ping hostPing an IP address. Use Control-C to stop the ping command. |
ping <hostname-or-ip-address>
|
Ping hostPing a host or IP address. Use Control-C to stop the command. Optionally use the repeat argument to specify how many packets to transmit. |
ping <hostname-or-ip-address> [repeat <number>]
|
Ping hostPing an IP address. Use Control-C to stop the ping command. The repeat argument specifies how many ping
packets to transmit.
The size argument specifies the size of the ping
packet. The dfbit argument specifies whether to
set the "don't fragment" bit in the ping packet. If enabled, the
packet will not be fragmented.
The |
ping <hostname-or-ip-address> [repeat <number>] [size <number>] [source <hostname-or-ip-address>] [dfbit enable]
|
Ping hostPing an IP address. Use Control-C to stop the ping command. The repeat argument specifies how many ping
packets to transmit. The vrf argument
specifies which VRF to send the pings from. You can get a list of
available VRFs with the get logical-routers command.
The size argument specifies the size of the ping
packet. The dfbit argument specifies whether to
set the "don't fragment" bit in the ping packet. If enabled, the
packet will not be fragmented.
The |
ping <hostname-or-ip-address> [repeat <number>] [size <number>] [source <hostname-or-ip-address>] [dfbit enable] [vrfid <vrf-id>]
|
Ping IPv6 hostPing an IPv6 address. Use Control-C to stop the ping command. |
ping6 <ip6-address>
|
Ping IPv6 hostIssue a ping command for IPv6 host. The |
ping6 <ip6-address> [egress <dpd-uuid-lrouter-port-arg>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The |
ping6 <ip6-address> [repeat <number>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The |
ping6 <ip6-address> [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]
|
Ping IPv6 hostPing an IPv6 address. Use Control-C to stop the ping command. The |
ping6 <ip6-address> [size <number>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The |
ping6 <ip6-address> [size <number>] [egress <dpd-uuid-lrouter-port-arg>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The |
ping6 <ip6-address> [size <number>] [repeat <number>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The The |
ping6 <ip6-address> [size <number>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]
|
Ping IPv6 hostPing an IPv6 address. Use Control-C to stop the ping command. The |
ping6 <ip6-address> [source <ip6-address>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The |
ping6 <ip6-address> [source <ip6-address>] [egress <dpd-uuid-lrouter-port-arg>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The The |
ping6 <ip6-address> [source <ip6-address>] [repeat <number>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The The |
ping6 <ip6-address> [source <ip6-address>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The The |
ping6 <ip6-address> [source <ip6-address>] [size <number>] [egress <dpd-uuid-lrouter-port-arg>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The The |
ping6 <ip6-address> [source <ip6-address>] [size <number>] [repeat <number>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The The The |
ping6 <ip6-address> [source <ip6-address>] [size <number>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The |
ping6 <ip6-address> [source <ip6-address>] [vrfid <vrf-id>]
|
Ping IPv6 hostPing an IPv6 address. Use Control-C to stop the ping command. The |
ping6 <ip6-address> [vrfid <vrf-id>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The |
ping6 <ip6-address> [vrfid <vrf-id>] [egress <dpd-uuid-lrouter-port-arg>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The |
ping6 <ip6-address> [vrfid <vrf-id>] [repeat <number>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The The The |
ping6 <ip6-address> [vrfid <vrf-id>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The |
ping6 <ip6-address> [vrfid <vrf-id>] [size <number>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The The |
ping6 <ip6-address> [vrfid <vrf-id>] [size <number>] [egress <dpd-uuid-lrouter-port-arg>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The The |
ping6 <ip6-address> [vrfid <vrf-id>] [size <number>] [repeat <number>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The The The |
ping6 <ip6-address> [vrfid <vrf-id>] [size <number>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The |
ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The The |
ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [egress <dpd-uuid-lrouter-port-arg>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The The The |
ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [repeat <number>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The The The |
ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The The |
ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [size <number>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The The The |
ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [size <number>] [egress <dpd-uuid-lrouter-port-arg>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. Ping an IPv6 address. Use Control-C to stop the ping command. The The The The |
ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [size <number>] [repeat <number>]
|
Ping IPv6 hostIssue a ping command for IPv6 host. The The The The |
ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [size <number>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]
|
Push certificate to management planePushes host certificate to management plane. Use the API username and password for the specified NSX Manager. If you do not provide a password on the command line, you will be prompted to enter one. Get the NSX Manager thumbprint by running the |
push host-certificate <manager-hostname-or-ip-address-and-optional-port-arg> username <api-username> thumbprint <api-thumbprint>
|
Reboot systemReboot the system. If you specify the force argument, the system will reboot immediately without prompting for confirmation. |
reboot [force]
|
Reset corelist related boot time option to factory defaultReset the corelist-related boot time option to factory default. |
reset dataplane corelist
|
Reset custom list of supported devices on the systemReset custom list of supported devices on the system. |
reset dataplane device list
|
Reset hugepage related boot time option to factory defaultReset the hugepage-related boot time option to factory default. |
reset dataplane hugepage
|
Recover management plane account on the hostRecover management plane account on the host. You can specify any NSX Manager in the management cluster in this command. Use the API username and password for the specified NSX Manager. If you do not provide a password on the command line, you will be prompted to enter one. Get the NSX Manager thumbprint by running the |
reset management-plane <hostname-or-ip-address[:port]> username <username> thumbprint <thumbprint> [password <password>]
|
Restart serviceRestart the specified service. |
restart service <restartable-service-name-arg>
|
Restore KeyManager from backed up dataRestore a backup of NSX KeyManager node data. If you do not provide a passphrase on the command line, you will be prompted to enter one. If you cannot remember the passphrase used to create the backup, you will not be able to restore the backup. Important: This restore request is one part of the restore
process. You must complete all backup and restore tasks in the
correct order. See the NSX-T Administration
Guide for information and instructions about performing backups
and restores.
|
restore node file <filename> [passphrase <passphrase>]
|
Execute playbook resume actionResume an upgrade after running the command start upgrade-bundle <bundle-name> playbook <playbook-file> and the system was rebooted. |
resume upgrade-bundle <bundle-name-arg> playbook
|
Set API account lockout periodSets 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 periodIn 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 faliuresSet 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 periodSets 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 faliuresSet 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 lengthSet 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 enabled propertySet the vidm service's enabled property. |
set auth-policy vidm enabled
|
Set auth-policy vidm propertiesSet 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 auth-policy vidm lb-extern enabled propertySet the external load balancer enabled property. |
set auth-policy vidm lb-extern enabled
|
Set security banner or message of the daySet the security banner or message of the day. |
set banner
|
Set status to display datetime stampSet status to display datetime stamp in command output. |
set cli-output datetime <datetime-arg>
|
Set inactivity timeoutSet inactivity timeout in seconds. To disable the timeout, specify 0. |
set cli-timeout <timeout-arg>
|
Set Cluster Virtual IPSet Cluster Virtual IP. |
set cluster vip <ip-address>
|
Enable/disable control packet prioritizationEnable/disable control packet prioritization |
set dataplane ctrl-prio <enabled-arg>
|
Set the custom list of physical NICsSet the custom list of physical NICs. |
set dataplane device list <pci-address-arg>
|
Enable/disable dynamic core featureEnabling dynamic core feature will allow fastpath cores to be shared when they are not busy and slowpath cores are busy. |
set dataplane dynamic-core <enabled-arg>
|
Enable/disable flow cacheEnable or disable flow cache. |
set dataplane flow-cache <enabled-arg>
|
Set the flow cache size for each coreSet the flow cache size for each core |
set dataplane flow-cache-size <flow-cache-size-arg>
|
Enable/disable geneve critical bitEnable or disable geneve critical bit. |
set dataplane geneve-cbit <enabled-arg>
|
Enable/disable interrupt modeEnable or disable interrupt mode. |
set dataplane interrupt-mode <enabled-arg>
|
Change the size of the buffer pool for jumbo frame crypto operationsChange the jumbo mbuf pool size |
set dataplane jumbo-mbuf-pool-size <jumbo-mbuf-pool-size-arg>
|
Enable/disable pmtu message generation in l2vpnEnable or disable pmtu message generation in l2vpn. |
set dataplane l2vpn-pmtu <enabled-arg>
|
Change the max number of packets that can be queued on each coreChange the per-core packet queue limit |
set dataplane packet-queue-limit <packet-queue-limit-arg>
|
Enable/disable pmtu learning in dataplaneEnable or disable pmtu learning in dataplane. |
set dataplane pmtu-learning <enabled-arg>
|
Enable/disable QAT device usage for IPsec (bare metal edge only)Enable or disable QAT device usage for IPsec. |
set dataplane qat <enabled-arg>
|
Set Rx/Tx queue number per port per coreSet Rx/Tx queue number per port per core |
set dataplane queue-num-per-port-per-core <queue-num-per-port-per-core-arg>
|
Set the rx ring size for physical portsSet the rx ring size for physical ports. |
set dataplane ring-size rx <ring-size-arg>
|
Set the tx ring size for physical portsSet the tx ring size for physical ports. |
set dataplane ring-size tx <ring-size-arg>
|
Change ENS lcore assignment modeChange mode of enhanced datapath lcore assignment. |
set ens lcore-assignment-mode <hs-name-arg> <ens-lc-mode-arg>
|
Set the acceptance of End User License AgreementSet the acceptance of the end user license agreement. |
set eula accepted
|
Set geneve critival bitSet geneve critival bit. |
set geneve-cbit <boolean-arg> dvs <dvs-name-arg>
|
Set gw-controller log levelSet gw-controller log level |
set gw-controller logging-level <Level>
|
Enable/Disable VM log forwarding for all VMsEnable/Disable VM log forwarding for all VMs |
set gw-controller vm-log-forwarding <enabled-clear-arg>
|
Enable/Disable VM log forwarding for one VMEnable/Disable VM log forwarding for one VM |
set gw-controller vm-log-forwarding <enabled-clear-arg> <VmID>
|
Set commands history sizeSet command history size. |
set history limit <history-size>
|
Set mcast filter mode for a host switchSet the mcast filter mode for the specified host switch. |
set host-switch <hs-name-arg> mcast-filter <mcast-filter-mode-arg>
|
Set host switch upgrade statusSet host switch upgrade status. |
set host-switch upgrade-status <boolean-arg>
|
Set system hostnameSet the system hostname. Changing the hostname changes the command line prompt. |
set hostname <hostname-arg>
|
Reserve hugepage for dataplane using system defaultSet the hugepage reserve size for the data plane using system default. |
set hugepage-reserve auto
|
Reserve hugepage for dataplaneSet the hugepage reserve size for the data plane. |
set hugepage-reserve size <hugepage-size-arg>
|
Configure the specified interface to use DHCPConfigure the specified interface to use DHCP. You cannot configure DHCP for NSX Manager or a controller because both must have a static IP address. |
set interface <configurable-interface-name> dhcp
|
Configure the specified interface to use DHCPConfigure the specified interface to use DHCP. |
set interface <configurable-interface-name> dhcp plane <interface-plane-arg> mode <bond-mode-arg> members <bond-slaves-arg> primary <bond-primary-arg>
|
Configure a bond interface and set the interface plane modeCreate bond interface and set the plane property of the interface and config the IP address. If plane is set to mgmt, it is reported as such to the management plane (MP) via MPA, and the slave devices are not consumed by dataplane for dataplane operations. You can configure the bond interface with a DHCP or static IP address. If you configure a static IP address, make sure an appropriate network route is also configured. |
set interface <configurable-interface-name> ip <cidr-notation> gateway <gateway-ip-address-arg> plane <interface-plane-arg> mode <bond-mode-arg> members <bond-slaves-arg> primary <bond-primary-arg>
|
Create VLAN network interfaceCreate a VLAN network interface from the specified parent interface and VLAN id. The new vlan network interface name will be of format interface. and the interface's plane property will be set to mgmt. Any existing configuration on the parent interface will be deleted. Users must use the newly created VLAN network interface for configuration. |
set interface <configurable-interface-name> vlan <vlan-id> plane mgmt
|
Create an in-band VLAN network interfaceCreate an in-band VLAN network interface from the physical interface identified by the mac. If the physical interface is not already owned by the edge dataplane, the dataplane service will be restarted in order to claim the physical interface. The new inband vlan network interface name will be of format ethX.vlan and the interface's plane property will be set to mgmt. Users must use the newly created in-band VLAN network interface for configuration. |
set interface mac <configurable-mac-address> vlan <vlan-id> in-band plane mgmt
|
Set logging-serverConfigure a logging server. The logging system uses the facility codes defined in RFC 5424. Facility local7 is used for audit messages, and local6 is used for non-audit messages. |
set logging-server <hostname-or-ip-address[:port]> proto <proto> level <level> [facility <facility>] [messageid <messageid>] [serverca <filename>] [clientca <filename>] [certificate <filename>] [key <filename>] [structured-data <structured-data>]
|
Set logging-serverConfigure a logging server. The logging system uses the facility codes defined in RFC 5424. Facility local7 is used for audit messages, and local6 is used for non-audit messages. |
set logging-server <hostname-or-ip-address[:port]> proto <proto> level <level> [facility <facility>] [messageid <messageid>] [serverca <filename>] [structured-data <structured-data>]
|
Set maintenance modeEnable or disable maintenance mode. Maintenance mode can be used during upgrade and debugging. When an TN is in maintenance mode only management traffic will be passed; data traffic will be dropped. |
set maintenance-mode <nsxproxy-maintenance-mode-arg>
|
Add name serverAdd a name server to the DNS configuration. |
set name-servers <name-server-arg>
|
Set kubeconfig file of the NAPP Kubernetes clusterSet kubeconfig file of the NAPP Kubernetes cluster. This operation overrides any existing NAPP kubeconfig file. |
set napp kubeconfig
|
Ignore Central Config from the Manager to this applianceIgnore Central Config from the Manager to this appliance. |
set node central-config disabled
|
Synchronize Central Config from the Manager to this applianceSynchronize Central Config from the Manager to this appliance. |
set node central-config enabled
|
Add NTP serverConfigure a new NTP server. |
set ntp-server <hostname-or-ip-address>
|
Set the specified physical port mtu to given valueSet the specified physical port mtu to given value. |
set physical-port <dpd-name-physical-port-arg> mtu <dpd-physical-port-mtu-arg>
|
Set the specified physical port admin state up or downSet the specified physical port admin state up or down. |
set physical-port <dpd-name-physical-port-arg> state <dpd-physical-port-state-arg>
|
Set repository state propertiesSet current node's IP address as repository IP. This command will restart the install-upgrade service. |
set repository-ip
|
Add a domain nameAdd a domain name to the DNS search list. |
set search-domains <search-domain-arg>
|
Set async replicator service logging levelSet the log level of the async replicator service. |
set service async_replicator logging-level <async-replicator-level-arg>
|
Set the controller service logging levelSet the log level for the controller service. |
set service controller logging-level <controller-logging-level-arg>
|
Set log level for given loggerSet the log level for the specified component. |
set service controller logging-level name <string-arg-controller> <controller-logging-level-arg>
|
Set log level for loggers matching regexSet the log level for components that match the specified pattern. The pattern can be a regular expression. |
set service controller logging-level pattern <string-arg-controller> <controller-logging-level-arg>
|
Set the Dataplane service logging levelSet the log level of the Dataplane service. |
set service dataplane logging-level <edge-service-logging-level-arg>
|
Set the DHCP service logging levelSet the log level of the DHCP service. |
set service dhcp logging-level <edge-service-logging-level-arg>
|
Enable/Disable DHCP pool monitor and set monitor interval in secondsEnable or disable DHCP pool monitor and set monitor interval in seconds |
set service dhcp pool-monitor <monitor-flag-arg> monitor-interval <monitor-interval-arg>
|
Enable or disable basic authentication in API calls.Enable or disable basic authentication in API calls. |
set service http basic-authentication <enabled-arg>
|
Set http API per-client concurrency limit, 0 to disableSet the HTTP API per-client concurrency limit value. |
set service http client-api-concurrency-limit <http-client-api-concurrency-limit-arg>
|
Set http per-client API rate limit, 0 to disableSet the HTTP API per-client rate limit value. |
set service http client-api-rate-limit <http-client-api-rate-limit-arg>
|
Set http service connection timeout, 0 to disableSet the HTTP service connection timeout value. |
set service http connection-timeout <http-conn-timeout-arg>
|
Enable or disable cookie-based authentication in API calls.Enable or disable cookie-based authentication in API calls. |
set service http cookie-based-authentication <enabled-arg>
|
Set http API global concurrency limit, 0 to disableSet the HTTP API global concurrency limit value. |
set service http global-api-concurrency-limit <http-global-api-concurrency-limit-arg>
|
Set HTTP service logging levelSet the log level of the HTTP service. |
set service http logging-level <http-level-arg>
|
Set http service redirect hostSet the HTTP service redirect host. |
set service http redirect-host <hostname-or-ip-address>
|
Set http service session timeout, 0 to disableSet the HTTP service session timeout value. |
set service http session-timeout <http-timeout-arg>
|
Set service hyperbus metrics logging levelSet service hyperbus metrics logging level |
set service hyperbus lib-metrics logging-level <hyperbus-logging-level-arg>
|
Set service hyperbus nestdb logging levelSet service hyperbus nestdb logging level |
set service hyperbus lib-nestdb logging-level <hyperbus-logging-level-arg>
|
Set service hyperbus net logging levelSet service hyperbus net logging level |
set service hyperbus lib-net logging-level <hyperbus-logging-level-arg>
|
Set service hyperbus rpc logging levelSet service hyperbus rpc logging level |
set service hyperbus lib-rpc logging-level <hyperbus-logging-level-arg>
|
Set service hyperbus logging levelSet service hyperbus logging level |
set service hyperbus logging-level <hyperbus-logging-level-arg>
|
Enable/Disable IKE per tunnel debuggingEnable or disable ike per tunnel debug mode |
set service ike debug-tunnel local-ip <ipv4-addr> remote-ip <ipv4-addr> debug-level <debug-level-arg>
|
Enable/Disable IKE per tunnel debuggingEnable or disable ike per tunnel debug mode |
set service ike debug-tunnel local-ip <ipv4-addr> remote-ip <ipv4-addr> debug-level <debug-level-arg> follow
|
Set the IKE service logging levelSet the log level of the IKE service. |
set service ike logging-level <edge-service-logging-level-arg>
|
Set install-upgrade service enabled propertySet the install-upgrade service's enabled property. |
set service install-upgrade enabled
|
Set keymanager service logging levelSet the log level of the keymanager service. |
set service keymanager logging-level <keymanager-level-arg>
|
Set the Local Controller service logging levelSet the log level of the Local Controller service. |
set service local-controller logging-level <edge-service-logging-level-arg>
|
Set manager service logging levelSet the log level of the manager service. |
set service manager logging-level <manager-level-arg>
|
Set manager service package logging levelSet the log level of the specified package in manager service. |
set service manager logging-level <manager-level-arg> package <manager-package-name-arg>
|
Set the log level of NSX Agent service.Dynamically set service daemon log level. |
set service nsx-agent logging-level <nsx-agent-logging-level-arg>
|
Set service cfgagent metrics logging levelSet service cfgagent metrics logging level |
set service nsx-cfgagent lib-metrics logging-level <cfgagent-logging-level-arg>
|
Set service cfgagent nestdb logging levelSet service cfgagent nestdb logging level |
set service nsx-cfgagent lib-nestdb logging-level <cfgagent-logging-level-arg>
|
Set service cfgagent net logging levelSet service cfgagent net logging level |
set service nsx-cfgagent lib-net logging-level <cfgagent-logging-level-arg>
|
Set service cfgagent rpc logging levelSet service cfgagent rpc logging level |
set service nsx-cfgagent lib-rpc logging-level <cfgagent-logging-level-arg>
|
Set service cfgagent SHA client logging levelSet service cfgagent SHA client logging level. |
set service nsx-cfgagent lib-sha logging-level <cfgagent-logging-level-arg>
|
Set service cfgagent workflow logging levelSet service cfgagent workflow logging level. |
set service nsx-cfgagent lib-wft logging-level <cfgagent-logging-level-arg>
|
Set service cfgagent workflow trace levelSet service cfgagent workflow trace level. |
set service nsx-cfgagent lib-wft trace-level <cfgagent-workflowtrace-level-arg>
|
Set service cfgagent logging levelSet service cfgagent logging level. |
set service nsx-cfgagent logging-level <cfgagent-logging-level-arg>
|
Set the log level of nsx-context-muxDynamically set service daemon log level. |
set service nsx-context-mux logging-level <context-mux-logging-level-arg>
|
Enable/disable TCP UDP ICMP eventsEnable/disable TCP UDP ICMP events |
set service nsx-ctxteng protocol <protocol> <enable>
|
Set the log level of exporter service.Dynamically set service daemon log level. |
set service nsx-exporter logging-level <level>
|
Set service netopa logging levelSet service netopa logging level. |
set service nsx-netopa logging-level <netopa-logging-level-arg>
|
Set service opsagent SHA client logging levelSet service opsagent SHA client logging level. |
set service nsx-opsagent lib-sha logging-level <opsagent-logging-level-arg>
|
Set service opsagent workflow logging levelSet service opsagent workflow logging level. |
set service nsx-opsagent lib-wft logging-level <opsagent-logging-level-arg>
|
Set service opsagent workflow trace levelSet service opsagent workflow trace level. |
set service nsx-opsagent lib-wft trace-level <opsagent-workflowtrace-level-arg>
|
Set service OpsAgent logging levelSet service OpsAgent logging level. |
set service nsx-opsagent logging-level <opsagent-logging-level-arg>
|
Set the log level of platform client service.Dynamically set service daemon log level. |
set service nsx-platform-client logging-level <platform-client-logging-level-arg>
|
Set service nsx-proxy central logging levelSet service nsx-proxy central logging level |
set service nsx-proxy central logging-level <nsxproxy-logging-level-arg>
|
Set service nsx-proxy metrics logging levelSet service nsx-proxy metrics logging level. |
set service nsx-proxy lib-metrics logging-level <nsxproxy-logging-level-arg>
|
Set service nsx-proxy nestdb logging levelSet service nsx-proxy nestdb logging level. |
set service nsx-proxy lib-nestdb logging-level <nsxproxy-logging-level-arg>
|
Set service nsx-proxy net logging levelSet service nsx-proxy net logging level. |
set service nsx-proxy lib-net logging-level <nsxproxy-logging-level-arg>
|
Set service nsx-proxy rpc logging levelSet service nsx-proxy rpc logging level. |
set service nsx-proxy lib-rpc logging-level <nsxproxy-logging-level-arg>
|
Set service nsx-proxy logging levelSet service nsx-proxy logging level. |
set service nsx-proxy logging-level <nsxproxy-logging-level-arg>
|
Set NTP service start on bootConfigure the NTP service to start on boot. |
set service ntp start-on-boot
|
Set policy service logging levelSet the log level of the policy service. |
set service policy logging-level <policy-level-arg>
|
Set log level for routing serviceSet the log level of the FRR service. |
set service router logging-level <edge-routing-service-logging-destination-arg> <edge-routing-service-logging-level-arg>
|
Set log level for routing platform serviceSet the log level of the routing platform and config services. |
set service routing-platform logging-level <edge-routing-platform-service-logging-level-arg>
|
Set snmp service start on bootConfigure the snmp service to start on boot. |
set service snmp start-on-boot
|
Set SSH service start on bootConfigure the SSH service to start on boot. |
set service ssh start-on-boot
|
Set SNMP service v1/v2c community stringSet the SNMP service v1/v2c community string in ciper text. This must be set before MIBs can be queried. Choose a string that is difficult to guess. |
set snmp community
|
Set SNMP service v1/v2c community stringSet the SNMP service v1/v2c community string. This must be set before MIBs can be queried. Choose a string that is difficult to guess. |
set snmp community <snmp-community-arg>
|
Set SNMP v2 Trap TargetsSet SNMP v2 Trap Targets. |
set snmp v2-targets <hostname-or-ip-address-optional-port-arg> community <snmp-community-arg>
|
Set SNMP v3 Engine IDSet SNMP v3 Engine ID. |
set snmp v3-engine-id <v3-engine-id-arg>
|
Set SNMP v3 ProtocolsSet SNMP v3 Protocols auth_protocol and priv_protocol. |
set snmp v3-protocols auth-protocol <v3-auth-protocol-arg> priv-protocol <v3-priv-protocol-arg>
|
Set SNMP v3 Trap TargetsSet SNMP v3 Trap Targets. |
set snmp v3-targets <hostname-or-ip-address-optional-port-arg> user <user-id-arg>
|
Set SNMP v3 usersSet SNMP v3 users,auth-password,priv-password in cipher text. |
set snmp v3-users <user-id-arg>
|
Set SNMP v3 usersSet SNMP v3 users auth-password,priv-password in plain text. |
set snmp v3-users <user-id-arg> auth-password <auth-password-arg> priv-password <priv-password-arg>
|
Set SSH Root login propertyEnable SSH Root login property |
set ssh root-login
|
Set system timezoneSet the system timezone. |
set timezone <timezone-arg>
|
Set number of days the user's password is valid after a password changeSet 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 userSet new user name for the specified non-root user. |
set user <node-username> username <new-node-username>
|
Set user passwordSet 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 userAdd 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>]
|
Set V2T migration configEnable or disable V2T migration. V2T migration is enabled used during V2T migration. When V2T migration is enabled, Edge will send GARP for DR ports when Edge HA state becomes Active. |
set v2t-migration-config <enabled-arg>
|
Set VMC migration modeEnable or disable VMC migration mode. Migration mode is used during upgrade. When an Edge is in VMC migration mode, VMC config will not be written to nestdb. |
set vmc migration-mode <enabled-arg>
|
set one vswitch runtime optionSet a runtime option for the specified vSwitch. |
set vswitch runtime <option-name-arg> <option-value-arg>
|
Shutdown systemShut down the system. If you specify the force argument, the system will shut down immediately without prompting for confirmation. |
shutdown [force]
|
Start Flow MonitorStart flow monitor on a certain core for a given time. Flow monitor will start immediately and stop and dump the flow file automatically after the time passed. Dump file will be stored at /var/vmware/nsx/file-store/flow_mon. |
start flow-monitor [core <core-id>] [timeout <time>]
|
Re-sync search serviceExecute full or partial re-sync of search service datastore. |
start search resync <search-scope-arg>
|
Start serviceStart the specified service. |
start service <start-stoppable-service-name-arg>
|
Execute a playbook given a valid playbook fileStart an upgrade with the specified upgrade bundle and according to the specified playbook. |
start upgrade-bundle <bundle-name-arg> playbook <playbook-file-arg>
|
Stop serviceStop the specified service. |
stop service <service name> [force]
|
Move to the top of the pathMove to the top of the path. The arrow moves to show which interface is current. |
top
|
tracerouteTrace the route to the specified IPv4 address or host. |
traceroute <hostname-or-ip-address>
|
tracerouteTrace the route to the specified IPv4 address or host. |
traceroute <ip-address>
|
tracerouteTrace the route to the specified IP address. The The |
traceroute <ip-address> [source <ip-address>] [maxttl <number>]
|
tracerouteTrace the route to the specified IP address. The maxttl specifies the maximum time-to-live, or
maximum number of routers the traceroute packet will traverse.
The The |
traceroute <ip-address> [source <ip-address>] [maxttl <number>] [vrfid <vrf-id>]
|
traceroute6Trace the route to target IPv6 address. |
traceroute6 <ip6-address>
|
traceroute6Trace the route to the specified IPv6 address. The maxttl specifies the maximum time-to-live, or maximum number of routers the traceroute packet will traverse. |
traceroute6 <ip6-address> [maxttl <number>]
|
traceroute6Trace the route to the specified IPv6 address. The |
traceroute6 <ip6-address> [source <ip6-address>]
|
traceroute6Trace the route to the specified IPv6 address. The The |
traceroute6 <ip6-address> [source <ip6-address>] [maxttl <number>]
|
traceroute6Trace the route to the specified IPv6 address. The |
traceroute6 <ip6-address> [vrfid <vrf-id>]
|
traceroute6Trace the route to the specified IPv6 address. The maxttl specifies the maximum time-to-live, or maximum number of routers the traceroute packet will traverse. The |
traceroute6 <ip6-address> [vrfid <vrf-id>] [maxttl <number>]
|
traceroute6Trace the route to the specified IPv6 address. The The |
traceroute6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>]
|
traceroute6Trace the route to the specified IPv6 address. The The The |
traceroute6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [maxttl <number>]
|
Move up the pathMove up the path. The arrow moves to show which interface is current. |
up
|
VDS Migrate Apply TopologyVDS Migrate Apply Topology |
vds-migrate apply-topology
|
VDS Migrate delete TopologyVDS Migrate delete Topology |
vds-migrate delete-topology
|
VDS Migrate DisableVDS Migrate Disable |
vds-migrate disable-migrate
|
Migrate NVDS to VDS By Cluster IdMigrate NVDS to VDS By Cluster Id |
vds-migrate esxi-cluster-id <cluster-id> [maintenance-timeout <timeout>]
|
Migrate NVDS to VDS By Cluster NameMigrate NVDS to VDS By Cluster Name |
vds-migrate esxi-cluster-name <cluster-name> [maintenance-timeout <timeout>]
|
VDS Migrate PrecheckVDS Migrate Precheck |
vds-migrate precheck
|
VDS Migrate Show TopologyVDS Migrate Show Topology |
vds-migrate show-topology
|
Migrate NVDS to VDS By Tn ListMigrate NVDS to VDS By Tn List |
vds-migrate tn-list <configfile> [maintenance-timeout <timeout>]
|
Verify NSX Edge service container image fileVerify NSX Edge service container image file. |
verify image <configurable-image-filename>
|
Verify all configured logging serversVerify iptables rules for all logging servers and update if needed |
verify logging-servers
|
Verify and extract bundle to default locationVerify and extract the specified upgrade bundle to the default location. |
verify upgrade-bundle <bundle-name-arg>
|