NSX CLI Guide

Associated Commands:

CLI Description Command

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

Show ENS lcore assignment mode


Show the current mode of enhanced datapath lcore assignment.
get ens lcore-assignment-mode <hs-name-arg>

Get geneve critical bit


Get geneve critical bit.
get geneve-cbit dvs <dvs-name-arg>

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 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

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 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

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

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>

Display vswitch runtime options


Display all vSwitch runtime options on this host.
get vswitch runtime

Get vxlan uplink queue filter


Get vxlan uplink queue filter.
get vxlan-uplink-queue-filter dvs <dvs-name-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 critical bit


Set geneve critical bit.
set geneve-cbit <boolean-arg> dvs <dvs-name-arg>

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 one vswitch runtime option


Set a runtime option for the specified vSwitch.
set vswitch runtime <option-name-arg> <option-value-arg>

Set vxlan uplink queue filter


Set vxlan uplink queue filter.
set vxlan-uplink-queue-filter <boolean-arg> dvs <dvs-name-arg>

Total commands: 38