NSX CLI Guide

Associated Commands:

CLI Description	Command
Show all IP leases under a DHCP server/subnet Display all IP leases under a DHCP server/subnet	get dhcp leases <dhcp-uuid-arg>
Show all DHCP servers/subnets enabled with DHCP Display all DHCP servers/subnets enabled with DHCP	get dhcp servers
Show the dynamic IP pool usage for a DHCP server/subnet Display the dynamic IP pool usage for a DHCP server/subnet	get dhcp stats <dhcp-uuid-arg>
Display DHCP server config for a host switch and dvport Display DHCP server config for a host switch and dvport	get dhcp-server config <hs-name-arg> <dvport-id-arg> ipv4
Display DHCP server stats for a host switch and dvport Display DHCP server stats for a host switch and dvport	get dhcp-server stats <hs-name-arg> <dvport-id-arg> ipv4
Display discovered bindings Display discovered bindings.	get ip-discovery bindings
Display ip discovery bindings for a host switch and dvport Display ip discovery bindings for a host switch and dvport.	get ip-discovery bindings <hs-name-arg> <dvport-id-arg>
Display ipv4 discovery bindings for a host switch and dvport Display ipv4 discovery bindings for a host switch and dvport.	get ip-discovery bindings <hs-name-arg> <dvport-id-arg> ipv4
Display ipv6 discovery bindings for a host switch and dvport Display ipv6 discovery bindings for a host switch and dvport.	get ip-discovery bindings <hs-name-arg> <dvport-id-arg> ipv6
Display discovered bindings for a given logical port Display discovered bindings for a given logical port.	get ip-discovery bindings <logical-port>
Display discovered bindings for a given logical port and type Display discovered bindings for a given logical port and type.	get ip-discovery bindings <logical-port> <ip-version>
Display ip-discovery config for all logical ports Display ip-discovery profile for all logical ports.	get ip-discovery config
Display IP discovery config for a host switch and dvport Display IP discovery config for a host switch and dvport.	get ip-discovery config <hs-name-arg> <dvport-id-arg>
Display ip-discovery config for a given logical port Display ip-discovery config for a given logical port.	get ip-discovery config <logical-port>
Display ignore bindings list Display ignore bindings list.	get ip-discovery ignore-list
Display ip discovery ignore list for a host switch and dvport Display ip discovery ignore list for a host switch and dvport.	get ip-discovery ignore-list <hs-name-arg> <dvport-id-arg>
Display ignore bindings list for a given logical port Display ignore bindings list for a given logical port.	get ip-discovery ignore-list <logical-port>
Display ignore bindings list for a given logical port and type Display ignore bindings list for a given logical port and type.	get ip-discovery ignore-list <logical-port> <ip-version>
Display ip-discovery ignore list stats for all logical ports Display ip-discovery ignore list stats for all logical ports.	get ip-discovery ignore-list stats
Display ip discovery ignore list stats for a host switch and dvport Display ip discovery ignore list stats for a host switch and dvport.	get ip-discovery ignore-list stats <hs-name-arg> <dvport-id-arg>
Display ip-discovery ignore list stats for a given logical ports. Display ip-discovery ignore list stats for a given logical ports.	get ip-discovery ignore-list stats <logical-port>
Display ip-discovery stats for all logical ports Display ip-discovery stats for all logical ports.	get ip-discovery stats
Display ip discovery stats for a host switch and dvport Display ip discovery stats for a host switch and dvport.	get ip-discovery stats <hs-name-arg> <dvport-id-arg>
Display ip-discovery stats for a given logical port Display ip-discovery profile for a given logical port.	get ip-discovery stats <logical-port>
Display logical switch information Display information about the specified logical switch.	get logical-switch <dpd-uuid-lswitch-arg> (Deprecated)
Display l2forwarder for a logical switch Display the l2forwarder for the specified logical switch.	get logical-switch <dpd-uuid-lswitch-arg> l2forwarders (Deprecated)
Display mac table for a logical switch Display the mac address table for the specified logical switch.	get logical-switch <dpd-uuid-lswitch-arg> mac-address-table (Deprecated)
Display mcast offload tunnel Display mcast offload tunnel.	get logical-switch <dpd-uuid-lswitch-arg> mcast-offload-tunnel source <ip-address> group <multicast-ip-address>
Display neighbor(ARP/NDP) table for a logical switch Display the ARP/NDP table for the specified logical switch.	get logical-switch <dpd-uuid-lswitch-arg> neighbor (Deprecated)
Display ports on a logical switch Display port information for the specified logical switch.	get logical-switch <dpd-uuid-lswitch-arg> ports (Deprecated)
Display port statistics for a logical switch Display port statistics for the specified logical switch.	get logical-switch <dpd-uuid-lswitch-arg> ports stats (Deprecated)
Display remote rtep-group mac addresses for a logical switch Display remote rtep-group mac addresses for a logical switch.	get logical-switch <dpd-uuid-lswitch-arg> rtep-group-mac-address-table (Deprecated)
Display remote rtep-group mac addresses Display remote rtep-group mac addresses.	get logical-switch <dpd-uuid-lswitch-arg> rtep-group-mac-address-table <rtep-group-id-arg> (Deprecated)
Display VTEP table for a logical switch Display the tunnel endpoint table for the specified logical switch.	get logical-switch <dpd-uuid-lswitch-arg> vtep-table (Deprecated)
Display information about a logical switch Display information about the specified logical switch.	get logical-switch <ls-id-arg-kvm> (Deprecated)
Display ARP table for a logical switch Display the ARP table for the specified logical switch.	get logical-switch <ls-id-arg-kvm> arp-table (Deprecated)
Display MAC table for a logical switch Display the MAC table for the specified logical switch.	get logical-switch <ls-id-arg-kvm> mac-table (Deprecated)
Display ports on a logical switch Display ports on the specified logical switch.	get logical-switch <ls-id-arg-kvm> ports (Deprecated)
Display information about a logical switch Display information about the specified logical switch.	get logical-switch <ls_id_arg_esx> (Deprecated)
Display ARP table for a logical switch Display the ARP table for the specified logical switch.	get logical-switch <ls_id_arg_esx> arp-table (Deprecated)
Display all the counters for the specified logical switch. Display all the counters for the specified logical switch.	get logical-switch <ls_id_arg_esx> datapath-stats all
Display all drop counters of all modules for the specified logical switch. Display all drop counters of all modules for the specified logical switch.	get logical-switch <ls_id_arg_esx> datapath-stats drops
Display new drop counters for the specified logical switch. Display new drop counters of all modules for the specified logical switch.	get logical-switch <ls_id_arg_esx> datapath-stats drops new
Display all the counters for the specified logical switch and module. Display all the counters for the specified logical switch and module.	get logical-switch <ls_id_arg_esx> datapath-stats module <mod_name_arg_esx> all
Display all new counters for the specified logical switch and module. Display all new counters for the specified logical switch and module.	get logical-switch <ls_id_arg_esx> datapath-stats module <mod_name_arg_esx> all new
Display drop counters for the specified logical switch and module. Display drop counters for the specified logical switch and module.	get logical-switch <ls_id_arg_esx> datapath-stats module <mod_name_arg_esx> drops
Display new drop counters for the specified logical switch and module. Display new drop counters for the specified logical switch and module.	get logical-switch <ls_id_arg_esx> datapath-stats module <mod_name_arg_esx> drops new
Display HW VTEP table for a logical switch Display the HW VTEP table for the specified logical switch.	get logical-switch <ls_id_arg_esx> hw-vtep-table (Deprecated)
Display MAC table for a logical switch Display the MAC table for the specified logical switch.	get logical-switch <ls_id_arg_esx> mac-table (Deprecated)
Display ND table for a logical switch Display the ND table for the specified logical switch.	get logical-switch <ls_id_arg_esx> nd-table (Deprecated)
Display VTEP group information Display VTEP groups for the specified logical switch	get logical-switch <ls_id_arg_esx> vtep-group (Deprecated)
Display VTEP table for a logical switch Display the VTEP table for the specified logical switch.	get logical-switch <ls_id_arg_esx> vtep-table (Deprecated)
Display L2Forwarder high-availability history of a switch Display L2Forwarder high-availability history of a switch	get logical-switch <nsxa-uuid-lswitch-arg> l2forwarders high-availability history state (Deprecated)
Display l2forwarder HA information of switch Display l2forwarder configuration and HA information of switch	get logical-switch <nsxa-uuid-lswitch-arg> l2forwarders high-availability state (Deprecated)
Display the logical switch ports Display port information for the specified logical switch.	get logical-switch <uuid-arg> ports (Deprecated)
Display the routing domain ID of a logical switch Display the routing domain ID of a logical switch.	get logical-switch <uuid-arg> routing-domain-from-app
Display information about a logical switch Display information about the specified logical switch. Use the `get logical-switches` command to get a list of all logical switches. You can use the VNI or UUID to specify the logical switch.	get logical-switch <vni-or-uuid-arg> (Deprecated)
Display local ARP table for a logical switch Display local ARP table for the specified logical switch.	get logical-switch <vni-or-uuid-arg> arp-table (Deprecated)
Display ARP table for a logical switch for both local and remote records Display the ARP table for the specified logical switch for both local and remote records.	get logical-switch <vni-or-uuid-arg> arp-table all (Deprecated)
Display ARP table for a logical switch for both local and remote records Display the ARP table for the specified logical switch for both local and remote records	get logical-switch <vni-or-uuid-arg> arp-table all verbose (Deprecated)
Display ARP table for a logical switch for only remote records, show site id at column TransportNodeId Display the ARP table for the specified logical switch for only remote records.	get logical-switch <vni-or-uuid-arg> arp-table remote (Deprecated)
Display ARP table for a logical switch for only remote records Display the ARP table for the specified logical switch for only remote records.	get logical-switch <vni-or-uuid-arg> arp-table remote verbose (Deprecated)
Display local ARP table for a logical switch Display local ARP table for the specified logical switch.	get logical-switch <vni-or-uuid-arg> arp-table verbose (Deprecated)
Display local MAC table for a logical switch Display local MAC address table for the specified logical switch.	get logical-switch <vni-or-uuid-arg> mac-table (Deprecated)
Display MAC table for a logical switch for both local and remote mac records Display the MAC address table for the specified logical switch for both local and remote mac records.	get logical-switch <vni-or-uuid-arg> mac-table all (Deprecated)
Display MAC table for a logical switch for both local and remote records Display the MAC address table for the specified logical switch for both local and remote records.	get logical-switch <vni-or-uuid-arg> mac-table all verbose (Deprecated)
Display MAC table for a logical switch for only remote mac records Display the MAC address table for the specified logical switch for only remote mac records.	get logical-switch <vni-or-uuid-arg> mac-table remote (Deprecated)
Display MAC table for a logical switch for only remote records Display the MAC address table for the specified logical switch for only remote records.	get logical-switch <vni-or-uuid-arg> mac-table remote verbose (Deprecated)
Display local MAC table for a logical switch Display local MAC address table for the specified logical switch.	get logical-switch <vni-or-uuid-arg> mac-table verbose (Deprecated)
Display the routing domain ID of a logical switch Display the routing domain ID of a logical switch.	get logical-switch <vni-or-uuid-arg> routing-domain-from-pigeon
Display statistics information about the specified logical switch Display statistics information about the specified logical switch.	get logical-switch <vni-or-uuid-arg> stats (Deprecated)
Display transport nodes which joined a given logical switch Display transport nodes which joined a given logical switch.	get logical-switch <vni-or-uuid-arg> transport-node-table (Deprecated)
Display information about a logical switch Display information about the specified logical switch and logical switch ports associated with it. Use the `get logical-switches` command to get a list of all logical switches. You can use the VNI or UUID to specify the logical switch.	get logical-switch <vni-or-uuid-arg> verbose (Deprecated)
Display ports for a logical switch Display port information for the specified logical switch.	get logical-switch port <dpd-uuid-lswitch-port-arg> (Deprecated)
Display stats for a logical switch port Display statistics for the specified logical switch port.	get logical-switch port <dpd-uuid-lswitch-port-arg> stats (Deprecated)
Display logical switch ports Display ports for all logical switches.	get logical-switch ports (Deprecated)
Display ports stats for all logical switches Display port statistics for all logical switches.	get logical-switch ports stats (Deprecated)
Get logical switch local mac Display a specific logical switch's local or remote MAC, ARP, or VTEP information.	get logical-switch {local \| remote} {mac-cache \| arp-cache \| vtep-cache} <vni>
Display the logical switch port Display information about the specified logical switch port.	get logical-switch-port <uuid-arg> (Deprecated)
Get logical switch port status Display the status for logical switch ports on this hypervisor host.	get logical-switch-port status
Display logical switches Display all logical switches on this host.	get logical-switches (Deprecated)
Display logical switches Display information about all logical switches.	get logical-switches (Deprecated)
Display all logical switches associated with the VIF on this host Display all logical switches associated with the VIF on this host.	get logical-switches (Deprecated)
Display specified counter's detailed description. Display specified counter's detailed description.	get logical-switches datapath-stats module <mod_name_arg_esx> counter <ctr_name_arg_esx> description verbose
List all the counters with brief description for the specified module. List all the counters with brief description for the specified module.	get logical-switches datapath-stats module <mod_name_arg_esx> counters list
Display specified kernel module's detailed description. Display specified kernel module's detailed description.	get logical-switches datapath-stats module <mod_name_arg_esx> description verbose
List all the observability enabled kernel modules. List all the observability enabled kernel modules with.	get logical-switches datapath-stats modules list
Display a summary of all logical switch statistics Display a summary of all logical switch statistics.	get logical-switches stats (Deprecated)
Display segment information Display information about the specified segment.	get segment <dpd-uuid-lswitch-arg>
Display l2forwarder for a segment Display the l2forwarder for the specified segment.	get segment <dpd-uuid-lswitch-arg> l2forwarders
Display mac table for a segment Display the mac address table for the specified segment.	get segment <dpd-uuid-lswitch-arg> mac-address-table
Display neighbor(ARP/NDP) table for a segment Display the ARP/NDP table for the specified segment.	get segment <dpd-uuid-lswitch-arg> neighbor
Display ports on a segment Display port information for the specified segment.	get segment <dpd-uuid-lswitch-arg> ports
Display port statistics for a segment Display port statistics for the specified segment.	get segment <dpd-uuid-lswitch-arg> ports stats
Display remote rtep-group mac addresses for a segment Display remote rtep-group mac addresses for a segment.	get segment <dpd-uuid-lswitch-arg> rtep-group-mac-address-table
Display remote rtep-group mac addresses Display remote rtep-group mac addresses.	get segment <dpd-uuid-lswitch-arg> rtep-group-mac-address-table <rtep-group-id-arg>
Display VTEP table for a segment Display the tunnel endpoint table for the specified segment.	get segment <dpd-uuid-lswitch-arg> vtep-table
Display L2Forwarder high-availability history of a segment Display L2Forwarder high-availability history of a segment	get segment <nsxa-uuid-lswitch-arg> l2forwarders high-availability history state
Display l2forwarder HA information of segment Display l2forwarder configuration and HA information of segment	get segment <nsxa-uuid-lswitch-arg> l2forwarders high-availability state
Display information about a segment Display information about the specified segment.	get segment <segment-id-arg-kvm>
Display ARP table for a segment Display the ARP table for the specified segment.	get segment <segment-id-arg-kvm> arp-table
Display MAC table for a segment Display the MAC table for the specified segment.	get segment <segment-id-arg-kvm> mac-table
Display ports on a segment Display ports on the specified segment.	get segment <segment-id-arg-kvm> ports
Display information about a segment Display information about the specified segment.	get segment <segment_id_arg_esx>
Display ARP table for a segment. Display the ARP table for the specified segment.	get segment <segment_id_arg_esx> arp-table
Display all the counters for the specified segment. Display all the counters for the specified segment.	get segment <segment_id_arg_esx> datapath-stats all
Display all drop counters of all modules for the specified segment. Display all drop counters of all modules for the specified segment.	get segment <segment_id_arg_esx> datapath-stats drops
Display new drop counters for the specified segment. Display new drop counters of all modules for the specified segment.	get segment <segment_id_arg_esx> datapath-stats drops new
Display all the counters for the specified segment and module. Display all the counters for the specified segment and module.	get segment <segment_id_arg_esx> datapath-stats module <mod_name_arg_esx> all
Display all new counters for the specified segment and module. Display all new counters for the specified segment and module.	get segment <segment_id_arg_esx> datapath-stats module <mod_name_arg_esx> all new
Display drop counters for the specified segment and module. Display drop counters for the specified segment and module.	get segment <segment_id_arg_esx> datapath-stats module <mod_name_arg_esx> drops
Display new drop counters for the specified segment and module. Display new drop counters for the specified segment and module.	get segment <segment_id_arg_esx> datapath-stats module <mod_name_arg_esx> drops new
Display HW VTEP table for a segment Display the HW VTEP table for the specified segment.	get segment <segment_id_arg_esx> hw-vtep-table
Display MAC table for a segment. Display the MAC table for the specified segment.	get segment <segment_id_arg_esx> mac-table
Display ND table for a segment Display the ND table for the specified segment.	get segment <segment_id_arg_esx> nd-table
Display VTEP group information Display VTEP groups for the specified segment	get segment <segment_id_arg_esx> vtep-group
Display VTEP table for a segment Display the VTEP table for the specified segment.	get segment <segment_id_arg_esx> vtep-table
Display the segment ports Display port information for the specified segment.	get segment <uuid-arg> ports
Display information about a Segment Display information about the specified segment. Use the `get segmentss` command to get a list of all segments. You can use the VNI or UUID to specify the logical switch.	get segment <vni-or-uuid-arg>
Display local ARP table for a segment Display local ARP table for the specified segment.	get segment <vni-or-uuid-arg> arp-table
Display ARP table for a segment for both local and remote records Display the ARP table for the specified segment for both local and remote records.	get segment <vni-or-uuid-arg> arp-table all
Display ARP table for a segment for both local and remote records Display the ARP table for the specified segment for both local and remote records	get segment <vni-or-uuid-arg> arp-table all verbose
Display ARP table for a Segment for only remote records, show site id at column TransportNodeId Display the ARP table for the specified segment for only remote records.	get segment <vni-or-uuid-arg> arp-table remote
Display ARP table for a segment for only remote records Display the ARP table for the specified segment for only remote records.	get segment <vni-or-uuid-arg> arp-table remote verbose
Display local ARP table for a segment Display local ARP table for the specified segment.	get segment <vni-or-uuid-arg> arp-table verbose
Display local MAC table for a segment Display local MAC address table for the specified Segment.	get segment <vni-or-uuid-arg> mac-table
Display MAC table for a segment for both local and remote mac records Display the MAC address table for the specified segment for both local and remote mac records.	get segment <vni-or-uuid-arg> mac-table all
Display MAC table for a segment for both local and remote records Display the MAC address table for the specified segment for both local and remote records.	get segment <vni-or-uuid-arg> mac-table all verbose
Display MAC table for a segment for only remote mac records Display the MAC address table for the specified Segment for only remote mac records.	get segment <vni-or-uuid-arg> mac-table remote
Display MAC table for a segment for only remote records Display the MAC address table for the specified segment for only remote records.	get segment <vni-or-uuid-arg> mac-table remote verbose
Display local MAC table for a segment Display local MAC address table for the specified segment.	get segment <vni-or-uuid-arg> mac-table verbose
Display transport nodes which joined a given segment Display transport nodes which joined a given segment.	get segment <vni-or-uuid-arg> transport-node-table
Display information about a segment Display information about the specified Segment and segment ports associated with it. Use the `get segments` command to get a list of all segmentss. You can use the VNI or UUID to specify the segment.	get segment <vni-or-uuid-arg> verbose
Display ports for a segment Display port information for the specified segment.	get segment port <dpd-uuid-lswitch-port-arg>
Display stats for a segment port Display statistics for the specified segment port.	get segment port <dpd-uuid-lswitch-port-arg> stats
Display segment ports Display ports for all segments.	get segment ports
Display ports stats for all segments Display port statistics for all segments.	get segment ports stats
Get segment local mac Display a specific segment's local or remote MAC, ARP, or VTEP information.	get segment {local \| remote} {mac-cache \| arp-cache \| vtep-cache} <vni>
Display the segment port Display information about the specified segment port.	get segment-port <uuid-arg>
Get segment port status Display the status for segment ports on this hypervisor host.	get segment-port status
Display all segment associated with the VIF on this host Display all segment associated with the VIF on this host.	get segments
Display segments Display information about all segments.	get segments
Display segments Display all segments on this host.	get segments
Display statistics information about the specified segment Display statistics information about the specified Segment.	get segments <vni-or-uuid-arg> stats
Display specified counter's detailed description. Display specified counter's detailed description.	get segments datapath-stats module <mod_name_arg_esx> counter <ctr_name_arg_esx> description verbose
List all the counters with brief description for the specified module. List all the counters with brief description for the specified module.	get segments datapath-stats module <mod_name_arg_esx> counters list
Display specified kernel module's detailed description. Display specified kernel module's detailed description.	get segments datapath-stats module <mod_name_arg_esx> description verbose
List all the observability enabled kernel modules. List all the observability enabled kernel modules.	get segments datapath-stats modules list
Display a summary of all segment statistics Display a summary of all segment statistics.	get segments stats
Display Switch Security config for a host switch and dvport Display Switch Security config for a host switch and dvport.	get switch-security config <hs-name-arg> <dvport-id-arg>
Display Switch Security stats for a host switch and dvport Display Switch Security stats for a host switch and dvport.	get switch-security stats <hs-name-arg> <dvport-id-arg>