Associated Commands:

CLI Description Command

Clear NSX Intelligence flows statistics

Clear NSX Intelligence flows statistics.

clear intelligence flows stats

Clear statistics of a specified pool

Clear the statistics for a specific load balancer and pool. In rare cases some of the counters may not be cleared and when that happens please try issuing the command again.

clear load-balancer <dlb-uuid-arg> pool <pool-arg> stats

Clear statistics of all pools

Clear the statistics for all pools of a specific load balancer. In rare cases some of the counters may not be cleared and when that happens please try issuing the command again.

clear load-balancer <dlb-uuid-arg> pools stats

Clear load balancer statistics

Clear the statistics for a specific load balancer.

clear load-balancer <dlb-uuid-arg> stats

Clear statistics of a specified virtual server

Clear the statistics for a specific load balancer and virtual server. In rare cases some of the counters may not be cleared and when that happens please try issuing the command again.

clear load-balancer <dlb-uuid-arg> virtual-server <vs-arg> stats

Clear statistics of all virtual servers

Clear the statistics for all virtual servers of a specific load balancer. In rare cases some of the counters may not be cleared and when that happens please try issuing the command again.

clear load-balancer <dlb-uuid-arg> virtual-servers stats

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

Delete a configured packet capture session

Delete a packet capture session configuration.

del capture session <esx-session-id-arg>

Delete NSX from host

Destroy 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

Detach host from management plane

Detach 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 get certificate api thumbprint command on the specified NSX Manager.

detach management-plane <hostname-or-ip-address[:port]> username <username> thumbprint <thumbprint> [password <password>]

Exit the CLI

Exit the VRF context mode if you are in it. Otherwise, exit the CLI.

exit

Display a packet capture session

Display information about the specified packet capture session.

get capture session <esx-session-id-arg>

Display packet capture sessions

Display configured packet capture sessions.

get capture sessions

Show status to display datetime stamp

Show status to display datetime stamp in command output.

get cli-output datetime

Show status to display ESXio data on ESXi host command output

Show status to display ESXio node data in ESXi host command output.

Applicable only when ESXio nodes are registered with ESXi host.

get cli-output esxio

Display commands history

Display 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

Display controller connection

Display the controllers connected to this node.

get controllers

List core dump files in the system

Display information about the core dump files in the system.

get core-dumps

Show ENS lcore assignment mode

Show the current mode of enhanced datapath lcore assignment.

get ens lcore-assignment-mode <hs-name-arg>

Display registered ESXio nodes

Display the list of registered ESXio nodes with Transport host node.

get esxio nodes

Display firewall address sets

get firewall <vif-uuid-arg> addrsets

Display firewall attribute profiles

Display firewall attribute profiles.

get firewall <vif-uuid-arg> profile

Display firewall rules

get firewall <vif-uuid-arg> ruleset rules

Display firewall exclusion

Display firewall exclusions.

get firewall exclusion

Display firewall ipfix containers

Display firewall ipfix containers.

get firewall ipfix-containers

Display firewall ipfix filters

Display firewall ipfix filters.

get firewall ipfix-filters

Display firewall ipfix profile configuration

Display firewall ipfix profile configration.

get firewall ipfix-profiles

Display firewall ipfix statistics

Display firewall ipfix statistics.

get firewall ipfix-stats

Show DFW packet log file contents

Display the contents of the DFW packet log file.

get firewall packetlog

Show last lines of DFW packet log file contents

Display last lines of the DFW packet log file.

get firewall packetlog last <line-count-arg>

Display firewall rule statistics

Display firewall rule statistics.

get firewall rule-stats

Display total firewall rule statistics

Display total firewall rule statistics.

get firewall rule-stats total

Display the firewall status

Display the firewall status.

get firewall status

Display firewall threshold alarms

Display firewall threshold alarms.

get firewall threshold-alarms

Display firewall thresholds

Display firewall thresholds.

get firewall thresholds

Display firewall VIFs

get firewall vifs

Display a gateway

Display information about the specified gateway.

get gateway <uuid-arg>

Display forwarding information for a gateway

Display forwarding for the specified gateway.

get gateway <uuid-arg> forwarding

Display forwarding information for a gateway

Display forwarding for the specified gateway filtered on prefix.

get gateway <uuid-arg> forwarding <network46-address>

Display IPv4 forwarding for a gateway

Display IPv4 forwarding for the specified gateway.

get gateway <uuid-arg> forwarding ipv4

Display IPv6 forwarding for a gateway

Display IPv6 forwarding for the specified gateway.

get gateway <uuid-arg> forwarding ipv6

Display Mcast Groups information for a gateway

Display Mcast Groups for the specified gateway.

get gateway <uuid-arg> igmp membership

Display Mcast Groups information for a gateway

Display Mcast Groups for the specified gateway.

get gateway <uuid-arg> igmp membership <ip-address>

Display interface instance for a gateway

Display information for the specified gateway instance.

get gateway <uuid-arg> interface <uuid-arg>

Display gateway interface instance policy table reference

Display policy table reference information for the specified gateway instance.

get gateway <uuid-arg> interface <uuid-arg> policy-table-ref

Display interface instance stats for a gateway

Display interface instance stats for a gateway.

get gateway <uuid-arg> interface <uuid-arg> stats

Display interface instance stats for a gateway (ipv4)

Display interface instance stats for a gateway (ipv4).

get gateway <uuid-arg> interface <uuid-arg> stats ipv4

Display interface instance stats for a gateway (ipv6)

Display interface instance stats for a gateway (ipv6).

get gateway <uuid-arg> interface <uuid-arg> stats ipv6

Display interfaces for a gateway

Display interface information for the specified gateway.

get gateway <uuid-arg> interfaces

Display neighbor for a gateway

Display neighbor information (ARP/ND cache) for the specified gateway, using IP or MAC.

get gateway <uuid-arg> neighbor <ipormac-address>

Display neighbors for a gateway

Display neighbor information (ARP cache) for the specified gateway.

get gateway <uuid-arg> neighbors

Display a proximity routing policy table

Display information about the specified proximity routing policy table.

get gateway-policy-table <policy_table_id_arg_esx>

Display proximity gateway policy tables summary

Display information about proximity gateway policy tables on this hypervisor host.

get gateway-policy-tables

Display gateway summary

Display information about gateways on this hypervisor host.

get gateways

Get geneve critical bit

Get geneve critical bit.

get geneve-cbit dvs <dvs-name-arg>

Display Global VTEP table

Display the Global VTEP table

get global-vtep-table <hs-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 NSX IDS Engine Fast Log setting

Display NSX IDS Engine Fast Log setting.

get ids engine alertlog

Display NSX IDS Engine Log Level

Display NSX IDS Engine Log Level.

get ids engine logging-level

Display NSX IDS Engine Profiles

Display NSX IDS Engine Profiles.

get ids engine profiles

Display NSX IDS Engine Profile statistics

Display NSX IDS Engine Profile statistics.

get ids engine profilestats <profile-id>

Display NSX IDS Engine Rules

Display NSX IDS Engine Rules.

get ids engine rules

Get Signature Action for a particular RuleID, ProfileID, SignID

get ids engine signaction <rule-id> <profile-id> <sign-id>

Display NSX IDS Engine global statistics

Display NSX IDS Engine global statistics.

get ids engine stats

Display NSX IDS Engine Status

Display NSX IDS Engine Status.

get ids engine status

Get IDS Event Engine stats

Get IDS Event Engine stats.

get ids events stats

Display NSX IDS Log Level

Display NSX IDS Log Level.

get ids logging-level

Display NSX IDS Profiles

Display NSX IDS Profiles.

get ids profiles

Display NSX IDS Rules

Display NSX IDS Rules.

get ids rules

Display NSX IDS Status

Display NSX IDS Status.

get ids status

Display NSX Intelligence flows configuration

Display NSX Intelligence flows configuration.

get intelligence flows config

Display NSX Intelligence flows aggregation mask

Display NSX Intelligence flows aggregation mask.

get intelligence flows mask

Display NSX Intelligence flows statistics

Display NSX Intelligence flows statistics.

get intelligence flows stats

Display NSX Intelligence flows acknowledgement statistics

Display NSX Intelligence flows acknowledgement statistics.

get intelligence flows stats ack

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

List all the observability enabled kernel modules.

List all the observability enabled kernel modules with.

get livetrace datapath-stats modules list

Display all the counters for the specified livetrace session.

get livetrace datapath-stats session <session-id> all

Display all counters for the specified livetrace session.

get livetrace datapath-stats session <session-id> all new

Display all drop counters of all modules for the specified livetrace session.

get livetrace datapath-stats session <session-id> drops

Display new drop counters for the specified livetrace session.

Display new drop counters of all modules for the specified livetrace session.

get livetrace datapath-stats session <session-id> drops new

Display all the counters for the specified livetrace session and module.

get livetrace datapath-stats session <session-id> module <mod_name_arg_esx> all

Display all new counters for the specified livetrace session and module.

get livetrace datapath-stats session <session-id> module <mod_name_arg_esx> all new

Display drop counters for the specified livetrace session and module.

get livetrace datapath-stats session <session-id> module <mod_name_arg_esx> drops

Display new drop counters for the specified livetrace session and module.

get livetrace datapath-stats session <session-id> module <mod_name_arg_esx> drops new

List all the datapath-stats enabled livetrace sessions.

get livetrace datapath-stats sessions list

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 Neighbor information on all devices

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

Show load balancer

Display a specific load balancer.

get load-balancer <dlb-uuid-arg>

Show the error log for the specified load balancer

Display the error log file for a specific load balancer.

get load-balancer <dlb-uuid-arg> error-log

Show persistence tables of a specific load balancer

Display the persistence tables of a specific load balancer.

get load-balancer <dlb-uuid-arg> persistence-tables

Show statistics of the specified load balancer and pool

Display the statistics for a specific load balancer and pool.

get load-balancer <dlb-uuid-arg> pool <pool-arg> stats

Show load balancer pools.

Display the pools of a specific load balancer.

get load-balancer <dlb-uuid-arg> pools

Show statistics of all pools of the specified load balancer

Display the statistics for all the pools of a specific load balancer.

get load-balancer <dlb-uuid-arg> pools stats

Show load balancer sessions

Display sessions of load balancer.

get load-balancer <dlb-uuid-arg> sessions

Show load balancer verbose

Display stats for load balancer.

get load-balancer <dlb-uuid-arg> stats

Show load balancer verbose stats

Display verbose stats for load balancer.

get load-balancer <dlb-uuid-arg> stats verbose

Show status for the specified load balancer

Display the status of a specific load balancer.

get load-balancer <dlb-uuid-arg> status

Get hash selected backend server for the specified source IP traffic

Display the backend server IP address for the specified source IP traffic..

get load-balancer <dlb-uuid-arg> virtual-server <vs-arg> hash <ip-address>

Show statistics of the specified load balancer and virtual server

Display the statistics for a specific load balancer and virtual server.

get load-balancer <dlb-uuid-arg> virtual-server <vs-arg> stats

Show verbose statistics of the specified load balancer and virtual server

Display verbose statistics for a specific load balancer and virtual server.

get load-balancer <dlb-uuid-arg> virtual-server <vs-arg> stats verbose

Show load balancer virtual servers

Display the virtual servers of a specific load balancer.

get load-balancer <dlb-uuid-arg> virtual-servers

Show statistics of all virtual servers of the specified load balancer

Display the statistics for all virtual servers of a specific load balancer.

get load-balancer <dlb-uuid-arg> virtual-servers stats

Show load balancer global verbose stats

Display global verbose stats for load balancer.

get load-balancer global stats

Show pool.

Display the information for pool.

get load-balancer pool <pool-arg>

Show a load balancer virtual server

Display a specific load balancer virtual server.

get load-balancer virtual-server <vs-arg>

Show the access log for the specified virtual server

Display the access log for the virtual server.

get load-balancer virtual-server <vs-arg> access-log

Show all load balancers

Display all load balancers.

get load-balancers

Show status for all load balancers

Display the status of all load balancers.

get load-balancers status

Display a logical router

Display information about the specified logical router.

get logical-router <uuid-arg>

Display forwarding information for a logical router

Display forwarding for the specified logical router.

get logical-router <uuid-arg> forwarding

Display forwarding information for a logical router

Display forwarding for the specified logical router filtered on prefix.

get logical-router <uuid-arg> forwarding <network46-address>

Display IPv4 forwarding for a logical router

Display IPv4 forwarding for the specified logical router.

get logical-router <uuid-arg> forwarding ipv4

Display IPv6 forwarding for a logical router

Display IPv6 forwarding for the specified logical router.

get logical-router <uuid-arg> forwarding ipv6

Display Mcast Groups information for a logical router

Display Mcast Groups for the specified logical router.

get logical-router <uuid-arg> igmp membership

Display Mcast Groups information for a logical router

Display Mcast Groups for the specified logical router.

get logical-router <uuid-arg> igmp membership <ip-address>

Display interface instance for a logical router

Display information for the specified logical router instance.

get logical-router <uuid-arg> interface <uuid-arg>

Display logical router interface instance policy table reference

Display policy table reference information for the specified logical router instance.

get logical-router <uuid-arg> interface <uuid-arg> policy-table-ref

Display interface instance stats for a logical router

Display interface instance stats for a logical router.

get logical-router <uuid-arg> interface <uuid-arg> stats

Display interface instance stats for a logical router (ipv4)

Display interface instance stats for a logical router (ipv4).

get logical-router <uuid-arg> interface <uuid-arg> stats ipv4

Display interface instance stats for a logical router (ipv6)

Display interface instance stats for a logical router (ipv6).

get logical-router <uuid-arg> interface <uuid-arg> stats ipv6

Display interfaces for a logical router

Display interface information for the specified logical router.

get logical-router <uuid-arg> interfaces

Display Mcast router backplane IP for load-balancing a multicast group

get logical-router <uuid-arg> multicast load-balancing <ip-address>

Display neighbor for a logical router

Display neighbor information (ARP/ND cache) for the specified logical router, using IP or MAC.

get logical-router <uuid-arg> neighbor <ipormac-address>

Display neighbors for a logical router

Display neighbor information (ARP cache) for the specified logical router.

get logical-router <uuid-arg> neighbors

Display a proximity routing policy table

Display information about the specified proximity routing policy table.

get logical-router-policy-table <policy_table_id_arg_esx>

Display proximity routing policy tables summary

Display information about proximity routing policy tables on this hypervisor host.

get logical-router-policy-tables

Display logical router summary

Display information about logical routers on this hypervisor host.

get logical-routers

Display information about a logical switch

Display information about the specified logical switch.

get logical-switch <ls_id_arg_esx>

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

Display all the counters for the specified logical switch.

get logical-switch <ls_id_arg_esx> datapath-stats all

Display all counters for the specified logical switch.

get logical-switch <ls_id_arg_esx> datapath-stats all new

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.

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.

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.

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.

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

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

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

Display VTEP group information

Display VTEP groups for the specified logical switch

get logical-switch <ls_id_arg_esx> vtep-group

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

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>

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

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.

get logical-switches datapath-stats module <mod_name_arg_esx> counters list

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

Get maintenance mode

Get maintenance mode status.

get maintenance-mode

Show managers

Show the current list of configured managers.

get managers

Show host UUID

Display the UUID for the host.

get node-uuid

Display port information

Display port information on the current host.

get ports

Display a routing domain

Display information about the specified routing domain.

get routing-domain <uuid-arg>

Display routing domain

Display information about all routing domains.

get routing-domains

Display all the counters for the specified segment.

get segment <ls_id_arg_esx> datapath-stats all

Display all counters for the specified segment.

get segment <ls_id_arg_esx> datapath-stats all new

Display all drop counters of all modules for the specified segment.

get segment <ls_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 <ls_id_arg_esx> datapath-stats drops new

Display all the counters for the specified segment and module.

get segment <ls_id_arg_esx> datapath-stats module <mod_name_arg_esx> all

Display all new counters for the specified segment and module.

get segment <ls_id_arg_esx> datapath-stats module <mod_name_arg_esx> all new

Display drop counters for the specified segment and module.

get segment <ls_id_arg_esx> datapath-stats module <mod_name_arg_esx> drops

Display new drop counters for the specified segment and module.

get segment <ls_id_arg_esx> datapath-stats module <mod_name_arg_esx> drops new

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

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>

Get segment port status

Display the status for segment ports on this hypervisor host.

get segment-port status

Display segments

Display all segments on this host.

get segments

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.

get segments datapath-stats module <mod_name_arg_esx> counters list

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.

get segments datapath-stats modules list

Get the whole cfgagent cache table

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

Display the status for HyperBus vmknic ports on this hypervisor host.

get service nsx-cfgagent hyperbus vmknic

Get service cfgagent hyperbus logging level

Get service cfgagent hyperbus logging level.

get service nsx-cfgagent lib-hyperbus logging-level

Get service cfgagent metrics logging level

get service nsx-cfgagent lib-metrics logging-level

Get service cfgagent nestdb logging level

get service nsx-cfgagent lib-nestdb logging-level

Get service cfgagent net logging level

get service nsx-cfgagent lib-net logging-level

Get service cfgagent rpc logging level

get service nsx-cfgagent lib-rpc logging-level

Get service cfgagent SHA client logging level

Get service cfgagent SHA client logging level.

get service nsx-cfgagent lib-sha logging-level

Get service cfgagent upm logging level

Get service cfgagent upm logging level.

get service nsx-cfgagent lib-upm logging-level

Get service cfgagent workflow logging level

Get service cfgagent workflow logging level.

get service nsx-cfgagent lib-wft logging-level

Get service cfgagent workflow trace level

Get service cfgagent workflow trace level.

get service nsx-cfgagent lib-wft trace-level

Get service cfgagent logging level

Get service cfgagent logging level.

get service nsx-cfgagent logging-level

Get LS's extra config

Display the extra config list for logical switch on this hypervisor host.

get service nsx-cfgagent logical-switch extra-config

Get LSP's extra config

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

Get service daemon log level for context-mux.

get service nsx-context-mux logging-level

Get current status of IDFW on host

get service nsx-ctxteng idfw status

Get context engine protocol enable in the order TCP UDP ICMP

get service nsx-ctxteng protocol

Get service exporter SmartNIC demux logging level

Get service exporter SmartNIC demux logging level.

get service nsx-exporter lib-sndemux logging-level

Get service netopa logging level

Get service netopa logging level.

get service nsx-netopa logging-level

Get service opsagent SHA client logging level

Get service opsagent SHA client logging level.

get service nsx-opsagent lib-sha logging-level

Get service opsagent SmartNIC demux logging level

Get service opsagent SmartNIC demux logging level.

get service nsx-opsagent lib-sndemux logging-level

Get service opsagent workflow logging level

Get service opsagent workflow logging level.

get service nsx-opsagent lib-wft logging-level

Get service opsagent workflow trace level

Get service opsagent workflow trace level.

get service nsx-opsagent lib-wft trace-level

Get service OpsAgent logging level

Get service OpsAgent logging level.

get service nsx-opsagent logging-level

Get service nsx-proxy central logging level

Get service nsx-proxy central logging level.

get service nsx-proxy central logging-level

Get service nsx-proxy metrics logging level

Get service nsx-proxy metrics logging level.

get service nsx-proxy lib-metrics logging-level

Get service nsx-proxy nestdb logging level

Get service nsx-proxy nestdb logging level.

get service nsx-proxy lib-nestdb logging-level

Get service nsx-proxy net logging level

Get service nsx-proxy net logging level.

get service nsx-proxy lib-net logging-level

Get service nsx-proxy rpc logging level

Get service nsx-proxy rpc logging level.

get service nsx-proxy lib-rpc logging-level

Get service nsx-proxy logging level

Get service nsx-proxy logging level.

get service nsx-proxy logging-level

Get service nsx-snproxy central logging level

Get service nsx-snproxy central logging level.

get service nsx-snproxy central logging-level

Get service nsx-snproxy connection info

get service nsx-snproxy conn-info

Get service nsx-snproxy net logging level

Get service nsx-snproxy net logging level.

get service nsx-snproxy lib-net logging-level

Get service nsx-snproxy rpc logging level

Get service nsx-snproxy rpc logging level.

get service nsx-snproxy lib-rpc logging-level

Get service nsx-snproxy logging level

Get service nsx-snproxy logging level.

get service nsx-snproxy logging-level

Display spoof guard config for a host switch and dvport

Display spoof guard config for a host switch and dvport.

get spoof-guard config <hs-name-arg> <dvport-id-arg>

Display spoof guard stats for a host switch and dvport

Display spoof guard stats for a host switch and dvport.

get spoof-guard stats <hs-name-arg> <dvport-id-arg>

Display spoof guard whitelist for a host switch and dvport

Display spoof guard whitelist for a host switch and dvport.

get spoof-guard whitelist <hs-name-arg> <dvport-id-arg>

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>

Display system version

Display the version of the NSX appliance.

get version

Display all selected service paths

Display selected paths info

get vsip-si selected-service-paths <chain_id_esx>

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

Display help for specified command or list available commands

Display help information. See the example below.

help

Join host with management plane

Join 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 get certificate api thumbprint command on the specified NSX Manager.

join management-plane <hostname-or-ip-address[:port]> username <username> thumbprint <thumbprint> [password <password>]

List available commands

This command lists all available commands.

list

Push certificate to management plane

Pushes 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 get certificate api thumbprint command on the specified NSX Manager.

push host-certificate <manager-hostname-or-ip-address-and-optional-port-arg> username <api-username> thumbprint <api-thumbprint>

Recover management plane account on the host

Recover 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 get certificate api thumbprint command on the specified NSX Manager.

reset management-plane <hostname-or-ip-address[:port]> username <username> thumbprint <thumbprint> [password <password>]

Set status to display datetime stamp

Set status to display datetime stamp in command output.

set cli-output datetime <datetime-arg>

Set ESXi to report ESXio data in NSX-CLI

Set NSX-CLI state on ESXi host to include or exclude data from ESXio node for issued commands.

Default state is set to be enabled when ESXi host is registered with ESXio nodes and is set to disabled when no ESXio nodes found.

set cli-output esxio <esxio-cli-state>

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 commands history size

Set command history size.

set history limit <history-size>

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>

Configure NSX IDS Engine Fast Log.

set ids engine alertlog <ids-eng-alertlog-arg>

Configure NSX IDS Engine Log Level

Configure NSX IDS Engine Log Level.

set ids engine logging-level <ids-eng-log-level-arg>

Clear IDS Event Engine stats

clear IDS Event Engine stats.

set ids events stats clear

Configure NSX IDS Log Level

Configure NSX IDS Log Level.

set ids logging-level <ids-log-level-arg>

Set maintenance mode

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

Set service cfgagent hyperbus logging level

Set service cfgagent hyperbus logging level.

set service nsx-cfgagent lib-hyperbus logging-level <cfgagent-logging-level-arg>

Set service cfgagent metrics logging level

set service nsx-cfgagent lib-metrics logging-level <cfgagent-logging-level-arg>

Set service cfgagent nestdb logging level

set service nsx-cfgagent lib-nestdb logging-level <cfgagent-logging-level-arg>

Set service cfgagent net logging level

set service nsx-cfgagent lib-net logging-level <cfgagent-logging-level-arg>

Set service cfgagent rpc logging level

set service nsx-cfgagent lib-rpc logging-level <cfgagent-logging-level-arg>

Set service cfgagent SHA client logging level

Set service cfgagent SHA client logging level.

set service nsx-cfgagent lib-sha logging-level <cfgagent-logging-level-arg>

Set service cfgagent upm logging level

Set service cfgagent upm logging level.

set service nsx-cfgagent lib-upm logging-level <cfgagent-logging-level-arg>

Set service cfgagent workflow logging level

Set service cfgagent workflow logging level.

set service nsx-cfgagent lib-wft logging-level <cfgagent-logging-level-arg>

Set service cfgagent workflow trace level

Set service cfgagent workflow trace level.

set service nsx-cfgagent lib-wft trace-level <cfgagent-workflowtrace-level-arg>

Set service cfgagent logging level

Set service cfgagent logging level.

set service nsx-cfgagent logging-level <cfgagent-logging-level-arg>

Set the log level of nsx-context-mux

Dynamically set service daemon log level.

set service nsx-context-mux logging-level <context-mux-logging-level-arg>

Enable/disable TCP UDP ICMP events

set service nsx-ctxteng protocol <idfw-protocol> <idfw-enable>

Set service exporter SmartNIC demux logging level

Set service exporter SmartNIC demux logging level.

set service nsx-exporter lib-sndemux logging-level <logging-level-arg>

Set the log level of exporter service.

Dynamically set service daemon log level.

set service nsx-exporter logging-level <level>

Set service netopa logging level

Set service netopa logging level.

set service nsx-netopa logging-level <netopa-logging-level-arg>

Set service opsagent SHA client logging level

Set service opsagent SHA client logging level.

set service nsx-opsagent lib-sha logging-level <opsagent-logging-level-arg>

Set service opsagent SmartNIC demux logging level

Set service opsagent SmartNIC demux logging level.

set service nsx-opsagent lib-sndemux logging-level <opsagent-logging-level-arg>

Set service opsagent workflow logging level

Set service opsagent workflow logging level.

set service nsx-opsagent lib-wft logging-level <opsagent-logging-level-arg>

Set service opsagent workflow trace level

Set service opsagent workflow trace level.

set service nsx-opsagent lib-wft trace-level <opsagent-workflowtrace-level-arg>

Set service OpsAgent logging level

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

set service nsx-proxy central logging-level <nsxproxy-logging-level-arg>

Set service nsx-proxy metrics logging level

Set service nsx-proxy metrics logging level.

set service nsx-proxy lib-metrics logging-level <nsxproxy-logging-level-arg>

Set service nsx-proxy nestdb logging level

Set service nsx-proxy nestdb logging level.

set service nsx-proxy lib-nestdb logging-level <nsxproxy-logging-level-arg>

Set service nsx-proxy net logging level

Set service nsx-proxy net logging level.

set service nsx-proxy lib-net logging-level <nsxproxy-logging-level-arg>

Set service nsx-proxy rpc logging level

Set service nsx-proxy rpc logging level.

set service nsx-proxy lib-rpc logging-level <nsxproxy-logging-level-arg>

Set service nsx-proxy logging level

Set service nsx-proxy logging level.

set service nsx-proxy logging-level <nsxproxy-logging-level-arg>

Set service nsx-snproxy central logging level

set service nsx-snproxy central logging-level <nsx-snproxy-logging-level-arg>

Set service nsx-snproxy net logging level

Set service nsx-snproxy net logging level.

set service nsx-snproxy lib-net logging-level <nsx-snproxy-logging-level-arg>

Set service nsx-snproxy rpc logging level

Set service nsx-snproxy rpc logging level.

set service nsx-snproxy lib-rpc logging-level <nsx-snproxy-logging-level-arg>

Set service nsx-snproxy logging level

Set service nsx-snproxy logging level.

set service nsx-snproxy logging-level <nsx-snproxy-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>

Set vxlan uplink queue filter

Set vxlan uplink queue filter.

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

Show packet capture on dvfilter

Display a packet capture on a given dvfilter. To get a list of dvfilter names, enter start capture dvfilter followed by a space and the Tab key.

start capture dvfilter <esx-dvfilter-name-arg>

Start packet capture on given interface with multiple options and save to file

Start a packet capture on the specified interface in the given direction. If you do not specify a file, the output is displayed on the terminal. Type Control-C to end the packet capture. You can filter the capture using tcpdump expressions. The expression must be the last argument of the command. The expression is a keyword followed by a value. You can specify multiple keyword-value pairs. The list of keywords and acceptable values are:

Keyword	Value
ethtype	Ethernet type in HEX format. 0x<ETHTYPE>
mac	Source or destination MAC address
srcmac	Source MAC address
dstmac	Destination MAC address
ipproto	IP protocol in HEX format. 0x<PROTO>
ip	Source or destination IPv4 address
ip6	Source or destination IPv6 address
srcip	Source IPv4 address
dstip	Destination IPv4 address
srcip6	Source IPv6 address
dstip6	Destination IPv6 address
port	Source or destination TCP port
srcport	Source TCP port
dstport	Destination TCP port
srcudpport	Source UDP port
dstudpport	Destination UDP port
vni	VNI of the flow. When specified, the decoding offset for the remainder of the expression changes to the inner packet.
vlan	VLAN ID

start capture interface <interface-name> [direction <direction>] [file <filename>] [count <packet-count>] [expression <expression>]

Show packet capture on all interfaces

Display a packet capture on all available interfaces.

start capture trace

Sync APH certificates from management plane

Syncs APH certificates from management plane to host. 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 get certificate api thumbprint command on the specified NSX Manager.

sync-aph-certificates <manager-hostname-or-ip-address[:port]> username <username> thumbprint <thumbprint> [password <password>]

Total commands: 311