NSX CLI Guide

Associated Commands:

CLI Description	Command
Reset flow cache stats for all fastpath cores Clear flow cache statistics for all fastpath cores.	clear dataplane flow-cache stats
Clear Edge Cluster state history Clear the Edge cluster state history.	clear edge-cluster history state
Clear the gateway high availability state history Clear 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 history Clear the high availability state history for the gateway in the VRF context.	clear gateway high-availability history state
Clear stats for a high-availability channel Clear 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 channels Clear statistics for all high-availability channels.	clear high-availability channels stats
Clear the logical router high availability state history Clear the high availability state history for the logical router in the VRF context.	clear high-availability history state
Clear stats for a high-availability session Clear 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 sessions Clear statistics for all high-availability sessions.	clear high-availability sessions stats
Deletes LLDP Neighbor information on all devices Deletes LLDP Neighbor information on all devices.	clear lldp neighbors
Deletes LLDP Neighbor information on given device Deletes LLDP Neighbor information on given device.	clear lldp neighbors <lldp-interface-name>
Deletes LLDP Statistics on all devices Deletes LLDP Statistics on all devices.	clear lldp stats
Deletes LLDP Statistics on given device Deletes LLDP Statistics on given device.	clear lldp stats <lldp-interface-name>
Clear the logical router high availability state history Clear 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 state Deletes 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 physical port stats by name Clear statistics for the specified physical port.	clear physical-port <dpd-name-physical-port-arg> stats
Delete the host's public cloud gateway certificate Delete the host's public cloud gateway certificate	del gateway certificate <ip-address>
Delete all the host's public cloud gateway certificates Delete all the host's public cloud gateway certificates	del gateway certificates
Remove public cloud VM certificate Remove public cloud VM certificate	del gw-controller vm-certificate <VmID>
Delete NSX Edge service container image Delete NSX Edge service container image. Only images that are not in use can be deleted.	del image <configurable-image-name> version <configurable-image-version>
Get bond interface stats Display 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 stats Display all bond interfaces. Specify the `stats` argument to display the statistics for the interfaces.	get bonds [stats]
Get dataplane configurations Display Data Plane Development Kit (DPDK) configurations, which include fastpath cores, hugepage reserved, NUMA, physical port bindings, etc.	get dataplane
Get the cpu stats for dataplane Display data plane cpu statistics.	get dataplane cpu stats
Get the list of supported devices on the system Get the list of supported devices on the system.	get dataplane device list
Check status of dynamic core feature Check status of dynamic core feature.	get dataplane dynamic-core
Get flow cache configuration Display the flow cache configurations.	get dataplane flow-cache config
Get flow cache stats for all fastpath cores Display flow cache statistics for all fastpath cores.	get dataplane flow-cache stats
Get flow cache stats for cores selected in coremask Display the flow cache statistics for the specified fastpath cores.	get dataplane flow-cache stats <lcore-list-all-arg>
Get geneve critical bit configuration Display geneve critical bit configurations.	get dataplane geneve-cbit config
Get l2vpn pmtu message generation settings Display l2vpn pmtu message generation settings.	get dataplane l2vpn-pmtu config
Get the memory stats for dataplane Display data plane memory statistics.	get dataplane memory stats
Get dataplane perf stats Display data plane performance statistics.	get dataplane perfstats <interval-arg>
Get dataplane pmtu learning settings Display dataplane pmtu learning settings.	get dataplane pmtu-learning config
Get admin and operational state of QAT crypto acceleration Get admin and operational state of QAT crypto acceleration.	get dataplane qat
Calculate all nics throughput given an interval Calculate all nics throughput given an interval	get dataplane throughput <time>
Get edge config diagnosis Get edge config diagnosis	get diagnosis config
Get runtime federation health check report Get runtime federation health check report	get diagnosis health-check
Check for inconsistency Check for any inconsistency on local edge	get diagnosis inconsistency
Get diagnosis analysis Get diagnosis analysis	get diagnosis log
Get number of diagnosis entries Get number of diagnosis entries	get diagnosis log limit <log-num>
Get two number of diagnosis entries Get two number of diagnosis entries	get diagnosis log limit <log-num> context <context-line-num>
Get edge logical topology Get logical topology on edge	get diagnosis topology
Get Edge Cluster state history Display the Edge cluster state history.	get edge-cluster history state
Get Edge Cluster status Display the Edge cluster status.	get edge-cluster status
Show ENS lcore assignment mode Show the current mode of enhanced datapath lcore assignment.	get ens lcore-assignment-mode <hs-name-arg>
Dump the host's public cloud gateway certificate Dump the host's public cloud gateway certificate	get gateway certificate <ip-address>
Dump the host's public cloud gateway certificates Dump the host's public cloud gateway certificates.	get gateway certificates
Dump the host's public cloud gateway connection status Dump the host's public cloud gateway connection status.	get gateway connection status
Get geneve critival bit Get geneve critival bit.	get geneve-cbit dvs <dvs-name-arg>
Dump public cloud gateway connections Dump public cloud gateway connections	get gw-controller connections
Get gw-controller logging level Get gw-controller logging level.	get gw-controller logging-level
Show public cloud VM certificate Display public cloud VM certificate	get gw-controller vm-certificate <VmID>
Show public cloud VM certificates Display all public cloud VM certificates	get gw-controller vm-certificates
Get VM log forwarding status Get VM log forwarding status	get gw-controller vm-log-forwarding
Get VM log forwarding status Get VM log forwarding status	get gw-controller vm-log-forwarding <VmID>
Show public cloud state for all VMs Display public cloud VM state for all VMs	get gw-controller vm-state
Show public cloud VM state Display public cloud VM state for specific VM	get gw-controller vm-state <VmID>
Display info for a high-availability channel Display 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 channel Display 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 channels Display information about high-availability channels.	get high-availability channels
Display high-availability channel stats Display statistics for the high-availability channels.	get high-availability channels stats
Display the logical router high availability state history Display the high availability state history for the logical router in the VRF context.	get high-availability history state
Display info for a high-availability session Display 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 session Display 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 sessions Display information about high-availability sessions.	get high-availability sessions
Display info about high-availability sessions of specified channel Display 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-type Display 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 channel Display 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-type Display 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 synchronization Displays 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 ongoing Displays 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 summary Display 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 sessions Display statistics for the high-availability sessions.	get high-availability sessions stats
Display Tunnels info on a host switch Display Tunnels info on the specified host switch.	get host-switch <hs-name-arg> <bfd-cmd-type-arg>
Display Tunnel Detail info on a host switch Display 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 switch Display 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 switch Display 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 switch Display 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 entry Display 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 switch Display IPFIX stats on the specified host switch	get host-switch <hs-name-arg> ipfix stats
Display mcast filter mode for a host switch Display the mcast filter mode for the specified host switch.	get host-switch <hs-name-arg> mcast-filter
Display stats of mirror on a host switch Display 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 switch Display 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 switch Display 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 switch Display 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 status Display if host switch is getting upgraded.	get host-switch upgrade-status
Display VLAN table for the host switch Display VLAN table for the host switch.	get host-switch vlan-table
Display host switches Display information about all host switches.	get host-switches
Get CIF configuration by AppID Display the container interface (CIF) configuration for the specified app.	get hyperbus app-id <app-ID> cif-config
Get CIF configuration cache table Display the container interface (CIF) configuration table.	get hyperbus cif-table
Get VIF connection info Display the virtual interface (VIF) connection information.	get hyperbus connection info
Get VIF connection info Display the virtual interface (VIF) connection information.	get hyperbus connection info
Get VIF connection version Display the virtual interface (VIF) connection version information.	get hyperbus connection version
Get LIP IP pool Display the LIP allocation pool.	get hyperbus lip ip-pool
Get CIF configuration by logical switch port ID Display 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 ID Display the connection information for the specified virtual interface (VIF).	get hyperbus vif-id <vif-ID> connection info
Get LIP by VIF ID Display the logical IP (LIP) for the specified virtual interface (VIF).	get hyperbus vif-id <vif-ID> lip
Get VIF LIP table Display the VIF (virtual interface) LIP (logical IP) table.	get hyperbus vif-lip-table
Get connected VIF table Display 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 service List all container images for given service.	get image <configurable-image-name>
List install history of container images for given service List install history of container images for given service.	get image <configurable-image-name> install history
List all service container images List all service container images.	get images
List install history for all service container images List install history for all service container images.	get images install history
Display LLDP configuration on all devices Display LLDP configuration on all devices.	get lldp config
Displays LLDP Configuration on all devices Displays LLDP configuration on all devices.	get lldp config
Display LLDP configuration on all devices Display LLDP configuration on all devices.	get lldp config
Display LLDP Configuration on given device Display LLDP configuration on given device.	get lldp config <lldp-interface-name-esx>
Display LLDP configuration on given device Display LLDP configuration on given device.	get lldp config <lldp-interface-name-kvm>
Displays LLDP Configuration on given device Displays LLDP configuration given device.	get lldp config <lldp-interface-name>
Display LLDP Neighbor information on all devices Display LLDP Neighbor information on all devices.	get lldp neighbors
Display LLDP Neighbor information on all devices Display LLDP Neighbor information on all devices.	get lldp neighbors
Displays LLDP Neighbor information on all devices Displays LLDP Neighbor information on all devices.	get lldp neighbors
Display LLDP Neighbor information on given device Display LLDP Neighbor information on given device.	get lldp neighbors <lldp-interface-name-esx>
Display LLDP Neighbor information on given device Display LLDP Neighbor information on given device.	get lldp neighbors <lldp-interface-name-kvm>
Displays LLDP Neighbor information on given device Displays LLDP Neighbor information on given device.	get lldp neighbors <lldp-interface-name>
Displays LLDP Statistics on all devices Displays LLDP Statistics on all devices.	get lldp stats
Displays LLDP Statistics on given device Displays LLDP Statistics on given device.	get lldp stats <lldp-interface-name>
Show logical service binding Display a specific logical service binding.	get logical-service binding <uuid-string-arg>
Show all logical service bindings Display all logical service bindings.	get logical-service bindings
Display a specific logical service port Display 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 ports Display information for all logical service ports. Optionally specify an argument to display the statistics.	get logical-service ports [stats]
Show logical service state Display the state of a specific logical service.	get logical-service state <uuid-string-arg>
Show all logical service states Display the state of all logical services.	get logical-service states
Display information about a mirror session Display information about the specified mirror session.	get mirror-session <ms-id-arg>
Display mirror sessions Display all mirror sessions on this host.	get mirror-sessions
Show physical port by name Display the specified physical port.	get physical-port <dpd-name-physical-port-arg>
Show physical port stats by name Display statistics for the specified physical port.	get physical-port <dpd-name-physical-port-arg> stats
Show physical port verbose stats by name Display verbose statistics for the specified physical port.	get physical-port <dpd-name-physical-port-arg> stats verbose
Show physical port xstats by name Display x statistics for the specified physical port.	get physical-port <dpd-name-physical-port-arg> xstats
Show physical port Display all physical ports.	get physical-ports
Show managed VPCs/VNETs Show managed VPCs/VNETs	get public-cloud-manager managed-vpcs
Show public cloud manager status Show public cloud manager status	get public-cloud-manager status
Show active network connections Display active network connections.	get sockets
Show active network connections Display active network connections.	get sockets
Display information about a IPFIX configuration Display information about the specified IPFIX configuration.	get switch-ipfix logical-switch-port <logical-port-id-arg> setting
Display Switch Security config for a logical port Displays Switch Security config for a logical port.	get switch-security config <logical-port>
Display Switch Security stats for a logical port Displays Switch Security stats for a logical port.	get switch-security stats <logical-port>
Get the topology of the system Display the topology of the system.	get topology
Display transport node agent status Display agent status information for the specified transport node.	get transport-node <uuid-arg> agent-status
Display the ARP table for the specified transport node Display the ARP table for the specified transport node.	get transport-node <uuid-arg> arp-table
Display the MAC address table for the specified transport node Display the MAC address table for the specified transport node.	get transport-node <uuid-arg> mac-table
Display routing domains joined by the specified transport node Display routing domains joined by the specified transport node.	get transport-node <uuid-arg> routing-domain
Display the routing vtep table for the specified transport node Display the routing vtep table for the specified transport node.	get transport-node <uuid-arg> routing-vtep
Display transport node status Display status information for the specified transport node.	get transport-node <uuid-arg> status
Display transport node status Display status information for the specified transport node.	get transport-node <uuid-arg> threat-status
Display VIF information for the specified transport node Display VIF information for the specified transport node.	get transport-node <uuid-arg> vifs
Display all VTEPs for the specified transport node Display all tunnel end points for the specified transport node.	get transport-node <uuid-arg> vtep
Display status of all transport nodes Display status information for all transport nodes.	get transport-nodes status
Dump the host's network mode and tagged interface Dump the host's network mode and tagged interface.	get vm-network-mode
Display info about EW policy service chain Display information about EW policy service chain.	get vsip-si policy-service-chains
Display all selected service paths Display selected paths info	get vsip-si selected-service-paths <chain_id_esx>
Display info about EW service chain Display 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 order Display service paths info	get vsip-si service-paths <chain_id_esx>
Display active service paths in order of path selection policy Display active service paths info	get vsip-si service-paths <chain_id_esx> active
Display all service paths in order of path selection policy Display service paths info	get vsip-si service-paths <chain_id_esx> all
Display service paths in maintenance Display 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 policies Display information about service policies.	get vsip-si service-policies
Display vswitch runtime options Display all vSwitch runtime options on this host.	get vswitch runtime
Install NSX Edge service container image Install NSX Edge service container image.	install image <configurable-image-name> version <configurable-image-version>
Reset corelist related boot time option to factory default Reset the corelist-related boot time option to factory default.	reset dataplane corelist
Reset custom list of supported devices on the system Reset custom list of supported devices on the system.	reset dataplane device list
Reset hugepage related boot time option to factory default Reset the hugepage-related boot time option to factory default.	reset dataplane hugepage
Enable/disable control packet prioritization Enable/disable control packet prioritization	set dataplane ctrl-prio <enabled-arg>
Set the custom list of physical NICs Set the custom list of physical NICs.	set dataplane device list <pci-address-arg>
Enable/disable dynamic core feature Enabling 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 cache Enable or disable flow cache.	set dataplane flow-cache <enabled-arg>
Set the flow cache size for each core Set the flow cache size for each core	set dataplane flow-cache-size <flow-cache-size-arg>
Enable/disable geneve critical bit Enable or disable geneve critical bit.	set dataplane geneve-cbit <enabled-arg>
Enable/disable interrupt mode Enable or disable interrupt mode.	set dataplane interrupt-mode <enabled-arg>
Change the size of the buffer pool for jumbo frame crypto operations Change the jumbo mbuf pool size	set dataplane jumbo-mbuf-pool-size <jumbo-mbuf-pool-size-arg>
Enable/disable pmtu message generation in l2vpn Enable 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 core Change the per-core packet queue limit	set dataplane packet-queue-limit <packet-queue-limit-arg>
Enable/disable pmtu learning in dataplane Enable 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 core Set 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 ports Set the rx ring size for physical ports.	set dataplane ring-size rx <ring-size-arg>
Set the tx ring size for physical ports Set the tx ring size for physical ports.	set dataplane ring-size tx <ring-size-arg>
Change ENS lcore assignment mode Change mode of enhanced datapath lcore assignment.	set ens lcore-assignment-mode <hs-name-arg> <ens-lc-mode-arg>
Set geneve critival bit Set geneve critival bit.	set geneve-cbit <boolean-arg> dvs <dvs-name-arg>
Set gw-controller log level Set gw-controller log level	set gw-controller logging-level <Level>
Enable/Disable VM log forwarding for all VMs Enable/Disable VM log forwarding for all VMs	set gw-controller vm-log-forwarding <enabled-clear-arg>
Enable/Disable VM log forwarding for one VM Enable/Disable VM log forwarding for one VM	set gw-controller vm-log-forwarding <enabled-clear-arg> <VmID>
Set mcast filter mode for a host switch Set 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 status Set host switch upgrade status.	set host-switch upgrade-status <boolean-arg>
Set the specified physical port mtu to given value Set 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 down Set the specified physical port admin state up or down.	set physical-port <dpd-name-physical-port-arg> state <dpd-physical-port-state-arg>
Set the Dataplane service logging level Set the log level of the Dataplane service.	set service dataplane logging-level <edge-service-logging-level-arg>
set one vswitch runtime option Set a runtime option for the specified vSwitch.	set vswitch runtime <option-name-arg> <option-value-arg>
Start Flow Monitor Start 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>]
Verify NSX Edge service container image file Verify NSX Edge service container image file.	verify image <configurable-image-filename>