NSX CLI Guide

All NSX-CLI Commands:

CLI Description Command

Activates specified local user account.


Activates specified local user account.
activate user <username> password [<password>]

Add new local user.


Add a new local user. By default status for newly created local user will be NOT_ACTIVATED and administrator will require to explicitly activate such users. When password is specified with command, status for created local user will be ACTIVE.
add user <username> [full-name <full-name>] [password <node-password>] [password-expiration-frequency <days>] [password-expiration-warning <days>] [password-reset-required]

Add audit user.


Re-create audit user if it was removed. By default status for re-created audit user will be NOT_ACTIVATED and administrator will require to explicitly activate audit user. When password is specified with command, status for re-created audit user will be ACTIVE.
add user audit [username <username>][full-name <full-name>] [password <node-password>] [password-expiration-frequency <days>] [password-expiration-warning <days>] [password-reset-required]

Move to the bottom of the path


Move to the bottom of the path. The arrow moves to show which interface is current.
bottom

Clear auth-policy vidm enabled property


Clear the vidm service's enabled property.
clear auth-policy vidm enabled

Clear auth-policy vidm lb-extern enabled property


Clear the external load balancer enabled property.
clear auth-policy vidm lb-extern enabled

Clear security banner or message of the day


Clear the security banner or message of the day. The banner is reset to the system default banner.
clear banner

Clear a BFD session stats


Clear the statistics for the specified BFD session
clear bfd-session local-ip <ip46-address> remote-ip <ip46-address> stats

Clear BFD sessions stats


Clear the statistics for all BFD sessions.
clear bfd-sessions stats

Reset specific BGP neighbor session


Reset specific BGP neighbor session.
clear bgp <ip46-address>

Reset all BGP neighbor sessions


Reset all BGP neighbor sessions.
clear bgp neighbors

Clear bond interface stats


Clear the LACP stats for the bond interface with the specified name.
clear bond <bond name> stats

Clear bootup error message(s) after user has resolved the issues


After user has resolved issues which cause bootup error, he/she can call this CLI to clear the bootup error message.
clear bootup error message

Clear cluster api service redirect host


Clear the cluster api service redirect host.
clear cluster api-service redirect-host

Clear Cluster Virtual IPv4 address


Clear Cluster Virtual IPv4 address.
clear cluster vip

Clears both cluster Virtual IPv4 & IPv6 addresses


Clears both cluster Virtual IPv4 & IPv6 addresses.
clear cluster vip all

Clear Cluster Virtual IPv6 address


Clear Cluster Virtual IPv6 address.
clear cluster vip ipv6

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 IDS Engine Event stats


clear IDS Engine Event stats.
clear edgeids events stats

Clear flow table for all fastpaths


Clear flow table for all fastpaths
clear ens flow-table

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 the stats of a specific gateway interface


Clear the statistic counters for the specified gateway interface.
clear gateway interface <dpd-uuid-lrouter-port-arg> stats

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

Clear NSX Intelligence flows statistics


Clear NSX Intelligence flows statistics.
clear intelligence flows stats

Delete VLAN and/or bond network interface


Delete the specified VLAN network interface and all it's configuration, or the specified bond configuration, or both if a VLAN was configured over the bond. Users must configure an alternate interface for management.
clear interface <configurable-interface-name>

Remove network IP configuration from the interface


Remove all network configuration from the specified interface.
clear interface <configurable-interface-name> ip

Clear the interface plane


Clear the network interface plane configuration.
clear interface <configurable-interface-name> plane

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

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 <lb-uuid-arg> pool <pool-uuid-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 <lb-uuid-arg> pools stats

Clear load balancer statistics


Clear the statistics for a specific load balancer.
clear load-balancer <lb-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 <lb-uuid-arg> virtual-server <vs-uuid-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 <lb-uuid-arg> virtual-servers stats

Clear load balancer performance profile settings


Clear load balancer performance profile parameter settings from edge.
clear load-balancer perf-profile

Clear all configured logging-servers


Clear all logging server configuration.
clear logging-servers

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

Clear the stats of a specific logical router interface


Clear the statistic counters for the specified logical router interface.
clear logical-router interface <dpd-uuid-lrouter-port-arg> 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

Clear all name servers


Clear all name servers from the DNS configuration.
clear name-servers

Reset specific OSPF neighbor session


Reset specific OSPF neighbor session.
clear ospf <ip-address>

Reset all OSPF neighbor sessions


Reset all OSPF neighbor sessions.
clear ospf neighbors

Resets configured password complexity requirements to default


Resets configured password complexity requirements to default.
clear password-complexity

Clear physical port stats by name


Clear statistics for the specified physical port.
clear physical-port <dpd-name-physical-port-arg> stats

Clear all PIM BSM data & messages


Clear all PIM BSM data & messages.
clear pim bsr-data

Clear search domains


Remove all domain names from the DNS search list.
clear search-domains

Clear http service redirect host


Clear the HTTP service redirect host.
clear service http redirect-host

Clear install-upgrade service enabled property


Clear the install-upgrade service's enabled property.
clear service install-upgrade enabled

Clear manager service logging levels


Clear the log levels of the manager service.
clear service manager logging-level

Clear NTP service start on boot


Configure the NTP service to not start on boot.
clear service ntp start-on-boot

Clear snmp service start on boot


Configure the snmp service to not start on boot.
clear service snmp start-on-boot

Clear SSH service start on boot


Configure the SSH service to not start on boot.
clear service ssh start-on-boot

Clear SSH Root login property


Disable SSH Root login property
clear ssh root-login

Delete all TLS inspection cached certificates


Delete all TLS inspection cached certificates.
clear tls-inspection cached-certificates

Delete TLS inspection cached certificates


Delete TLS inspection cached certificates.
clear tls-inspection cached-certificates <certificate-id-string-arg>

Clear all TLS inspection error stats


Clear all TLS inspection error stats.
clear tls-inspection errors

Clear all TLS inspection traffic stats


Clear all TLS inspection traffic stats.
clear tls-inspection traffic-stats

Disable password expiration for the user


Disable password expiration for the user.
clear user <node-all-username> password-expiration

Disable password expiration warning for the user


Disable password expiration warning for the user.
clear user <node-all-username> password-expiration-warning

Copy core dumps to remote file


Copy system generated core dumps to a remote destination.
copy core-dump <core-dump-file-arg> url <scp-file-url-arg>

Copy a local file to remote file


Copy a local file to a remote destination.
copy file <existing-file-arg> url <scp-file-url-arg>

Copy a remote file to the local file store


Copy a remote file to the local file store. If no destination file is specified, the copied file has the same file name as the source file. You can use the file argument to specify a different destination file name.
To specify IPv6 remote addresses, url server should be enclosed between square brackets.
copy url <url> [file <filename>]

Copy a remote https url file with same filename


Copy a remote https url file to local file using same filename.
copy url <url> thumbprint <thumbprint> [file <filename>]

Remove all other management nodes from the cluster


Remove all other management nodes from the cluster. This will effectively convert a multi-node management cluster into a single node setup. The system will prompt for confirmation for this operation. It is recommended to use GSS guidance before using this command.
deactivate cluster

Deactivate local user.


Deactivate account for local user. Deactivating an account is permanent, unlike an account that is temporarily locked because of too many password failures. A deactivated account has to be explicitly activated.
deactivate user <username>

Delete all packet capture sessions


Delete all packet capture sessions.
del all capture sessions

Delete packet capture session


Delete a packet capture session configuration.
del capture session <dpd-number-session-id-arg>

Delete a configured packet capture session


Delete a packet capture session configuration.
del capture session <dpd-number-session-id-arg>

Delete an interface from a packet capture session


Delete the specified interface from a packet capture session configuration. If you are only monitoring one interface, this deletes the monitoring session configuration.
del capture session <dpd-number-session-id-arg> interface <dpd-uuid-name-port-arg>

Delete an interface from a packet capture session


Delete the specified interface from a packet capture session configuration. If you are only monitoring one interface, this deletes the monitoring session configuration.
del capture session <dpd-number-session-id-arg> interface <variable-interface-name>

Delete a configured packet capture session


Delete a packet capture session configuration.
del capture session <esx-session-id-arg>

Delete packet capture session


Delete the specified packet capture session.
del capture session <session-id-arg>

Delete core dump files in the system


Delete core dump files in the system.
del core-dump [all|<core-dump-file-arg>]

Delete local file


Delete a local file.
del file <existing-file-or-pattern-arg>

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

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>

Delete logging-server


Delete the specified logging server configuration. You can use the get logging-servers command to display the current logging server configuration.
del logging-server <hostname-or-ip-address[:port]> proto <proto> level <level> [facility <facility>] [messageid <messageid>] [structured-data <structured-data>]

Delete name server


Delete the specified name server from the DNS configuration.
del name-server <name-server-arg>

Delete NSX config


Delete NSX config on this node without removing it as transport node from management plane.
del nsx

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

Delete NSX config, management IP, logs and filestore


Delete NSX config on this node without removing it as transport node from management plane. Additionally clear logs, filestore and management IP from the node.
del nsx all

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. Skips the pre-checks.
del nsx force

Remove NTP server


Remove an existing NTP server.
del ntp-server <hostname-or-ip-address>

Delete IPv4 or IPv6 network route


Delete the specified network IPv4 or IPv6 route. Default value for the IPv6 route metric is 1024.
del route prefix <prefix> [gateway <gateway-ip>] [interface <interface-name>] [metric <ip-route-metric>]

Delete IPv4 network route


Delete the specified network IPv4 network route.
del route prefix <prefix> [gateway <gateway-ip>] [interface <interface-name>] [metric <ip-route-metric>]

Delete a domain name


Delete the specified domain name from the DNS search list.
del search-domains <search-domain-arg>

Delete SNMP v2 Trap Targets


Delete SNMP v2 Trap Targets.
del snmp v2-targets <hostname-or-ip-address-optional-port-arg>

Delete SNMP v3 Trap Targets


Delete SNMP v3 Trap Targets.
del snmp v3-targets <hostname-or-ip-address-optional-port-arg>

Delete SNMP v3 Users


Delete SNMP v3 Users.
del snmp v3-users <user-id-arg>

Delete SSH service known host


Delete the specified host entry from the SSH known hosts file.
del ssh-known-host <hostname-or-ip-address-optional-port-arg>

Delete existing local users.


Delete specified user who is configured to log into the NSX appliance. Whereas local users root and administrator are not allowed to be deleted, but local user audit is deletable on-demand. In case to recreate a deleted user, kindly check the following link here
del user <username>

Delete existing local users.


Delete specified user who is configured to log into the NSX appliance. Whereas local users root and administrator are not allowed to be deleted, but local user audit is deletable on-demand.

Note: Deleted users cannot be created again.
del user <username>

Delete SSH service keys from authorized_keys file for specified user


Delete any SSH key with specified label from specified user's authorized_keys file. If password is not provided in the command then you are prompted to enter it. Password is required only for users root and admin.
del user <username> ssh-keys label <key-label> [password <password>]

Deregister Edge from management plane


Detach this Edge from the management plane.
detach management-plane <hostname-or-ip-address[:port]> username <username> thumbprint <thumbprint> [password <password>]

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

Detach specified node from the cluster


Detach the specified node from the cluster.
detach node <node-id-arg>

Detach specified node from the cluster without checking repository-ip modification errors


Detach specified node from the cluster without checking repository-ip modification errors.
detach node <node-id-arg> ignore-repository-ip-check

Display packet capture result


Display the result of the specified packet capture session with the tcpdump command.
display capture session <session-id-arg>

Display packet capture result


Display packet capture result with command tcpdump.
display capture session <session-id-arg> parameters <capture-options-arg>

Move down the path


Move down the path. The arrow moves to show which interface is current.
down

Writes IDPS filter specific statistics to /var/log/nsx-idps/filter_stats.txt


Writes IDPS filter specific statistics to /var/log/nsx-idps/filter_stats.txt
dump ids filter stats

Exit the CLI


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

Query all packet capture sessions


Display information for all packet capture sessions.
get all capture sessions

Show system ARP or neighbour address table


Display the ARP or neighbour address table.
get arp-table

Get API account lockout period


Get the amount of time, in seconds, that an account will remain locked out of the API after exceeding the maximum number of failed authentication attempts.
get auth-policy api lockout-period

Get API account lockout reset period


In order to trigger an account lockout, all authentication failures must occur in this time window. If the reset period exprires, the failed login count is reset to zero.
get auth-policy api lockout-reset-period

Get API maximum authentication faliures


Get the number of failed API authentication attempts that are allowed before the account is locked. If set to 0, account lockout is disabled.
get auth-policy api max-auth-failures

Get CLI account lockout period


Get the amount of time, in seconds, that an account will remain locked out of the CLI after exceeding the maximum number of failed authentication attempts.
get auth-policy cli lockout-period

Get CLI maximum authentication faliures


Get the number of failed CLI authentication attempts that are allowed before the account is locked. If set to 0, account lockout is disabled.
get auth-policy cli max-auth-failures

Get minimum allowable password length


Get the minimum number of characters that passwords must have.
get auth-policy minimum-password-length

Get auth-policy vidm


Get the vidm's properties.
get auth-policy vidm

Display security banner or message of the day


Display the security banner or message of the day.
get banner

Display logical router BFD config


Display parameters defined in global logical router BFD
get bfd-config

Display info for a BFD session


Display information about the specified BFD session.
get bfd-session local-ip <ip46-address> remote-ip <ip46-address>

Display stats for a BFD session


Display statistics for the specified BFD session.
get bfd-session local-ip <ip46-address> remote-ip <ip46-address> stats

Display info about BFD sessions


Display information about BFD sessions.
get bfd-sessions

Display logical router BFD sessions


Display BFD sessions in a logical router
get bfd-sessions [stats]

Display BFD sessions stats


Display the BFD sessions statistics.
get bfd-sessions stats

Display all IPv4 & IPv6 BGP routes


Display all IPv4 & IPv6 BGP routes.
get bgp

Display detailed information about BGP IPv4 route


Display detailed information about BGP IPv4 route.
get bgp <network-address>

Display detailed information about BGP IPv6 route


Display detailed information about BGP IPv6 route.
get bgp <network6-address>

Display all BGP NLRI matching the community.


Display all BGP NLRI matching the community.
get bgp community { NO_EXPORT | NO_ADVERTISE | NO_EXPORT_SUBCONFED | AA:NN }

Display BGP EVPN routes


Display BGP EVPN routes.
get bgp evpn

Display BGP EVPN Ethernet Segment information


Display BGP EVPN Ethernet Segment information.
get bgp evpn es

Display BGP EVPN Ethernet Segment(ES) per EVPN instance(EVI) information


Display BGP EVPN Ethernet Segment(ES) per EVPN instance(EVI) information.
get bgp evpn es-evi

Display BGP EVPN overlay information for all RDs


Display BGP EVPN overlay information for all RDs.
get bgp evpn overlay

Display BGP EVPN VNI information


Display BGP EVPN VNI information.
get bgp evpn vni

Display all IPv4 BGP routes


Display all IPv4 BGP routes.
get bgp ipv4

Display all IPv6 BGP routes


Display all IPv6 BGP routes.
get bgp ipv6

Display all BGP NLRI matching the large-community.


Display all BGP NLRI matching the large-community.
get bgp large-community <bgp-large-community-arg>

Display all BGP neighbor information


Display all BGP neighbor information.
get bgp neighbor

Display information about a specific BGP neighbor


Display information about a specifie BGP neighbor.
get bgp neighbor <ip-address>

Display routes advertised to a BGP neighbor in internal debug context


Display routes advertised to a BGP neighbor in internal debug context
get bgp neighbor <ip-address> advertised-routes

Display routes advertised to a BGP neighbor


Display routes advertised to a BGP neighbor.
get bgp neighbor <ip-address> advertised-routes

Display routes learnt from a BGP neighbor


Display routes learnt from a BGP neighbor.
get bgp neighbor <ip-address> routes

Display routes learnt from a BGP neighbor in internal debug context


Display routes learnt from a BGP neighbor in internal debug context
get bgp neighbor <ip-address> routes

Display a specific BGP neighbor diagnostic information


Display a specific BGP neighbor diagnostic information.
get bgp neighbor <ip46-address> session-diagnostics

Display BGP neighbor diagnostic information


Display BGP neighbor diagnostic information.
get bgp neighbor session-diagnostics

Display summarized inter-sr neighbors information from the default VRF in internal debug context


Display summarized inter-sr neighbors information from the default VRF in internal debug context.
get bgp neighbor summary

Display summarized BGP neighbor information


Display summarized BGP neighbor information.
get bgp neighbor summary

Display summarized BGP neighbor information for a given address-family


Display summarized BGP neighbor information for a given address-family.
get bgp neighbor summary <address-family>

Display all IPv4 & IPv6 BGP routes of shadow VRF


Display all IPv4 & IPv6 BGP routes of shadow VRF.
get bgp vrfid <vrf-id>

Generate BGP/BFD diagnostic report


Generate BGP/BFD diagnostic report.
get bgp-bfd diagnostics report

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]

Show all bridge ports configuration and state


Show all bridge ports configuration and state.
get bridge

Show bridge port configuration and state


Show bridge port configuration and state.
get bridge <dpd-uuid-l2bridge-port-arg>

Display high-availability history of bridge port


Display high-availability history of bridge port.
get bridge <dpd-uuid-l2bridge-port-arg> high-availability-history

Display mac-sync table on a bridge port


Display Mac Sync table on an bridge port.
get bridge <dpd-uuid-l2bridge-port-arg> mac-sync-table

Show bridge port configuration and state attached to specified logical-switch


Show bridge port configuration and state attached to specified logical-switch.
get bridge logical-switch <dpd-uuid-lswitch-arg>

Display mac-sync table on bridge ports


Display mac-sync table on bridge ports.
get bridge mac-sync-table

Show bridge ports whose attached logical-switch name matches the specified name


Show bridge ports whose attached logical-switch name matches the specified name.
get bridge name <bridge-lswitch-name-arg>

Display summary of bridge ports


Display summary of bridge ports.
get bridge summary

Show bridge ports configuration and state with specified vlan


Show bridge ports configuration and state with specified vlan.
get bridge vlan <vlan-id-arg>

Display a packet capture session


Display information about the specified packet capture session.
get capture session <dpd-number-session-id-arg>

Display a packet capture session


Display information about the specified packet capture session.
get capture session <esx-session-id-arg>

Query packet capture session


Display information for the specified packet capture session.
get capture session <session-id-arg>

Display packet capture sessions


Display configured packet capture sessions. Session 0 is reserved for captures started with the start capture interface <interface-name> command.
get capture sessions

Display packet capture sessions


Display configured packet capture sessions.
get capture sessions

Display API server certificate


Display the API server's certificate.
get certificate api

Display API server certificate text


Display the API server's certificate text.
get certificate api text

Display API server certificate thumbprint


Display the API server's certificate thumbprint.
get certificate api thumbprint

Display cluster certificate


Display the clsuter certificate.
get certificate cluster

Display cluster certificate text


Display the cluster certificate text.
get certificate cluster text

Display cluster certificate thumbprint


Display the cluster certificate thumbprint.
get certificate cluster thumbprint

Show the cgroup translation


Display the translations for the specified container group. Optionally specify a translation type to display translations of that type.
get cgroup <uuid> [<translation-type>]

Show all existing cgroups


Display all container groups.
get cgroups (Deprecated)

Lookup cgroups for the IP address


Display container groups with the specified IP address.
get cgroups with ip <ip46-address> (Deprecated)

Lookup cgroups for the hardware address


Display container groups with the specified MAC address.
get cgroups with mac <hardware-address> (Deprecated)

Lookup cgroups for the network interface


Display container groups with the specified network interface.
get cgroups with vif <vif-id-arg> (Deprecated)

Show status to display datetime stamp


Show status to display datetime stamp in command output.
get cli-output datetime

Show status to display commad deprecate warning


Show status to display deprecate warning in command output.
get cli-output deprecate-warning

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

Show inactivity timeout


Show inactivity timeout in seconds.
get cli-timeout

Display system clock


Display the current date and time.
get clock

Display cluster api-service configuration


Display cluster api-service configuration.
get cluster api-service

Get Cluster Config


Get Cluster Config.
get cluster config

Get Cluster Status


Get status of all the groups.
get cluster status

Get Cluster Status


Get status of all the groups. Show leadership if there is any.
get cluster status verbose

Get Cluster Virtual IP


Get Cluster Virtual IP.
get cluster vip

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

Show system configuration


Display configuration settings in command line syntax.
get configuration

Display controller connection


Display the controllers connected to this node.
get controllers

Get core dump config


Get core dump generation and rotation configurations
get core-dump config

List core dump files in the system


Display information about the core dump files in the system.
get core-dumps

Show the system CPU status


Display the system CPU information.
get cpu-stats

Display the current port or interface


Display information about the current interface.
get current

Show the datum ID(s) and span(s) for the message ID


Display the datum ID(s) and span(s) for the specified message ID.
get data <data-id-arg>

Lookup datum ID(s) for the receiver


Display datum ID(s) for the specified receiver.
get data with receiver <uuid-arg>

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 verbose cpu stats for dataplane


Display verbose data plane cpu statistics.
get dataplane cpu stats verbose

Get the list of supported devices on the system


Get the list of supported devices on the system.
get dataplane device list

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>

Show dhcp ip pool


Display a specific DHCP IP pool.
get dhcp ip-pool <uuid-string-arg>

Show all dhcp ip pool


Display all DHCP IP pools.
get dhcp ip-pools

Show dhcp ip pools matched server uuid


Display DHCP IP pools which matched a specific server UUID.
get dhcp ip-pools server-uuid <uuid-string-arg>

Show DHCPv6 IP pool


Display a specific DHCPv6 IP pool.
get dhcp ipv6-ip-pool <uuid-string-arg>

Show all DHCPv6 IP pools


Display all DHCPv6 IP pools.
get dhcp ipv6-ip-pools

Show DHCPv6 IP pools matching server uuid


Display DHCPv6 IP pools which match a specific server UUID.
get dhcp ipv6-ip-pools server-uuid <uuid-string-arg>

Show all non-released DHCPv6 leases by search string


Display all non-released DHCPv6 leases by search string.
get dhcp ipv6-lease <string-arg>

Show all DHCPv6 leases by search string


Display all DHCPv6 leases(both released and non-released) by search string.
get dhcp ipv6-lease <string-arg> all

Show all non-released DHCPv6 leases


Display all non-released DHCPv6 leases.
get dhcp ipv6-leases

Show all DHCPv6 leases


Display all DHCPv6 leases.
get dhcp ipv6-leases all

Show DHCPv6 static binding


Display a specific DHCPv6 static binding.
get dhcp ipv6-static-binding <uuid-string-arg>

Show all DHCPv6 static bindings


Display all DHCPv6 static bindings.
get dhcp ipv6-static-bindings

Show DHCPv6 static bindings matching server uuid


Display DHCPv6 static bindings which match a specific server UUID.
get dhcp ipv6-static-bindings server-uuid <uuid-string-arg>

Show non-released DHCP lease


Display a specific DHCP lease. You can specify a DHCP server's UUID, or a MAC address, or an IP address.
get dhcp lease <string-arg>

Show DHCP lease


Display a specific DHCP lease. You can specify a DHCP server's UUID, or a MAC address, or an IP address.
get dhcp lease <string-arg> all

Show all non-released dhcp leases


Display all non-released DHCP leases.
get dhcp leases

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 leases


Display all DHCP leases.
get dhcp leases all

Display DHCP Server IPv6 Stats Entries


Display the DHCP Server IPv6 Stats Entries.
get dhcp server <uuid-string-arg> ipv6-stats

Display DHCP Server IPv4 Stats Entries


Display the DHCP Server IPv4 Stats Entries.
get dhcp server <uuid-string-arg> stats

Show logical dhcp server


Display a specific DHCP server. Optionally specify an argument to display only the status or the synchronization information.
get dhcp server <uuid> [status | sync]

Show all DHCP servers/subnets enabled with DHCP


Display all DHCP servers/subnets enabled with DHCP
get dhcp servers

Show all logical DHCP server


Display all DHCP servers. Optionally specify an argument to display only the status or the synchronization information.

If the edge node is the only member of the edge cluster, the STATUS property will be displayed as UNKNOWN when you call get dhcp servers status because HA (high availability) is not available.
get dhcp servers [status | sync]

Show dhcp static binding


Display a specific DHCP static binding.
get dhcp static-binding <uuid-string-arg>

Show all dhcp static binding


Display all DHCP static bindings.
get dhcp static-bindings

Show dhcp static bindings matched server uuid


Display a specific DHCP static bindings which matched a specific server UUID.
get dhcp static-bindings server-uuid <uuid-string-arg>

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

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

Display DNS Forwarder Cache Entries


Display the DNS Forwarder Cache Entries.
get dns-forwarder <uuid-string-arg> cache

Display DNS Forwarder Config


Display the DNS Forwarder Config.
get dns-forwarder <uuid-string-arg> config

Display DNS Forwarder Stats Entries


Display the DNS Forwarder Stats Entries.
get dns-forwarder <uuid-string-arg> stats

Display DNS Forwarder Status


Display DNS Forwarder Status
get dns-forwarder <uuid-string-arg> status

Display DNS Forwarder Entries


Display the DNS Forwarder Entries.
get dns-forwarder <uuid-string-arg> table

Live debugging DNS Forwarder


Live debugging the DNS Forwarder
get dns-forwarder <uuid> live-debug [server-ip <ip-address>] [lookup <hostname-or-ip-address>]

Display DNS Forwarder Cache Entries Per SR


Display the DNS Forwarder Cache Entries Per SR.
get dns-forwarder cache

Live debugging DNS forwarder


Live debugging the DNS Forwarder
get dns-forwarder live-debug [server-ip <ip-address>] [lookup <hostname-or-ip-address>]

Display DNS Forwarder Stats Entries Per SR


Display the DNS Forwarder Stats Entries Per SR.
get dns-forwarder stats

Display DNS Forwarder Status Per SR


Display the DNS Forwarder Entries Per SR.
get dns-forwarder status

Display DNS Forwarder Entries Per SR


Display the DNS Forwarder Entries Per SR.
get dns-forwarder table

Display DNS Forwarders Config


Display the DNS Forwarders Config.
get dns-forwarders config

Display DNS Forwarders Status


Display DNS Forwarder Status
get dns-forwarders status

List docker containers in the system


List all the docker containers in the system (equivalent of 'docker ps -a').
get docker-containers

List docker images in the system


List docker images in the system (equivalent of 'docker images').
get docker-images

Get a domain object by id


Display information about the specified domain object.
get domain-object <domain-object-id>

Find all domain objects of a given type


Display domain objects of the specified type.
get domain-objects <domain-object-type>

Find all domain objects of a given type with the specified component name


Display domain objects of the specified type with the specified component name
get domain-objects <objects-type-with-component-name> <component-name>

Display NSX DPI Lib Log Level


Display NSX DPI Lib Log Level.
get dpi lib-dfw logging-level all

Display NSX DPI Log Level


Display NSX DPI Log Level.
get dpi logging-level

Display NSX DPI Statistics


Display NSX DPI Statistics.
get dpi stats

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

Get IDS Event Engine config stats


Get IDS Event Engine config stats.
get edgeids event-config stats

Get IDS Engine Event stats


Get IDS Engine Event stats.
get edgeids events stats

Show ENS device affinity list


Show the current device affinity of enhanced datapath.
get ens dev affinity list

Get flow stats for an ENS switch with switch ID


Show flow stats for an ENS switch with switch ID
get ens flow-stats <switch-id-arg>

Get flow stats for an ENS fastpath with switch ID and lcore ID


Show flow stats for an ENS fastpath with switch ID and lcore ID
get ens flow-stats <switch-id-arg> <lcore-ID-arg>

Dump Flow Table for all lcores of requested switch ID


Dump Flow Table for all lcores of requested switch ID
get ens flow-table dump <switch-id-arg>

Dump Flow Table for a specific lcore from specific switch


Dump Flow Table for a specific lcore from specific switch
get ens flow-table dump <switch-id-arg> <lcore-ID-arg>

Get flow table size


Get flow table size
get ens flow-table size

Get flow timeout in seconds


Get flow timeout in seconds
get ens flow-table timeout

Get global FPO configuration


Get global FPO configuration
get ens fpo

Get FPO stats for a datapath with switch ID and lcore ID


Get FPO stats for a datapath with switch ID and lcore ID
get ens fpo stats <switch-id-arg> <lcore-ID-arg>

Get FPO stats for a datapath with uplink name


Get FPO stats for a datapath with uplink name
get ens fpo stats <uplink-arg>

Get FPO status for an uplink


Get FPO status for an uplink
get ens fpo status <uplink-arg>

Get HW flow cache counters on smart NIC


Get HW flow cache counters on smart NIC
get ens hw-flow-stats

Get the lcore latency config data


Get the lcore latency config data
get ens latency lcore config <switch-id-arg>

Dump the lcore latency stats data


Dump the lcore latency stats data
get ens latency lcore dump <switch-id-arg>

Dump latency histos for all vmxnet3 vnics and all lcores of this switch


Dump latency histos for all vmxnet3 vnics and all lcores of this switch
get ens latency system dump <switch-id-arg>

Show ENS lcore assignment mode


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

List all ports in all switches


List all ports in all switches
get ens port list

List all ports in a specified ENS switch


List all ports in a specified ENS switch
get ens port list <switch-id-arg>

Get the netq information for a port


Get the netq information for a port
get ens port netq <switch-id-arg> <ens-port-id-arg>

Get PRP config for a switch


Get PRP config for a switch
get ens prp config <switch-id-arg>

List all active PRP nodes


List all active PRP nodes
get ens prp node <switch-id-arg>

Get a PRP node information


Get a PRP node information
get ens prp node <switch-id-arg> <vLAN-id-arg> <mac-arg>

List PRP per lcore stats


List PRP per lcore stats
get ens prp stats lcore <switch-id-arg> <lcore-aggr-arg>

List all active PRP nodes stats


List all active PRP nodes stats
get ens prp stats node <switch-id-arg>

List vDAN stats


List vDAN stats
get ens prp stats vdan <switch-id-arg>

List active vDANs


List active vDANs
get ens prp vdan list <switch-id-arg>

List all ENS switches


List all ENS switches
get ens switch list

List latest Telemetry related infra-counters.


List latest Telemetry related infra-counters.
get ens telemetry-infra-counters

Dump thread load balancer statistics


Dump thread load balancer statistics
get ens tlb stats

Dump thread load balancer statistics for a specific switch


Dump thread load balancer statistics for a specific switch
get ens tlb stats <switch-id-arg>

Get the current thread load balancer status


Get the current thread load balancer status
get ens tlb status <hs-name-arg>

Get the RSS setting of an uplink


Get the RSS setting of an uplink
get ens uplink rss list <uplink-arg>

Get the stats and private stats of an uplink port


Get the stats and private stats of an uplink port
get ens uplink stats <uplink-arg>

Display registered ESXio nodes


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

Show the content of End User License Agreement


Show the content of End User License Agreement
get eula

Show the acceptance of End User License Agreement


Show the acceptance of End User License Agreement
get eula acceptance

Display EVPN All VNIs ARP information


Display EVPN All VNIs ARP information.
get evpn arp

Display EVPN VNI ARP information


Display EVPN VNI ARP information.
get evpn arp ["<vni-value>"]

Display EVPN deployment Mode information


Display EVPN deployment Mode information.
get evpn deployment-mode

Display EVPN Ethernet Segment information


Display EVPN Ethernet Segment information.
get evpn es

Display particular EVPN Ethernet Segment information


Display particular EVPN Ethernet Segment information.
get evpn es <esi-arg>

Display EVPN VNI MAC information


Display EVPN VNI MAC information.
get evpn mac

Display EVPN VNI MAC information


Display EVPN VNI MAC information.
get evpn mac [<vni-value>]

Display router MACs for all VNIs


Display router MACs for all VNIs.
get evpn rmac

Display all EVPN VNI information


Display all EVPN VNI information.
get evpn vni

List file in the filestore


Display information about the specified file in the filestore.
get file <existing-file-arg>

Display file thumbprint


Display the file thumbprint.
get file <existing-file-arg> thumbprint

List files in the filestore


Display information about the files in the filestore.
get files

Show the system storage capacity


Display the file system information.
get filesystem-stats

Display the specified firewall address set


Display the specified firewall address set for the logical router interface.
get firewall <dpd-uuid-firewall-port-arg> addrset name <string-arg>

Display all the firewall address sets


Display all the firewall address sets for the logical router interface.
get firewall <dpd-uuid-firewall-port-arg> addrset sets

Display the specified firewall attribute set


Display the specified firewall attribute set for the logical router interface.
get firewall <dpd-uuid-firewall-port-arg> attrset name <string-arg>

Display all the firewall attribute sets


Display all the firewall attribute sets for the logical router interface.
get firewall <dpd-uuid-firewall-port-arg> attrset sets

Display firewall connection information


Display the firewall connections on the specified logical router interface.
get firewall <dpd-uuid-firewall-port-arg> connection

Display firewall connection count


Display the firewall connection count.
get firewall <dpd-uuid-firewall-port-arg> connection count

Display firewall connection information


Display the firewall connections on the specified logical router interface.
get firewall <dpd-uuid-firewall-port-arg> connection raw

Display firewall connection state


Display the state of the firewall connections.
get firewall <dpd-uuid-firewall-port-arg> connection state

Display firewall interface statistics


Display firewall interface statistics for the specified logical router interface.
get firewall <dpd-uuid-firewall-port-arg> interface stats

Display firewall active/standby configuration


Display the active/standby configuration for the firewall on the specified logical router interface.
get firewall <dpd-uuid-firewall-port-arg> sync config

Display firewall synchronization statistics


Display the firewall synchronization statistics.
get firewall <dpd-uuid-firewall-port-arg> sync stats

Display the fixed timeouts for connection events


Display the fixed timeouts for connection events.
get firewall <dpd-uuid-firewall-port-arg> timeouts

Display specific firewall L7 profile info on given Logical Router UUID


Display specific firewall L7 profile information on given Logical Router UUID.
get firewall <dpd-uuid-lrouter-port-arg> l7-profile <uuid-string-arg>

Display specific firewall L7 profile entry stats info on given Logical Router UUID


Display specific firewall L7 profile entry stats information on given Logical Router UUID.
get firewall <dpd-uuid-lrouter-port-arg> l7-profile <uuid-string-arg> stats

Display all firewall L7 profiles info on given Logical Router UUID


Display all firewall L7 profiles information on given Logical Router UUID.
get firewall <dpd-uuid-lrouter-port-arg> l7-profiles

Display all firewall L7 profile entry stats info on given Logical Router UUID


Display all firewall L7 profile entry stats information on given Logical Router UUID.
get firewall <dpd-uuid-lrouter-port-arg> l7-profiles stats

Display IKE policy


Display IKE policy for the specified logical router interface.
get firewall <uuid> ike policy [<rule-id>]

Display firewall rules


Display firewall rules with expanded address sets for the specified logical router interface.
get firewall <uuid> ruleset [type <rule-type>] rules [<ruleset-detail>]

Display firewall rule statistics


Display firewall rule statistics for the specified logical router interface.
get firewall <uuid> ruleset [type <rule-type>] stats

Display firewall address sets


Display firewall address sets
get firewall <vif-uuid-arg> addrsets

Display firewall fqdn attribute of profiles


Display firewall fqdn attribute of profiles.
get firewall <vif-uuid-arg> fqdn

Display firewall attribute profiles


Display firewall attribute profiles.
get firewall <vif-uuid-arg> profile

Display firewall rules


Display firewall rules
get firewall <vif-uuid-arg> ruleset rules

Display firewall interfaces


Display the logical router or switch interfaces which have firewall rules.
get firewall [logical-switch <uuid>] interfaces

Display firewall addresses for the specified address set


Display firewall addresses for the specified address set.
get firewall addrset name <uuid-arg>

Display firewall address sets for the available virtual interface


Display firewall address sets for the available virtual interface.
get firewall addrset sets

Display firewall connection state


Display the state of the firewall connections in the VRF context.
get firewall connection state

Display firewall fqdn attribute of profiles


Display firewall fqdn attribute of profiles.
get firewall context-profile <context-profile-id-arg> fqdn

Display firewall fqdn attribute of profiles


Display firewall fqdn attribute of profiles.
get firewall context-profiles

Display firewall exclude interfaces


Display firewall exclude interfaces.
get firewall exclude

Get the firewall exclusion list


Display the firewall exclusion list.
get firewall exclude-list

Display firewall exclusion


Display firewall exclusions.
get firewall exclusion

Display firewall interface statistics


Display firewall interface statistics for the specified logical router interface in the VRF context.
get firewall interface stats

Display firewall interfaces


Display the logical router or switch interfaces which have firewall rules.
get firewall interfaces

Display firewall sync interfaces


Display sync configuration for logical router interfaces with firewall rules.
get firewall interfaces sync

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

Display specific firewall L7 profile info based on UUID


Display specific firewall L7 profile information based on UUID.
get firewall l7-profile <uuid-string-arg>

Display specific firewall L7 profile entry stats based on UUID


Display specific firewall L7 profile entry stats information based on UUID.
get firewall l7-profile <uuid-string-arg> stats

Display all firewall L7 profiles info


Display all firewall L7 profiles information.
get firewall l7-profiles

Display all firewall L7 profile entry stats


Display all firewall L7 profile entry stats information.
get firewall l7-profiles 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 summary of firewall rules


Display the summary of firewall rules.
get firewall rules

Display the firewall status


Display the firewall status.
get firewall status

Get the firewall summary


Display the firewall summary.
get firewall summary

Display firewall active/standby configuration


Display the active/standby configuration for the firewall on the specified logical router interface.
get firewall sync config

Display firewall synchronization statistics


Display the firewall synchronization statistics in the VRF context.
get firewall sync stats

Display firewall threshold alarms


Display firewall threshold alarms.
get firewall threshold-alarms

Display firewall thresholds


Display firewall thresholds.
get firewall thresholds

Display firewall VIFs


Display firewall VIFs
get firewall vifs

Display firewall vsipioctl fqdn entries with no debug


Display firewall vsipioctl fqdn entries with no debug.
get firewall vsipioctl <vsip_commands> [<vsip_param>]

Display the MAC table or IP FIB


Display forwarding information for the current interface. If the interface is a switch port, the MAC address table is displayed. If the interface is a router interface, the IP forwarding table is displayed.
get forwarding

Display the forwarding table


Display the forwarding table for the logical router in the VRF context. Optionally specify a prefix to display only the entry that matches that network.
get forwarding [<prefix>]

Display a gateway


Display information about the specified gateway.
get gateway <dpd-uuid-lrouter-arg>

Display gateway BFD config


Display parameters defined in global gateway BFD
get gateway <dpd-uuid-lrouter-arg> bfd-config

Display IgmpSnooping Table of the Gateway


Display information about IGMP reports snooped in the Gateway
get gateway <dpd-uuid-lrouter-arg> igmp-snooping-table

Display IgmpSnooping Table of the Gateway


Display information about IGMP reports snooped in the Gateway filtered by multicast group
get gateway <dpd-uuid-lrouter-arg> igmp-snooping-table <ip-address>

Display a gateway's interfaces


Display interface information for the specified gateway.
get gateway <dpd-uuid-lrouter-arg> interfaces

Display the interface stats for a gateway


Display the interface statistics for the specified gateway.
get gateway <dpd-uuid-lrouter-arg> interfaces stats

Display the gateway multicast forwarding table


Display the multicast forwarding table for the specified gateway. The forwarding plane merges the mroutes from the control plane and from IGMP snooping to build out mfib. A (s,g) mroute displayed from the control plane may not be shown identically from the forwarding plane. When there are multiple matches from mfib lookup, the packet will be replicated to all valid outgoing interfaces for each matched entry.
get gateway <dpd-uuid-lrouter-arg> mfib

Display multicast forwarding entries matching a multicast group


Display multicast forwarding entries matching a multicast group for the specified gateway. The forwarding plane merges the mroutes from the control plane and from IGMP snooping to build out mfib. A (s,g) mroute displayed from the control plane may not be shown identically from the forwarding plane. When there are multiple matches from mfib lookup, the packet will be replicated to all valid outgoing interfaces for each matched entry.
get gateway <dpd-uuid-lrouter-arg> mfib <ip-address>

Display the gateway's neighbor table


Display the neighbor table for the specified gateway.
get gateway <dpd-uuid-lrouter-arg> neighbors

Display neighbors and stats for a gateway


Display the neighbor table and statistics for the specified gateway.
get gateway <dpd-uuid-lrouter-arg> neighbors stats

Display QoS config for a gateway


Display QoS config for the specified gateway.
get gateway <dpd-uuid-lrouter-arg> qos-config

Display stats for a gateway


Display statistics for the specified gateway.
get gateway <dpd-uuid-lrouter-arg> stats

Display a gateway's tenant context


Display tenant context information for the specified gateway.
get gateway <dpd-uuid-lrouter-arg> tenant-context

Display information about the specified Gateway


Display information about the specified Gateway.
get gateway <gateway-id>

Display the routing table for the specified Gateway


Display the routing table for the specified Gateway.
get gateway <gateway-id> <route-arg>

Display a specific IPv4 route on the specified Gateway


Display a specific IPv4 route on the specified Gateway.
get gateway <gateway-id> <route-arg> <network-address>

Display information about a specific interface on the specified Gateway


Display information about a specific interface on the specified Gateway
get gateway <gateway-id> interface <gateway-interface-id>

Display all interfaces on the specified gateway


Display all interfaces on the specified gateway.
get gateway <gateway-id> interfaces

Get all routing Config entities on the specified Service Gateway


Get all routing Config entities on the specified Service Gateway.
get gateway <gateway-id> routing-config

Display gateway high availability state history


Display the high availability state history for the specified logical router. Only service routers have a high availability status. Use the get gateway command to get a list of logical routers and their router types.
get gateway <nsxa-uuid-service-router-arg> high-availability history state

Display gateway high availability state history


Display the high availability state history for the specified logical router. Only service routers have a high availability status. Use the get gateway command to get a list of logical routers and their router types.
get gateway <nsxa-uuid-service-router-arg> high-availability history state details

Display the gateway high availability status


Display the high availability status for the specified gateway. Only service routers have a high availability status. Use the get gateway command to get a list of gateways and their router types.
get gateway <nsxa-uuid-service-router-arg> high-availability status

Display service groups of the gateway


Display the service groups state for the gateway
get gateway <nsxa-uuid-service-router-arg> service-groups

Display service groups of the gateway


Display the service groups state for the gateway
get gateway <nsxa-uuid-service-router-arg> service-groups details

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 by prefix.
get gateway <uuid-arg> forwarding <network46-address>

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 a gateway interface


Display interface information for the specified gateway and port.
get gateway <uuid-arg> interface <uuid-arg>

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 a gateway interface statistics


Display interface statistics for the specified gateway and port.
get gateway <uuid-arg> interface <uuid-arg> stats

Display interface instance stats for a gateway


Display interface instance stats for a gateway.
get gateway <uuid-arg> interface <uuid-arg> stats

Display a gateway interface statistics


Display interface statistics for the specified gateway and port.
get gateway <uuid-arg> interface <uuid-arg> stats <ip-version>

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 gateway BFD sessions


Display BFD sessions in a gateway
get gateway <uuid> bfd-sessions [stats]

Display the gateway forwarding table


Display the forwarding table for the specified gateway. Optionally specify a prefix to display only the entry that matches that network.
get gateway <uuid> forwarding [<prefix>]

Display gateway BFD config


Display parameters defined in global gateway BFD
get gateway bfd-config

Display gateway BFD sessions


Display BFD sessions in a gateway
get gateway bfd-sessions [stats]

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

Display the forwarding table


Display the forwarding table for the gateway in the VRF context. Optionally specify a prefix to display only the entry that matches that network.
get gateway forwarding [<prefix>]

Display the gateway high availability state history


Display the high availability state history for the gateway in the VRF context.
get gateway high-availability history state

Display the gateway high availability status


Display the high availability status for the gateway in the VRF context.
get gateway high-availability status

Display interface info for a gateway


Display interface information for the specified gateway.
get gateway interface <dpd-uuid-lrouter-port-arg>

Display ARP proxy table for a gateway port


Display ARP proxy for a gateway port.
get gateway interface <dpd-uuid-lrouter-port-arg> arp-proxy

Display interface-group info for gateway interface


Display interface-group info for gateway interface
get gateway interface <dpd-uuid-lrouter-port-arg> interface-groups high-availability

Display the neighbor table of the gateway interface


Display the neighbor table for the specified gateway interface.
get gateway interface <dpd-uuid-lrouter-port-arg> neighbors

Display shadow port mac list for gateway port


Display shadow port mac list for gateway port
get gateway interface <dpd-uuid-lrouter-port-arg> shadow-macs

Get the shadow port MAC address selected for specific IP address


Get the shadow port MAC address selected for specific IP address
get gateway interface <dpd-uuid-lrouter-port-arg> shadow-macs ip <ip46-address> (Deprecated)

Get the shadow port MAC address selected for specific source and destination IP addresses


Get the shadow port MAC address selected for specific source and destination IP addresses
get gateway interface <dpd-uuid-lrouter-port-arg> shadow-macs source-ip <ip46-address> dest-ip <ip46-address>

Display the gateway interface stats


Display statistics for the specified gateway interface.
get gateway interface <dpd-uuid-lrouter-port-arg> stats

Display a gateway's interfaces


Display interface information for the gateway in the VRF context.
get gateway interfaces

Display the gateway ports


Display information for all gateway interfaces.
get gateway interfaces

Display the gateway interface stats


Display statistics for all gateway interfaces.
get gateway interfaces stats

Display the interface statistics of the gateway


Display the interface statistics for the gateway in the VRF context.
get gateway interfaces stats

Display multicast forwarding table The forwarding plane merges the mroutes from the control plane and from IGMP snooping to build out mfib. A (s,g) mroute displayed from the control plane may not be shown identically from the forwarding plane. When there are multiple matches from mfib lookup, the packet will be replicated to all valid outgoing interfaces for each matched entry.


Display the multicast forwarding table for the gateway in the VRF context.
get gateway mfib

Display multicast forwarding entries matching a multicast group in VRF


Display multicast forwarding entries matching a multicast group for the specified gateway in the VRF context. The forwarding plane merges the mroutes from the control plane and from IGMP snooping to build out mfib. A (s,g) mroute displayed from the control plane may not be shown identically from the forwarding plane. When there are multiple matches from mfib lookup, the packet will be replicated to all valid outgoing interfaces for each matched entry.
get gateway mfib <ip-address>

Display the neighbors table


Display the neighbors table for all gateway interfaces.
get gateway neighbors

Display the gateway's neighbor table


Display the neighbor table for the gateway in the VRF context.
get gateway neighbors

Display specific IPv4 routes from all the Gateway


Display specific IPv4 routes from all the Gateway.
get gateway routes <network-address>

Display the gateway statistics


Display statistics for the gateway in the VRF context.
get gateway stats

Display a gateway's tenant context


Display tenant context information for the gateway in the VRF context.
get gateway tenant-context

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 information about gateways asscociated with the VIF on this public cloud host


Display information about gateways asscociated with the VIF on this public cloud host.
get gateways

Display gateway summary


Display information about gateways on this hypervisor host.
get gateways

Display gateways


Display information about all gateways.
get gateways

Display gateways and stats


Display statistics for all gateways.
get gateways stats

Get geneve critical bit


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

Display TN TEP Groups for a Host switch


Display the TN TEP Groups configured for a specified host switch
get global-tep-group <hs-name-arg>

Display Global VTEP table


Display the Global VTEP table
get global-vtep-table <hs-name-arg>

Display info about GRE keepalive


Display information about GRE keepalive. For GRE tunnel information use tunnel-ports CLI.
get gre-keepalive

Display info for a GRE keepalive


Display information about the specified GRE keepalive.
get gre-keepalive local-ip <ip46-address> remote-ip <ip46-address>

Display stats for a GRE keepalive


Display statistics for the specified GRE keepalive.
get gre-keepalive local-ip <ip46-address> remote-ip <ip46-address> stats

Display stats for GRE keepalive


Display statistics for GRE keepalive only. For GRE tunnel stats use tunnel-ports CLI.
get gre-keepalive stats

Show the group translation


Display the translations for the specified container group. Optionally specify a translation type to display translations of that type.
get group <uuid> [<translation-type>]

Show all existing groups


Display all groups.
get groups

Lookup groups for the IP address


Display groups with the specified IP address.
get groups with ip <ip46-address>

Lookup groups for the hardware address


Display groups with the specified MAC address.
get groups with mac <hardware-address>

Lookup group for the network interface


Display groups with the specified network interface.
get groups with vif <vif-id-arg>

Display GRUB menu timeout


Display GRUB menu timeout.
get grub menu timeout

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

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 the logical router high availability status


Display the high availability status for the logical router in the VRF context.
get high-availability status

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

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

Display system hostname


Display the system hostname.
get hostname

Get hugepage info of the system


Display hugepage information, including total system memory, hugepage sizes supported and hugepage pools.
get hugepage

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 IDS Engine Fast Log setting


Display IDS Engine Fast Log setting.
get ids engine fastlog

Displays all IDS global stats


Displays all IDS global stats.
get ids engine global stats

Display IDS logging level


Displays the IDS logging level.
get ids engine logging-level

Display NSX IDS Engine Log Level


Display NSX IDS Engine Log Level.
get ids engine logging-level

Display IDS profiles


Displays the IDS profiles.
get ids engine profiles

Display NSX IDS Engine Profiles


Display NSX IDS Engine Profiles.
get ids engine profiles

Lists IDS profiles for a specified signature


Displays the IDS profiles for the specified signature.
get ids engine profiles signature <ids-sig-id-arg>

Display NSX IDS Engine Profile statistics


Display NSX IDS Engine Profile statistics.
get ids engine profilestats <profile-id>

Display NSX IDS Enginet Profile status


Display NSX IDS Engine Profile status
get ids engine profilestatus <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 Signature Action for a particular RuleID, ProfileID, SignID
get ids engine signaction <rule-id> <profile-id> <sign-id>

Checks for membership and action for a signature-profile pair


Checks for membership and action for a signature-profile pair.
get ids engine signature <ids-sig-id-arg> profile <context-profile-id-arg> membership

Display NSX IDS Engine global statistics


Display NSX IDS Engine global statistics.
get ids engine stats

Display IDS Enable/Disable


Displays the IDS Enable/Disable Status.
get ids engine status

Display NSX IDS Engine Status


Display NSX IDS Engine Status.
get ids engine status

Get IDS Event Engine queue stats


Get IDS Event Engine queue stats.
get ids events queue stats

Get IDS Event Engine stats


Get IDS Event Engine stats.
get ids events stats

Display NSX IDPS filter specific statistics


Display NSX IDPS filter specific statistics.
get ids filter stats <filtername-arg>

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


Display information about all IGMP reports snooped by the Edge
get igmp-snooping-table

Display IgmpSnooping Table


Display information about all IGMP reports snooped in the LR
get igmp-snooping-table

Display IgmpSnooping Table


Display information about all IGMP reports snooped in the LR
get igmp-snooping-table <multicast-ip-address>

Display IgmpSnooping Stats


Display statistics about IGMP reports snooped by the Edge
get igmp-snooping-table stats

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 NSX Intelligence broker statistics


Display NSX Intelligence broker statistics.
get intelligence broker stats

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 metrics


Display NSX Intelligence flows metrics.
get intelligence flows metrics

Display NSX Intelligence flows metrics for ports


Display NSX Intelligence flows metrics for ports.
get intelligence flows metrics ports

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 network interface properties


Display information about the specified network interface.
get interface <edge-view-interface-name>

Display network interface properties


Display information about the specified network interface.
get interface <interface-name-arg>

Display the logical router interface-groups high availability status


Display the high availability status of interface-groups for the logical router in the VRF context.
get interface-groups high-availability

Display a logical router's interfaces


Display interface information for the logical router in the VRF context.
get interfaces

Display all network interface properties


Display information about all network interfaces.
get interfaces

Display the interface statistics of the logical router


Display the interface statistics for the logical router in the VRF context.
get interfaces stats

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 full information from CA Certificate


Display full information from a specific CA Certificate
get ipsecvpn ca-certificate <uuid-string-arg>

Display Subject Name from CA Certificates


Display Subject Name from all CA Certificates.
get ipsecvpn ca-certificates

Display full information from CA Certificates


Display full information from all CA Certificates.
get ipsecvpn ca-certificates verbose

Display complete information from Certificates


Display complete information from a specific Certifiate.
get ipsecvpn certificate <uuid-string-arg>

Display Subject Name from Certificates


Display Subject Names from all Certificates.
get ipsecvpn certificates

Display complete information from Certificates


Display complete information from all Certificates.
get ipsecvpn certificates verbose

Display all configured Dead Peer Detection profiles


Display all configured Dead Peer Detection profiles.
get ipsecvpn config dpd-profile

Display configured Dead Peer Detection profile


Display configured Dead Peer Detection profile.
get ipsecvpn config dpd-profile <uuid-string-arg>

Display all configured IKE profiles


Display all configured IKE profiles.
get ipsecvpn config ike-profile

Display configured IKE profile


Display configured IKE profile.
get ipsecvpn config ike-profile <uuid-string-arg>

Display all configured IPSec local endpoint profiles


Display all configured IPSec local endpoint profiles.
get ipsecvpn config local-endpoint

Display configured IPSec local endpoint profile


Display configured IPSec local endpoint profile.
get ipsecvpn config local-endpoint <uuid-string-arg>

Display CA-Certificates configured for IPsec Local Endpoint


Display all CA-Certificates for a specific IPsec Local Endpoint.
get ipsecvpn config local-endpoint <uuid-string-arg> ca-certificates

Display Certificate configured for IPsec Local Endpoint


Display Certificate for a specific IPsec Local Endpoint.
get ipsecvpn config local-endpoint <uuid-string-arg> certificate

Display CRL configured for IPsec Local Endpoint


Display all CRLs for a specific IPsec Local Endpoint.
get ipsecvpn config local-endpoint <uuid-string-arg> crls

Display all configured MultiPath Groups


Display all configured MultiPath Groups.
get ipsecvpn config multi-path-group

Display configured MultiPath Group


Display configured MultiPath Group.
get ipsecvpn config multi-path-group <uuid-string-arg>

Display all configured IPSec peer endpoint profiles


Display all configured IPSec peer endpoint profiles.
get ipsecvpn config peer-endpoint

Display configured IPSec peer endpoint profile


Display configured IPSec peer endpoint profile.
get ipsecvpn config peer-endpoint <uuid-string-arg>

Display IPSec Service configuration from NestDB


Display IPSec Servicce configuration from NestDB.
get ipsecvpn config service

Display all configured IPSec VPN sessions


Display all configured IPSec VPN sessions.
get ipsecvpn config session

Display a configured IPSec VPN session


Display a configured IPSec VPN session.
get ipsecvpn config session <uuid-string-arg>

Display a configured IPSec VPN session with specific endpoints


Display a configured IPSec VPN session with specific endpoints.
get ipsecvpn config session local-ip <ip46-address> remote-ip <ip46-address>

Display all configured IPSec tunnel profiles


Display all configured IPsec tunnel profiles.
get ipsecvpn config tunnel-profile

Display configured IPSec tunnel profile


Display configured IPSec tunnel profile.
get ipsecvpn config tunnel-profile <uuid-string-arg>

Display complete information from CRL certificate


Display complete information from a specific CRL certificate.
get ipsecvpn crl <uuid-string-arg>

Display Issuer Name from CRL Certificates


Display Issuer Name from all CRL certificates.
get ipsecvpn crls

Display complete information from CRL certificates


Display complete information from all CRL certificates.
get ipsecvpn crls verbose

Display all IKE SAs


Display all IKE SAs.
get ipsecvpn ikesa

Display all IKE security associations in active state


Display all IKE security associations in active state.
get ipsecvpn ikesa active

Display all IKE security associations in active state


Display all IKE security associations in active state.
get ipsecvpn ikesa active logical-router <uuid-string-arg>

Display IKE security association in active state on given Logical Router


Display IKE security association in active state on given Logical Router.
get ipsecvpn ikesa active logical-router <uuid-string-arg> sessionid <ipsec-vpn-session-id-arg>

Display IKE security association in active state


Display IKE security association in active state.
get ipsecvpn ikesa active sessionid <ipsec-vpn-session-id-arg>

Display all IKE SAs on given Logical Router


Display all IKE SAs on given Logical Router.
get ipsecvpn ikesa logical-router <uuid-string-arg>

Display an IKE SA on given Logical Router


Display an IKE SA on given Logical Router.
get ipsecvpn ikesa logical-router <uuid-string-arg> sessionid <ipsec-vpn-session-id-arg>

Display all IKE security associations in negotiating state


Display all IKE security associations in negotiating state.
get ipsecvpn ikesa negotiating

Display all IKE security associations in negotiating state


Display all IKE security associations in negotiating state.
get ipsecvpn ikesa negotiating logical-router <uuid-string-arg>

Display IKE security association in negotiating state


Display IKE security association in negotiating state.
get ipsecvpn ikesa negotiating logical-router <uuid-string-arg> sessionid <ipsec-vpn-session-id-arg>

Display IKE security association in negotiating state


Display IKE security association in negotiating state.
get ipsecvpn ikesa negotiating sessionid <ipsec-vpn-session-id-arg>

Display IKE SA with specific session id


Display an IKE SA.
get ipsecvpn ikesa sessionid <ipsec-vpn-session-id-arg>

Display all IPSec SAs from control plane


Display all IPSec SAs from control plane.
get ipsecvpn ipsecsa

Display all IPSec SAs from control plane on a LogicalRouter


Display all IPSec SAs from control plane.
get ipsecvpn ipsecsa logical-router <uuid-string-arg>

Display IPSec SA with specific rule id from control plane


Display IPSec SA with specific rule id from control plane.
get ipsecvpn ipsecsa logical-router <uuid-string-arg> ruleid <ipsec-vpn-rule-id-arg>

Display an IPSec SA with specific session id from control plane


Display an IPSec SA with specific session id from control plane.
get ipsecvpn ipsecsa logical-router <uuid-string-arg> sessionid <ipsec-vpn-session-id-arg>

Display IPSec SA with specific rule id from control plane


Display IPSec SA with specific rule id from control plane.
get ipsecvpn ipsecsa ruleid <ipsec-vpn-rule-id-arg>

Display an IPSec SA with specific session id from control plane


Display an IPSec SA with specific session id from control plane.
get ipsecvpn ipsecsa sessionid <ipsec-vpn-session-id-arg>

Display all active MultiPath Groups information


Display all active MultiPath Groups information.
get ipsecvpn multi-path-group

Display active MultiPath Group information


Display active MultiPath Group information.
get ipsecvpn multi-path-group <uuid-string-arg>

Display active MultiPath tunnels probe history information


Display active MultiPath tunnels probe history information.
get ipsecvpn multi-path-group <uuid-string-arg> probe history

Display active MultiPath group probe statistics


Display active MultiPath group probe statistics.
get ipsecvpn multi-path-group <uuid-string-arg> probe stats

Display active MultiPath Group verbose information


Display active MultiPath Group verbose information.
get ipsecvpn multi-path-group <uuid-string-arg> verbose

Display all active MultiPath tunnels probe history information


Display all active MultiPath tunnels probe history information.
get ipsecvpn multi-path-group probe history

Display all active MultiPath group probe statistics


Display all active MultiPath group probe statistics.
get ipsecvpn multi-path-group probe stats

Display all active MultiPath Groups verbose information


Display all active MultiPath Groups verbose information.
get ipsecvpn multi-path-group verbose

Display all IPSec VPN policy rules


Display all IPSec VPN policy rules.
get ipsecvpn policy

Display all IPSec VPN policy rules for a LogicalRouter


Display all IPSec VPN policy rules for a LogicalRouter.
get ipsecvpn policy logical-router <uuid-string-arg>

Display an IPSec policy rule for a LogicalRouter


Display an IPSec policy rule for a LogicalRouter.
get ipsecvpn policy logical-router <uuid-string-arg> rules <uuid-string-arg>

Display an IPSec policy rule


Display an IPSec policy rule.
get ipsecvpn policy rules <uuid-string-arg>

Display summary of IPSec VPN policy rules


Display summary of IPSec VPN policy rules.
get ipsecvpn policy summary

Display summary of IPSec VPN policy rules per logical router


Display summary of IPSec VPN policy rules per logical router
get ipsecvpn policy summary logical-router <uuid-string-arg>

Display all IPSec SAs present in Security Association Database(datapath)


Display all IPSec SAs present in Security Association Database(datapath).
get ipsecvpn sad

Display IPSec SA present in Security Association Database(datapath)


Display IPSec SA present in Security Association Database(datapath).
get ipsecvpn sad <uuid-string-arg>

Display IPSec SA present in Security Association Database(datapath)


Display IPSec SA present in Security Association Database(datapath).
get ipsecvpn sad logical-router <uuid-string-arg>

Display IPSec SA present in Security Association Database(datapath)


Display IPSec SA present in Security Association Database(datapath).
get ipsecvpn sad session <uuid-string-arg>

Display summary of all IPSec SAs present in Security Association Database(datapath)


Display summary of all IPSec SAs present in Security Association Database(datapath).
get ipsecvpn sad summary

Display all IPSec Services


Display all IPSec Services Information.
get ipsecvpn service

Display IPSec Service


Display IPSec Service Information.
get ipsecvpn service <uuid-string-arg>

Display detail information of a IPSec Service


Display all IPSec Service Information in detail.
get ipsecvpn service <uuid-string-arg> verbose

Display detail information of all IPSec Services


Display IPSec Service Information in detail.
get ipsecvpn service verbose

Display all IPSec VPN sessions


Display all IPSec VPN sessions.
get ipsecvpn session

Display specific IPSec VPN session


Display specific IPSec VPN session.
get ipsecvpn session <uuid-string-arg>

Display specific IPSec VPN session history


Display IPsec VPN session history using session uuid as the filter
get ipsecvpn session <uuid-string-arg> history

Display all IPSec VPN sessions in active state


Display all IPSec VPN sessions in active state.
get ipsecvpn session active

Display an IPSec VPN session in active state


Display an IPSec VPN session in active state.
get ipsecvpn session active <uuid-string-arg>

Display IPSec VPN session in active state for specific endpoints


Display IPSec VPN session in active state for specific endpoints.
get ipsecvpn session active local-ip <ip46-address> remote-ip <ip46-address>

Display an IPSec VPN session in active state


Display an IPSec VPN session in active state.
get ipsecvpn session active sessionid <ipsec-vpn-session-id-arg>

Display all IPsec VPN sessions in down state


Display all IPsec VPN sessions in down state.
get ipsecvpn session down

Display an IPsec VPN session in down state


Display an IPsec VPN session in down state.
get ipsecvpn session down <uuid-string-arg>

Display IPsec VPN session in down state for specific endpoints


Display IPsec VPN session in down state for specific endpoints.
get ipsecvpn session down local-ip <ip46-address> remote-ip <ip46-address>

Display an IPsec VPN session in down state


Display an IPsec VPN session in down state.
get ipsecvpn session down sessionid <ipsec-vpn-session-id-arg>

Display all IPsec VPN sessions history


Display all IPsec VPN sessions history.
get ipsecvpn session history

Display IPSec VPN session for specific endpoints


Display IPSec VPN session for specific endpoints.
get ipsecvpn session local-ip <ip46-address> remote-ip <ip46-address>

Display IPSec VPN session history for specific endpoints


Display IPSec VPN session history for specific endpoints.
get ipsecvpn session local-ip <ip46-address> remote-ip <ip46-address> history

Display all IPSec VPN sessions of Logical Router


Display all IPSec VPN sessions of Logical Router.
get ipsecvpn session logical-router <uuid-string-arg>

Display specific IPSec VPN session of Logical Router


Display specific IPSec VPN session of Logical Router.
get ipsecvpn session logical-router <uuid-string-arg> <uuid-string-arg>

Display an IPsec VPN session in negotiating state of Logical Router


Display an IPsec VPN session in negotiating state of Logical Router.
get ipsecvpn session logical-router <uuid-string-arg> <uuid-string-arg> negotiating

Display all IPSec VPN sessions in active state of Logical Router


Display all IPSec VPN sessions in active state of Logical Router.
get ipsecvpn session logical-router <uuid-string-arg> active

Display an IPSec VPN session in active state of Logical Router


Display an IPSec VPN session in active state of Logical Router.
get ipsecvpn session logical-router <uuid-string-arg> active <uuid-string-arg>

Display IPSec VPN session in active state for specific endpoints of Logical Router


Display IPSec VPN session in active state for specific endpoints of Logical Router.
get ipsecvpn session logical-router <uuid-string-arg> active local-ip <ip46-address> remote-ip <ip46-address>

Display an IPSec VPN session in active state of Logical Router


Display an IPSec VPN session in active state of Logical Router.
get ipsecvpn session logical-router <uuid-string-arg> active sessionid <ipsec-vpn-session-id-arg>

Display all IPsec VPN sessions in down state of Logical Router


Display all IPsec VPN sessions in down state of Logical Router.
get ipsecvpn session logical-router <uuid-string-arg> down

Display an IPsec VPN session in down state of Logical Router


Display an IPsec VPN session in down state of Logical Router.
get ipsecvpn session logical-router <uuid-string-arg> down <uuid-string-arg>

Display IPsec VPN session in down state for specific endpoints of Logical Router


Display IPsec VPN session in down state for specific endpoints of Logical Router.
get ipsecvpn session logical-router <uuid-string-arg> down local-ip <ip46-address> remote-ip <ip46-address>

Display an IPsec VPN session in down state of Logical Router


Display an IPsec VPN session in down state of Logical Router.
get ipsecvpn session logical-router <uuid-string-arg> down sessionid <ipsec-vpn-session-id-arg>

Display IPSec VPN session history for a Logical Router


Display IPSec VPN session history for a Logical Router.
get ipsecvpn session logical-router <uuid-string-arg> history

Display IPSec VPN session for specific endpoints on Logical Router


Display IPSec VPN session for specific endpoints on Logical Router.
get ipsecvpn session logical-router <uuid-string-arg> local-ip <ip46-address> remote-ip <ip46-address>

Display IPSec VPN session history for specific endpoints on Logical Router


Display IPSec VPN session history for specific endpoints on Logical Router.
get ipsecvpn session logical-router <uuid-string-arg> local-ip <ip46-address> remote-ip <ip46-address> history

Display all IPsec VPN sessions in negotiating state of Logical Router


Display all IPsec VPN sessions in negotiating state of Logical Router.
get ipsecvpn session logical-router <uuid-string-arg> negotiating

Display IPsec VPN session in negotiating state for specific endpoints


Display IPsec VPN session in negotiating state for specific endpoints.
get ipsecvpn session logical-router <uuid-string-arg> negotiating local-ip <ip46-address> remote-ip <ip46-address>

Display all IPSec VPN sessions of Logical Router


Display all IPSec VPN sessions of Logical Router.
get ipsecvpn session logical-router <uuid-string-arg> sessionid <ipsec-vpn-session-id-arg>

Display IPSec VPN session history of a specific session for a Logical Router


Display IPSec VPN session history of a specific session for a Logical Router
get ipsecvpn session logical-router <uuid-string-arg> sessionid <ipsec-vpn-session-id-arg> history

Display IPSec VPN session status for a LogicalRouter


Display IPSec VPN session status for a Logical Router.
get ipsecvpn session logical-router <uuid-string-arg> status

Display summary of all IPSec VPN sessions for a Logical Router


Display summary of all IPSec VPN sessions for a Logical Router.
get ipsecvpn session logical-router <uuid-string-arg> summary

Display all IPsec VPN sessions in negotiating state


Display all IPsec VPN sessions in negotiating state.
get ipsecvpn session negotiating

Display an IPsec VPN session in negotiating state


Display an IPsec VPN session in negotiating state.
get ipsecvpn session negotiating <uuid-string-arg>

Display IPsec VPN session in negotiating state for specific endpoints of Logical Router


Display IPsec VPN session in negotiating state for specific endpoints of Logical Router.
get ipsecvpn session negotiating local-ip <ip46-address> remote-ip <ip46-address>

Display an IPsec VPN session in negotiating state of Logical Router


Display an IPsec VPN session in negotiating state of Logical Router.
get ipsecvpn session negotiating logical-router <uuid-string-arg> sessionid <ipsec-vpn-session-id-arg>

Display an IPsec VPN session in negotiating state


Display an IPsec VPN session in negotiating state.
get ipsecvpn session negotiating sessionid <ipsec-vpn-session-id-arg>

Display all IPSec VPN sessions


Display all IPSec VPN sessions.
get ipsecvpn session sessionid <ipsec-vpn-session-id-arg>

Display IPsec VPN sessions history for specific session


Display IPsec VPN session history with sessionid as the filter
get ipsecvpn session sessionid <ipsec-vpn-session-id-arg> history

Display IPSec VPN session status


Display IPSec VPN session status.
get ipsecvpn session status

Display summary of all IPSec VPN sessions


Display summary of all IPSec VPN sessions.
get ipsecvpn session summary

Display summary of all IPSec IPv4 VPN sessions


Display summary of all IPSec IPv4 VPN sessions.
get ipsecvpn session summary ipv4

Display summary of all IPSec IPv6 VPN sessions


Display summary of all IPSec IPv6 VPN sessions.
get ipsecvpn session summary ipv6

Display all IPSec VPN synced sessions


Display all IPSec VPN synced sessions.
get ipsecvpn sync-session

Display specific IPSec VPN synced session


Display specific IPSec VPN synced session.
get ipsecvpn sync-session session-uuid <uuid-string-arg>

Display IPSec tunnel statistics and multipath statistics


Display IPSec SA tunnel statistics and multipath statistics.
get ipsecvpn tunnel multipath stats

Display IPSec tunnel statistics and multipath statistics.


Display IPSec tunnel statistics and multipath statistics.
get ipsecvpn tunnel multipath stats <uuid-string-arg>

Display all IPSec SA tunnel statistics


Display all IPSec SA tunnel statistics.
get ipsecvpn tunnel stats

Display IPSec SA tunnel statistics


Display IPSec SA tunnel statistics.
get ipsecvpn tunnel stats <ipsec-vpn-keypolicy-id-arg>

Display all IPSec VPN VTI Rules


Displays all IPSec VPN VTI Rules.
get ipsecvpn vti rules

Display an IPSec VPN VTI rule


Display an IPSec VPN VTI rule.
get ipsecvpn vti rules <uuid-string-arg>

Show L2VPN sessions configuration for a given L2VPN service


Display L2VPN sessions configuration for a given L2VPN service.
get l2vpn service <uuid-string-arg> sessions config

Show all L2VPN services configuration


Display all L2VPN services configuration.
get l2vpn services config

Display stretched logical switch behind L2VPN session


Display stretched logical switch behind L2VPN session.
get l2vpn session <dpd-uuid-l2vpn-session-arg> logical-switch <dpd-uuid-lswitch-arg>

Display remote macs learnt on L2VPN stretched logical-switch


Display remote macs learnt on L2VPN stretched logical-switch.
get l2vpn session <dpd-uuid-l2vpn-session-arg> logical-switch <dpd-uuid-lswitch-arg> remote-macs

Display stats for stretched logical-switch behind L2VPN session


Display stats for stretched logical-switch behind L2VPN session.
get l2vpn session <dpd-uuid-l2vpn-session-arg> logical-switch <dpd-uuid-lswitch-arg> stats

Display stretched logical switches behind given L2VPN session


Display stretched logical switches behind given L2VPN session.
get l2vpn session <dpd-uuid-l2vpn-session-arg> logical-switches

Display stats for specific L2VPN session


Display stats for L2VPN session
get l2vpn session <dpd-uuid-l2vpn-session-arg> stats

Display status of specific L2VPN session


Display status of specific L2VPN session.
get l2vpn session <dpd-uuid-l2vpn-session-arg> status

Display all L2VPN sessions


Display all L2VPN sessions information.
get l2vpn sessions

Show all L2VPN sessions configuration


Display all L2VPN sessions configuration.
get l2vpn sessions config

Display all L2VPN sessions on a logical-router


Display all L2VPN sessions information on a logical-router.
get l2vpn sessions logical-router <uuid-string-arg>

Display L2VPN sessions stats


Display L2VPN sessions stats
get l2vpn sessions stats

Get the last barrier processed by NestDb Pigeon for the specified transport node


Get the last barrier processed by NestDb Pigeon for the specified transport node.
get last processed barrier <<uuid-arg>

Display specified counter's detailed description.


Display specified counter's detailed description.
get livetrace 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 livetrace datapath-stats module <mod_name_arg_esx> counters list

Display specified kernel module's detailed description.


Display specified kernel module's detailed description.
get livetrace 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 livetrace datapath-stats modules list

Display all the counters for the specified livetrace session.


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.


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.


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.


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.


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.


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.


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.


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


Display a specific load balancer.
get load-balancer <lb-uuid-arg>

Show load balancer diagnosis information


Show load balancer diagnosis information
get load-balancer <lb-uuid-arg> diagnosis

Show the error log for the specified load balancer


Display the error log file for a specific load balancer.
get load-balancer <lb-uuid-arg> error-log

Follow the error log for the specified load balancer


Display the last 10 lines of the error log file for a specific load balancer and all new messages that are written to the log file.
get load-balancer <lb-uuid-arg> error-log follow

Show the error log with regular expression filter for the specified load balancer


Display error log messages containing strings that match the given regular expression pattern for a specific load balancer.
get load-balancer <lb-uuid-arg> error-log reg-filter <regex>

Show health check table of a specific load balancer


Display the health check table of a specific load balancer.
get load-balancer <lb-uuid-arg> health-check-table

Show HA state of a specific load balancer


Display the HA state of a specific load balancer.
get load-balancer <lb-uuid-arg> high-availability-state

Show a load balancer monitor


Display a specific load balancer monitor.
get load-balancer <lb-uuid-arg> monitor <monitor-uuid-arg>

Show a load balancer monitor status.


Show the health check table of a load balancer monitor.
get load-balancer <lb-uuid-arg> monitor <monitor-uuid-arg> status

Show load balancer monitors


Display the monitors for a specific load balancer.
get load-balancer <lb-uuid-arg> monitors

Show persistence tables of a specific load balancer


Display the persistence tables of a specific load balancer.
get load-balancer <lb-uuid-arg> persistence-tables

Show a load balancer pool


Display a specific load balancer pool.
get load-balancer <lb-uuid-arg> pool <pool-uuid-arg>

Display information about an LB pool


Display information about an LB pool.
get load-balancer <lb-uuid-arg> pool <pool-uuid-arg> snat-pools

Show statistics of the specified load balancer and pool


Display the statistics for a specific load balancer and pool.
get load-balancer <lb-uuid-arg> pool <pool-uuid-arg> stats

Show status for the given pool


Display the status of a specific load balancer and pool.
get load-balancer <lb-uuid-arg> pool <pool-uuid-arg> status

Show load balancer pools


Display the pools of a specific load balancer.
get load-balancer <lb-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 <lb-uuid-arg> pools stats

Show status for all pools of the given load balancer


Display the status of all the pools of a specific load balancer.
get load-balancer <lb-uuid-arg> pools status

Show sessions of a specific load balancer


Display the sessions of a specific load balancer.
get load-balancer <lb-uuid-arg> session-tables

Get load balancer L4 session table


Get the load balancer L4 session table with the expiration time.
get load-balancer <lb-uuid-arg> session-tables l4

Get load balancer L7 session table


Get the load balancer L7 session table with the expiration time.
get load-balancer <lb-uuid-arg> session-tables l7

Get LB pool information, especially port usage


Get load-balancer snat pools' information.
get load-balancer <lb-uuid-arg> snat-pools

Show statistics for the specified load balancer


Display the statistics for a specific load balancer.
get load-balancer <lb-uuid-arg> stats

Show status for the specified load balancer


Display the status of a specific load balancer.
get load-balancer <lb-uuid-arg> status

Show a load balancer virtual server


Display a specific load balancer virtual server.
get load-balancer <lb-uuid-arg> virtual-server <vs-uuid-arg>

Show the access log for the specified load balancer and virtual server


Display the access log file for a specific load balancer and virtual server.
get load-balancer <lb-uuid-arg> virtual-server <vs-uuid-arg> access-log

Follow the access log for the specified virtual server of load balancer


Display the last 10 lines of the access log file for a specific virtual server of load balancer and all new messages that are written to the log file.
get load-balancer <lb-uuid-arg> virtual-server <vs-uuid-arg> access-log follow

Show the access log with regular expression filter for the specified load balancer


Display access log messages containing strings that match the given regular expression pattern for a specific load balancer.
get load-balancer <lb-uuid-arg> virtual-server <vs-uuid-arg> access-log reg-filter <regex>

Show load balancer rules


Display the load balancer rules for a specific load balancer and virtual server.
get load-balancer <lb-uuid-arg> virtual-server <vs-uuid-arg> lbrules

Show statistics of the specified load balancer and virtual server


Display the statistics for a specific load balancer and virtual server.
get load-balancer <lb-uuid-arg> virtual-server <vs-uuid-arg> stats

Show status for the given virtual server


Display the status of a specific load balancer virtual server.
get load-balancer <lb-uuid-arg> virtual-server <vs-uuid-arg> status

Show load balancer virtual servers


Display the virtual servers of a specific load balancer.
get load-balancer <lb-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 <lb-uuid-arg> virtual-servers stats

Show status for all virtual servers of the given load balancer


Display the status of all virtual servers of a specific load balancer.
get load-balancer <lb-uuid-arg> virtual-servers status

Show load balancer global verbose stats


Display global verbose stats for load balancer.
get load-balancer global stats

Get load balancer performance config


Get edge parameters configured by load balancer for performance.
get load-balancer perf-profile config

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

Show log file contents


Display the contents of the specified log file.
get log-file <log-file-arg>

Show log file contents


Display the last 10 lines of the specified log file and all new messages that are written to the log file.
get log-file <log-file-arg> follow

Display the list of logs files


Display the list of logs files
get log-file list

Display all configured logging servers


Display logging server configuration.
get logging-servers

Display a logical router


Display information about the specified logical router.
get logical-router <dpd-uuid-lrouter-arg> (Deprecated)

Display logical router BFD config


Display parameters defined in global logical router BFD
get logical-router <dpd-uuid-lrouter-arg> bfd-config (Deprecated)

Display all IPv4 & IPv6 BGP routes


Display all IPv4 & IPv6 BGP routes.
get logical-router <dpd-uuid-lrouter-arg> bgp

Display all BGP NLRI matching the community.


Display all BGP NLRI matching the community.
get logical-router <dpd-uuid-lrouter-arg> bgp community <bgp-community-arg>

Display BGP EVPN Ethernet Segment information


Display BGP EVPN Ethernet Segment information.
get logical-router <dpd-uuid-lrouter-arg> bgp evpn es

Display BGP EVPN Ethernet Segment(ES) per EVPN instance(EVI) information


Display BGP EVPN Ethernet Segment(ES) per EVPN instance(EVI) information.
get logical-router <dpd-uuid-lrouter-arg> bgp evpn es-evi

Display all BGP NLRI matching the large-community.


Display all BGP NLRI matching the large-community.
get logical-router <dpd-uuid-lrouter-arg> bgp large-community <bgp-large-community-arg>

Display all BGP neighbor information


Display all BGP neighbor information.
get logical-router <dpd-uuid-lrouter-arg> bgp neighbor

Display EVPN VNI ARP information


Display EVPN VNI ARP information.
get logical-router <dpd-uuid-lrouter-arg> evpn arp

Display EVPN Mode information


Display EVPN Mode information.
get logical-router <dpd-uuid-lrouter-arg> evpn deployment-mode

Display EVPN Ethernet Segment information


Display EVPN Ethernet Segment information.
get logical-router <dpd-uuid-lrouter-arg> evpn es

Display particular EVPN Ethernet Segment information


Display particular EVPN Ethernet Segment information.
get logical-router <dpd-uuid-lrouter-arg> evpn es <esi-arg>

Display EVPN VNI MAC information


Display EVPN VNI MAC information.
get logical-router <dpd-uuid-lrouter-arg> evpn mac

Display IgmpSnooping Table of the LR


Display information about IGMP reports snooped in the LR
get logical-router <dpd-uuid-lrouter-arg> igmp-snooping-table (Deprecated)

Display IgmpSnooping Table of the LR


Display information about IGMP reports snooped in the LR filtered by multicast group
get logical-router <dpd-uuid-lrouter-arg> igmp-snooping-table <multicast-ip-address> (Deprecated)

Display a logical router's interfaces


Display interface information for the specified logical router.
get logical-router <dpd-uuid-lrouter-arg> interfaces (Deprecated)

Display the interface stats for a logical router


Display the interface statistics for the specified logical router.
get logical-router <dpd-uuid-lrouter-arg> interfaces stats (Deprecated)

Display the logical router multicast forwarding table


Display the multicast forwarding table for the specified logical router. The forwarding plane merges the mroutes from the control plane and from IGMP snooping to build out mfib. A (s,g) mroute displayed from the control plane may not be shown identically from the forwarding plane. When there are multiple matches from mfib lookup, the packet will be replicated to all valid outgoing interfaces for each matched entry.
get logical-router <dpd-uuid-lrouter-arg> mfib (Deprecated)

Display multicast forwarding entries matching a multicast group


Display multicast forwarding entries matching a multicast group for the specified logical router. The forwarding plane merges the mroutes from the control plane and from IGMP snooping to build out mfib. A (s,g) mroute displayed from the control plane may not be shown identically from the forwarding plane. When there are multiple matches from mfib lookup, the packet will be replicated to all valid outgoing interfaces for each matched entry.
get logical-router <dpd-uuid-lrouter-arg> mfib <multicast-ip-address> (Deprecated)

Display multicast load-balancing selection for a logical router


Display the multicast load-balancing selection for the specified logical router.
get logical-router <dpd-uuid-lrouter-arg> multicast load-balancing <multicast-ip-address>

Display the logical router's neighbor table


Display the neighbor table for the specified logical router.
get logical-router <dpd-uuid-lrouter-arg> neighbor (Deprecated)

Display neighbors and stats for a logical router


Display the neighbor table and statistics for the specified logical router.
get logical-router <dpd-uuid-lrouter-arg> neighbor stats (Deprecated)

Display OSPF information


Display OSPF information.
get logical-router <dpd-uuid-lrouter-arg> ospf

Display OSPF database summary


Display OSPF database summary.
get logical-router <dpd-uuid-lrouter-arg> ospf database

Display ASBR-Summary LSAs


Display ASBR-Summary LSAs.
get logical-router <dpd-uuid-lrouter-arg> ospf database asbr-summary

Display ASBR-Summary LSAs


Display ASBR-Summary LSAs.
get logical-router <dpd-uuid-lrouter-arg> ospf database asbr-summary <ip-address>

Display external LSAs


Display external LSAs.
get logical-router <dpd-uuid-lrouter-arg> ospf database external

Display external LSAs


Display external LSAs.
get logical-router <dpd-uuid-lrouter-arg> ospf database external <ip-address>

Display Network LSAs


Display Network LSAs.
get logical-router <dpd-uuid-lrouter-arg> ospf database network

Display Network LSAs


Display Network LSAs.
get logical-router <dpd-uuid-lrouter-arg> ospf database network <ip-address>

Display NSSA external LSAs


Display NSSA external LSAs.
get logical-router <dpd-uuid-lrouter-arg> ospf database nssa-external

Display NSSA external LSAs


Display NSSA external LSAs.
get logical-router <dpd-uuid-lrouter-arg> ospf database nssa-external <ip-address>

Display router LSAs


Display router LSAs.
get logical-router <dpd-uuid-lrouter-arg> ospf database router

Display router LSAs


Display router LSAs.
get logical-router <dpd-uuid-lrouter-arg> ospf database router <ip-address>

Display summary LSAs


Display summary LSAs.
get logical-router <dpd-uuid-lrouter-arg> ospf database summary

Display summary LSAs


Display summary LSAs.
get logical-router <dpd-uuid-lrouter-arg> ospf database summary <ip-address>

Display OSPF Graceful Restart information


Display OSPF Graceful Restart information.
get logical-router <dpd-uuid-lrouter-arg> ospf graceful-restart

Display OSPF interface information


Display OSPF interface information.
get logical-router <dpd-uuid-lrouter-arg> ospf interface

Display OSPF neighbor list


Display OSPF neighbor list.
get logical-router <dpd-uuid-lrouter-arg> ospf neighbor

Display OSPF routes


Display OSPF routes.
get logical-router <dpd-uuid-lrouter-arg> ospf route

Show external summary addresses


Show external summary addresses.
get logical-router <dpd-uuid-lrouter-arg> ospf summary-address

Display QoS config for a logical router


Display QoS config for the specified logical router.
get logical-router <dpd-uuid-lrouter-arg> qos-config (Deprecated)

Display all OSPF routes in RIB


Display all OSPF routes in RIB.
get logical-router <dpd-uuid-lrouter-arg> route ospf

Display stats for a logical router


Display statistics for the specified logical router.
get logical-router <dpd-uuid-lrouter-arg> stats (Deprecated)

Display a logical router's tenant context


Display tenant context information for the specified logical router.
get logical-router <dpd-uuid-lrouter-arg> tenant-context

Display information about the specified logical router


Display information about the specified logical router.
get logical-router <logical-router-id> (Deprecated)

Display the routing table for the specified logical router


Display the routing table for the specified logical router.
get logical-router <logical-router-id> <route-arg> (Deprecated)

Display a specific IPv4 route on the specified logical router


Display a specific IPv4 route on the specified logical router.
get logical-router <logical-router-id> <route-arg> <network-address> (Deprecated)

Display information about a specific interface on the specified logical router


Display information about a specific interface on the specified logical router.
get logical-router <logical-router-id> interface <logical-router-interface-id> (Deprecated)

Display all interfaces on the specified logical router


Display all interfaces on the specified logical router.
get logical-router <logical-router-id> interfaces (Deprecated)

Get all routing Config entities on the specified Service Router


Get all routing Config entities on the specified Service Router.
get logical-router <logical-router-id> routing-config (Deprecated)

Display logical router high availability state history


Display 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.
get logical-router <nsxa-uuid-service-router-arg> high-availability history state (Deprecated)

Display logical router high availability state history


Display 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.
get logical-router <nsxa-uuid-service-router-arg> high-availability history state details (Deprecated)

Display the logical router high availability status


Display the high availability status 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.
get logical-router <nsxa-uuid-service-router-arg> high-availability status (Deprecated)

Display logical router high availability status of interface-groups


Display the high availability status of interface-groups for the logical router
get logical-router <nsxa-uuid-service-router-arg> interface-groups high-availability

Display service groups of the service router


Display the service groups state for the service router
get logical-router <nsxa-uuid-service-router-arg> service-groups

Display service groups of the service router


Display the service groups state for the service router
get logical-router <nsxa-uuid-service-router-arg> service-groups details

Display a logical router


Display information about the specified logical router.
get logical-router <uuid-arg> (Deprecated)

Display forwarding information for a logical router


Display forwarding for the specified logical router.
get logical-router <uuid-arg> forwarding (Deprecated)

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> (Deprecated)

Display forwarding information for a logical router


Display forwarding for the specified logical router, filtered by prefix.
get logical-router <uuid-arg> forwarding <network46-address> (Deprecated)

Display IPv4 forwarding for a logical router


Display IPv4 forwarding for the specified logical router.
get logical-router <uuid-arg> forwarding ipv4 (Deprecated)

Display IPv6 forwarding for a logical router


Display IPv6 forwarding for the specified logical router.
get logical-router <uuid-arg> forwarding ipv6 (Deprecated)

Display Mcast Groups information for a logical router


Display Mcast Groups for the specified logical router.
get logical-router <uuid-arg> igmp membership (Deprecated)

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> (Deprecated)

Display interface instance for a logical router


Display information for the specified logical router instance.
get logical-router <uuid-arg> interface <uuid-arg> (Deprecated)

Display a logical router interface


Display interface information for the specified logical router and port.
get logical-router <uuid-arg> interface <uuid-arg> (Deprecated)

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 (Deprecated)

Display a logical router interface statistics


Display interface statistics for the specified logical router and port.
get logical-router <uuid-arg> interface <uuid-arg> stats (Deprecated)

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 (Deprecated)

Display a logical router interface statistics


Display interface statistics for the specified logical router and port.
get logical-router <uuid-arg> interface <uuid-arg> stats <ip-version> (Deprecated)

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 (Deprecated)

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 (Deprecated)

Display interfaces for a logical router


Display interface information for the specified logical router.
get logical-router <uuid-arg> interfaces (Deprecated)

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


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> (Deprecated)

Display neighbors for a logical router


Display neighbor information (ARP cache) for the specified logical router.
get logical-router <uuid-arg> neighbors (Deprecated)

Display logical router BFD sessions


Display BFD sessions in a logical router
get logical-router <uuid> bfd-sessions [stats] (Deprecated)

Display BGP EVPN routes


Display BGP EVPN routes.
get logical-router <uuid> bgp evpn

Display BGP EVPN overlay information for all RDs


Display BGP EVPN overlay information for all RDs.
get logical-router <uuid> bgp evpn overlay

Display BGP EVPN VNI information


Display BGP EVPN VNI information.
get logical-router <uuid> bgp evpn vni

Display information about a specific BGP neighbor


Display information about a specific BGP neighbor.
get logical-router <uuid> bgp neighbor <ip-address>

Display routes advertised to a BGP neighbor


Display routes advertised to a BGP neighbor.
get logical-router <uuid> bgp neighbor <ip-address> advertised-routes

Display routes learnt from a BGP neighbor


Display routes learnt from a BGP neighbor.
get logical-router <uuid> bgp neighbor <ip-address> routes

Display a specific BGP neighbor diagnostic information


Display a specific BGP neighbor diagnostic information.
get logical-router <uuid> bgp neighbor <ip-address> session-diagnostics

Display BGP neighbor diagnostic information


Display BGP neighbor diagnostic information.
get logical-router <uuid> bgp neighbor session-diagnostics

Display summarized BGP neighbor information


Display summarized BGP neighbor information.
get logical-router <uuid> bgp neighbor summary

Display summarized BGP neighbor information for a given address-family


Display summarized BGP neighbor information for a given address-family.
get logical-router <uuid> bgp neighbor summary <address-family>

Generate BGP/BFD diagnostic report


Generate BGP/BFD diagnostic report.
get logical-router <uuid> bgp-bfd diagnostics report

Display EVPN VNI ARP information


Display EVPN VNI ARP information.
get logical-router <uuid> evpn arp [<vni-value>]

Display EVPN VNI MAC information


Display EVPN VNI MAC information.
get logical-router <uuid> evpn mac [<vni-value>]

Display router MACs for all VNIs


Display router MACs for all VNIs.
get logical-router <uuid> evpn rmac

Display all EVPN VNI information


Display all EVPN VNI information.
get logical-router <uuid> evpn vni

Display the logical router forwarding table


Display the forwarding table for the specified logical router. Optionally specify a prefix to display only the entry that matches that network.
get logical-router <uuid> forwarding [<prefix>] (Deprecated)

Display multicast routes


Display all the multicast learnt routes.
get logical-router <uuid> mroute <ip-address>

Display detailed information of an IPv4 route in RIB of a tier 0 logical router


Display the routing table for the specified logical router. You must specify a tier 0 service router in this command. Use the get logical-routers command to get a list of logical routers and their router types.

Optionally specify a prefix or IPv4 address to display only the route used for that network.

get logical-router <uuid> route [<prefix>]

Display detailed information of an IPv6 route in RIB of a tier 0 logical router


Display the routing table for the specified logical router. You must specify a tier 0 service router in this command. Use the get logical-routers command to get a list of logical routers and their router types.

Optionally specify a prefix or IPv6 address to display only the route used for that network.

get logical-router <uuid> route [<prefix>]

Display IPv4 BGP routes for a specified prefix in RIB


Display IPv4 BGP routes for a specified prefix in RIB.
get logical-router <uuid> route bgp [<prefix>]

Display IPv4 Connected routes for a specified prefix in RIB


Display IPv4 Connected routes for a specified prefix in RIB.
get logical-router <uuid> route connected [<prefix>]

Display IPv4 OSPF routes for a specified prefix in RIB


Display IPv4 OSPF routes for a specified prefix in RIB.
get logical-router <uuid> route ospf [<prefix>]

Display IPv4 Static routes for a specified prefix in RIB


Display IPv4 Static routes for a specified prefix in RIB.

get logical-router route static command also displays Tier 0 NAT, Tier 1 NAT, Tier 1 connected, Load balancer routes along with Tier 0 & Tier 1 static routes

get logical-router <uuid> route static [<prefix>]

Display the multicast HA role.


Display the multicast HA role. Active - Multicast is running in Active mode. Standby - Multicast is running in Standby mode. None - Multicast is not running.
get logical-router <uuid> route static [<prefix>]

Display all VRF VNI information


Display all VRF VNI information.
get logical-router <uuid> vrf vni

Display interface info for a logical router


Display interface information for the specified logical router.
get logical-router interface <dpd-uuid-lrouter-port-arg> (Deprecated)

Display ARP proxy table for a logical router port


Display ARP proxy for a logical router port.
get logical-router interface <dpd-uuid-lrouter-port-arg> arp-proxy (Deprecated)

Display interface-group info for logical router port


Display interface-group info for logical router port
get logical-router interface <dpd-uuid-lrouter-port-arg> interface-groups high-availability

Display the neighbor table of the logical router interface


Display the neighbor table for the specified logical router interface.
get logical-router interface <dpd-uuid-lrouter-port-arg> neighbor

Display shadow port mac list for lrouter port


Display shadow port mac list for lrouter port
get logical-router interface <dpd-uuid-lrouter-port-arg> shadow-macs (Deprecated)

Get the shadow port MAC address selected for specific IP address


Get the shadow port MAC address selected for specific IP address
get logical-router interface <dpd-uuid-lrouter-port-arg> shadow-macs ip <ip46-address> (Deprecated)

Get the shadow port MAC address selected for specific source and destination IP addresses


Get the shadow port MAC address selected for specific source and destination IP addresses
get logical-router interface <dpd-uuid-lrouter-port-arg> shadow-macs source-ip <ip46-address> dest-ip <ip46-address>

Display the logical router interface stats


Display statistics for the specified logical router interface.
get logical-router interface <dpd-uuid-lrouter-port-arg> stats (Deprecated)

Display the logical router ports


Display information for all logical router interfaces.
get logical-router interfaces (Deprecated)

Display the logical router interface stats


Display statistics for all logical router interfaces.
get logical-router interfaces stats (Deprecated)

Display the neighbor table


Display the neighbor table for all logical router interfaces.
get logical-router neighbor (Deprecated)

Display specific IPv4 routes from all the logical routers


Display specific IPv4 routes from all the logical routers.
get logical-router routes <network-address> (Deprecated)

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 information about the specified logical router port.


Display information about the specified logical router port.
get logical-router-port <logical-router-interface-id>

Display logical router summary


Display information about logical routers on this hypervisor host.
get logical-routers (Deprecated)

Display logical routers


Display information about all logical routers.
get logical-routers (Deprecated)

Display information about all logical routers


Display information about all logical routers.
get logical-routers (Deprecated)

Display information about logical routers asscociated with the VIF on this public cloud host


Display information about logical routers asscociated with the VIF on this public cloud host.
get logical-routers (Deprecated)

Display logical routers and stats


Display statistics for all logical routers.
get logical-routers stats (Deprecated)

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 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 remote rtep-groups for a logical switch


Display remote rtep-groups for a logical switch
get logical-switch <dpd-uuid-lswitch-arg> rtep-groups (Deprecated)

Display tunnel information for a logical switch


Display the tunnel information for the specified logical switch.
get logical-switch <dpd-uuid-lswitch-arg> tunnel-ports (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 VTEP table for a logical switch


Display the VTEP table for the specified logical switch.
get logical-switch <ls-id-arg-kvm> vtep (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 counters for the specified logical switch.


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.


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 RTEP Group synced from remote site, the first row shows local RTEP Group.


Display RTEP Group synced from remote site
get logical-switch <vni-or-uuid-arg> rtep-group (Deprecated)

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 all virtual tunnel end points related to the specified logical switch


Display all virtual tunnel end points related to the specified logical switch.
get logical-switch <vni-or-uuid-arg> vtep (Deprecated)

Display all virtual tunnel end points related to the specified logical switch


Display all virtual tunnel end points related to the specified logical switch.
get logical-switch <vni-or-uuid-arg> vtep 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 external IP and internal IP of LSP


Display external IP and internal IP of LSP.
get lsp-eip-binding-under-ls <ls-uuid>

Get maintenance mode


Get maintenance mode status.
get maintenance-mode

Show managers


Show the current list of configured managers.
get managers

Show logical mdproxy server


Display a specific metadata proxy server.
get mdproxy server <uuid-string-arg>

Show all logical mdproxy server


Display all metadata proxy servers.
get mdproxy servers

Show the system memory status


Display the system memory information.
get memory-stats

Display multicast forwarding table


Display the multicast forwarding table for the logical router in the VRF context. The forwarding plane merges the mroutes from the control plane and from IGMP snooping to build out mfib. A (s,g) mroute displayed from the control plane may not be shown identically from the forwarding plane. When there are multiple matches from mfib lookup, the packet will be replicated to all valid outgoing interfaces for each matched entry.
get mfib

Display multicast forwarding entries matching a multicast group in VRF


Display multicast forwarding entries matching a multicast group for the specified logical router in the VRF context. The forwarding plane merges the mroutes from the control plane and from IGMP snooping to build out mfib. A (s,g) mroute displayed from the control plane may not be shown identically from the forwarding plane. When there are multiple matches from mfib lookup, the packet will be replicated to all valid outgoing interfaces for each matched entry.
get mfib <multicast-ip-address>

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


Display all the multicast learnt routes.
get mroute <ip-address>

Display load-balancing selection for multicast group in VRF


Display the load-balancing selection for a multicast group for the specified logical router in the VRF context.
get multicast load-balancing <multicast-ip-address>

Get all name servers


Get all name servers in the DNS configuration.
get name-servers

Show namespace config


Display a specific namespace config
get namespace status <string-arg>

Show all namespace configs


Display all namespace configs.
get namespaces status

Display all EIP binding config table entries


Display all EIP binding config table entries.
get nat eip-binding

Display EIP binding config table entries with matching eip table id


Display all EIP binding config entries with matching eip table id.
get nat eip-binding eip-table-id <uuid-string-arg>

Display EIP binding config table entries with specific ip and uuid


Display all EIP binding config table entries with ip and uuid.
get nat eip-binding eip-table-id <uuid-string-arg> ip <ip46-address>

Display all EIP binding fastpath table entries


Display all EIP binding fastpath table entries.
get nat eip-binding fastpath

Display EIP binding fastpath table entries with matching eip table id


Display all EIP binding fastpath table entries with matching eip table id.
get nat eip-binding fastpath eip-table-id <uuid-string-arg>

Display EIP binding fastpath table entries with specific ip and uuid


Display all EIP binding fastpath table entries with specific ip and uuid
get nat eip-binding fastpath eip-table-id <uuid-string-arg> ip <ip46-address>

Display EIP binding fastpath table entries with specific ip


Display all EIP binding fastpath table entries with ip.
get nat eip-binding fastpath ip <ip46-address>

Display EIP binding config table entries with specific ip


Display all EIP binding config table entries with ip.
get nat eip-binding ip <ip46-address>

Display the logical router's neighbor table


Display the neighbor table for the logical router in the VRF context.
get neighbor

Show the system network statistics


Display the system network statistics.
get network-stats

Get central-config properties


Get central-config properties.
get node central-config

Display upgrade status of the node


Display upgrade status of the node.
get node upgrade status

Display progress state of last rollback task


Display the status of the rollback tasks executed on the node and details of the last rollback task.
get node-rollback progress-status

Show node UUID


Show the UUID for the node.
get node-uuid

Show host UUID


Display the UUID for the host.
get node-uuid

Display registered nodes


Display the list of registered nodes.
get nodes

Display registered nodes detail


Display the list of registered nodes information in detail.
get nodes verbose

Show NTP associations


Display the status of the NTP system. The delay, offset and dispersion values are in seconds.
get ntp-server associations

Show NTP servers


Display all NTP servers.
get ntp-servers

Display OSPF information


Display OSPF information.
get ospf

Display OSPF database summary


Display OSPF database summary.
get ospf database

Display ASBR-Summary LSAs


Display ASBR-Summary LSAs.
get ospf database asbr-summary

Display ASBR-Summary LSAs


Display ASBR-Summary LSAs.
get ospf database asbr-summary <ip-address>

Display external LSAs


Display external LSAs.
get ospf database external

Display external LSAs


Display external LSAs.
get ospf database external <ip-address>

Display Network LSAs


Display Network LSAs.
get ospf database network

Display Network LSAs


Display Network LSAs.
get ospf database network <ip-address>

Display NSSA external LSAs


Display NSSA external LSAs.
get ospf database nssa-external

Display NSSA external LSAs


Display NSSA external LSAs.
get ospf database nssa-external <ip-address>

Display router LSAs


Display router LSAs.
get ospf database router

Display router LSAs


Display router LSAs.
get ospf database router <ip-address>

Display summary LSAs


Display summary LSAs.
get ospf database summary

Display summary LSAs


Display summary LSAs.
get ospf database summary <ip-address>

Display OSPF Graceful Restart information


Display OSPF Graceful Restart information.
get ospf graceful-restart

Display OSPF interface information


Display OSPF interface information.
get ospf interface

Display OSPF neighbor list


Display OSPF neighbor list.
get ospf neighbor

Display OSPF routes


Display OSPF routes.
get ospf route

Show external summary addresses


Show external summary addresses.
get ospf summary-address

Display the parent of current port or interface


Display the parent of the current interface.
get parent

Get configured password complexity requirements


Get configured password complexity requirements.
get password-complexity

Display the path


Display the path. The arrow indicates which interface is selected. Other commands, such as get current, will display information about the selected interface.
get path

Show physical port by 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

Display the state of BSM message processing.


Display the state of BSM message processing. Enabled - BSM messages are processed. Disabled - BSM messages are ignored.
get pim bsm state

Display logical objects related to the specified logical port


Display logical objects related to the specified logical port.
get port <uuid-string-arg> [api-args]

Display Ports


Display information about all ports.
get ports

Display port information


Display port information on the current host.
get ports

Display system processes


Display a snapshot of the system processes.
get processes

Display process monitor


Display information about processes that are running. The display is updated every few seconds.
get processes monitor

Get the realization status for the specified transport node


Get the realization status for the specified transport node.
get realization-status <uuid-arg>

Get all connected receivers


Display all connected receivers.
get receivers

Display info about redirection Policy


Display information about Redirection Policy
get redirection-policy

Display info about Redirection POlicy


Display information about Redirection Policy.
get redirection-policy <dpd-uuid-service-insertion-arg>

Display info about Redirection Policy BFD control status.


Display information about Redirection Policy BFD control status.
get redirection-policy bfd-ctrl

Display info about Redirection Policy flow programming table.


Display information about Redirection Policy flow programming table.
get redirection-policy flow-prog-table

Display info about Redirection Policy failed SPI.


Display information about Redirection Policy failed SPI.
get redirection-policy spi-fail-table

Display info about EW Redirection VRF to interface mapping.


Display information about EW Redirection VRF to interface mapping.
get redirection-policy vrf-to-intf

Display detailed information of an IPv6 route in RIB


Display detailed information of an IPv6 route in RIB. Specify a prefix or IPv6 address to display only the route used for that network.
get route [<prefix>]

Display detailed information of an IPv4 route in RIB


Display detailed information of an IPv4 route in RIB. Specify a prefix or IPv4 address to display only the route used for that network.
get route [<prefix>]

Display IPv4 BGP routes for a specified prefix in RIB


Display IPv4 BGP routes for a specified prefix in RIB.
get route bgp [<prefix>]

Display IPv4 Connected routes for a specified prefix in RIB


Display IPv4 Connected routes for a specified prefix in RIB.
get route connected [<prefix>]

Display all OSPF routes in RIB


Display all OSPF routes in RIB.
get route ospf

Display IPv4 OSPF routes for a specified prefix in RIB


Display IPv4 OSPF routes for a specified prefix in RIB.
get route ospf [<prefix>]

Display a specific IPv4 route or IPv6 routes for the prefix


Display the specified IPv4 route or IPv6 routes for the prefix.
get route prefix <cidr46-notation>

Display specific IPv4 or IPv6 routes for the prefix


Display specific IPv4 or IPv6 routes for the prefix.
get route prefix <cidr46-notation>

Display IPv4 Static routes for a specified prefix in RIB


Display IPv4 Static routes for a specified prefix in RIB.

get route static command also displays Tier 0 NAT, Tier 1 NAT, Tier 1 connected, Load balancer routes along with Tier 0 & Tier 1 static routes

get route static [<prefix>]

Display routes across Tier0 and all its associated VRFs


Display routes across Tier0 and all its associated VRFs.
get route vrf all <ip-version>

Display IPv4 routes


Display all configured IPv4 routes.
get routes

Display IPv4 and IPv6 routes


Display all configured IPv4 and IPv6 routes.
get routes

Display IPv4 or IPv6 routes


Display all configured IPv4 or IPv6 routes.
get routes <ip-address-type>

Display a routing domain


Display information about the specified routing domain.
get routing-domain <dpd-uuid-routing-domain-arg>

Display a routing domain mtep


Display mtep information about the specified routing domain.
get routing-domain <dpd-uuid-routing-domain-arg> mtep

Display a routing domain


Display information about the specified routing domain.
get routing-domain <uuid-arg>

Display information about all logical switches in a routing domains


Display information about all logical switches in a routing domains.
get routing-domain <uuid-arg> logical-switches-from-app

Display information about all logical switches in a routing domains


Display information about all logical switches in a routing domains.
get routing-domain <uuid-arg> logical-switches-from-pigeon

Display information about all logical switches in a routing domains


Display information about all logical switches in a routing domains.
get routing-domain <uuid-arg> stats

Display information about all routing domains


Display information about all routing domains.
get routing-domain <uuid-arg> vtep

Display routing domain


Display information about all routing domains.
get routing-domains

Display routing domain mtep


Display mtep information about all routing domains.
get routing-domains mtep

Display routing domains from the application


Display information about all routing domains.
get routing-domains-from-app

Display routing domains from Pigeon


Display information about all routing domains.
get routing-domains-from-pigeon

Display information of RTEP group


Display information about a RTEP group.
get rtep-group <rtep-group-id-arg>

Display RTEP group's stats


Display stats about a RTEP group.
get rtep-group <rtep-group-id-arg> stats

Display RTEP group information


Display information about all RTEP groups
get rtep-groups

Display RTEP groups' stats


Display stats about all RTEP groups.
get rtep-groups stats

Display RTEP information


Display information about all rtep tunnel endpoints.
get rteps

Display help information on runbook usage


Display help information on runbook usage.
get runbook <runbook-id-arg> help

Display runbook information


Display information of available runbooks on the current node.
get runbooks

Get all search domains


Get all domain names in the DNS search list.
get search-domains

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 remote rtep-groups for a segment


Display remote rtep-groups for a segment
get segment <dpd-uuid-lswitch-arg> rtep-groups

Display tunnel information for a segment


Display the tunnel information for the specified segment.
get segment <dpd-uuid-lswitch-arg> tunnel-ports

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 VTEP table for a segment


Display the VTEP table for the specified segment.
get segment <segment-id-arg-kvm> vtep

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 counters for the specified segment.


Display all counters for the specified segment.
get segment <segment_id_arg_esx> datapath-stats all new

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 RTEP Group synced from remote site, the first row shows local RTEP Group.


Display RTEP Group synced from remote site
get segment <vni-or-uuid-arg> rtep-group

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 all virtual tunnel end points related to the specified segment


Display all virtual tunnel end points related to the specified segment.
get segment <vni-or-uuid-arg> vtep

Display all virtual tunnel end points related to the specified segment


Display all virtual tunnel end points related to the specified segment.
get segment <vni-or-uuid-arg> vtep 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 service properties


Display information about the specified service.
get service <service-name-arg>

Display global logging configuration


Display global logging configuration.
get service controller logging-config

Display configuration for logger with given log level


Display the logging configuration for components that have the specified log level.
get service controller logging-config logging-level <controller-logging-level-arg>

Display configuration for given logger


Display the logging configuration for the specified component.
get service controller logging-config name <string-arg-controller>

Display configuration for loggers matching to given regex


Display the logging configuration for components that match the specified pattern. The pattern can be a regular expression.
get service controller logging-config pattern <string-arg-controller>

Display the controller service logging level


Display the log level for the controller service.
get service controller logging-level

Get the dataplane service logging level


Display the log level of the dataplane service.
get service dataplane logging-level

Get the dhcp service logging level


Display the log level of the dhcp service.
get service dhcp logging-level

Display DHCP pool monitor configuration


Display DHCP pool monitor configuration
get service dhcp pool-monitor

Display IKE per tunnel debugging configuration


Display IKE per tunnel debugging configuration
get service ike debug-tunnel

Get the IKE service logging level


Display the log level of the IKE service.
get service ike logging-level

Get the local-controller service logging level


Display the log level of the local-controller service.
get service local-controller logging-level

Get local-controller service state


Display the state of the local controller service.
get service local-controller state

Get Node Management service logging level


Get the log level of the Node Management service.
get service node-mgmt logging-level

Get the log level of nsd


Get nsd logging level.
get service nsd logging-level

Get the log level of NSX Agent service.


Get service nsx-agent logging level.
get service nsx-agent logging-level

Get the whole cfgagent cache 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 cfgagent metrics logging level
get service nsx-cfgagent lib-metrics logging-level

Get service cfgagent nestdb logging level


Get service cfgagent nestdb logging level
get service nsx-cfgagent lib-nestdb logging-level

Get service cfgagent net logging level


Get service cfgagent net logging level
get service nsx-cfgagent lib-net logging-level

Get service cfgagent rpc 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 attachment config


Display the attachment config logical switch on this hypervisor host.
get service nsx-cfgagent logical-switch attachment-config

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 nsx-context-mux feature status


Get nsx-context-mux feature status.
get service nsx-context-mux feature <context-mux-feature-type-arg> status

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 current status of IDFW on host
get service nsx-ctxteng idfw status

Get current status of IDS on host


Get current status of IDS on host
get service nsx-ctxteng ids status

Get context engine protocol enable in the order TCP UDP ICMP


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 the log level of the exporter service


Get exporter service logging level.
get service nsx-exporter logging-level

Display service properties for nsx-lastline-rapid


Display information about the nsx-lastline-rapid service.
get service nsx-lastline-rapid

Get the log level of nsx-lastline-rapid


Get nsx-lastline-rapid log level
get service nsx-lastline-rapid 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 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

Get the entire routing configuration


Display the entire routing configuration.
get service router config

Get redistribution configuration


Display the redistribution configuration.
get service router config redist

Get route maps configuration


Display the route map configuration.
get service router config route-maps

Display service properties for Security Hub


Display information about the SecurityHub service.
get service security-hub

Get the log level of EPSEC Library


Get EPSEC Library log level
get service security-hub epsec logging-level

Get configured SecurityHub feature details


Get configured SecurityHub feature details
get service security-hub feature

Get the log level of security-hub


Get security-hub log level
get service security-hub logging-level

Display service groups of the service router


Display the service groups state for the service router
get service-groups

Display service groups of the service router


Display the service groups state for the service router
get service-groups details

Display info about Service Insertion


Display information about Service Insertion.
get service-insertion

Display info about Service Insertion


Display information about Service Insertion.
get service-insertion <dpd-uuid-service-insertion-arg>

Display info about NS Service Insertion BFD control status.


Display information about NS Service Insertion BFD control status.
get service-insertion bfd-ctrl

Display info about Service Insertion flow programming table.


Display information about Service Insertion flow programming table.
get service-insertion flow-prog-table

Display info about Service Insertion failed SPI.


Display information about Service Insertion failed SPI.
get service-insertion spi-fail-table

Display info about EW Service Insertion VRF to interface mapping.


Display information about EW Service Insertion VRF to interface mapping.
get service-insertion vrf-to-intf

Display service properties


Display information about all services.
get services

Show the remote site(s) and their sync status


Display the remote sites along with their sync status.
get site-replicator remote-sites

Get SNMP v2 configured status


Indicates whether the local SNMP agent is configured with community string(s).
get snmp v2-configured

Get SNMP v2 Trap Targets


Get SNMP v2 Trap Targets.
get snmp v2-targets

Get SNMP v3 configured status


Indicates whether the local SNMP agent is configured with v3 user(s).
get snmp v3-configured

Get SNMP v3 Engine ID


Get SNMP v3 Engine ID.
get snmp v3-engine-id

Get SNMP v3 Protocols


Get SNMP v3 Protocols auth_protocol and priv_protocol.
get snmp v3-protocols

Get SNMP v3 Trap Targets


Get SNMP v3 Trap Targets.
get snmp v3-targets

Get SNMP v3 User IDs


Get SNMP v3 User IDs.
get snmp v3-users

Show active network connections


Display active network connections.
get sockets

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 config for a logical port


Displays Spoof Guard config for a logical port.
get spoof-guard config <logical-port>

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 stats for a logical port


Displays Spoof Guard stats for a logical port.
get spoof-guard stats <logical-port>

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 Spoof Guard whitelist for a logical port


Displays Spoof Guard whitelist for a logical port.
get spoof-guard whitelist <logical-port>

Display the logical router statistics


Display statistics for the logical router in the VRF context.
get stats

Display the stats of all ifaces in the path


Display the statistics for all interfaces in the path.
get stats

Show the stretched cgroup translation on both local and remote sites


Display both local and remote translations for the specified stretched container group. Optionally specify a translation type to display translations of that type.
get stretched cgroup <container-id> <translation-type> (Deprecated)

Show the stretched group translation on both local and remote sites


Display both local and remote translations for the specified stretched group. Optionally specify a translation type to display translations of that type.
get stretched group <group-id> <translation-type>

Save support bundle in filestore


Save the contents of the tech support bundle. Specify the file argument to save the bundle to a file with the specified file name in the file store. NSX Manager support bundles are .tar archives, NSX Edge support bundles are .tgz archives. This support bundle does not contain core or audit log files. To include those files, specify the all argument. To remove core dump files after collected in support bundle, specify optional argument remove-core-files along with all argument.

Core files contain system information and all information stored in memory at the time of the dump (this may include confidential, sensitive or personal information such as passwords and encryption keys, if they are being processed in memory at that time). If you choose to send the support bundle to VMware, it will be processed in accordance with VMware's standard processes and policies, to provide you with support, fix problems and improve the product and services.

Specify the log-age argument to include log files with modified times not past the age limit in days.

Specify the eal4-audit argument to collect pre-defined selective log files modified in last 4 hours.

Note: all, log-age, remove-core-files arguments are not allowed along with eal4-audit argument.
get support-bundle [file <filename> [[log-age <no-of-days>] [all [remove-core-file]]] | [eal4-audit]]

Save support bundle in filestore


Saves support bundle to the specified filename in the filestore.
get support-bundle [file <filename>]

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 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 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 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 Switch Security stats for a logical port


Displays Switch Security stats for a logical port.
get switch-security stats <logical-port>

Display a logical router's tenant context


Display tenant context information for the logical router in the VRF context.
get tenant-context

Display transit gateway summary


Display information about transit gateways on this hypervisor host.
get tgws

Display Configured TGWs


Display information about all TGWs.
get tgws

Display transit gateway summary


Display information on transit gateway routers at policy path on this hypervisor host.
get tgws <policy-path-string-arg>

Display TLS inspection info


Display TLS inspection information.
get tls-inspection

Display TLS inspection action profile details


Display TLS inspection action profile details.
get tls-inspection action-profile <uuid-string-arg>

Display TLS inspection action profile info


Display TLS inspection action profile information.
get tls-inspection action-profiles

Display TLS inspection bypassed sites


Display TLS inspection bypassed sites and the reason.
get tls-inspection bypassed-sites lr-uuid <uuid>

Display TLS inspection bypassed sites


Display TLS inspection bypassed sites and the reason.
get tls-inspection bypassed-sites sr-uuid <uuid>

Display TLS inspection CA bundle details


Display TLS inspection CA bundle details.
get tls-inspection ca-bundle <uuid-string-arg>

Display TLS inspection CA bundle info


Display TLS inspection CA bundle information.
get tls-inspection ca-bundles

Show TLS Inspection Cached Certificate Details


Show TLS Inspection Cached Certificate Details.
get tls-inspection cached-certificate <certificate-id-string-arg>

Display TLS inspection cached certificates


Display TLS inspection cached certificates.
get tls-inspection cached-certificates

Show TLS Inspection Certificate Details


Show TLS Inspection Certificate Details.
get tls-inspection certificate <tls-certificate-id-arg>

Display TLS inspection CRL info


Display TLS inspection CRL information.
get tls-inspection crls

Display revoked certs of a TLS inspection CRL matching a serial number


Display revoked certs of a TLS inspection CRL matching a serial number.
get tls-inspection crls <crl-uuid> certificate-serial-number <certificate-serial-number>

Display revoked certs of a TLS inspection CRL of an issuer


Display revoked certs of a TLS inspection CRL of an issuer.
get tls-inspection crls <crl-uuid> issuer <issuer-SHA256>

Display the revoked cert of a TLS inspection CRL that matches the issuer hash and serial number


Display the revoked cert of a TLS inspection CRL that matches the issuer hash and serial number.
get tls-inspection crls <crl-uuid> issuer <issuer-SHA256> certificate-serial-number <certificate-serial-number>

Display the revoked cert of a TLS inspection CRL that matches the public key hash


Display the revoked cert of a TLS inspection CRL that matches the public key hash.
get tls-inspection crls <crl-uuid> public-key-hash <public-key-hash>

Display the revoked cert of a TLS inspection CRL that matches the subject SHA256 hash


Display the revoked cert of a TLS inspection CRL that matches the subject SHA256 hash.
get tls-inspection crls <crl-uuid> subject <subject-SHA256>

Display the revoked cert of a TLS inspection CRL that matches the subject and public key hash


Display the revoked cert of a TLS inspection CRL that matches the subject and public key hash.
get tls-inspection crls <crl-uuid> subject <subject-SHA256> public-key-hash <public-key-hash>

Display revoked certs of a TLS inspection CRL


Display revoked certs of a TLS inspection CRL.
get tls-inspection crls <uuid-string-arg>

Display TLS inspection global error stats


Display TLS inspection global error stats associated with the routers.
get tls-inspection errors

Display TLS inspection error stats


Display TLS inspection error stats associated with the routers.
get tls-inspection errors lr-uuid <uuid>

Display TLS inspection error stats


Display TLS inspection error stats associated with the routers.
get tls-inspection errors sr-uuid <uuid>

Display TLS inspection logging levels


Display TLS inspection logging levels.
get tls-inspection logging-level

Display TLS inspection rule stats


Display TLS inspection rule stats associated with the routers.
get tls-inspection rule-stats <lr-uuid|sr-uuid>

Display TLS inspection rule stats


Display TLS inspection rule stats associated with the routers.
get tls-inspection rule-stats <lr-uuid|sr-uuid> [<rule-id>]

Display TLS inspection rules brief


Display TLS inspection rules brief associated with the routers.
get tls-inspection rules brief <lr-uuid|sr-uuid>

Display TLS inspection rules brief


Display TLS inspection rules brief associated with the routers.
get tls-inspection rules brief <lr-uuid|sr-uuid> [<rule-id>]

Display TLS inspection status info


Display TLS inspection status information.
get tls-inspection status

Display TLS inspection traffic stats


Display TLS inspection traffic stats associated with the routers.
get tls-inspection traffic-stats lr-uuid <uuid>

Display TLS inspection traffic stats


Display TLS inspection traffic stats associated with the routers.
get tls-inspection traffic-stats sr-uuid <uuid>

Display information of a TN TEP group


Display information about a TN TEP group.
get tn-tep-group <tn-tep-group-id-arg>

Display TN TEP group information


Display information about all TN TEP groups
get tn-tep-groups

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 after querying all controller nodes in UA cluster.


Display status information for the specified transport node after querying all controller nodes in UA cluster.
get transport-node <uuid-arg> status-from-all-nodes

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 external IP mapping table entries on the host


Display external IP mapping table entries on the host
get transport-node external-ip

Display external IP mapping table entry on the host


Display external IP mapping table entry on the host
get transport-node external-ip <ip-address>

Display the health metric for specific transport node nsx stats module.


Display the health metric for specific transport node nsx stats module.
get transport-node health-metrics module <mod_name_arg_esx> metrics all

List all the health metrics with brief description for all the modules.


List all the health metrics with brief description for all the modules.
get transport-node health-metrics module <mod_name_arg_esx> metrics list

List all the health metrics enabled transport node nsx modules.


List all the health metrics enabled transport node nsx modules.
get transport-node health-metrics modules list

Display specified transport node nsx stats counter's detailed description.


Display specified transport node nsx stats counter's detailed description.
get transport-node nsx-stats module <mod_name_arg_esx> counter <ctr_name_arg_esx> description verbose

Display the counters value for specific transport node nsx stats module.


Display the counters value for specific transport node nsx stats module.
get transport-node nsx-stats module <mod_name_arg_esx> counters all

List all the nsx stats counters with brief description for the specified module.


List all the nsx stats counters with brief description for the specified module.
get transport-node nsx-stats module <mod_name_arg_esx> counters list

Display specified module's detailed description for observability transport node nsx stats counters.


Display specified module's detailed description for observability transport node nsx stats counters.
get transport-node nsx-stats module <mod_name_arg_esx> description verbose

List all the observability enabled transport node nsx stats modules.


List all the observability enabled transport node nsx stats modules.
get transport-node nsx-stats modules list

Display specified transport node platform stats counter's detailed description.


Display specified transport node platform stats counter's detailed description.
get transport-node platform-stats module <mod_name_arg_esx> counter <ctr_name_arg_esx> description verbose

Display the counters value for specific transport node platform stats module.


Display the counters value for specific transport node platform stats module.
get transport-node platform-stats module <mod_name_arg_esx> counters all

List all the platform stats counters with brief description for the specified module.


List all the platform stats counters with brief description for the specified module.
get transport-node platform-stats module <mod_name_arg_esx> counters list

Display specified module's detailed description for observability transport node platform stats counters.


Display specified module's detailed description for observability transport node platform stats counters.
get transport-node platform-stats module <mod_name_arg_esx> description verbose

List all the observability enabled transport node platform stats modules.


List all the observability enabled transport node platform stats modules.
get transport-node platform-stats modules list

Display status of all transport nodes


Display status information for all transport nodes.
get transport-nodes status

Display status of all transport nodes after querying all controller nodes in UA cluster.


Display status information for all transport nodes after querying all controller nodes in UA cluster.
get transport-nodes status-from-all-nodes

Display information about a tunnel port


Display information about the specified tunnel port.
get tunnel-port <dpd-uuid-tunnel-port-arg>

Display stats for a tunnel port


Display statistics for the specified tunnel port.
get tunnel-port <dpd-uuid-tunnel-port-arg> stats

Display tunnel ports


Display information about all tunnel ports e.g. Geneve, GRE, VxLAN
get tunnel-ports

Display stats for all tunnel ports


Display statistics for all tunnel ports e.g. Geneve, GRE, VxLAN
get tunnel-ports stats

Display Multicast Underlay subscriptions


Display all Multicast Groups the Edge joined in Underlay
get underlay-subscription

Display progress status of last upgrade step


Display the status of the upgrade steps run on the node and details of last upgrade step.
get upgrade progress-status

Display playbook contents


Display the contents of the specified playbook for the specified upgrade bundle.
get upgrade-bundle <bundle-name-arg> playbook <playbook-file-arg>

List all playbooks in the filestore


Display all playbooks in the file store.
get upgrade-bundle playbooks

Show the system uptime


Display the system uptime information.
get uptime

Display reputation and category info about URL


Display reputation and category info about URL
get url-classification <url-string-arg>

Get number of days od details user password expiration details


Get number of days the user's password is valid after a password change and number of days before user receives password expiration warning message.
get user <node-all-username> password-expiration

Get user status for specified non-root user


Get user status for specified non-root user.
get user <node-all-username> status

Get SSH keys from authorized_keys file for specified user


Get SSH keys from authorized_keys file for specified user.
get user <node-username> ssh-keys

Display system version


Display the version of the NSX appliance.
get version

Display VIF info


Display information about the sepcified VIF. You can find VIF IDs with the get transport-node <uuid> vif command or the get logical-switch <uuid> ports command (see Child-UUID where Child-EntityType is VIF).
get vif <vif-id-arg>

Dump the host's network mode and tagged interface


Dump the host's network mode and tagged interface.
get vm-network-mode

Get VMC migration mode


Get VMC migration mode status.
get vmc migration-mode

Display Configured VPCs


Display information about all VPCs.
get vpcs

Display vpc gateway summary


Display information about vpc gateway routers on this hypervisor host.
get vpcs

Display vpc gateway router summary


Display information on vpc gateway routers on this hypervisor host.
get vpcs <policy-path-string-arg>

Display vpc segment summary


Display information on subnet on this hypervisor host.
get vpcs <policy-path-string-arg> subnets

Display all VRF VNI information


Display all VRF VNI information.
get vrf vni

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

Get MAC Table associated with a Team of a vswitch


Get MAC Table associated with a Team of a vswitch
get vswitch mac-table team <hs-name-arg>

Display vswitch runtime options


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

Display all VTEP records for specific VTEP GROUP


Display all VTEP records for specific VTEP GROUP
get vtep-group <int-arg> vtep

Display all VTEP records for specific VTEP GROUP


Display all VTEP records for specific VTEP GROUP
get vtep-group <int-arg> vteps-staleness-status

Display information of a VTEP group


Display information about a VTEP group.
get vtep-group <vtep-group-id-arg>

Display VTEP group information


Display information about all VTEP groups
get vtep-groups

Display VTEP information


Display information about all tunnel endpoints.
get vteps

Get vxlan uplink queue filter


Get vxlan uplink queue filter.
get vxlan-uplink-queue-filter dvs <dvs-name-arg>

Display CLI command help information


Display CLI command help information.
help

Install NSX Edge service container image


Install NSX Edge service container image.
install image <configurable-image-name> version <configurable-image-version>

Join this node to a NSX Cluster


Join this node to a management cluster. You must provide the API username and password of a node that is already in the cluster. On that node, you can run the get cluster config command to get the cluster ID, and run the get certificate api thumbprint command to get the thumbprint. If you do not provide a password on the command line, you will be prompted to enter one.
join <ip-address[:port]> cluster-id <cluster-id> thumbprint <thumbprint> [token <api-token>] [username <username> [password <password>]] [force]

Join node to the management plane


Join this node to the management plane.
join management-plane <hostname-or-ip-address[:port]> thumbprint <thumbprint> token <token> [node-uuid <uuid>] [replace]

Join host with management 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>]

Join node to the management plane


Join this node to the management plane.
join management-plane <hostname-or-ip-address[:port]> username <username> thumbprint <thumbprint> [password <password>] [node-uuid <uuid>] [replace]

List available commands


This command lists all available commands.
list

Configure livetrace session.


Configure livetrace session.
livetrace config <action-type> <dpd-uuid-name-port-arg> protocol <proto-num> source-ip <network46-address> <l4-port-range-arg> dest-ip <network46-address> <l4-port-range-arg> timeout <time-out>

Configure livetrace session for ESP protocol with IP.


Configure livetrace session for ESP protocol with IP..
livetrace config <action-type> <dpd-uuid-name-port-arg> protocol <proto-num> source-ip <network46-address> dest-ip <network46-address> timeout <time-out>

Configure livetrace session for ESP protocol with SPI.


Configure livetrace session for ESP protocol with SPI..
livetrace config <action-type> <dpd-uuid-name-port-arg> protocol <proto-num> spi <spi-value> timeout <time-out>

Configure livetrace session for all packets.


Configure livetrace session for all packets.
livetrace config <action-type> <dpd-uuid-name-port-arg> protocol <proto-num> timeout <time-out>

Get live trace session information.


Retrieve live trace session information.
livetrace show

Extract rollback scripts and start rollback


Extract the specified rollback scripts and start rollback.
node-rollback run-step step1_start_rollback

Execute a rollback step


None
node-rollback run-step step2_restore_data

Execute a rollback step


None
node-rollback run-step step3_exit_rollback

nslookup


Display nslookup information.
nslookup <hostname-arg>

nslookup


Get DNS lookup information.

Note that when run on an NSX Manager, the responding server is reported as 127.0.0.1 instead of the configured name server.

nslookup <hostname-or-ip-address>

Display Nslookup DNS Forwarder result


Display Nslookup DNS Forwarder result.
nslookup dns-forwarder <hostname-or-ip-address> [[server-ip <ip-address>] [source-ip <ip-address>]]

Display Nslookup DNS Forwarder result


Display Nslookup DNS Forwarder result.
nslookup dns-forwarder <uuid> <hostname-or-ip-address> [server-ip <ip-address>] [source-ip <ip-address>]

Enter path context mode


Enter path context mode. This mode allows you to get information about each interface that is in the path between the specified logical router port and the specified IP address.

You can get a list of logical router interfaces with the get logical-router interfaces command.

Once you are in the path context, use the path commands to navigate and get information, for example, get path, get current, up and down.

path <dpd-uuid-lrouter-port-arg> <ip46-address>

Ping host


Ping an IP address. Use Control-C to stop the ping command.
ping <hostname-or-ip-address>

Ping host


Ping a host or IP address. Use Control-C to stop the command. Optionally use the repeat argument to specify how many packets to transmit.
ping <hostname-or-ip-address> [repeat <number>]

Ping host


Ping an IP address. Use Control-C to stop the ping command. The repeat argument specifies how many ping packets to transmit. The size argument specifies the size of the ping packet. The dfbit argument specifies whether to set the "don't fragment" bit in the ping packet. If enabled, the packet will not be fragmented.

The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.

ping <hostname-or-ip-address> [repeat <number>] [size <number>] [source <hostname-or-ip-address>] [dfbit enable]

Ping host


Ping an IP address. Use Control-C to stop the ping command. The repeat argument specifies how many ping packets to transmit. The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command. The size argument specifies the size of the ping packet. The dfbit argument specifies whether to set the "don't fragment" bit in the ping packet. If enabled, the packet will not be fragmented.

The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.

ping <hostname-or-ip-address> [repeat <number>] [size <number>] [source <hostname-or-ip-address>] [dfbit enable] [vrfid <vrf-id>]

Ping IPv6 host


Ping an IPv6 address. Use Control-C to stop the ping command.
ping6 <ip6-address>

Ping IPv6 host


Issue a ping command for IPv6 host.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address

ping6 <ip6-address> [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The repeat argument specifies how many ping packets to transmit.

ping6 <ip6-address> [repeat <number>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

The repeat argument specifies how many ping packets to transmit.

ping6 <ip6-address> [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host


Ping an IPv6 address. Use Control-C to stop the ping command.

The size argument specifies the size of the ping packet.

ping6 <ip6-address> [size <number>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The size argument specifies the size of the ping packet.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

ping6 <ip6-address> [size <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The repeat argument specifies how many ping packets to transmit.

The size argument specifies the size of the ping packet.

ping6 <ip6-address> [size <number>] [repeat <number>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The size argument specifies the size of the ping packet.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

The repeat argument specifies how many ping packets to transmit.

ping6 <ip6-address> [size <number>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host


Ping an IPv6 address. Use Control-C to stop the ping command.

The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.

ping6 <ip6-address> [source <ip6-address>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address

The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.

ping6 <ip6-address> [source <ip6-address>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The repeat argument specifies how many ping packets to transmit.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address

The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.

ping6 <ip6-address> [source <ip6-address>] [repeat <number>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.

The size argument specifies the size of the ping packet.

ping6 <ip6-address> [source <ip6-address>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The size argument specifies the size of the ping packet.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.

ping6 <ip6-address> [source <ip6-address>] [size <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.

The size argument specifies the size of the ping packet.

The repeat argument specifies how many ping packets to transmit.

ping6 <ip6-address> [source <ip6-address>] [size <number>] [repeat <number>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The repeat argument specifies how many ping packets to transmit.

The size argument specifies the size of the ping packet.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.

ping6 <ip6-address> [source <ip6-address>] [size <number>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.

ping6 <ip6-address> [source <ip6-address>] [vrfid <vrf-id>]

Ping IPv6 host


Ping an IPv6 address. Use Control-C to stop the ping command.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

ping6 <ip6-address> [vrfid <vrf-id>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address

ping6 <ip6-address> [vrfid <vrf-id>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The repeat argument specifies how many ping packets to transmit.

ping6 <ip6-address> [vrfid <vrf-id>] [repeat <number>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The repeat argument specifies how many ping packets to transmit.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The size argument specifies the size of the ping packet.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

ping6 <ip6-address> [vrfid <vrf-id>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The size argument specifies the size of the ping packet.

ping6 <ip6-address> [vrfid <vrf-id>] [size <number>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The size argument specifies the size of the ping packet.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

ping6 <ip6-address> [vrfid <vrf-id>] [size <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The repeat argument specifies how many ping packets to transmit.

The size argument specifies the size of the ping packet.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

ping6 <ip6-address> [vrfid <vrf-id>] [size <number>] [repeat <number>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The repeat argument specifies how many ping packets to transmit.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The size argument specifies the size of the ping packet.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

ping6 <ip6-address> [vrfid <vrf-id>] [size <number>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.

ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.

The repeat argument specifies how many ping packets to transmit.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The size argument specifies the size of the ping packet.

ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [repeat <number>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The repeat argument specifies how many ping packets to transmit.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.

ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The size argument specifies the size of the ping packet.

ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [size <number>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The size argument specifies the size of the ping packet.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.

ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [size <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host


Issue a ping command for IPv6 host. Ping an IPv6 address. Use Control-C to stop the ping command.

The repeat argument specifies how many ping packets to transmit.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The size argument specifies the size of the ping packet.

The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.

ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [size <number>] [repeat <number>]

Ping IPv6 host


Issue a ping command for IPv6 host.

The repeat argument specifies how many ping packets to transmit.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The size argument specifies the size of the ping packet.

The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.

ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [size <number>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]

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>

Reboot system


Reboot the system. If you specify the force argument, the system will reboot immediately without prompting for confirmation.
reboot [force]

Reset corelist related boot time option to factory 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

Reset DHCP Server IPv6 Stats Entries


Reset the DHCP Server IPv6 Stats Entries.
reset dhcp server <uuid-string-arg> ipv6-stats

Reset DHCP Server IPv4 Stats Entries


Reset the DHCP Server IPv4 Stats Entries.
reset dhcp server <uuid-string-arg> stats

Clear DNS Forwarder cache


Clear the DNS Forwarder cache
reset dns-forwarder <uuid-string-arg> cache

Reset DNS Forwarder Stats and Display the Latest Entries


Reset the DNS Forwarder Stats Entries.
reset dns-forwarder <uuid-string-arg> stats

Clear DNS Forwarder Cache Per SR


Clear the DNS Forwarder Cache Per SR.
reset dns-forwarder cache

Reset DNS Forwarder Stats and Display Entries Per SR


Reset the DNS Forwarder Stats Entries Per SR.
reset dns-forwarder stats

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

Restart service


Restart the specified service.
restart service <service-name-arg>

Restart service nsx-lastline-rapid


Restart the nsx-lastline-rapid service.
restart service nsx-lastline-rapid

Restart service Security Hub


Restart the Security Hub service.
restart service security-hub

Execute playbook resume action


Resume an upgrade after running the command start upgrade-bundle <bundle-name> playbook <playbook-file> and the system was rebooted.
resume upgrade-bundle <bundle-name-arg> playbook

Search for a string to get its mapping


Search for a string to get its mapping
search <input-str> [resource-type <resource-type-arg>]

Set API account lockout period


Sets the amount of time, in seconds, that an account will remain locked out of the API after exceeding the maximum number of failed authentication attempts.
set auth-policy api lockout-period <lockout-period-arg>

Set API account lockout reset period


In order to trigger an account lockout, all authentication failures must occur in this time window. If the reset period exprires, the failed login count is reset to zero.
set auth-policy api lockout-reset-period <lockout-reset-period-arg>

Set API maximum authentication faliures


Set the number of failed API authentication attempts that are allowed before the account is locked. If set to 0, account lockout is disabled.
set auth-policy api max-auth-failures <auth-failures-arg>

Set CLI account lockout period


Sets the amount of time, in seconds, that an account will remain locked out of the CLI after exceeding the maximum number of failed authentication attempts. While the lockout period is in effect, additional authentication attempts restart the lockout period, even if a valid password is specified.
set auth-policy cli lockout-period <cli-lockout-period-arg>

Set CLI maximum authentication faliures


Set the number of failed CLI authentication attempts that are allowed before the account is locked. If set to 0, account lockout is disabled.
set auth-policy cli max-auth-failures <cli-auth-failures-arg>

Set minimum allowable password length


Set the minimum number of characters that passwords must have. The smallest value that can be set is 8.
set auth-policy minimum-password-length <password-length-arg>

Set auth-policy vidm enabled property


Set the vidm service's enabled property.
set auth-policy vidm enabled

Set auth-policy vidm properties


Set the vidm's properties.
set auth-policy vidm hostname <hostname-or-ip-address> thumbprint <vidm-host-thumbprint-arg> client-id <vidm-client-id-arg> client-secret <vidm-client-secret-arg> node-hostname <hostname-or-ip-address>

Set auth-policy vidm lb-extern enabled property


Set the external load balancer enabled property.
set auth-policy vidm lb-extern enabled

Set security banner or message of the day


Set the security banner or message of the day.
set banner

Set the specified bridge port HA state to Active


Set the specified bridge port HA state to Active
set bridge <nsxa-uuid-lswitch-port-arg> state active

Display packet capture on session


Start a packet capture. You must have already configured the packet capture with the set capture session <session-number> interface <port-uuid-name> direction <direction> command in basic mode, or with the set capture session <session-number> direction <direction> command in path mode.

Use the get capture sessions command in basic mode to see all configured capture sessions.

set capture session <dpd-number-session-id-arg>

Monitor current port in a packet capture session


Configure a packet capture using the current interface in the path. You can change the current interface and run this command again to configure multiple interfaces on the same packet capture session.

Start the packet capture with the set capture session <session-number> command in either basic or path mode, or with the set capture session <session-number> [file <filename> [count <packet-count> [expression <expression> command in basic mode.

Use the get capture sesssions command in basic mode to see all configured capture sessions.

set capture session <dpd-number-session-id-arg> direction <capture-direction-arg>

Monitor a port in a packet capture session


Configure a packet capture using the specified interface. You can run this command multiple times to configure multiple interfaces on the same packet capture session.

To run the packet capture using this configuration, use the set capture session <session-number> [file <filename>] [count <packet-count>] [expression <expression>] command.

If you need to capture packets from only one interface, you can configure and run the packet capture with a single command: start capture interface <interface-name> [file <filename>] [count <packet-count>] [expression <expression>].

Use the get capture sessions command to see all configured capture sessions.

set capture session <dpd-number-session-id-arg> interface <variable-interface-name> direction <capture-direction-arg>

Start packet capture for the specified session


Start a packet capture. You must have already configured the packet capture with the set capture session <session-number> interface <port-uuid-name> direction <direction> command.

If you don't specify a file, the output displays 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.

Use the get capture sessions command to see all configured capture sessions.

set capture session <session-number> [file <filename>] [count <packet-count>] [expression <expression>]

Start packet capture for the specified session


Start a packet capture. You must have already configured the packet capture with the set capture session <session-number> interface <port-uuid-name> direction <direction> command.

If you don't specify a file, the output displays on the terminal.

If file is specified, the file count can be specified to enable rotating capture files, where each file will be of size 100MB. Multiple files will be bundled into single tarfile.

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.

Use the get capture sessions command to see all configured capture sessions.

set capture session <session-number> [file <filename>] [file-count <file-count>] [count <packet-count>] [expression <expression>]

Monitor a port on a certain core in a packet capture session


Configure a packet capture using the specified interface. You can run this command multiple times to configure multiple interfaces on the same packet capture session. On a LAG interface, LACP packets will also be captured when the direction of packet capture is ingress or dual.

To run the packet capture using this configuration, use the set capture session <session-number> [file <filename>] [count <packet-count>] [expression <expression>] command.

If you need to capture packets from only one interface, you can configure and run the packet capture with a single command: start capture interface <interface-name> [direction <direction>] [file <filename>] [count <packet-count>] [expression <expression>].

Use the get capture sessions command to see all configured capture sessions.

set capture session <session-number> interface <port-uuid-name> direction <capture-direction> [core <core-id>]

Set status to display datetime stamp


Set status to display datetime stamp in command output.
set cli-output datetime <datetime-arg>

Set status to display commad deprecate warning


Set status to display deprecate warning in command output.
set cli-output deprecate-warning <deprecate-warn-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>

Set inactivity timeout


Set inactivity timeout in seconds. To disable the timeout, specify 0.
set cli-timeout <timeout-arg>

Enable or disable basic authentication in API calls


Enable or disable basic authentication in API calls.
set cluster api-service basic-authentication <enabled-arg>

Set cluster API service API per-client concurrency limit, 0 to disable


Set the cluster API service API per-client concurrency limit value.
set cluster api-service client-api-concurrency-limit <api-service-client-api-concurrency-limit-arg>

Set per-client API rate limit, 0 to disable


Set the cluster API service API per-client rate limit value.
set cluster api-service client-api-rate-limit <api-service-client-api-rate-limit-arg>

Set cluster api service connection timeout, 0 to disable


Set the cluster api service connection timeout value.
set cluster api-service connection-timeout <api-service-conn-timeout-arg>

Enable or disable cookie-based authentication in API calls


Enable or disable cookie-based authentication in API calls.
set cluster api-service cookie-based-authentication <enabled-arg>

Set cluster API service API global concurrency limit, 0 to disable


Set the Cluster API ServiceAPI global concurrency limit value.
set cluster api-service global-api-concurrency-limit <api-service-global-api-concurrency-limit-arg>

Set cluster api service redirect host


Set the cluster api service redirect host.
set cluster api-service redirect-host <hostname-or-ip-address>

Set cluster api service session timeout, 0 to disable


Set the cluster api service session timeout value.
set cluster api-service session-timeout <api-service-timeout-arg>

Set Cluster Virtual IP


Set Cluster Virtual IP.
set cluster vip <ip46-address>

Set core dump file limit global config


Global limit for count to preserve latest core dump files generated for all processes or applications. By default lastest 2 core dump files will be preserved. To disable this config, set value to 0.

Note, disabling config may consume higher disk space and can cause disk outage.


set core-dump global file-limit <core-dump-limit>

Set core dump frequency threshold global config


Global limit for setting threshold in seconds for frequency of generated core dump files for all processes or applications. Any application generating core dump within threshold seconds will be neglected and new core dump request will only be in effect after expired threshold period. By default processes generating core dump within threshold frequency of 600 seconds will be denied. To disable this config, set value to 0.

Note, disabling config may consume higher disk space and can cause disk outage.


set core-dump global frequency-threshold <core-dump-limit>

Set Core dump limit config per application


Limit for count to preserve latest core dump files generated per process or application. To disable this config, set value to 0.

Note, disabling config may consume higher disk space and can cause disk outage.


set core-dump process <process-name> file-limit <core-dump-limit>

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

Configure NSX DPI Lib Log Level


Configure NSX DPI Lib Log Level.
set dpi lib-dfw logging-level <dpi-lib-log-level-arg>

Configure NSX DPI Log Level


Configure NSX DPI Log Level.
set dpi logging-level <dpi-log-level-arg>

Disable flow cache for all switches


Disable flow cache for all switches
set ens flow-table disable

Disable flow cache for a specific switch


Disable flow cache for a specific switch
set ens flow-table disable <switch-id-arg>

Enable flow cache for all switches


Enable flow cache for all switches
set ens flow-table enable

Enable flow cache for a specific switch


Enable flow cache for a specific switch
set ens flow-table enable <switch-id-arg>

Set flow table size per Lcore. Rounded up to nearest power of 2.


Set flow table size per Lcore. Rounded up to nearest power of 2.
set ens flow-table size <size-arg>

Enable/disable global FPO and configure FPO model


Enable/disable global FPO and configure FPO model
set ens fpo <fpo-config-arg>

Enable/disable per switch FPO and configure FPO model


Enable/disable per switch FPO and configure FPO model
set ens fpo <fpo-config-arg> <hs-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>

Migrate port queue between lcores


Migrate port queue between lcores
set ens port migrate <switch-id-arg> <ens-port-id-arg> <queue-id-arg> <dir-arg> <lcore-ID-arg>

Disable usePerVnicQCb option of ENS switch


Disable usePerVnicQCb option of ENS switch
set ens switch use-per-vnic-qcb disable <hs-name-arg>

Enable usePerVnicQCb option of ENS switch


Enable usePerVnicQCb option of ENS switch
set ens switch use-per-vnic-qcb enable <hs-name-arg>

Disable automatic thread load balancing


Disable automatic thread load balancing
set ens tlb status disable <hs-name-arg>

Enable automatic thread load balancing


Enable automatic thread load balancing
set ens tlb status enable <hs-name-arg>

Enable automatic thread load balancing based on metric


Enable automatic thread load balancing based on metric
set ens tlb status enable <hs-name-arg> <metric-arg>

Set Tx and Rx ring size of an uplink


Set Tx and Rx ring size of an uplink
set ens uplink ring-size <uplink-arg> <tx-ring-size-arg> <rx-ring-size-arg>

Set the acceptance of End User License Agreement


Set the acceptance of the end user license agreement.
set eula accepted

Set peer configuration for firewall active/standby


Set the peer configuration for active/standby configuration. This configuration happens automatically when firewall rules are added to an active/standby logical router via the NSX Manager web interface or API.

This command should be used for advanced configuration or troubleshooting only.

If you manually configure the active/standby peer on an edge node, you must also configure its peer.

set firewall <dpd-uuid-firewall-port-arg> local-ip <ip-address> sync-peer <nsxa-uuid-lrouter-port-arg> sync-peer-ip <ip-address>

Set mode for firewall synchronization


Set the firewall synchronization mode for active/standby configuration. This configuration happens automatically when firewall rules are added to an active/standby logical router via the NSX Manager web interface or API.

This command should be used for advanced configuration or troubleshooting only.

If you manually configure the active/standby sync, you must correctly configure both edge nodes in the active/standby configuration. One node must be configured as primary and one as secondary. One node must be configured as active, and one as passive.

set firewall <dpd-uuid-firewall-port-arg> sync-rank <fw-primary-arg> sync-mode <fw-active-arg>

Set geneve critical bit


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

Set GRUB menu timeout


Set GRUB menu timeout.
set grub menu timeout <grub-menu-timeout>

Set GRUB user password


Set GRUB user password.
set grub user <grub-username> password [<grub-password>]

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>

Set system hostname


Set the system hostname. Changing the hostname changes the command line prompt.
set hostname <hostname-arg>

Reserve hugepage for dataplane using system default


Set the hugepage reserve size for the data plane using system default.
set hugepage-reserve auto

Reserve hugepage for dataplane


Set the hugepage reserve size for the data plane.
set hugepage-reserve size <hugepage-size-arg>

Configure NSX IDS Engine Fast Log.


Configure NSX IDS Engine Fast Log.
set ids engine alertlog <ids-eng-alertlog-arg>

Configure IDS Engine Fast Log.


Configure IDS Engine Fast Log.
set ids engine fastlog <ids-eng-fastlog-arg>

Configure NSX IDS Engine Log Level


Configure NSX IDS Engine Log Level.
set ids engine logging-level <ids-eng-log-level-arg>

Set IDS logging level


Sets the IDS logging level.
set ids engine logging-level <ids-logging-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>

Configure the specified interface to use DHCP


Configure the specified interface to use DHCP. You cannot configure DHCP for NSX Manager or a controller because both must have a static IP address.
set interface <configurable-interface-name> dhcp

Configure the specified interface to use DHCP


Configure the specified interface to use DHCP.
set interface <configurable-interface-name> dhcp plane <interface-plane-arg> mode <bond-mode-arg> members <bond-slaves-arg> primary <bond-primary-arg>

Configure a bond interface and set the interface plane mode


Create bond interface and set the plane property of the interface and config the IP address. If plane is set to mgmt, it is reported as such to the management plane (MP) via MPA, and the slave devices are not consumed by dataplane for dataplane operations.

You can configure the bond interface with a DHCP or static IP address. If you configure a static IP address, make sure an appropriate network route is also configured.

set interface <configurable-interface-name> ip <cidr46-notation> gateway <gateway-ip46-address-arg> plane <interface-plane-arg> mode <bond-mode-arg> members <bond-slaves-arg> primary <bond-primary-arg>

Create VLAN network interface


Create a VLAN network interface from the specified parent interface and VLAN id. The new vlan network interface name will be of format interface. and the interface's plane property will be set to mgmt. Any existing configuration on the parent interface will be deleted. Users must use the newly created VLAN network interface for configuration.
set interface <configurable-interface-name> vlan <vlan-id> plane mgmt

Set the interface plane mode


Set the plane property of the interface and optionally configure the IP address. By default, the plane property is not configured, the dataplane component takes control of the interface for the data path and the interface is not visible to the Linux kernel. If plane is set to mgmt, it is reported as such to the management plane (MP) via MPA, and the corresponding interface is not consumed by the dataplane for dataplane operations and is available for configuration from the CLI. If it is set to debug, the dataplane does not consume the interface for dataplane operations and the interface is available for configuration from the CLI.

Optionally, you can configure the interface with a DHCP or static IP address. If you configure a static IP address, make sure an appropriate network route is also configured. You can use the optional gateway argument, or set a route using the set route command.

For NSX Manager or a controller, you cannot configure the plane property. You also cannot configure a DHCP or static IP address because both NSX Manager and a controller have a static IP address that is set at installation and cannot be changed.

set interface <interface-name> [ip <prefix-ipv46> [gateway <gateway-ip>] | dhcp] plane <plane>

Set network IP address and netmask


Configure a static IP address and netmask. Make sure an appropriate network route is also configured. You can use the optional gateway argument, or set a route using the set route command.

You cannot configure a static IP address for NSX Manager or a controller because their static IP address is set at installation and cannot be changed.

set interface <interface-name> ip <prefix-ipv46> [gateway <gateway-ip>]

Set the IPv6 interface


Set IPv6 static interface. If IPv6 interface already configured then user cannot configure it again.
set interface <interface-name> ipv6 <prefix-ipv6> [gateway <gateway-ipv6>]

Create an in-band VLAN network interface


Create an in-band VLAN network interface from the physical interface identified by the mac. If the physical interface is not already owned by the edge dataplane, the dataplane service will be restarted in order to claim the physical interface. The new inband vlan network interface name will be of format ethX.vlan and the interface's plane property will be set to mgmt. Users must use the newly created in-band VLAN network interface for configuration.
set interface mac <configurable-mac-address> vlan <vlan-id> in-band plane mgmt

Enable/disable rule log


Enable or disable rule log for a specific load balancer.
set load-balancer <lb-uuid-arg> rule-log <enabled-arg>

Enable/disable rule log


Enable or disable rule log for a specific pool.
set load-balancer <lb-uuid-arg> rule-log pool <pool-uuid-arg> <enabled-arg>

Enable/disable rule log


Enable or disable rule log for a specific virtual server.
set load-balancer <lb-uuid-arg> rule-log virtual-server <vs-uuid-arg> <enabled-arg>

Set load balancer performance profile


Apply edge parameters to accelerate load balancer performance.
set load-balancer perf-profile <perf-profile-type-arg>

Set logging-server


Configure a logging server. The logging system uses the facility codes defined in RFC 5424. Facility local7 is used for audit messages, and local6 is used for non-audit messages.
set logging-server <hostname-or-ip-address[:port]> proto <proto> level <level> [facility <facility>] [messageid <messageid>] [serverca <filename>] [clientca <filename>] [certificate <filename>] [key <filename>] [structured-data <structured-data>]

Add name server


Add a name server to the DNS configuration.
set name-servers <name-server-arg>

Set kubeconfig file of the NAPP Kubernetes cluster


Set kubeconfig file of the NAPP Kubernetes cluster. This operation overrides any existing NAPP kubeconfig file.
set napp kubeconfig

Ignore Central Config from the Manager to this appliance


Ignore Central Config from the Manager to this appliance.
set node central-config disabled

Synchronize Central Config from the Manager to this appliance


Synchronize Central Config from the Manager to this appliance.
set node central-config enabled

Add NTP server


Configure a new NTP server.
set ntp-server <hostname-or-ip-address>

Configure password complexity requirements


Configure password complexity requirements.
  • Minimum password length: minimum number of characters expected in password; user can not set their password of length lesser than this parameter. Default: 12, Minimum: 8, Maximum: 128

  • Maximum password length: maximum number of characters allowed in password; user can not set their password of length greater than this parameter. Default: 128, Minimum: 8, Maximum: 128

  • Lower characters: number of lower case characters (a..z) expected in user password.

    N < 0, to set minimum credit for having lower case character in the new password, i.e. this is the minimum number of lower case character that must be met for a new password.

    N > 0, to set maximum credit for having lower case character in the new password, i.e. per occurrence of lower case character in password will attribute additional credit of +1 towards meeting the current minimum password length value upto N lower case characters.

    N = 0, to disable the policy check.

    Default: -1, Minimum: -128, Maximum: 128

  • Upper characters: number of upper case characters (A..Z) expected in user password.

    N < 0, to set minimum credit for having upper case character in the new password, i.e. this is the minimum number of lower case characters that must be met for a new password.

    N > 0, to set maximum credit for having upper case characters in the new password, i.e. per occurrence of upper case character in password will attribute additional credit of +1 towards meeting the current minimum password length value upto N upper case characters.

    N = 0, to disable the policy check.

    Default: -1, Minimum: -128, Maximum: 128

  • Numeric characters: number of digits (0..9) expected in user password.

    N < 0, to set minimum credit for having digits in the new password, i.e. this is the minimum number of digits that must be met for a new password.

    N > 0, to set maximum credit for having digits in the new password, i.e. per occurrence of digit in password will attribute additional credit of +1 towards meeting the current minimum password length value upto N digits.

    N = 0, to disable the policy check.

    Default: -1, Minimum: -128, Maximum: 128

  • Special characters: number of special characters (!@#$&*..) expected in user password.

    N < 0, to set minimum credit for having special characters in the new password, i.e. this is the minimum number of special characters that must be met for a new password.

    N > 0, to set maximum credit for having special characters in the new password, i.e. per occurrence of special case character in password will attribute additional credit of +1 towards meeting the current minimum password length value upto N special case characters..

    N = 0, to disable the policy check.

    Default: -1, Minimum: -128, Maximum: 128

  • Minimum unique characters: number of character changes in the new password that differentiate it from the old password. To disable the check, value should be set to 0. Default: 0, Minimum: 0, Maximum: 128

  • Allowed similar consecutives: reject passwords which contain more than N same consecutive characters. To disable the check, value should be set to 0. Default: 0, Minimum: 0, Maximum: 128

  • Allowed monotonic sequence: reject passwords which contain more than N monotonic character sequences. Monotonic sequences can be '12345' or 'fedcb'. To disable the check, value should be set to 0. Default: 0, Minimum: 0, Maximum: 128

  • Hash algorithm: sets hash/cryptographic algorithm type for new passwords. Default: sha512. Enum: [ sha512, sha256 ]

  • Password remembrance: limit using a password that was used in past; users can not set the same password within the N generations. To disable the check, value should be set to 0. Default: 0, Minimum: 0

Understanding PAM's maximum credit values with an example, consider password complexity configured as follows:
  • Minimum password length: 12
  • Lower case characters: -1
  • Upper case characters: 2
  • Digits: -1
  • Special case characters: -1
above values represent a password to be atleast of length 12 (or credits) which should consist atleast 1 lower case character, atleast 1 digit, atleast 1 special case character and any number of upper case characters.
If included, for first 2 upper case characters additional credit of +2 will be secured.
Which signifies password having 1 upper case character with additional 10 or more characters of required complexity will be allowed to set where total password length would be 11 or more,
password having 2 upper case characters with additional 8 or more characters of required complexity will be allowed to set where total password length would be 10 or more,
whereas password with 3 upper case characters shall still require 7 or more characters with above minimum value requirements, as there's only maximum credit of 2 configured for upper case characters.

Few valid passwords with respect to configured example complexity requirements:

  • hivmware@123 - consists of required minimum 1 - lower case character, special case character, digit and overall length is 12
  • Hivmware@12 - consists of required minimum 1 - lower case character, special case character, digit; whereas length is 11 but inclusion of 1 upper case character attributes an extra +1 credit, hence password is valid
  • HiVmware@1 - consists of required minimum 1 - lower case character, special case character, digit; whereas length is 10 but inclusion of 2 upper case characters attributes an extra +2 credit, hence password is valid

whereas following passwords will be invalid:

  • hivmware@12 - required length of 12 is not fulfilled
  • hivmware1234 - required minimum 1 special case character is not fulfilled
  • HiVMwar@1 - there are 3 upper case characters out which only maximum 2 characters will be considered for extra credit, third occurrence of upper case character will be attributed as 1 credit only, hence the overall credit score 11 does not fulfills complexity

Note, passwords less than 8 characters are never allowed.


set password-complexity [<complexity-name> <complexity-value>]

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 repository state properties


Set current node's IP address as repository IP. This command will restart the install-upgrade service.
set repository-ip

Add IPv4 or IPv6 network route


Add IPv4 or IPv6 network route. You can also just set a gateway by specifying a prefix value of 0.0.0.0/0 for Ipv4 and ::/0 for Ipv6. Default value for the IPv6 route metric is 1024.
set route prefix <prefix> [gateway <gateway-ip>] [interface <interface-name>] [metric <ip-route-metric>]

Add IPv4 network route


Add IPv4 network route. You can also just set a gateway by specifying a prefix value of 0.0.0.0/0.
set route prefix <prefix> [gateway <gateway-ip>] [interface <interface-name>] [metric <ip-route-metric>]

Add a domain name


Add a domain name to the DNS search list.
set search-domains <search-domain-arg>

Set async replicator service logging level


Set the log level of the async replicator service.
set service async_replicator logging-level <async-replicator-level-arg>

Set Auth service logging level


Set the log level of the Auth service.
set service auth logging-level <auth-level-arg>

Set the controller service logging level


Set the log level for the controller service.
set service controller logging-level <controller-logging-level-arg>

Set log level for given logger


Set the log level for the specified component.
set service controller logging-level name <string-arg-controller> <controller-logging-level-arg>

Set log level for loggers matching regex


Set the log level for components that match the specified pattern. The pattern can be a regular expression.
set service controller logging-level pattern <string-arg-controller> <controller-logging-level-arg>

Set the Dataplane service logging level


Set the log level of the Dataplane service.
set service dataplane logging-level <edge-service-logging-level-arg>

Set the DHCP service logging level


Set the log level of the DHCP service.
set service dhcp logging-level <edge-service-logging-level-arg>

Enable/Disable DHCP pool monitor and set monitor interval in seconds


Enable or disable DHCP pool monitor and set monitor interval in seconds
set service dhcp pool-monitor <monitor-flag-arg> monitor-interval <monitor-interval-arg>

Enable or disable basic authentication in API calls.


Enable or disable basic authentication in API calls.
set service http basic-authentication <enabled-arg>

Set http API per-client concurrency limit, 0 to disable


Set the HTTP API per-client concurrency limit value.
set service http client-api-concurrency-limit <http-client-api-concurrency-limit-arg>

Set http per-client API rate limit, 0 to disable


Set the HTTP API per-client rate limit value.
set service http client-api-rate-limit <http-client-api-rate-limit-arg>

Set http service connection timeout, 0 to disable


Set the HTTP service connection timeout value.
set service http connection-timeout <http-conn-timeout-arg>

Enable or disable cookie-based authentication in API calls.


Enable or disable cookie-based authentication in API calls.
set service http cookie-based-authentication <enabled-arg>

Set http API global concurrency limit, 0 to disable


Set the HTTP API global concurrency limit value.
set service http global-api-concurrency-limit <http-global-api-concurrency-limit-arg>

Set HTTP service logging level


Set the log level of the HTTP service.
set service http logging-level <http-level-arg>

Set http service redirect host


Set the HTTP service redirect host.
set service http redirect-host <hostname-or-ip-address>

Set http service session timeout, 0 to disable


Set the HTTP service session timeout value.
set service http session-timeout <http-timeout-arg>

Enable/Disable IKE per tunnel debugging


Enable or disable ike per tunnel debug mode
set service ike debug-tunnel local-ip <ip46-address> remote-ip <ip46-address> debug-level <debug-level-arg>

Enable/Disable IKE per tunnel debugging


Enable or disable ike per tunnel debug mode
set service ike debug-tunnel local-ip <ip46-address> remote-ip <ip46-address> debug-level <debug-level-arg> follow

Set the IKE service logging level


Set the log level of the IKE service.
set service ike logging-level <edge-service-logging-level-arg>

Set install-upgrade service enabled property


Set the install-upgrade service's enabled property.
set service install-upgrade enabled

Set the Local Controller service logging level


Set the log level of the Local Controller service.
set service local-controller logging-level <edge-service-logging-level-arg>

Set manager service logging level


Set the log level of the manager service.
set service manager logging-level <manager-level-arg>

Set manager service package logging level


Set the log level of the specified package in manager service.
set service manager logging-level <manager-level-arg> package <manager-package-name-arg>

Set Monitoring service logging level


Set the log level of the Monitoring service.
set service monitoring logging-level <monitoring-level-arg>

Set Node Management service logging level


Set the log level of the Node Management service.
set service node-mgmt logging-level <node-mgmt-level-arg>

Set the log level of nsd.


Dynamically set nsd log level.
set service nsd logging-level <level>

Set the log level of NSX Agent service.


Dynamically set service daemon log level.
set service nsx-agent logging-level <nsx-agent-logging-level-arg>

Set service cfgagent 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 cfgagent metrics logging level
set service nsx-cfgagent lib-metrics logging-level <cfgagent-logging-level-arg>

Set service cfgagent nestdb logging level


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 cfgagent net logging level
set service nsx-cfgagent lib-net logging-level <cfgagent-logging-level-arg>

Set service cfgagent rpc logging level


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>

Enable/Disable ContextMux feature


Enable/Disable ContextMux feature
set service nsx-context-mux feature <context-mux-feature-type-arg> <context-mux-feature-operation-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


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 <exporter-sndemux-loglevel-arg>

Set the log level of exporter service.


Dynamically set service daemon log level.
set service nsx-exporter logging-level <level>

Set the log level of nsx-lastline-rapid


Dynamically set nsx-lastline-rapid log level
set service nsx-lastline-rapid logging-level <rapid-logging-level-arg>

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
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
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 NTP service start on boot


Configure the NTP service to start on boot.
set service ntp start-on-boot

Set log level for routing service


Set the log level of the FRR service.
set service router logging-level <edge-routing-service-logging-destination-arg> <edge-routing-service-logging-level-arg>

Set log level for routing platform service


Set the log level of the routing platform and config services.
set service routing-platform logging-level <edge-routing-platform-service-logging-level-arg>

Set the log level of EPSEC Library


Dynamically set EPSEC Library log level
set service security-hub epsec logging-level <epsec-lib-logging-level-arg>

Enable/Disable SecurityHub Fileless feature and sub-features


Enable/Disable SecurityHub Fileless feature and sub-features
set service security-hub fileless <fileless-feature-subtype-arg> <feature-operation-arg> vms <feature-target-arg>

Set the log level of security-hub


Dynamically set security-hub log level
set service security-hub logging-level <security-hub-logging-level-arg>

Set snmp service start on boot


Configure the snmp service to start on boot.
set service snmp start-on-boot

Set SSH service start on boot


Configure the SSH service to start on boot.
set service ssh start-on-boot

Set Telemetry service logging level


Set the log level of the Telemetry service.
set service telemetry logging-level <telemetry-level-arg>

Set SNMP service v1/v2c community string


Set the SNMP service v1/v2c community string in ciper text. This must be set before MIBs can be queried. Choose a string that is difficult to guess.
set snmp community

Set SNMP service v1/v2c community string


Set the SNMP service v1/v2c community string. This must be set before MIBs can be queried. Choose a string that is difficult to guess.
set snmp community <snmp-community-arg>

Set SNMP v2 Trap Targets


Set SNMP v2 Trap Targets.
set snmp v2-targets <hostname-or-ip-address-optional-port-arg> community <snmp-community-arg>

Set SNMP v3 Engine ID


Set SNMP v3 Engine ID.
set snmp v3-engine-id <v3-engine-id-arg>

Set SNMP v3 Protocols


Set SNMP v3 Protocols auth_protocol and priv_protocol.
set snmp v3-protocols auth-protocol <v3-auth-protocol-arg> priv-protocol <v3-priv-protocol-arg>

Set SNMP v3 Trap Targets


Set SNMP v3 Trap Targets.
set snmp v3-targets <hostname-or-ip-address-optional-port-arg> user <user-id-arg>

Set SNMP v3 users


Set SNMP v3 users,auth-password,priv-password in cipher text.
set snmp v3-users <user-id-arg>

Set SNMP v3 users


Set SNMP v3 users auth-password,priv-password in plain text.
set snmp v3-users <user-id-arg> auth-password <auth-password-arg> priv-password <priv-password-arg>

Set SSH Root login property


Enable SSH Root login property
set ssh root-login

Set system timezone


Set the system timezone.
set timezone <timezone-arg>

Set TLS inspection logging level for all destinations


Set TLS inspection logging level for all destinations.
set tls-inspection logging-level <edge-service-logging-level-arg>

Set TLS inspection logging level for a destination


Set TLS inspection logging level for a destination.
set tls-inspection logging-level <edge-service-logging-level-arg> destination <dest-arg>

Set the audit and guest user accounts password


Set the password for all the active users except admin and root users. This command does not require current password for the user account. The account of the target user must be ACTIVE to reset the password of the respective user. If you do not specify the 'new password' in the command line, you will be prompted for it. Note: This command can only be executed by administrator privileged user only.
set user <active-user> password [<password>]

Set number of days the user's password is valid after a password change


Set number of days the user's password is valid after a password change.
set user <node-all-username> password-expiration <password-expiration-arg>

Set number of days prior user receives warning message before password expires


Set number of days prior user receives warning message before password expires. Set 0 to disable warning messages for password expiry.
set user <node-all-username> password-expiration-warning <password-expiration-warn-arg>

Set new username for specified non-root user


Set new user name for the specified non-root user.
set user <node-all-username> username <new-node-username>

Set user password


Set the password for the specified user. If you do not specify the password on the command line, you will be prompted for it. For details on setting passwords during installation, see the NSX Installation Guide.
set user <username> password [<password> [old-password <old-password>]]

Add SSH service key to authorized_keys file for specified user


Add SSH service key to authorized_keys file for specified user. If password is not provided in the command then you are prompted to enter it. Password is required only for users root and admin.
set user <username> ssh-keys label <key-label> type <key-type> value <key-value> [password <password>]

Set VMC migration mode


Enable or disable VMC migration mode. Migration mode is used during upgrade. When an Edge is in VMC migration mode, VMC config will not be written to nestdb.
set vmc migration-mode <enabled-arg>

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

Shutdown system


Shut down the system. If you specify the force argument, the system will shut down immediately without prompting for confirmation.
shutdown [force]

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 and core. If you do not specify a file, the output is displayed on the terminal. If file is specified, the file count can be specified to enable rotating capture files, where each file will be of size 100MB. Multiple files will be bundled into single tarfile. 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.
start capture interface <interface-name> [direction <direction>] [core <core-id>] [snaplen <capture-snaplen-arg] [file <filename>] [file-count <file-count>] [expression <expression>]

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

Start packet capture on node with given parameters


Start packet capture in standalone mode with given fcport.
start capture node <cap-node-id-arg> fcport <fcport-id-arg> direction <capture-direction-arg>

Start packet capture on node with given parameters


Start packet capture in standalone mode with given fcport.
start capture node <cap-node-id-arg> fcport <fcport-id-arg> direction <capture-direction-arg> parameters <capture-options-arg>

Start packet capture on node with given parameters


Start packet capture in steam mode with given fcport.
start capture node <cap-node-id-arg> fcport <fcport-id-arg> direction <capture-direction-arg> stream-to <receiver-address-arg> port <receiver-port-arg>

Start packet capture on node with given parameters


Start packet capture in steam mode with given fcport.
start capture node <cap-node-id-arg> fcport <fcport-id-arg> direction <capture-direction-arg> stream-to <receiver-address-arg> port <receiver-port-arg> parameters <capture-options-arg>

Start packet capture on node with given filter


Start packet capture in standalone mode with given filter.
start capture node <cap-node-id-arg> filter <filter-name-arg> stage <stage-type-arg>

Start packet capture on node with given filter


Start packet capture in standalone mode with given filter.
start capture node <cap-node-id-arg> filter <filter-name-arg> stage <stage-type-arg> parameters <capture-options-arg>

Start packet capture on node with given filter


Start packet capture in stream mode with given filter.
start capture node <cap-node-id-arg> filter <filter-name-arg> stage <stage-type-arg> stream-to <receiver-address-arg> port <receiver-port-arg>

Start packet capture on node with given filter


Start packet capture in stream mode with given filter.
start capture node <cap-node-id-arg> filter <filter-name-arg> stage <stage-type-arg> stream-to <receiver-address-arg> port <receiver-port-arg> parameters <capture-options-arg>

Start packet capture on node with given parameters


Start packet capture in standalone mode with given interface.
start capture node <cap-node-id-arg> interface <cap-interface-id-arg> direction <capture-direction-arg>

Start packet capture on node with given parameters


Start packet capture in standalone mode with given interface.
start capture node <cap-node-id-arg> interface <cap-interface-id-arg> direction <capture-direction-arg> parameters <capture-options-arg>

Start packet capture on node with given parameters


Start packet capture in stream mode with given interface.
start capture node <cap-node-id-arg> interface <cap-interface-id-arg> direction <capture-direction-arg> stream-to <receiver-address-arg> port <receiver-port-arg>

Start packet capture on node with given parameters


Start packet capture in stream mode with given interface.
start capture node <cap-node-id-arg> interface <cap-interface-id-arg> direction <capture-direction-arg> stream-to <receiver-address-arg> port <receiver-port-arg> parameters <capture-options-arg>

Start packet capture on node with given parameters


Start packet capture in standalone mode with given pnic.
start capture node <cap-node-id-arg> pnic <pnic-value-arg> direction <capture-direction-arg>

Start packet capture on node with given parameters


Start packet capture in standalone mode with given pnic.
start capture node <cap-node-id-arg> pnic <pnic-value-arg> direction <capture-direction-arg> parameters <capture-options-arg>

Start packet capture on node with given parameters


Start packet capture in steam mode with given pnic.
start capture node <cap-node-id-arg> pnic <pnic-value-arg> direction <capture-direction-arg> stream-to <receiver-address-arg> port <receiver-port-arg>

Start packet capture on node with given parameters


Start packet capture in steam mode with given pnic.
start capture node <cap-node-id-arg> pnic <pnic-value-arg> direction <capture-direction-arg> stream-to <receiver-address-arg> port <receiver-port-arg> parameters <capture-options-arg>

Start packet capture on ESXi node with given parameters


Start packet capture in standalone mode with given parameters.
start capture node <cap-node-id-arg> vdrport <vdrport-id-arg> direction <capture-direction-arg>

Start packet capture on ESXi node with given parameters


Start packet capture in standalone mode with given parameters.
start capture node <cap-node-id-arg> vdrport <vdrport-id-arg> direction <capture-direction-arg> parameters <capture-options-arg>

Start packet capture on ESXi node with given parameters


Start packet capture on ESXi node with given parameters.
start capture node <cap-node-id-arg> vdrport <vdrport-id-arg> direction <capture-direction-arg> stream-to <receiver-address-arg> port <receiver-port-arg>

Start packet capture on ESXi node with given parameters


Start packet capture on ESXi node with given parameters.
start capture node <cap-node-id-arg> vdrport <vdrport-id-arg> direction <capture-direction-arg> stream-to <receiver-address-arg> port <receiver-port-arg> parameters <capture-options-arg>

Start packet capture on node with given parameters


Start packet capture in standalone mode with given vif.
start capture node <cap-node-id-arg> vif <vif-id-arg> direction <capture-direction-arg>

Start packet capture on node with given parameters


Start packet capture in standalone mode with given vif.
start capture node <cap-node-id-arg> vif <vif-id-arg> direction <capture-direction-arg> parameters <capture-options-arg>

Start packet capture on node with given parameters


Start packet capture in stream mode with given vif.
start capture node <cap-node-id-arg> vif <vif-id-arg> direction <capture-direction-arg> stream-to <receiver-address-arg> port <receiver-port-arg>

Start packet capture on node with given parameters


Start packet capture in stream mode with given vif.
start capture node <cap-node-id-arg> vif <vif-id-arg> direction <capture-direction-arg> stream-to <receiver-address-arg> port <receiver-port-arg> parameters <capture-options-arg>

Start packet capture on ESXi node with given vmknic


Start packet capture in standalone mode on ESXi node with given vmknic.
start capture node <cap-node-id-arg> vmknic <vmknic-id-arg> direction <capture-direction-arg>

Start packet capture on ESXi node with given parameters


Start packet capture in standalone mode with given parameters.
start capture node <cap-node-id-arg> vmknic <vmknic-id-arg> direction <capture-direction-arg> parameters <capture-options-arg>

Start packet capture on ESXi node with given vmknic


Start packet capture on ESXi node with given vmknic.
start capture node <cap-node-id-arg> vmknic <vmknic-id-arg> direction <capture-direction-arg> stream-to <receiver-address-arg> port <receiver-port-arg>

Start packet capture on ESXi node with given vmknic


Start packet capture on ESXi node with given vmknic.
start capture node <cap-node-id-arg> vmknic <vmknic-id-arg> direction <capture-direction-arg> stream-to <receiver-address-arg> port <receiver-port-arg> parameters <capture-options-arg>

Start packet capture on ESXi node with given vmnic


Start packet capture in standalone mode on ESXi node with given vmnic.
start capture node <cap-node-id-arg> vmnic <vmnic-id-arg> direction <capture-direction-arg>

Start packet capture on ESXi node with given parameters


Start packet capture in standalone mode with given parameters.
start capture node <cap-node-id-arg> vmnic <vmnic-id-arg> direction <capture-direction-arg> parameters <capture-options-arg>

Start packet capture on ESXi node with given vmnic


Start packet capture on ESXi node with given vmnic.
start capture node <cap-node-id-arg> vmnic <vmnic-id-arg> direction <capture-direction-arg> stream-to <receiver-address-arg> port <receiver-port-arg>

Start packet capture on ESXi node with given vmnic


Start packet capture on ESXi node with given vmnic.
start capture node <cap-node-id-arg> vmnic <vmnic-id-arg> direction <capture-direction-arg> stream-to <receiver-address-arg> port <receiver-port-arg> parameters <capture-options-arg>

Start packet capture on ESXi node with given vnic


Start packet capture in standalone mode on ESXi node with given vnic.
start capture node <cap-node-id-arg> vnic <vnic-id-arg> direction <capture-direction-arg>

Start packet capture on ESXi node with given parameters


Start packet capture in standalone mode with given parameters.
start capture node <cap-node-id-arg> vnic <vnic-id-arg> direction <capture-direction-arg> parameters <capture-options-arg>

Start packet capture on ESXi node with given vnic


Start packet capture on ESXi node with given vnic.
start capture node <cap-node-id-arg> vnic <vnic-id-arg> direction <capture-direction-arg> stream-to <receiver-address-arg> port <receiver-port-arg>

Start packet capture on ESXi node with given vnic


Start packet capture on ESXi node with given vnic.
start capture node <cap-node-id-arg> vnic <vnic-id-arg> direction <capture-direction-arg> stream-to <receiver-address-arg> port <receiver-port-arg> parameters <capture-options-arg>

Show packet capture on all interfaces


Display a packet capture on all available interfaces.
start capture trace

Start firewall synchronization for the logical router interface


Start firewall synchronization for the logical router interface. Synchronization happens automatically, but you can optionally start a bulk sync to more quickly synchronize a new or restarted standby router. The sync must be started from the primary router.
start firewall <dpd-uuid-firewall-port-arg> bulk-sync

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

Start a runbook invocation with multiple arguments specified


Start an invocation of a specified runbook. You can also pass arguments for the certain invocation. The specification of runbook parameters can vary as per individual runbook and can be found by command `get runbook help`. To specify a parameter "foo" with value "bar", the argument can be written in the following syntax: `--foo bar`
start invocation runbook <runbook-id> [runbook-arg <runbook-param>]

Recover search service


Execute recover of search service datastore.
start search recover

Re-sync search service


Execute full or partial re-sync of search service datastore.
start search resync <search-scope-arg>

Start service


Start the specified service.
start service <service-name-arg>

Start service nsx-lastline-rapid


Start the nsx-lastline-rapid service.
start service nsx-lastline-rapid

Start service Security Hub


Start the Security Hub service.
start service security-hub

Execute a playbook given a valid playbook file


Start an upgrade with the specified upgrade bundle and according to the specified playbook.
start upgrade-bundle <bundle-name-arg> playbook <playbook-file-arg>

Stop packet capture


Stop packet capture by session id.
stop capture session <session-id-arg>

Stop firewall bulk synchronization for the logical router interface


Stop firewall bulk synchronization for the logical router interface.
stop firewall <dpd-uuid-firewall-port-arg> bulk-sync

Stop service


Stop the specified service.
stop service <service name> [force]

Stop service nsx-lastline-rapid


Stop the nsx-lastline-rapid service.
stop service nsx-lastline-rapid

Stop service Security Hub


Stop the Security Hub service.
stop service security-hub

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

Move to the top of the path


Move to the top of the path. The arrow moves to show which interface is current.
top

Trace an injected packet


Trace the specified packet.
traceflow <dpd-uuid-name-port-arg> <dpd-string-base64-arg>

traceroute


Trace the route to the specified IPv4 address or host.
traceroute <hostname-or-ip-address>

traceroute


Trace the route to the specified IPv4 address or host.
traceroute <ip-address>

traceroute


Trace the route to the specified IP address.

The maxttl specifies the maximum time-to-live, or maximum number of routers the traceroute packet will traverse.

The source argument specifies which source IP address to use for traceroute. This may be required in some circumstances for traceroute to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, traceroute packets from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the traceroute packets will reach the virtual machines.

traceroute <ip-address> [source <ip-address>] [maxttl <number>]

traceroute


Trace the route to the specified IP address. The maxttl specifies the maximum time-to-live, or maximum number of routers the traceroute packet will traverse.

The vrfid argument specifies which VRF to send the traceroute packets from. You can get a list of available VRFs with the get logical-routers command.

The source argument specifies which source IP address to use for traceroute. This may be required in some circumstances for traceroute to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, traceroute packets from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the traceroute packets will reach the virtual machines.

traceroute <ip-address> [source <ip-address>] [maxttl <number>] [vrfid <vrf-id>]

traceroute6


Trace the route to target IPv6 address.
traceroute6 <ip6-address>

traceroute6


Trace the route to the specified IPv6 address. The maxttl specifies the maximum time-to-live, or maximum number of routers the traceroute packet will traverse.
traceroute6 <ip6-address> [maxttl <number>]

traceroute6


Trace the route to the specified IPv6 address.

The source argument specifies which source IP address to use for traceroute. This may be required in some circumstances for traceroute to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, traceroute packets from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the traceroute packets will reach the virtual machines.

traceroute6 <ip6-address> [source <ip6-address>]

traceroute6


Trace the route to the specified IPv6 address.

The maxttl specifies the maximum time-to-live, or maximum number of routers the traceroute packet will traverse.

The source argument specifies which source IP address to use for traceroute. This may be required in some circumstances for traceroute to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, traceroute packets from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the traceroute packets will reach the virtual machines.

traceroute6 <ip6-address> [source <ip6-address>] [maxttl <number>]

traceroute6


Trace the route to the specified IPv6 address.

The vrfid argument specifies which VRF to send the traceroute packets from. You can get a list of available VRFs with the get logical-routers command.

traceroute6 <ip6-address> [vrfid <vrf-id>]

traceroute6


Trace the route to the specified IPv6 address. The maxttl specifies the maximum time-to-live, or maximum number of routers the traceroute packet will traverse.

The vrfid argument specifies which VRF to send the traceroute packets from. You can get a list of available VRFs with the get logical-routers command.

traceroute6 <ip6-address> [vrfid <vrf-id>] [maxttl <number>]

traceroute6


Trace the route to the specified IPv6 address.

The vrfid argument specifies which VRF to send the traceroute packets from. You can get a list of available VRFs with the get logical-routers command.

The source argument specifies which source IP address to use for traceroute. This may be required in some circumstances for traceroute to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, traceroute packets from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the traceroute packets will reach the virtual machines.

traceroute6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>]

traceroute6


Trace the route to the specified IPv6 address.

The maxttl specifies the maximum time-to-live, or maximum number of routers the traceroute packet will traverse.

The vrfid argument specifies which VRF to send the traceroute packets from. You can get a list of available VRFs with the get logical-routers command.

The source argument specifies which source IP address to use for traceroute. This may be required in some circumstances for traceroute to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, traceroute packets from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the traceroute packets will reach the virtual machines.

traceroute6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [maxttl <number>]

Move up the path


Move up the path. The arrow moves to show which interface is current.
up

VDS Migrate Apply Topology


VDS Migrate Apply Topology
vds-migrate apply-topology (Deprecated)

VDS Migrate delete Topology


VDS Migrate delete Topology
vds-migrate delete-topology (Deprecated)

VDS Migrate Disable


VDS Migrate Disable
vds-migrate disable-migrate (Deprecated)

Migrate NVDS to VDS By Cluster Id


Migrate NVDS to VDS By Cluster Id
vds-migrate esxi-cluster-id <cluster-id> [maintenance-timeout <timeout>] (Deprecated)

Migrate NVDS to VDS By Cluster Name


Migrate NVDS to VDS By Cluster Name
vds-migrate esxi-cluster-name <cluster-name> [maintenance-timeout <timeout>] (Deprecated)

VDS Migrate Precheck


VDS Migrate Precheck
vds-migrate precheck (Deprecated)

VDS Migrate Show Topology


VDS Migrate Show Topology
vds-migrate show-topology (Deprecated)

Migrate NVDS to VDS By Tn List


Migrate NVDS to VDS By Tn List
vds-migrate tn-list <configfile> [maintenance-timeout <timeout>] (Deprecated)

Verify controllers certificate


Verify controllers certificate from configuration file in the host.
verify controllers certificate

Verify NSX Edge service container image file


Verify NSX Edge service container image file.
verify image <configurable-image-filename>

Verify all configured logging servers


Verify iptables rules for all logging servers and update if needed
verify logging-servers

Verify managers certificate


Verify managers certificate from configuration file in the host.
verify managers certificate

Verify and extract bundle to default location


Verify and extract the specified upgrade bundle to the default location.
verify upgrade-bundle <bundle-name-arg>

Enter VRF context mode.


This command enters VRF context mode. You can find VRF IDs with the get logical-routers command.
vrf <dpd-uuid-vrfid-lrouter-arg>

Total commands: 1734