NSX Command-Line Interface Reference
Copyright © 2014-2025 VMware, Inc. All rights reserved. Copyright and trademark information.
EN-002526-00
NSX Command-Line Interface Reference
NSX 9.0.0
Table of Contents
get host-switch <hs-name-arg> dvport <dvport-id-arg> mcast-filter <entry-mode-arg> <entry-group-arg>
get ipsecvpn ikesa negotiating logical-router <uuid-string-arg> sessionid <ipsec-vpn-session-id-arg>
get segments datapath-stats module <mod_name_arg_esx> counter <ctr_name_arg_esx> description verbose
About This Book
The NSX Command-Line Interface Reference describes how to use the NSX
Command-Line Interface (CLI) and includes examples and command overviews.
Intended Audience
The information in this guide is written
for experienced systems and network administrators who are familiar with virtual
machine technology and virtual datacenter operations.
VMware Technical Publications Glossary
VMware Technical Publications provides a glossary of terms that might
be unfamiliar to you. For definitions of terms as they are used in
VMware technical documentation go to
http://www.vmware.com/support/pubs.
Document Feedback
VMware welcomes your suggestions for improving our documentation.
If you have comments, send your feedback to
[email protected].
Introduction to the NSX CLI
Each NSX virtual appliance contains a command-line interface (CLI).
The command syntax and output format of NSX commands are not guaranteed
to be the same from release to release. If you are automating tasks, please use the
API. See the NSX API Guide for details.
Logging In and Out of the CLI
Before you can run CLI commands, you must connect to
an NSX virtual appliance. You can connect to the console or through
SSH.
If you did not enable SSH while installing the appliance, you can use the
set service ssh start-on-boot command to enable
the SSH service.
To log out, type exit from Basic mode.
CLI Command Modes
The commands available to you at any given time depend on the mode you
are currently in.
Important Note
Starting with NSX 2.1, the NSX Manager GUI uses the term N-VDS
(NSX managed virtual distributed switch) to refer to what was known as
host switch in previous releases. In this document, the term
host switch is still used. The two terms are synonyms.
NSX CLI Commands
Activates specified local user account.
| Option | Description |
|---|---|
| <username> | Username of user |
| <password> | Password of user |
Example
nsx-manager> activate user testuser password Str0ng_Pwd!Wins$
nsx-manager>
or
nsx-manager> activate user testuser password
New password:
Confirm new password:
nsx-manager>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
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.| Option | Description |
|---|---|
| <username> | Local user username argument Allowed pattern: ^((?!audit$).)+$ |
| <password-expiration-warn-days> | Number of days password warn messages before change (1 - 9999) |
| <password-expiration-days> | Number of days password valid after change (1 - 9999) |
| <password> | Password of user |
| <full-name> | Full name of the user |
Example
nsx-manager> add user testuser full-name "Test User" password Str0ng_Pwd!Wins$
nsx-manager>
or
nsx-manager> add user testuser full-name "Test User" password-expiration-frequency 90 password-reset-required
nsx-manager>
or
nsx-manager> add user testuser password Str0ng_Pwd!Wins$ password-expiration-warning 7
nsx-manager>
Mode
Basic
Availability
Global Manager, Manager
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.| Option | Description |
|---|---|
| <password-expiration-warn-days> | Number of days password warn messages before change (1 - 9999) |
| <password-expiration-days> | Number of days password valid after change (1 - 9999) |
| <password> | Password of user |
| <full-name> | Full name of the user |
| <username> | Local user username argument Allowed pattern: ^((?!audit$).)+$ |
Example
nsx-manager> add user audit username audit_user full-name "Audit User" password Str0ng_Pwd!Wins$
nsx-manager>
or
nsx-manager> add user audit password-expiration-frequency 90 password-reset-required
nsx-manager>
or
nsx-manager> add user audit password Str0ng_Pwd!Wins$ password-expiration-warning 7
nsx-manager>
Mode
Basic
Availability
Global Manager, Manager
Move to the bottom of the path. The arrow moves to show which interface is current.
Example
nsx-edge-1(path)> bottom
interface : ee749ae4-93cc-418d-b5f5-e94ad4723862 : loopback + SR-ContainerT1
interface : a19e4784-92dc-4731-bbf7-11985d348c34 : uplink + ContainerT0-ContainerT1-t1_lrp
port : 617770c9-ec83-4229-98e1-41ff66068ecf : vni:65537 + ContainerT0-ContainerT1-t1_lrp
port : 683f7226-6711-4d6f-80c4-0a1fe6412745 : vni:65537 + ContainerT0-ContainerT1-t0_lrp
interface : c4adf8c5-edec-448f-a45a-2b7113e8704f : downlink + ContainerT0-ContainerT1-t0_lrp
interface : 64b419b5-4f55-4e75-9b1e-d00f3a56b5e2 : uplink + tier0-interface200
->port : 6858f1bc-7965-45e8-bc47-60f9a0101d57 : vlan:untagged + tier0-interface200
Mode
Path
Availability
Autonomous Edge, Edge
Clear the vidm service's enabled property.
Example
nsx-manager-1> clear auth-policy vidm enabled
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Clear the external load balancer enabled property.
Example
nsx-manager-1> clear auth-policy vidm lb-extern enabled
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Clear the security banner or message of the day. The banner is reset to the system default banner.
Example
nsx> clear banner
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Clear the statistics for the specified BFD session
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> clear bfd-session local-ip 192.168.250.60 remote-ip 192.168.250.61 stats
nsx-edge-1>
Mode
Basic
Availability
Autonomous Edge, Edge
Clear the statistics for all BFD sessions.
Example
nsx-edge-1> clear bfd-session stats
nsx-edge-1>
Mode
Basic
Availability
Autonomous Edge, Edge
Reset specific BGP neighbor session.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1(tier0_sr)> clear bgp 2005::2828:280a
nsx-edge-1(tier0_sr)>
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Reset all BGP neighbor sessions.
Example
nsx-edge-1(tier0_sr)> clear bgp neighbors
nsx-edge-1(tier0_sr)>
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Clear the LACP stats for the bond interface with the specified name.
| Option | Description |
|---|---|
| <bond-name> | Datapath device name argument |
Example
nsx-edge-1> clear bond bond0 stats
Mode
Basic
Availability
Autonomous Edge, Edge
After user has resolved issues which cause bootup error, he/she can call this CLI to clear the bootup error message.
Example
nsx> clear bootup error message
nsx>
Mode
Basic
Availability
Autonomous Edge
Clear the cluster api service redirect host.
Example
nsx-manager-1> clear cluster api-service redirect-host
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Clear Cluster Virtual IPv4 address.
Example
nsx-manager-1> clear cluster vip
Mode
Basic
Availability
Global Manager, Manager
Clears both cluster Virtual IPv4 & IPv6 addresses.
Example
nsx-manager-1> clear cluster vip all
Mode
Basic
Availability
Global Manager, Manager
Clear Cluster Virtual IPv6 address.
Example
nsx-manager-1> clear cluster vip ipv6
Mode
Basic
Availability
Global Manager, Manager
Clear flow cache statistics for all fastpath cores.
Example
nsx-edge-1> clear dataplane flow-cache stats
nsx-edge-1>
Mode
Basic
Availability
Autonomous Edge, Edge
Clear the Edge cluster state history.
Example
nsx-edge-1> clear edge-cluster history state
nsx-edge-1>
Mode
Basic
Availability
Autonomous Edge, Edge
clear IDS Engine Event stats.
Example
rahum-svc> clear edgeids events stats
Status OK
Mode
Availability
Edge
Clear flow table for all fastpaths
Example
esx-1> clear ens flow-table
esx-1>
Mode
Basic
Availability
ESXi
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.| Option | Description |
|---|---|
| <uuid> | UUID argument |
Example
nsx-edge-1> clear gateway 4e425c9e-09c6-4021-bbc7-fab2895a2c09 high-availability history state
nsx-edge-1>
Mode
Basic
Availability
Autonomous Edge, Edge
Clear the high availability state history for the gateway in the VRF context.
Example
nsx-edge-1(tier1_sr)> clear gateway high-availability history state
nsx-edge-1(tier1_sr)>
Mode
Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Clear the statistic counters for the specified gateway interface.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> clear gateway interface 9d96cb16-6d03-4117-a511-a4aeb3e6a060 stats
nsx-edge-1>
Mode
Basic
Availability
Autonomous Edge, Edge
Clear statistics for the specified high-availability channel
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> clear high-availability channel local-ip 30.0.246.232 remote-ip 30.0.29.0 stats
Mode
Basic
Availability
Autonomous Edge, Edge
Clear statistics for all high-availability channels.
Example
nsx-edge-1> clear high-availability channels stats
Mode
Basic
Availability
Autonomous Edge, Edge
Clear the high availability state history for the logical router in the VRF context.
Example
nsx-edge-1(tier1_sr)> clear high-availability history state
nsx-edge-1(tier1_sr)>
Mode
Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Clear statistics for the specified high-availability session
| Option | Description |
|---|---|
| <service-id> | Service id (0-65535) |
Example
nsx-edge-1> clear high-availability session local-service-id 101 peer-service-id 101 stats
Mode
Basic
Availability
Autonomous Edge, Edge
Clear statistics for all high-availability sessions.
Example
nsx-edge-1> clear high-availability sessions stats
Mode
Basic
Availability
Autonomous Edge, Edge
Clear NSX Intelligence flows statistics.
Example
>clear intelligence flows stats
Clear NSX Intelligence stats: successful
Mode
Basic
Availability
ESXi, KVM
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.
| Option | Description |
|---|---|
| <interface-name> | Configurable network interface argument |
Example
nsx-edge> clear interface eth0.11
Deleted interface eth0.11. The system does not have a management
IP address, you may configure one.
nsx-edge> clear interface bond0
Deleted interface bond0. The system does not have a management
IP address, you may configure one.
nsx-edge> clear interface bond0.50
Deleted interface bond0.50. The system does not have a management
IP address, you may configure one.
Mode
Basic
Availability
Autonomous Edge, Edge
Remove all network configuration from the specified interface.
| Option | Description |
|---|---|
| <interface-name> | Configurable network interface argument |
Example
nsx-edge> clear interface eth0 ip
nsx-edge>
Mode
Basic
Availability
Autonomous Edge, Edge
Clear the network interface plane configuration.
| Option | Description |
|---|---|
| <interface-name> | Configurable network interface argument |
Example
nsx-edge> clear interface eth0 plane
nsx-edge>
Mode
Basic
Availability
Autonomous Edge, Edge
Deletes LLDP Neighbor information on all devices.
Example
nsx-edge-1> clear lldp neighbors
Mode
Basic
Availability
Autonomous Edge, Edge
Deletes LLDP Neighbor information on given device.
| Option | Description |
|---|---|
| <interface-name> | LLDP interface argument |
Example
nsx-edge-1> clear lldp neighbors eth0
Mode
Basic
Availability
Autonomous Edge, Edge
Deletes LLDP Statistics on all devices.
Example
nsx-edge-1> clear lldp stats
Mode
Basic
Availability
Autonomous Edge, Edge
Deletes LLDP Statistics on given device.
| Option | Description |
|---|---|
| <interface-name> | LLDP interface argument |
Example
nsx-edge-1> clear lldp stats eth0
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <pool-uuid> | Pool UUID argument |
Example
nsx-edge-1> clear load-balancer ed785df6-2143-4944-b918-66470886be83 pool 46e57906-413e-4075-98b1-49a3e73a2c62 stats
Mode
Basic
Availability
ESXi
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.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> clear load-balancer ed785df6-2143-4944-b918-66470886be83 pools stats
Mode
Basic
Availability
ESXi
Clear the statistics for a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> clear load-balancer ed785df6-2143-4944-b918-66470886be83 stats
Mode
Basic
Availability
ESXi
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.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
Example
nsx-edge-1> clear load-balancer ed785df6-2143-4944-b918-66470886be83 virtual-server 46e57906-413e-4075-98b1-49a3e73a2c62 stats
Mode
Basic
Availability
ESXi
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.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> clear load-balancer ed785df6-2143-4944-b918-66470886be83 virtual-servers stats
Mode
Basic
Availability
ESXi
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.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <pool-uuid> | Pool UUID argument |
Example
nsx-edge-1> clear load-balancer ed785df6-2143-4944-b918-66470886be83 pool 46e57906-413e-4075-98b1-49a3e73a2c62 stats
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> clear load-balancer ed785df6-2143-4944-b918-66470886be83 pools stats
Mode
Basic
Availability
Autonomous Edge, Edge
Clear the statistics for a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> clear load-balancer ed785df6-2143-4944-b918-66470886be83 stats
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
Example
nsx-edge-1> clear load-balancer ed785df6-2143-4944-b918-66470886be83 virtual-server 46e57906-413e-4075-98b1-49a3e73a2c62 stats
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> clear load-balancer ed785df6-2143-4944-b918-66470886be83 virtual-servers stats
Mode
Basic
Availability
Autonomous Edge, Edge
Clear load balancer performance profile parameter settings from edge.
Example
nsx-edge-1> clear load-balancer perf-profile
Mode
Basic
Availability
Autonomous Edge, Edge
Clear all logging server configuration.
Example
nsx> clear logging-servers
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
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.| Option | Description |
|---|---|
| <uuid> | UUID argument |
Example
nsx-edge-1> clear logical-router 4e425c9e-09c6-4021-bbc7-fab2895a2c09 high-availability history state
nsx-edge-1>
Mode
Basic
Availability
Autonomous Edge, Edge
Clear the statistic counters for the specified logical router interface.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> clear logical-router interface 9d96cb16-6d03-4117-a511-a4aeb3e6a060 stats
nsx-edge-1>
Mode
Basic
Availability
Autonomous Edge, Edge
Deletes all NSX configuration and modules from the host only. Please delete the corresponding transport node entries from NSX manager using GUI/API.
Example
host-1> clear management-plane
host-1>
Mode
Basic
Availability
ESXi, KVM
Clear all name servers from the DNS configuration.
Example
nsx> clear name-servers
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Reset specific OSPF neighbor session.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1(tier0_sr)> clear ospf 40.40.40.10
nsx-edge-1(tier0_sr)>
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Reset all OSPF neighbor sessions.
Example
nsx-edge-1(tier0_sr)> clear ospf neighbors
nsx-edge-1(tier0_sr)>
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Resets configured password complexity requirements to default.
Example
nsx> clear password-complexity
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Clear statistics for the specified physical port.
| Option | Description |
|---|---|
| <physical-port-name> | Datapath String argument |
Example
nsx-edge-1> clear physical-port fp-eth2 stats
nsx-edge-1>
Mode
Basic
Availability
Autonomous Edge, Edge
Clear all PIM BSM data & messages.
Example
nsx-edge-1(tier0_sr)> clear pim bsr-data
nsx-edge-1(tier0_sr)>
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Remove all domain names from the DNS search list.
Example
nsx> clear search-domains
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Clear the HTTP service redirect host.
Example
nsx-manager-1> clear service http redirect-host
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Clear the install-upgrade service's enabled property.
Example
nsx-manager-1> clear service install-upgrade enabled
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Clear the log levels of the manager service.
Example
nsx-manager-1> clear service manager logging-level
Mode
Basic
Availability
Global Manager, Manager
Configure the NTP service to not start on boot.
Example
nsx> clear service ntp start-on-boot
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Configure the snmp service to not start on boot.
Example
nsx> clear service snmp start-on-boot
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Configure the SSH service to not start on boot.
Example
nsx> clear service ssh start-on-boot
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Disable SSH Root login property
Example
nsx> clear ssh root-login
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Delete all TLS inspection cached certificates.
Example
nsx-edge-1> clear tls-inspection cached-certificates
Mode
Basic
Availability
Edge
Delete TLS inspection cached certificates.
| Option | Description |
|---|---|
| <cached-certificate-id> | Certificate id string argument Allowed pattern: ^([0-9a-f]*)$ |
Example
nsx-edge-1> clear tls-inspection cached-certificates 01bb55d577e05b05526f8e801b3f2a52229e1419
Mode
Basic
Availability
Edge
Clear all TLS inspection error stats.
Example
nsx-edge-1> clear tls-inspection errors
% Stats cleared
Mode
Basic
Availability
Edge
Clear all TLS inspection traffic stats.
Example
nsx-edge-1> clear tls-inspection traffic-stats
% Stats cleared
Mode
Basic
Availability
Edge
Disable password expiration for the user.
| Option | Description |
|---|---|
| <username> | Username of user |
Example
nsx> clear user audit password-expiration
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Disable password expiration warning for the user.
| Option | Description |
|---|---|
| <username> | Username of user |
Example
nsx> clear user audit password-expiration-warning
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Copy system generated core dumps to a remote destination.
| Option | Description |
|---|---|
| <filepath> | Path of generated core dump file |
| <url> | Remote file url (e.g. scp://username@ip_address/filepath/filename) |
Example
nsx> copy core-dump core.nginx.1559278043.gz url scp://[email protected]/tmp/
[email protected]'s password:
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Copy a local file to a remote destination.
| Option | Description |
|---|---|
| <filename> | Existing file argument |
| <url> | Remote file url (e.g. scp://username@ip_address/filepath/filename) |
Example
nsx> copy file support-bundle-0.tgz url scp://[email protected]/home/admin/
[email protected]'s password:
nsx>
or
nsx> copy file support-bundle-0.tgz url scp://admin@[fd01:1:2:2919:0:a:0:d03]/home/admin/
admin@fd01:1:2:2919:0:a:0:d03's password:
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, NSX Cloud VM, Manager, NSX on VMC
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
To specify IPv6 remote addresses, url server should be enclosed between square brackets.
file argument to specify a different destination file name.To specify IPv6 remote addresses, url server should be enclosed between square brackets.
| Option | Description |
|---|---|
| <url> | Remote file url (e.g. scp://username@ip_address/filepath/filename) |
| <filename> | Filename argument Allowed pattern: ^[^/ *;&|]+$ |
Example
nsx> copy url scp://[email protected]/home/admin/file-0.txt
[email protected]'s password:
nsx>
or
nsx> copy url scp://[email protected]/home/admin/file-1.txt file newfile-1.txt
[email protected]'s password:
nsx>
or
nsx> copy url scp://admin@[fd01:1:2:2919:0:a:0:d03]/home/admin/file-1.txt file newfile-1.txt
admin@fd01:1:2:2919:0:a:0:d03's password:
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, NSX Cloud VM, Manager, NSX on VMC
Copy a remote https url file to local file using same filename.
| Option | Description |
|---|---|
| <url> | Remote file url (e.g. scp://username@ip_address/filepath/filename) |
| <thumbprint> | Remote host thumbprint |
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, NSX Cloud VM, Manager, NSX on VMC
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.
Example
nsx-manager-1> deactivate cluster
Are you sure you want to remove all other nodes from this cluster (yes/no)
Cluster has been deactivated.
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
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.
| Option | Description |
|---|---|
| <username> | Username of user |
Example
nsx-manager> deactivate user testuser
nsx-manager>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Delete all packet capture sessions.
Example
nsx-manager> del all capture sessions
Session Count: 1
Session ID: 62fd4a28-5463-4f92-af34-42e55547ec7e
Session Status: deleted
Start Time: 2018-07-31 07:09:36
Stop Time: 2018-07-31 07:09:51
Request:
Node: af1c570b-f78d-4ea3-8858-219f9fe73511
Capture Type: vmknic
Capture Value: vmk0
Capture Direction: input
Capture Mode: standalone
Mode
Basic
Availability
Global Manager, Manager
Delete a packet capture session configuration.
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
Example
kvm-1> del capture session 1
kvm-1>
or
nsx-edge-1> del capture session 1
nsx-edge-1>
Mode
Basic
Availability
Autonomous Edge, Edge, KVM
Delete a packet capture session configuration.
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
Example
nsx-edge-1(path)> del capture session 1
nsx-edge-1(path)>
Mode
Path
Availability
Autonomous Edge, Edge
Delete the specified interface from a packet capture session configuration. If you are only monitoring one interface, this deletes the monitoring session configuration.
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
| <port-uuid-name> | Datapath String argument |
Example
nsx-edge-1> del capture session 1 interface fp-eth1
nsx-edge-1>
Mode
Basic
Availability
Autonomous Edge, Edge
Delete the specified interface from a packet capture session configuration. If you are only monitoring one interface, this deletes the monitoring session configuration.
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
| <interface-name> | Network interface argument |
Example
kvm-1> del capture session 1 interface b592a7c8-4e21-493e-b0fc-0b1d152c949c
kvm-1>
Mode
Basic
Availability
KVM
Delete a packet capture session configuration.
| Option | Description |
|---|---|
| <esx-session-id-arg> | Packet Capture session id parameter |
Example
esx-1> del capture session 1
esx-1>
Mode
Basic
Availability
ESXi
Delete the specified packet capture session.
| Option | Description |
|---|---|
| <session-id-arg> | Packet capture session id parameter |
Example
nsx-manager> del capture session 2e4d5f24-88a9-4d88-8af0-e588833064d9
Session ID: 2e4d5f24-88a9-4d88-8af0-e588833064d9
Session Status: deleted
Start Time: 2018-07-31 07:10:35
Stop Time: 2018-07-31 07:10:45
Request:
Node: af1c570b-f78d-4ea3-8858-219f9fe73511
Capture Type: vmknic
Capture Value: vmk0
Capture Direction: input
Capture Mode: standalone
Mode
Basic
Availability
Global Manager, Manager
Delete core dump files in the system.
| Option | Description |
|---|---|
| <filepath> | Path of generated core dump file |
Example
nsx> del core-dump /var/log/core/core.nginx.1559278043.gz
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, ESXi, KVM, NSX Cloud VM, Manager, NSX on VMC
Delete a local file.
| Option | Description |
|---|---|
| <filepattern> | Existing file or pattern argument |
Example
nsx> del file support-bundle-0.tgz
nsx> del file support*
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, NSX Cloud VM, Manager, NSX on VMC
Delete the host's public cloud gateway certificate
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
host-1> del gateway certificate 13.14.41.34
Mode
Basic
Availability
NSX Cloud VM
Delete all the host's public cloud gateway certificates
Example
host-1> del gateway certificates
Mode
Basic
Availability
NSX Cloud VM
Delete NSX Edge service container image.
Only images that are not in use can be deleted.
| Option | Description |
|---|---|
| <image-name> | Edge service container image name |
| <image-version> | Edge service container image version |
Example
nsx-edge> del image nsx-edge-mdproxy version ob-22302541
Image deleted successfully
Mode
Basic
Availability
Autonomous Edge, Edge
Delete the specified logging server configuration. You can use the
get logging-servers command to display the current logging server configuration.| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | A hostname or IPv4 or IPv6 (enclose between []) address with optional port delimited by a colon |
| <proto> | Logging server protocol Allowed values: tcp, udp, tls, li, li-tls |
| <level> | Level of log entries to export Allowed values: emerg, alert, crit, err, warning, notice, info, debug |
| <facility> | Comma delimited list of facilities of log entries to export |
| <messageid> | Comma delimited list of MSGIDs of log entries to export |
| <structured-data> | Structured data of log entries to export Allowed pattern: ^(alarmId|alarmState|audit|comp|depr|entId|eReqId|errorCode|eventFeatureName|eventId|eventSev|eventState|eventType|euser|inst|level|method|nodeId|org|path|proj|security|site|subcomp|s2comp|splitId|splitIndex|tenantId|tid|tname|update|username|vpc|namespace)=.+$ |
Example
nsx> del logging-server 192.168.110.60 proto udp level info facility syslog messageid SYSTEM,FABRIC structured-data audit=true
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Delete the specified name server from the DNS configuration.
| Option | Description |
|---|---|
| <ip-address> | Name server IP v4 or v6 address argument |
Example
nsx> del name-server 192.168.110.11
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Delete NSX config on this node without removing it as transport node from management plane.
Example
nsx-edge> del nsx
*************** STOP STOP STOP STOP STOP ***************
Carefully read and agree to the following:
1. Proceed if the deletion of this Transport Node from the NSX UI or API failed, and this is the last resort.
2. This node will be put into maintenance mode. If you plan to reuse this node, disable maintenance-mode after registering with NSX Manager.
3. Intended for use on bare metal node only. For VM form factor, it is recommended to delete the VM.
Are you sure you want to delete all NSX config from this system? (yes/no): y
nsx-edge>
Mode
Basic
Availability
Edge
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.
Example
host-1> del nsx
host-1>
Mode
Basic
Availability
ESXi, KVM
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.
Example
nsx-edge> del nsx all
*************** STOP STOP STOP STOP STOP ***************
Carefully read and agree to the following:
1. Proceed if the deletion of this Transport Node from the NSX UI or API failed, and this is the last resort.
2. This node will be put into maintenance mode. If you plan to reuse this node, disable maintenance-mode after registering with NSX Manager.
3. Intended for use on bare metal node only. For VM form factor, it is recommended to delete the VM.
4. Management IP will be cleared and this will impact ability to access the node via the network.
Are you sure you want to delete all NSX config from this system? (yes/no): y
nsx-edge>
Mode
Basic
Availability
Edge
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.
Example
host-1> del nsx force
host-1>
Mode
Basic
Availability
ESXi, KVM
Remove an existing NTP server.
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
Example
nsx-manager-1> del ntp-server 172.31.32.2
nsx-manager-1>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Delete the specified network IPv4 network route.
| Option | Description |
|---|---|
| <prefix> | CIDR notation argument |
| <ip-route-metric> | IP route metric argument Allowed pattern: ^[0-9]+$ |
| <gateway-ip> | Gateway IP address argument |
| <interface-name> | Configurable network interface argument |
Example
nsx> del route prefix 10.79.224.0/20 gateway 10.78.239.254
nsx>
or
nsx> del route prefix 10.79.224.0/20 interface eth0
nsx>
or
nsx> del route prefix 10.79.224.0/20 gateway 10.78.239.254 metric 256
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge
Delete the specified network IPv4 or IPv6 route. Default value for the IPv6 route metric is 1024.
| Option | Description |
|---|---|
| <prefix-ipv46> | CIDR notation argument for IPv4/IPv6 address |
| <ip-route-metric> | IP route metric argument Allowed pattern: ^[0-9]+$ |
| <gateway-ipv46> | Gateway IPv4/IPv6 address argument |
| <interface-name> | Configurable network interface argument |
Example
nsx> del route prefix 10.79.224.0/20 gateway 10.78.239.254
nsx>
or
nsx> del route prefix fd01:0:106:10::/64 interface eth0
nsx>
or
nsx> del route prefix fd01:0:106:10::/64 gateway fd01:0:106:10::253
nsx>
or
nsx> del route prefix fd01:0:106:8::/64 gateway fe80::106:8:1 metric 256
nsx>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Delete the specified domain name from the DNS search list.
| Option | Description |
|---|---|
| <domain> | Search domain argument |
Example
nsx> del search-domains eng.example.com
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Delete SNMP v2 Trap Targets.
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | A hostname or IPv4 or IPv6 (enclose between []) address with optional port delimited by a colon |
Example
nsx> del snmp v3-targets 10.20.125.6:1162
nsx>
or
nsx> del snmp v3-targets [fd01:1:2:2919:0:a:0:d03]:1162
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Delete SNMP v3 Trap Targets.
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | A hostname or IPv4 or IPv6 (enclose between []) address with optional port delimited by a colon |
Example
nsx> del snmp v3-targets 10.20.125.6:1162
nsx>
or
nsx> del snmp v3-targets [fd01:1:2:2919:0:a:0:d03]:1162
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Delete SNMP v3 Users.
| Option | Description |
|---|---|
| <v3-user> | SNMP v3 user Allowed pattern: ^[\S]{1,32}$ |
Example
nsx> del snmp v3-users user1
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Delete the specified host entry from the SSH known hosts file.
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | A hostname or IPv4 or IPv6 (enclose between []) address with optional port delimited by a colon |
Example
nsx> del ssh-known-host 192.168.110.105
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
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.
Note: Deleted users cannot be created again.
| Option | Description |
|---|---|
| <username> | Username of user |
Example
nsx-edge> del user audit
User information and the data associated with user will be lost.
Deleted users cannot be created again.
Do you want to continue? (yes/no): yes
nsx-edge>
Mode
Basic
Availability
Autonomous Edge, Edge
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
| Option | Description |
|---|---|
| <username> | Username of user |
Example
nsx-manager> del user audit
User information and the data associated with user will be lost.
Plan a system backup if user might need later or user can be recreated.
Do you want to continue? (yes/no): yes
nsx-manager>
Mode
Basic
Availability
Global Manager, Manager
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.
| Option | Description |
|---|---|
| <username> | Username of user |
| <key-label> | Unique label for SSH key |
| <password> | Password of user |
Example
nsx> del user admin ssh-keys label user1@domain1 password Pa$$w0rd
nsx>
or
nsx> del user admin ssh-keys label user1@domain1
Password (required only for users root and admin):
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Detach this Edge from the management plane.
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | Hostname or IPv4 or IPv6 address of an NSX Manager and optional port |
| <username> | Manager API username |
| <thumbprint> | Manager API thumbprint |
| <password> | Manager API password |
Example
nsx-edge> detach management-plane 192.168.110.105 username admin thumbprint 7f1374c339b592da504b352857a0bdc4e77b9b998a9971f9335633210f667c97
Password for API user:
Node successfully deregistered
Mode
Basic
Availability
Edge
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.
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | Hostname or IPv4 or IPv6 address of an NSX Manager and optional port |
| <username> | Manager API username |
| <thumbprint> | Manager API thumbprint |
| <password> | Manager API password |
Example
host-1> detach management-plane 192.168.110.105 username admin thumbprint 898b75618e3e56615d53f987a720ff22b6381f4b85bec1eb973214ff7361f8b8
Password for API user:
Node successfully removed
Mode
Basic
Availability
ESXi, KVM
Detach the specified node from the cluster.
| Option | Description |
|---|---|
| <node-id> | Node ID of cluster node to detach Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-manager-1> detach node ac5d4a62-3203-4b31-922e-d166a4f7e860
Node has been detached. Detached node must be deleted permanently.
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Detach specified node from the cluster without checking repository-ip modification errors.
| Option | Description |
|---|---|
| <node-id> | Node ID of cluster node to detach Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-manager-1> detach node ac5d4a62-3203-4b31-922e-d166a4f7e860 ignore-repository-ip-check
Node has been detached. Detached node must be deleted permanently.
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Display the result of the specified packet capture session with the tcpdump command.
| Option | Description |
|---|---|
| <session-id-arg> | Packet capture session id parameter |
Example
nsx-manager> display capture session 0fea2cac-5a13-44cf-b92e-b63f69572268
reading from file /tmp/pktcap/0fea2cac-5a13-44cf-b92e-b63f69572268.pcap, link-type EN10MB (Ethernet)
07:10:46.513603 IP w1-mvpcloud-164.eng.vmware.com.31181 > nsx-controller-leng1.eng.vmware.com.1235: Flags [.], ack 2218716988, win 128, length 0
07:10:48.460753 IP w1-mvpcloud-164.eng.vmware.com.52976 > nsx-controller-leng4.eng.vmware.com.amqps: Flags [P.], seq 768580848:768580898, ack 2927523439, win 128, length 50
07:10:48.463135 IP w1-mvpcloud-164.eng.vmware.com.52976 > nsx-controller-leng4.eng.vmware.com.amqps: Flags [P.], seq 50:100, ack 554, win 128, length 50
Mode
Basic
Availability
Global Manager, Manager
Display packet capture result with command tcpdump.
| Option | Description |
|---|---|
| <session-id-arg> | Packet capture session id parameter |
| <arguments> | Packet capture option parameter |
Example
nsx-manager-1> display capture session ed0a79df-4e4d-4784-9f2a-d14327e511a1 parameters -c 2
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Move down the path. The arrow moves to show which interface is current.
Example
nsx-edge-1(path)> get path
interface : 08a9e0e2-27c0-4676-892b-bcc88ae28ce7 : backplane + bp-sr0-port
interface : ca237e2a-27f6-4f68-98df-8e55b0bb36e7 : uplink + ContainerT0-domain-c9:aa317e48-b458-4b0f-acf6-197ff61aa550-t1_lrp
->port : c00823ee-2c85-476b-b657-ffc64afbb2e8 : vni:65540 + ContainerT0-domain-c9:aa317e48-b458-4b0f-acf6-197ff61aa550-t1_lrp
port : 7685f62d-9f55-4c4c-8726-f26c0de75e09 : vni:65540 + ContainerT0-domain-c9:aa317e48-b458-4b0f-acf6-197ff61aa550-t0_lrp
interface : af9f8664-cd47-48c0-ad27-b03a009911ff : downlink + ContainerT0-domain-c9:aa317e48-b458-4b0f-acf6-197ff61aa550-t0_lrp
interface : 64b419b5-4f55-4e75-9b1e-d00f3a56b5e2 : uplink + tier0-interface200
port : 6858f1bc-7965-45e8-bc47-60f9a0101d57 : vlan:untagged + tier0-interface200
nsx-edge-1(path)> down
interface : 08a9e0e2-27c0-4676-892b-bcc88ae28ce7 : backplane + bp-sr0-port
interface : ca237e2a-27f6-4f68-98df-8e55b0bb36e7 : uplink + ContainerT0-domain-c9:aa317e48-b458-4b0f-acf6-197ff61aa550-t1_lrp
port : c00823ee-2c85-476b-b657-ffc64afbb2e8 : vni:65540 + ContainerT0-domain-c9:aa317e48-b458-4b0f-acf6-197ff61aa550-t1_lrp
->port : 7685f62d-9f55-4c4c-8726-f26c0de75e09 : vni:65540 + ContainerT0-domain-c9:aa317e48-b458-4b0f-acf6-197ff61aa550-t0_lrp
interface : af9f8664-cd47-48c0-ad27-b03a009911ff : downlink + ContainerT0-domain-c9:aa317e48-b458-4b0f-acf6-197ff61aa550-t0_lrp
interface : 64b419b5-4f55-4e75-9b1e-d00f3a56b5e2 : uplink + tier0-interface200
port : 6858f1bc-7965-45e8-bc47-60f9a0101d57 : vlan:untagged + tier0-interface200
Mode
Path
Availability
Autonomous Edge, Edge
Writes IDPS filter specific statistics to /var/log/nsx-idps/filter_stats.txt
Example
> dump ids filter stats
Dump NSX IDPS slowpath per filter stats
--------------------------------------------------
result: Successfully dumped ids filter stats at /var/log/nsx-idps/filter_stats.txt
Mode
Basic
Availability
ESXi
Exit the VRF context mode if you are in it. Otherwise, exit the CLI.
Example
nsx-edge-1> vrf 1
nsx-edge-1(tier1_sr)> exit
nsx-edge-1>
Mode
Availability
Autonomous Edge, Edge, Global Manager, ESXi, KVM, NSX Cloud VM, Manager, NSX on VMC
Display information for all packet capture sessions.
Example
nsx-manager> get all capture sessions
Session Count: 1
Session ID: 0fea2cac-5a13-44cf-b92e-b63f69572268
Session Status: stopped
Start Time: 2018-07-31 07:11:54
Stop Time: 2018-07-31 07:12:10
Request:
Node: af1c570b-f78d-4ea3-8858-219f9fe73511
Capture Type: vmknic
Capture Value: vmk0
Capture Direction: input
Capture Mode: standalone
Mode
Basic
Availability
Global Manager, Manager
Display the ARP or neighbour address table.
Example
nsx-manager-1> get arp-table
Protocol Address Hardware Addr Type Interface
Internet 192.168.110.201 00:50:56:a9:8a:8c ether eth0
Internet 192.168.110.101 00:50:56:a9:45:29 ether eth0
Internet 192.168.110.1 68:ef:bd:4e:98:7f ether eth0
Internet 192.168.110.10 00:50:56:a6:e0:14 ether eth0
or
nsx-manager> get arp-table
Protocol Address Hardware Addr Type Interface
Internet 10.83.79.64 0a:00:3f:e8:6d:de ether eth0
Internet 10.83.75.199 0a:00:3f:e6:13:c3 ether eth0
Internet fe80::50:56ff:fe56:4453 02:50:56:56:44:53 ether eth0
Internet fe80::50:56ff:fe56:4453 02:50:56:56:44:53 ether eth0
Internet fd01:0:106:209::1 0a:00:3f:e8:6d:de ether eth0
or
nsx-edge> get arp-table
Protocol Address Hardware Addr Type Interface
Internet 192.168.110.201 00:50:56:a9:8a:8c ether eth0
Internet 192.168.110.101 00:50:56:a9:45:29 ether eth0
Internet 192.168.110.1 68:ef:bd:4e:98:7f ether eth0
Internet 192.168.110.10 00:50:56:a6:e0:14 ether eth0
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
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.
Example
nsx> get auth-policy api lockout-period
900 seconds
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
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.
Example
nsx> get auth-policy api lockout-reset-period
900 seconds
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Get the number of failed API authentication attempts that are
allowed before the account is locked. If set to 0, account
lockout is disabled.
Example
nsx> get auth-policy api max-auth-failures
5
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
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.
Example
nsx> get auth-policy cli lockout-period
900 seconds
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Get the number of failed CLI authentication attempts that are
allowed before the account is locked. If set to 0, account
lockout is disabled.
Example
nsx> get auth-policy cli max-auth-failures
3
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Get the minimum number of characters that passwords must have.
Example
nsx> get auth-policy minimum-password-length
8 characters
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Get the vidm's properties.
Example
nsx-manager-1> get auth-policy vidm
nsx-manager-1>
LB enabled: True
vIDM Enabled: True
Hostname: jt-vidm.eng.vmware.com
Thumbprint: 898b75618e3e56615d53f987a720ff22b6381f4b85bec1eb973214ff7361f8b8
Client Id: OAuth2Client_NsxClientId
Node Hostname: jt-nsx.eng.vmware.com
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Display the security banner or message of the day.
Example
nsx> get banner
Authorized access only
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display parameters defined in global logical router BFD
Example
nsx-edge(tier0_sr)> get bfd-config
Logical Router
UUID : d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8
vrf : 6
lr-id : 6
name :
type : SERVICE_ROUTER_TIER0
BFD global configuration
Enabled : True
Min RX Interval: 1000
Min TX Interval: 1000
Min RX TTL : 255
Multiplier : 3
Port : 4451c48f-8cff-4444-8e10-bff403783dca
BFD session configuration
Source : 192.168.50.1
Peer : 192.168.50.10
Enabled : True
Min RX Interval: 1000
Min TX Interval: 1000
RX TTL : 255
Multiplier : 3
Source : 192.168.50.1
Peer : 192.168.50.20
Enabled : True
Min RX Interval: 3000
Min TX Interval: 3000
RX TTL : 255
Multiplier : 5
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display information about the specified BFD session.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get bfd-session local-ip 192.168.250.60 remote-ip 192.168.250.61
BFD Session
Diag : Control Detection Time Expired(from local)
Forwarding : last true (current true)
Last_down_time : 2016-02-09 22:38:47
Last_up_time : 2016-02-09 22:38:52
Local_address : 192.168.250.60
Remote_address : 192.168.250.61
Remote_diag : No Diagnostic
Remote_state : up
Rx_cfg_min : 500
Rx_interval : 500
State : up
Tx_cfg_min : 100
Tx_interval : 500
Mode
Basic
Availability
Autonomous Edge, Edge
Display statistics for the specified BFD session.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get bfd-session local-ip 192.168.250.60 remote-ip 192.168.250.61 stats
BFD Session
Admin_down_count : 0
Cpath_down_count : 0
Down_count : 1
Local_address : 192.168.250.60
Remote_address : 192.168.250.61
Rx_drop : 0
Rx_drop_admin_down : 0
Rx_drop_auth_set : 0
Rx_drop_bad_version : 0
Rx_drop_intf_unmatch : 0
Rx_drop_multipoint_set: 0
Rx_drop_null_my_disc : 0
Rx_drop_null_your_disc: 0
Rx_drop_pkt_len_unmatch: 0
Rx_drop_pkt_too_short: 0
Rx_drop_rx_ttl_small : 0
Rx_drop_your_disc_unmatch: 0
Rx_drop_zero_multipier: 0
Rx_packets : 44993
Tx_error : 0
Tx_packets : 49249
Up_count : 2
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about BFD sessions.
Example
nsx-edge-1> get bfd-sessions
BFD Session
Diag : Control Detection Time Expired(from local)
Forwarding : last true (current true)
Last_down_time : 2016-02-09 22:38:47
Last_up_time : 2016-02-09 22:38:52
Local_address : 192.168.250.60
Remote_address : 192.168.250.62
Remote_diag : No Diagnostic
Remote_state : up
Rx_cfg_min : 500
Rx_interval : 500
State : up
Tx_cfg_min : 100
Tx_interval : 500
BFD Session
Diag : Control Detection Time Expired(from local)
Forwarding : last true (current true)
Last_down_time : 2016-02-09 22:38:47
Last_up_time : 2016-02-09 22:38:52
Local_address : 192.168.250.60
Remote_address : 192.168.250.61
Remote_diag : No Diagnostic
Remote_state : up
Rx_cfg_min : 500
Rx_interval : 500
State : up
Tx_cfg_min : 100
Tx_interval : 500
Mode
Basic
Availability
Autonomous Edge, Edge
Display BFD sessions in a logical router
Example
nsx-edge(tier0_sr)> get bfd-sessions
BFD Session
Dest_port : 3784
Diag : No Diagnostic
Encap : vlan
Forwarding : last false (current false)
Interface : 4451c48f-8cff-4444-8e10-bff403783dca
Last_cp_diag : No Diagnostic
Last_cp_rmt_diag : No Diagnostic
Last_cp_rmt_state : admin_down
Last_cp_state : admin_down
Last_fwd_state : NONE
Local_address : 192.168.50.1
Local_discr : 2830404107
Min_rx_ttl : 255
Multiplier : 5
Prev_failure_diag : No Diagnostic
Received_remote_diag : No Diagnostic
Received_remote_state : down
Remote_address : 192.168.50.20
Remote_admin_down : false
Remote_diag : No Diagnostic
Remote_discr : 0
Remote_min_rx_interval : 0
Remote_min_tx_interval : 0
Remote_multiplier : 0
Remote_state : down
Rx_cfg_min : 3000
Rx_interval : 3000
Session_type : LR_PORT
State : down
Tx_cfg_min : 3000
Tx_interval : 3000
.
.
.
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display the BFD sessions statistics.
Example
nsx-edge-1> get bfd-sessions stats
BFD Global Counters
Bfd_sessions_count : 2
Last_notify_time : 2016-02-09 22:38:52
Last_nsxa_msg_receive_time: 2016-02-09 22:38:52
Nsxa_connect_count : 1
Nsxa_disconnect_count: 0
Nsxa_err_msg_receive_count: 0
Nsxa_msg_receive_count: 166085
Nsxa_notify_count : 107287
Rx_drop_bad_csum : 0
Rx_drop_count : 32
Rx_drop_intf_type : 0
Rx_drop_ip_mismatch : 0
Rx_drop_non_bfd : 0
Rx_drop_non_udp : 0
Rx_drop_null_bfd_session: 32
Rx_drop_null_intf : 0
Rx_drop_runt_pkt : 0
Rx_drop_udp_len : 0
BFD Session
Admin_down_count : 0
Cpath_down_count : 0
Down_count : 1
Local_address : 192.168.250.60
Remote_address : 192.168.250.62
Rx_drop : 0
Rx_drop_admin_down : 0
Rx_drop_auth_set : 0
Rx_drop_bad_version : 0
Rx_drop_intf_unmatch : 0
Rx_drop_multipoint_set: 0
Rx_drop_null_my_disc : 0
Rx_drop_null_your_disc: 0
Rx_drop_pkt_len_unmatch: 0
Rx_drop_pkt_too_short: 0
Rx_drop_rx_ttl_small : 0
Rx_drop_your_disc_unmatch: 0
Rx_drop_zero_multipier: 0
Rx_packets : 44754
Tx_error : 0
Tx_packets : 48989
Up_count : 2
.
.
.
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPv4 & IPv6 BGP routes.
Example
nsx-edge-1(tier0_sr)> get bgp
BGP table version is 1, local router ID is 50.50.50.1
Status flags: > - best, I - internal
Origin flags: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
> 111.111.0.0/16 100.64.0.1 0 100 32768 2000 ?
> 2003::/24 :: 0 100 32768 2000 ?
> 2002::/64 fca9:1c1c:96b2:e000::2 0 100 32768 2000 ?
> 2001::/64 fca9:1c1c:96b2:e000::2 0 100 32768 2000 ?
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display detailed information about BGP IPv4 route.
| Option | Description |
|---|---|
| <prefix> | Network Address argument |
Example
nsx-edge-1(tier0_sr)> get bgp 111.111.0.0/16
BGP routing table entry for 111.111.0.0/16
Prefix advertised to: 50.50.50.10
1 Paths available:
Origin incomplete, Metric 0, LocalPref 100, Weight 32768, best, valid
Peer is 0.0.0.0 with router id 50.50.50.1
Last Updated: Sat Dec 8 03:54:07 2018
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display detailed information about BGP IPv6 route.
| Option | Description |
|---|---|
| <prefix> | Network Address argument |
Example
nsx-edge-1(tier0_sr)> get bgp 2003::/24
BGP routing table entry for 2003::/24
Prefix advertised to:
1 Paths available:
Origin incomplete, Metric 0, LocalPref 100, Weight 32768, best, valid
Peer is :: with router id 50.50.50.1
Last Updated: Sat Dec 8 03:54:06 2018
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display all BGP NLRI matching the community.
| Option | Description |
|---|---|
| <bgp-community> | BGP community argument, either NO_EXPORT, NO_ADVERTISE, NO_EXPORT_SUBCONFED or community in AA:NN format |
Example
nsx-edge-1(tier0_sr)> get bgp community 1:1
BGP table version is 1, local router ID is 50.50.50.1
Status flags: > - best, I - internal
Origin flags: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
> 111.111.0.0/16 100.64.0.1 0 100 32768 2000 ?
> 2003::/24 :: 0 100 32768 2000 ?
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display BGP EVPN routes.
Example
EVPN-M0-EDGE-ONE(tier0_sr)> get bgp evpn
BGP table version is 4, local router ID is 20.20.20.10
Status codes: s suppressed, d damped, h history, * valid, > best, i - internal
Origin codes: i - IGP, e - EGP, ? - incomplete
EVPN type-2 prefix: [2]:[EthTag]:[MAClen]:[MAC]:[IPlen]:[IP]
EVPN type-3 prefix: [3]:[EthTag]:[IPlen]:[OrigIP]
EVPN type-4 prefix: [4]:[ESI]:[IPlen]:[OrigIP]
EVPN type-5 prefix: [5]:[EthTag]:[IPlen]:[IP]
Network Next Hop Metric LocPrf Weight Path
Route Distinguisher: 12.1.1.2:2
*> [5]:[0]:[32]:[12.1.1.2]
70.1.1.2 0 0 200 ?
*> [5]:[0]:[32]:[80.1.1.1]
70.1.1.2 0 0 200 i
*> [5]:[0]:[32]:[81.1.1.1]
70.1.1.2 0 0 200 i
*> [5]:[0]:[32]:[87.1.1.1]
70.1.1.2 0 0 200 i
Displayed 4 prefixes (4 paths)
Mode
Tier0_sr
Availability
Edge
Display BGP EVPN Ethernet Segment information.
Example
nsx-edge-1(tier0_sr)> get bgp evpn es
ES Flags: L local, R remote, I inconsistent
VTEP Flags: E ESR/Type-4, A active nexthop
ESI Flags RD #VNIs VTEPs
03:11:22:33:44:55:02:00:00:01 R - 1 192.168.1.2(A)
03:11:22:33:44:55:03:00:00:02 R - 1 192.168.1.2(A),192.168.1.3(A)
Mode
Tier0_sr
Availability
Edge
Display BGP EVPN Ethernet Segment(ES) per EVPN instance(EVI) information.
Example
nsx-edge-1(tier0_sr)> get bgp evpn es-evi
Flags: L local, R remote, I inconsistent
VTEP-Flags: E EAD-per-ES, V EAD-per-EVI
VNI ESI Flags VTEPs
101 03:11:22:33:44:55:02:00:00:01 R 192.168.1.2(EV),192.168.1.3(V)
201 03:11:22:33:44:55:03:00:00:02 R 192.168.1.2(EV),192.168.1.3(EV)
Mode
Tier0_sr
Availability
Edge
Display BGP EVPN overlay information for all RDs.
Example
EVPN-M0-EDGE-ONE(tier0_sr)> get bgp evpn overlay
Route Distinguisher: as2 0:0
*> [5]:[0]:[24]:[101.1.1.0]
0.0.0.0 00:00:00:00:00:00:00:00:00:00/0.0.0.0
*> [5]:[0]:[32]:[12.12.12.12]
0.0.0.0 00:00:00:00:00:00:00:00:00:00/0.0.0.0
Route Distinguisher: ip 100.1.1.2:2
*> [5]:[0]:[24]:[100.1.1.0]
5.1.1.2 00:00:00:00:00:00:00:00:00:00/0.0.0.0/92:fc:ee:ac:51:61
*> [5]:[0]:[32]:[11.11.11.11]
5.1.1.2 00:00:00:00:00:00:00:00:00:00/0.0.0.0/92:fc:ee:ac:51:61
Route Distinguisher: ip 101.1.1.3:2
*> [5]:[0]:[24]:[101.1.1.0]
6.1.1.2 00:00:00:00:00:00:00:00:00:00/0.0.0.0/1a:de:dd:e7:46:b7
*> [5]:[0]:[32]:[12.12.12.12]
6.1.1.2 00:00:00:00:00:00:00:00:00:00/0.0.0.0/1a:de:dd:e7:46:b7
Route Distinguisher: ip 150.1.1.2:4
Displayed 7 out of 7 total prefixes
Mode
Tier0_sr
Availability
Edge
Display BGP EVPN VNI information.
Example
EVPN-M0-EDGE-ONE(tier0_sr)> get bgp evpn vni
Advertise Gateway Macip: Disabled
Advertise All VNI flag: Enabled
BUM flooding: Head-end replication
Number of L2 VNIs: 0
Number of L3 VNIs: 1
Flags: * - Kernel
VNI Type RD Import RT Export RT Tenant VRF
* 10001 L3 101.1.1.3:2 1:500 1:500 vrf-blue
Mode
Tier0_sr
Availability
Edge
Display all IPv4 BGP routes.
Example
nsx-edge-1(tier0_sr)> get bgp ipv4
BGP table version is 1, local router ID is 50.50.50.1
Status flags: > - best, I - internal
Origin flags: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
> 111.111.0.0/16 100.64.0.1 0 100 32768 2000 ?
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display all IPv6 BGP routes.
Example
nsx-edge-1(tier0_sr)> get bgp ipv6
BGP table version is 3, local router ID is 50.50.50.1
Status flags: > - best, I - internal
Origin flags: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
> 2003::/24 :: 0 100 32768 2000 ?
> 2002::/64 fca9:1c1c:96b2:e000::2 0 100 32768 2000 ?
> 2001::/64 fca9:1c1c:96b2:e000::2 0 100 32768 2000 ?
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display all BGP NLRI matching the large-community.
| Option | Description |
|---|---|
| <bgp-large-community> | BGP large-community argument in AA:BB:CC format |
Example
nsx-edge-1(tier0_sr)> get bgp large-community 1:1:1
BGP table version is 1, local router ID is 50.50.50.1
Status flags: > - best, I - internal
Origin flags: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
> 111.111.0.0/16 100.64.0.1 0 100 32768 2000 ?
> 2003::/24 :: 0 100 32768 2000 ?
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display all BGP neighbor information.
Example
nsx-edge-1(tier0_sr)> get bgp neighbor
BGP neighbor is 50.50.50.10, remote AS 1000, local AS 2000, external link
Hostname: prome-mdt-dhcp412
BGP version 4, remote router ID 50.50.50.10, local router ID 50.50.50.1
BGP state = Established, up for 2d13h18m
Last read 00:00:00, Last write 00:00:02
Hold time is 180, keepalive interval is 60 seconds
Configured hold time is 180, keepalive interval is 60 seconds
Neighbor capabilities:
4 Byte AS: advertised and received
AddPath:
IPv4 Unicast: RX advertised IPv4 Unicast and received
Route refresh: advertised and received(old & new)
Address Family IPv4 Unicast: advertised and received
Hostname Capability: advertised (name: nsx-edge-1,domain name: n/a) received (name: prome-mdt-dhcp412,domain name: n/a)
Graceful Restart Capabilty: advertised and received
Remote Restart timer is 120 seconds
Address families by peer:
none
Graceful restart informations:
End-of-RIB send: IPv4 Unicast
End-of-RIB received: IPv4 Unicast
Message statistics:
Inq depth is 0
Outq depth is 0
Sent Rcvd
Opens: 14 13
Notifications: 2 16
Updates: 10 10
Keepalives: 3822 3817
Route Refresh: 0 0
Capability: 0 0
Total: 3848 3856
Minimum time between advertisement runs is 0 seconds
Update source is 50.50.50.1
For address family: IPv4 Unicast
Update group 49, subgroup 49
Packet Queue length 0
Community attribute sent to this neighbor(all)
0 accepted prefixes
Connections established 6; dropped 5
Last reset 2d13h18m, due to Interface down
Local host: 50.50.50.1, Local port: 179
Foreign host: 50.50.50.10, Foreign port: 39948
Nexthop: 50.50.50.1
Nexthop global: 2005::2828:2801
Nexthop local: fe80::53ff:feb2:c1ad
BGP connection: shared network
BGP Connect Retry Timer in Seconds: 120
Estimated round trip time: 1 ms
Read thread: on Write thread: on
BFD Status: peer 50.50.50.10 status down
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display information about a specifie BGP neighbor.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1(tier0_sr)> get bgp neighbor 50.50.50.10
BGP neighbor is 50.50.50.10, remote AS 1000, local AS 2000, external link
Hostname: prome-mdt-dhcp412
BGP version 4, remote router ID 50.50.50.10, local router ID 50.50.50.1
BGP state = Established, up for 2d13h46m
Last read 00:00:30, Last write 00:00:32
Hold time is 180, keepalive interval is 60 seconds
Configured hold time is 180, keepalive interval is 60 seconds
Neighbor capabilities:
4 Byte AS: advertised and received
AddPath:
IPv4 Unicast: RX advertised IPv4 Unicast and received
Route refresh: advertised and received(old & new)
Address Family IPv4 Unicast: advertised and received
Hostname Capability: advertised (name: nsx-edge-1,domain name: n/a) received (name: prome-mdt-dhcp412,domain name: n/a)
Graceful Restart Capabilty: advertised and received
Remote Restart timer is 120 seconds
Address families by peer:
none
Graceful restart informations:
End-of-RIB send: IPv4 Unicast
End-of-RIB received: IPv4 Unicast
Message statistics:
Inq depth is 0
Outq depth is 0
Sent Rcvd
Opens: 14 13
Notifications: 2 16
Updates: 10 10
Keepalives: 3850 3845
Route Refresh: 0 0
Capability: 0 0
Total: 3876 3884
Minimum time between advertisement runs is 0 seconds
Update source is 50.50.50.1
For address family: IPv4 Unicast
Update group 49, subgroup 49
Packet Queue length 0
Community attribute sent to this neighbor(all)
0 accepted prefixes
Connections established 6; dropped 5
Last reset 2d13h46m, due to Interface down
Local host: 50.50.50.1, Local port: 179
Foreign host: 50.50.50.10, Foreign port: 39948
Nexthop: 50.50.50.1
Nexthop global: 2005::2828:2801
Nexthop local: fe80::53ff:feb2:c1ad
BGP connection: shared network
BGP Connect Retry Timer in Seconds: 120
Estimated round trip time: 1 ms
Read thread: on Write thread: on
BFD Status: peer 50.50.50.10 status down
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display routes advertised to a BGP neighbor.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1(tier0_sr)> get bgp neighbor 50.50.50.10 advertised-routes
BGP table version is 1, local router ID is 50.50.50.1
Status flags: > - best, I - internal
Origin flags: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
> 111.111.0.0/16 100.64.0.1 0 100 32768 2000 ?
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display routes advertised to a BGP neighbor in internal debug context
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| <ip-version> | Internet Protocol Version (IPV4 or IPV6) Allowed values: ipv4, ipv6 |
Example
nsx-edge-1(internal)> get bgp neighbor 50.50.50.10 advertised-routes vpn ipv4
BGP table version is 1, local router ID is 50.50.50.1
Status flags: > - best, I - internal
Origin flags: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
> 111.111.0.0/16 100.64.0.1 0 100 32768 2000 ?
Mode
Availability
Autonomous Edge, Edge
Display routes learnt from a BGP neighbor.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1(tier0_sr)> get bgp neighbor 50.50.50.10 routes
BGP table version is 1, local router ID is 50.50.50.1
Status flags: > - best, I - internal
Origin flags: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
> 11.11.0.0/16 100.64.0.2 0 100 32768 2000 ?
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display routes learnt from a BGP neighbor in internal debug context
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| <ip-version> | Internet Protocol Version (IPV4 or IPV6) Allowed values: ipv4, ipv6 |
Example
nsx-edge-1(internal)> get bgp neighbor 50.50.50.10 routes vpn ipv4
BGP table version is 1, local router ID is 50.50.50.1
Status flags: > - best, I - internal
Origin flags: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
> 11.11.0.0/16 100.64.0.2 0 100 32768 2000 ?
Mode
Availability
Autonomous Edge, Edge
Display a specific BGP neighbor diagnostic information.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1(tier0_sr)> get bgp neighbor 10.1.1.20 session-diagnostics
BGP neighbor is 10.1.1.20
Current State: Connect
Number of session flaps : 2
Session last reset due to : BGP Notification send
Session Statistics:
Recent keeep-alives sent (most recent first, upto maximum 5):
2023-09-01-10:02.55
2023-09-01-10:02.52
2023-09-01-10:02.49
2023-09-01-10:02.46
2023-09-01-10:02.43
Recent keeep-alives received(most recent first, upto maximum 5):
2023-09-01-10:02.49
2023-09-01-10:02.46
2023-09-01-10:02.43
2023-09-01-10:02.40
2023-09-01-10:02.37
Recent Events (most recent first, upto maximum 8):
2023-09-01-10:02.59: BGP_Start [Idle -> Connect]
2023-09-01-10:02.58: Clearing_Completed [Clearing -> Idle]
Recent Flaps (most recent first, upto maximum 4):
Down at: 2023-09-01-10:02.58
Down events:
2023-09-01-10:02.58: Hold_Timer_expired [Established -> Clearing]
2023-09-01-10:02.34: TCP_connection_open_failed [OpenConfirm -> Established]
2023-09-01-10:02.34: Receive_OPEN_message [OpenSent -> OpenConfirm]
2023-09-01-10:02.34: TCP_connection_open [Active -> OpenSent]
2023-09-01-10:02.34: Null [Idle -> Active]
Keepalives sent before flap:
2023-09-01-10:02.55
2023-09-01-10:02.52
2023-09-01-10:02.49
2023-09-01-10:02.46
2023-09-01-10:02.43
Keepalives received before flap:
2023-09-01-10:02.49
2023-09-01-10:02.46
2023-09-01-10:02.43
2023-09-01-10:02.40
2023-09-01-10:02.37
Up events:
Down at: 2023-09-01-09:59.42
Down events:
2023-09-01-09:59.42: Hold_Timer_expired [Established -> Clearing]
2023-09-01-09:39.09: BGP_Stop [OpenConfirm -> Established]
2023-09-01-09:39.09: Receive_OPEN_message [OpenSent -> OpenConfirm]
2023-09-01-09:39.09: TCP_connection_open [Active -> OpenSent]
2023-09-01-09:39.09: Null [Idle -> Active]
Keepalives sent before flap:
2023-09-01-09:59.42
2023-09-01-09:59.39
2023-09-01-09:59.36
2023-09-01-09:59.33
2023-09-01-09:59.30
Keepalives received before flap:
2023-09-01-09:59.33
2023-09-01-09:59.30
2023-09-01-09:59.27
2023-09-01-09:59.24
2023-09-01-09:59.21
Up events:
2023-09-01-10:02.34: TCP_connection_open_failed [OpenConfirm -> Established]
2023-09-01-10:02.34: Receive_OPEN_message [OpenSent -> OpenConfirm]
2023-09-01-10:02.34: TCP_connection_open [Active -> OpenSent]
2023-09-01-10:02.34: Null [Idle -> Active]
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display BGP neighbor diagnostic information.
Example
nsx-edge-1(tier0_sr)> get bgp neighbor session-diagnostics
BGP neighbor is 10.1.1.20
Current State: Connect
Number of session flaps : 2
Session last reset due to : BGP Notification send
Session Statistics:
Recent keeep-alives sent (most recent first, upto maximum 5):
2023-09-01-10:02.55
2023-09-01-10:02.52
2023-09-01-10:02.49
2023-09-01-10:02.46
2023-09-01-10:02.43
Recent keeep-alives received(most recent first, upto maximum 5):
2023-09-01-10:02.49
2023-09-01-10:02.46
2023-09-01-10:02.43
2023-09-01-10:02.40
2023-09-01-10:02.37
Recent Events (most recent first, upto maximum 8):
2023-09-01-10:02.59: BGP_Start [Idle -> Connect]
2023-09-01-10:02.58: Clearing_Completed [Clearing -> Idle]
Recent Flaps (most recent first, upto maximum 4):
Down at: 2023-09-01-10:02.58
Down events:
2023-09-01-10:02.58: Hold_Timer_expired [Established -> Clearing]
2023-09-01-10:02.34: TCP_connection_open_failed [OpenConfirm -> Established]
2023-09-01-10:02.34: Receive_OPEN_message [OpenSent -> OpenConfirm]
2023-09-01-10:02.34: TCP_connection_open [Active -> OpenSent]
2023-09-01-10:02.34: Null [Idle -> Active]
Keepalives sent before flap:
2023-09-01-10:02.55
2023-09-01-10:02.52
2023-09-01-10:02.49
2023-09-01-10:02.46
2023-09-01-10:02.43
Keepalives received before flap:
2023-09-01-10:02.49
2023-09-01-10:02.46
2023-09-01-10:02.43
2023-09-01-10:02.40
2023-09-01-10:02.37
Up events:
Down at: 2023-09-01-09:59.42
Down events:
2023-09-01-09:59.42: Hold_Timer_expired [Established -> Clearing]
2023-09-01-09:39.09: BGP_Stop [OpenConfirm -> Established]
2023-09-01-09:39.09: Receive_OPEN_message [OpenSent -> OpenConfirm]
2023-09-01-09:39.09: TCP_connection_open [Active -> OpenSent]
2023-09-01-09:39.09: Null [Idle -> Active]
Keepalives sent before flap:
2023-09-01-09:59.42
2023-09-01-09:59.39
2023-09-01-09:59.36
2023-09-01-09:59.33
2023-09-01-09:59.30
Keepalives received before flap:
2023-09-01-09:59.33
2023-09-01-09:59.30
2023-09-01-09:59.27
2023-09-01-09:59.24
2023-09-01-09:59.21
Up events:
2023-09-01-10:02.34: TCP_connection_open_failed [OpenConfirm -> Established]
2023-09-01-10:02.34: Receive_OPEN_message [OpenSent -> OpenConfirm]
2023-09-01-10:02.34: TCP_connection_open [Active -> OpenSent]
2023-09-01-10:02.34: Null [Idle -> Active]
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display summarized BGP neighbor information.
Example
nsx-edge-1(tier0_sr)> get bgp neighbor summary
BFD States: NC - Not configured, DC - Disconnected
AD - Admin down, DW - Down, IN - Init, UP - Up
BGP summary information for VRF default for address-family: ipv4Unicast
Router ID: 50.50.50.1 Local AS: 2000
Neighbor AS State Up/DownTime BFD InMsgs OutMsgs InPfx OutPfx
50.50.50.10 1000 Estab 2d13h52m DW 3890 3882 0 1
BFD States: NC - Not configured, DC - Disconnected
AD - Admin down, DW - Down, IN - Init, UP - Up
BGP summary information for VRF default for address-family: ipv6Unicast
Router ID: 50.50.50.1 Local AS: 2000
Neighbor AS State Up/DownTime BFD InMsgs OutMsgs InPfx OutPfx
2005::2828:280a 1000 Idle never NC 0 0 0 0
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display summarized inter-sr neighbors information from the default VRF in internal debug context.
Example
nsx-edge-1(internal)> get bgp neighbor summary
BFD States: NC - Not configured, DC - Disconnected
AD - Admin down, DW - Down, IN - Init, UP - Up
BGP summary information for VRF default for address-family: ipv4Vpn
Router ID: 50.50.50.1 Local AS: 2000
Neighbor AS State Up/DownTime BFD InMsgs OutMsgs InPfx OutPfx
169.254.0.130 422 Activ 3d16h39m NC 226286 226388 0 0
169.254.0.132 422 Estab 4d07h04m NC 371306 371343 19 28
BFD States: NC - Not configured, DC - Disconnected
AD - Admin down, DW - Down, IN - Init, UP - Up
BGP summary information for VRF default for address-family: ipv6Vpn
Router ID: 50.50.50.1 Local AS: 2000
Neighbor AS State Up/DownTime BFD InMsgs OutMsgs InPfx OutPfx
169.254.0.130 422 Activ 3d16h39m NC 226286 226388 0 0
169.254.0.132 422 Estab 4d07h04m NC 371306 371343 7 31
Mode
Availability
Autonomous Edge, Edge
Display summarized BGP neighbor information for a given address-family.
| Option | Description |
|---|---|
| <address-family> | BGP address family argument Allowed values: ipv4, ipv6, evpn |
Example
nsx-edge-1(tier0_sr)> get bgp neighbor summary evpn
BFD States: NC - Not configured, DC - Disconnected
AD - Admin down, DW - Down, IN - Init, UP - Up
BGP summary information for VRF default for address-family: l2VpnEvpn
Router ID: 150.1.1.3 Local AS: 200
Neighbor AS State Up/DownTime BFD InMsgs OutMsgs InPfx OutPfx
150.1.1.2 100 Estab 10:32:15 NC 762 765 3 7
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display all IPv4 & IPv6 BGP routes of shadow VRF.
| Option | Description |
|---|---|
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
Example
Edge1(inter_sr_vrf)> get bgp vrfid 7
BGP IPv4 table version is 32, BGP IPv6 table version is 42
Local router ID is 40.40.40.1
Status flags: > - best, I - internal
Origin flags: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
> 40.40.42.0/24 100.64.0.1 0 100 0 ?
> 40.40.42.0/24 0.0.0.0 0 100 32768 ?
> 40.40.42.1/24 0.0.0.0 0 100 32768 ?
> 90.90.92.0/24 0.0.0.0 0 100 32768 ?
> 90.90.92.2/32 0.0.0.0 0 100 32768 ?
> 2009:42::/64 :: 0 100 32768 ?
> 2009:42::1/128 :: 0 100 32768 ?
> 2010:92::/64 :: 0 100 32768 ?
> 2010:92::2/128 :: 0 100 32768 ?
Mode
Availability
Autonomous Edge, Edge
Generate BGP/BFD diagnostic report.
Example
nsx-edge-1(tier0_sr)> get bgp-bfd diagnostics report
2024-07-19 17:59:12,205 - INFO - CSV write operation is completed. Time taken = 0:00:01.494980
Fri Jul 19 2024 UTC 17:59:08.784
nsx-edge-1(tier0_sr)>
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display the bond interface with the specified name. Specify the
stats argument to display the statistics for the interface.| Option | Description |
|---|---|
| <bond-name> | Datapath device name argument |
Example
nsx-edge-1> get bond bond0
Bond
Hash algorithm : layer 2+3+4
Mode : lacp active
Name : bond0
Port id : 2
Slaves :
Name : fp-eth0
LACP state :
Local admin key : 11
Local oper key : 11
Local oper port state : ACT FTO AGG DEF
Local port internal state: LACP_ENABLED
Local port number : 1
Local port priority : 255
Local port rx machine state: DEFAULTED
Local timeout cfg : fast
Partner age in sec : 2
Partner device id : 00:00:00:00:00:00
Partner mode : LACP passive
Partner oper key : 0
Partner oper port state:
Partner port number : 0
Partner port priority : 0
Partner timeout cfg : slow
State : stand-alone
State : active
Name : fp-eth1
LACP state :
Local admin key : 11
Local oper key : 11
Local oper port state : ACT FTO AGG DEF
Local port internal state: LACP_ENABLED
Local port number : 2
Local port priority : 255
Local port rx machine state: DEFAULTED
Local timeout cfg : fast
Partner age in sec : 2
Partner device id : 00:00:00:00:00:00
Partner mode : LACP passive
Partner oper key : 0
Partner oper port state:
Partner port number : 0
Partner port priority : 0
Partner timeout cfg : slow
State : stand-alone
State : active
Status : up
nsx-edge-1> get bond bond0 stats
Bond
Name : bond0
Slaves :
Name : fp-eth0
LACP drops : 0
Rx LACP errors : 0
Rx LACP pdus : 10
Tx LACP errors : 0
Tx LACP pdus : 10
Name : fp-eth1
LACP drops : 0
Rx LACP errors : 0
Rx LACP pdus : 10
Tx LACP errors : 0
Tx LACP pdus : 10
name : bond0
rx_bytes : 1488
rx_drop_no_match : 0
rx_errors : 0
rx_misses : 0
rx_nombufs : 0
rx_packets : 12
tx_bytes : 0
tx_drops : 0
tx_errors : 0
tx_packets : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display all bond interfaces. Specify the
stats argument to display the statistics for the interfaces.Example
nsx-edge-1> get bonds
Bond
Hash algorithm : layer 2+3+4
Mode : lacp active
Name : bond0
Port id : 2
Slaves :
Name : fp-eth0
LACP state :
Local admin key : 11
Local oper key : 11
Local oper port state : ACT FTO AGG DEF
Local port internal state: LACP_ENABLED
Local port number : 1
Local port priority : 255
Local port rx machine state: DEFAULTED
Local timeout cfg : fast
Partner age in sec : 2
Partner device id : 00:00:00:00:00:00
Partner mode : LACP passive
Partner oper key : 0
Partner oper port state:
Partner port number : 0
Partner port priority : 0
Partner timeout cfg : slow
State : stand-alone
State : active
Name : fp-eth1
LACP state :
Local admin key : 11
Local oper key : 11
Local oper port state : ACT FTO AGG DEF
Local port internal state: LACP_ENABLED
Local port number : 2
Local port priority : 255
Local port rx machine state: DEFAULTED
Local timeout cfg : fast
Partner age in sec : 2
Partner device id : 00:00:00:00:00:00
Partner mode : LACP passive
Partner oper key : 0
Partner oper port state:
Partner port number : 0
Partner port priority : 0
Partner timeout cfg : slow
State : stand-alone
State : active
Status : up
nsx-edge-1> get bonds stats
Bond
Name : bond0
Slaves :
Name : fp-eth0
LACP drops : 0
Rx LACP errors : 0
Rx LACP pdus : 10
Tx LACP errors : 0
Tx LACP pdus : 10
Name : fp-eth1
LACP drops : 0
Rx LACP errors : 0
Rx LACP pdus : 10
Tx LACP errors : 0
Tx LACP pdus : 10
name : bond0
rx_bytes : 1488
rx_drop_no_match : 0
rx_errors : 0
rx_misses : 0
rx_nombufs : 0
rx_packets : 12
tx_bytes : 0
tx_drops : 0
tx_errors : 0
tx_packets : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Show all bridge ports configuration and state.
Example
nsx-edge-1> get bridge
Bridge Port UUID : 038b3ae3-bd93-4601-9bcf-82495777dd7e
Bridge Logical Switch : f5ec216f-4744-5928-8e69-8cd2fbc404ad
Attached Logical Switch : afb6a736-df2f-4623-940c-1f5f0275a93f
Attached Logical Switch Name : 22-switch-1216
VLAN ID : 10
State : Forwarding
Transport Zone : a9ab09eb-de46-46c0-bc90-5f726766b2e5
Device : fp-eth0
Device State : Up
HA Failover Mode : Non-Preemptive
State : Active
Event : Remote State Updated
Time : 2020-05-25T17:38:47.749744
Peer Node UUID : 862027e0-8cd3-11ea-bbb8-020058bc587c
Peer State : Standby
Last RARP : 2020-05-25 17:38:48.750
RARP Count : 3
Mode
Basic
Availability
Autonomous Edge, Edge
Show bridge port configuration and state.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get bridge 038b3ae3-bd93-4601-9bcf-82495777dd7e
Bridge Port UUID : 038b3ae3-bd93-4601-9bcf-82495777dd7e
Bridge Logical Switch : f5ec216f-4744-5928-8e69-8cd2fbc404ad
Attached Logical Switch : afb6a736-df2f-4623-940c-1f5f0275a93f
Attached Logical Switch Name : 22-switch-1216
VLAN ID : 10
State : Forwarding
Transport Zone : a9ab09eb-de46-46c0-bc90-5f726766b2e5
Device : fp-eth0
Device State : Up
HA Failover Mode : Non-Preemptive
State : Active
Event : Remote State Updated
Time : 2020-05-25T17:38:47.749744
Peer Node UUID : 862027e0-8cd3-11ea-bbb8-020058bc587c
Peer State : Standby
Last RARP : 2020-05-25 17:38:48.750
RARP Count : 3
Mode
Basic
Availability
Autonomous Edge, Edge
Display high-availability history of bridge port.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get bridge 1e3355fc-a396-478f-b3db-030b966c0999 high-availability-history
Bridge Port UUID : 1e3355fc-a396-478f-b3db-030b966c0999
Time State Event
2020-05-14T17:18:46.802781 Init Init
2020-05-14T17:18:46.802804 Down Init
2020-05-14T17:18:46.802929 Standby Device Up
2020-05-14T17:22:04.843406 Active Force Failover
2020-05-24T06:52:01.334959 Down Node Down
2020-05-24T06:52:02.754586 Standby Node Up
2020-05-24T06:52:02.754671 Active Node Up
Mode
Basic
Availability
Autonomous Edge, Edge
Display Mac Sync table on an bridge port.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get bridge 63eaad17-7792-44e1-9c7d-2c5391dd7f47 mac-sync-table
MAC-SYNC Table
MAC : 00:0c:29:ac:e4:2e
TYPE : Local
VNI : 65540
VLAN : 5
Bridge Port UUID : 038b3ae3-bd93-4601-9bcf-82495777dd7e
MAC : 02:00:58:5f:cc:c6
TYPE : Remote
VNI : 65540
VLAN : 4096
Bridge Port UUID : 038b3ae3-bd93-4601-9bcf-82495777dd7e
Mode
Basic
Availability
Autonomous Edge, Edge
Show bridge port configuration and state attached to specified logical-switch.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get bridge logical-switch afb6a736-df2f-4623-940c-1f5f0275a93f
Bridge Port UUID : 038b3ae3-bd93-4601-9bcf-82495777dd7e
Bridge Logical Switch : f5ec216f-4744-5928-8e69-8cd2fbc404ad
Attached Logical Switch : afb6a736-df2f-4623-940c-1f5f0275a93f
Attached Logical Switch Name : 22-switch-1216
VLAN ID : 10
State : Forwarding
Transport Zone : a9ab09eb-de46-46c0-bc90-5f726766b2e5
Device : fp-eth0
Device State : Up
HA Failover Mode : Non-Preemptive
State : Active
Event : Remote State Updated
Time : 2020-05-25T17:38:47.749744
Peer Node UUID : 862027e0-8cd3-11ea-bbb8-020058bc587c
Peer State : Standby
Last RARP : 2020-05-25 17:38:48.750
RARP Count : 3
Mode
Basic
Availability
Autonomous Edge, Edge
Display mac-sync table on bridge ports.
Example
nsx-edge-1> get bridge 63eaad17-7792-44e1-9c7d-2c5391dd7f47 mac-sync-table
MAC-SYNC Table
MAC : 00:0c:29:ac:e4:2e
TYPE : Local
VNI : 65540
VLAN : 5
Bridge Port UUID : 038b3ae3-bd93-4601-9bcf-82495777dd7e
MAC : 02:00:58:5f:cc:c6
TYPE : Remote
VNI : 65540
VLAN : 4096
Bridge Port UUID : 038b3ae3-bd93-4601-9bcf-82495777dd7e
Mode
Basic
Availability
Autonomous Edge, Edge
Show bridge ports whose attached logical-switch name matches the specified name.
| Option | Description |
|---|---|
| <bridge-lswitch-name-arg> | Attached logical switch name or regex |
Example
nsx-edge-1> get bridge name 22-switch-1216
Bridge Port UUID : 038b3ae3-bd93-4601-9bcf-82495777dd7e
Bridge Logical Switch : f5ec216f-4744-5928-8e69-8cd2fbc404ad
Attached Logical Switch : afb6a736-df2f-4623-940c-1f5f0275a93f
Attached Logical Switch Name : 22-switch-1216
VLAN ID : 10
State : Forwarding
Transport Zone : a9ab09eb-de46-46c0-bc90-5f726766b2e5
Device : fp-eth0
Device State : Up
HA Failover Mode : Non-Preemptive
State : Active
Event : Remote State Updated
Time : 2020-05-25T17:38:47.749744
Peer Node UUID : 862027e0-8cd3-11ea-bbb8-020058bc587c
Peer State : Standby
Last RARP : 2020-05-25 17:38:48.750
RARP Count : 3
Mode
Basic
Availability
Autonomous Edge, Edge
Display summary of bridge ports.
Example
nsx-edge-1> get bridge summary
UUID State VLAN Switch Name
1e3355fc-a396-478f-b3db-030b966c0999 Blocking 202 1-switch-292
66b8d799-cdce-4d58-8316-c139fbbcf005 Blocking range 21-switch-829
81af4e63-5612-45b6-9428-720bfdfd061a Forwarding untagged 23-switch-1216
Mode
Basic
Availability
Autonomous Edge, Edge
Show bridge ports configuration and state with specified vlan.
| Option | Description |
|---|---|
| <vlan-id-arg> | VLAN Id (0-4094) |
Example
nsx-edge-1> get bridge vlan 10
Bridge Port UUID : 038b3ae3-bd93-4601-9bcf-82495777dd7e
Bridge Logical Switch : f5ec216f-4744-5928-8e69-8cd2fbc404ad
Attached Logical Switch : afb6a736-df2f-4623-940c-1f5f0275a93f
Attached Logical Switch Name : 22-switch-1216
VLAN ID : 1-100
State : Forwarding
Transport Zone : a9ab09eb-de46-46c0-bc90-5f726766b2e5
Device : fp-eth0
Device State : Up
HA Failover Mode : Non-Preemptive
State : Active
Event : Remote State Updated
Time : 2020-05-25T17:38:47.749744
Peer Node UUID : 862027e0-8cd3-11ea-bbb8-020058bc587c
Peer State : Standby
Last RARP : 2020-05-25 17:38:48.750
RARP Count : 3
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about the specified packet capture session.
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
Example
kvm-1> get capture session 1
Packet Capture Session
ID : 1
PORTS : ['b592a7c8-4e21-493e-b0fc-0b1d152c949c']
or
nsx-edge-1> get capture session 1
Packet Capture Session
ID : 1
PORTS : ['fp-eth0', 'fp-eth1']
Mode
Basic
Availability
Autonomous Edge, Edge, KVM
Display information about the specified packet capture session.
| Option | Description |
|---|---|
| <esx-session-id-arg> | Packet Capture session id parameter |
Example
esx-1> get capture session 1
Packet Capture Session
ID : 1
PORT : b2dce32f-8312-4c10-a7fe-320d4cb226ff
VNI : 24580
Mode
Basic
Availability
ESXi
Display information for the specified packet capture session.
| Option | Description |
|---|---|
| <session-id-arg> | Packet capture session id parameter |
Example
nsx-manager-leng5> get capture session 0fea2cac-5a13-44cf-b92e-b63f69572268
Session ID: 0fea2cac-5a13-44cf-b92e-b63f69572268
Session Status: stopped
Start Time: 2018-07-31 07:11:54
Stop Time: 2018-07-31 07:12:10
Request:
Node: af1c570b-f78d-4ea3-8858-219f9fe73511
Capture Type: vmknic
Capture Value: vmk0
Capture Direction: input
Capture Mode: standalone
Mode
Basic
Availability
Global Manager, Manager
Display configured packet capture sessions. Session 0 is reserved for captures started with the
start capture interface <interface-name> command.Example
kvm-1> get capture sessions
Packet Capture Session
ID : 0
PORTS : []
Packet Capture Session
ID : 1
PORTS : ['b592a7c8-4e21-493e-b0fc-0b1d152c949c']
Packet Capture Session
ID : 2
PORTS : ['b592a7c8-4e21-493e-b0fc-0b1d152c949c', 'd0c59cee-6095-5eeb-815b-ae6732d749e4']
Packet Capture Session
ID : 3
PORTS : []
or
nsx-edge-1> get capture sessions
Packet Capture Session
ID : 0
PORTS : []
Packet Capture Session
ID : 1
PORTS : ['fp-eth0', 'fp-eth1']
Packet Capture Session
ID : 2
PORTS : ['d0c59cee-6095-5eeb-815b-ae6732d749e4']
Packet Capture Session
ID : 3
PORTS : []
Mode
Basic
Availability
Autonomous Edge, Edge, KVM
Display configured packet capture sessions.
Example
esx-1> get capture sessions
Packet Capture Session
ID : 0
PORT : b2dce32f-8312-4c10-a7fe-320d4cb226ff
VNI : 24580
Packet Capture Session
ID : 1
PORT : 10
Packet Capture Session
ID : 2
TRACE : True
Packet Capture Session
ID : 3
PORT : uplink1
Mode
Basic
Availability
ESXi
Display the API server's certificate.
Example
nsx-manager-1> get certificate api
-----BEGIN CERTIFICATE-----
MIIDfzCCAmegAwIBAgIEVQEDTTANBgkqhkiG9w0BAQsFADBwMQswCQYDVQQGEwJVUzELMAkGA1UE
...
/JbzbimmEgaC3Yy5rOZXUnhn+dANkUShIeGIpOnH7rpLrrPYcB1Hx31jieY=
-----END CERTIFICATE-----
or
nsx-edge-1> get certificate api
-----BEGIN CERTIFICATE-----
MIIDfzCCAmegAwIBAgIEVQEDTTANBgkqhkiG9w0BAQsFADBwMQswCQYDVQQGEwJVUzELMAkGA1UE
...
/JbzbimmEgaC3Yy5rOZXUnhn+dANkUShIeGIpOnH7rpLrrPYcB1Hx31jieY=
-----END CERTIFICATE-----
Mode
Basic
Availability
Autonomous Edge, Global Manager, Manager, NSX on VMC
Display the API server's certificate text.
Example
nsx-manager-1> get certificate api text
Certificate:
Data:
Version: v3 (0x2)
Serial Number: 414425709 (0x18b3a26d)
Signature Algorithm: sha256
Issuer: C=US, ST=CA, L=Palo Alto, O=VMware Inc., OU=NSX, CN=localhost.nsxmanager
Validity
Not Before: Sep 17 05:48:41 2021 GMT
Not After : Dec 21 05:48:41 2023 GMT
Subject: C=US, ST=CA, L=Palo Alto, O=VMware Inc., OU=NSX, CN=localhost.nsxmanager
...
-----BEGIN CERTIFICATE-----
MIID/jCCAuagAwIBAgIEGLOibTANBgkqhkiG9w0BAQsFADCBiDELMAkGA1UEBhMC
...
j7dIDdeV0Z5GCmma11ds3xh/
-----END CERTIFICATE-----
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Display the API server's certificate thumbprint.
Example
nsx-manager-1> get certificate api thumbprint
82d99b793ff84f1f1f01f420656975522a03b9bebe87c50bcff80e7d3ebe8705
or
nsx-edge-1> get certificate api thumbprint
82d99b793ff84f1f1f01f420656975522a03b9bebe87c50bcff80e7d3ebe8705
Mode
Basic
Availability
Autonomous Edge, Global Manager, Manager, NSX on VMC
Display the clsuter certificate.
Example
nsx-manager-1> get certificate cluster
-----BEGIN CERTIFICATE-----
MIIDfjCCAmagAwIBAgIETzOK8zANBgkqhkiG9w0BAQsFADBlMQswCQYDVQQGEwJV
...
QaWyyFxNFfuCLibJPuiO5scGJmGB6UvZLGt/7stcuLIQ3A==
-----END CERTIFICATE-----
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Display the cluster certificate text.
Example
nsx-manager-1> get certificate cluster text
Certificate:
Data:
Version: 3 (0x2)
Serial Number: 897458966 (0x357e2316)
Signature Algorithm: sha256
Issuer: C=US, ST=CA, L=Palo Alto, O=VMware Inc., OU=NSX, CN=localhost.nsxmanager
Validity
Not Before: Nov 18 09:38:43 2019 GMT
Not After : Nov 15 09:38:43 2029 GMT
Subject: C=US, ST=CA, L=Palo Alto, O=VMware Inc., OU=NSX, CN=localhost.nsxmanager
...
-----BEGIN CERTIFICATE-----
MIIDfjCCAmagAwIBAgIETzOK8zANBgkqhkiG9w0BAQsFADBlMQswCQYDVQQGEwJV
...
QaWyyFxNFfuCLibJPuiO5scGJmGB6UvZLGt/7stcuLIQ3A==
-----END CERTIFICATE-----
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Display the cluster certificate thumbprint.
Example
nsx-manager-1> get certificate cluster thumbprint
40a5d453ea43ef1e21597d9d14749d4c6b0874402ed0b4c2d6a212a4fe7819c5
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Display the translations for the specified container group. Optionally specify a translation type to display translations of that type.
| Option | Description |
|---|---|
| <uuid> | Cgroup identifier |
| <translation-type> | Translation type Allowed values: logical-objects, ips, vifs, macs, tns, vms, excluded-ips, directory-groups, bms, bmsi |
Example
nsx-controller-1> get cgroup 5539c4dc-621e-4d8b-8a40-2ee299f1ec73 logical-objects
id: 5539c4dc-621e-4d8b-8a40-2ee299f1ec73, type: Container, name: testNSGroup6
id: 34adf781-4fc1-4418-a63d-72e2d4fb9786, type: LogicalSwitchPort
Mode
Basic
Availability
Manager
Display all container groups.
Example
nsx-controller-1> get cgroups
id: 9e0b012c-c93c-4693-9c32-f9e29b7aa928, type: Container, name: Edge_NSGroup, multitenancy_scope: /orgs/default/projects/project-1
id: 5539c4dc-621e-4d8b-8a40-2ee299f1ec73, type: Container, name: testNSGroup6, multitenancy_scope: /orgs/default/projects/project-2
id: 8eeb7875-ef19-4d91-9e5d-a5690914338f, type: Container, name: ServiceInsertion_NSGroup, multitenancy_scope: /orgs/default/projects/project-1/vpcs/vpc-1
Mode
Basic
Availability
Manager
Display container groups with the specified IP address.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-controller-1> get cgroups with ip 192.168.1.123
id: 5539c4dc-621e-4d8b-8a40-2ee299f1ec73, type: Container, name: testNSGroup6
id: 141e822d-c0eb-4bb3-ba8d-61c58379c928, type: LogicalSwitch
id: 192.168.1.123/32, type: IpSpec
id: 34adf781-4fc1-4418-a63d-72e2d4fb9786, type: LogicalSwitchPort
Mode
Basic
Availability
Manager
Display container groups with the specified MAC address.
| Option | Description |
|---|---|
| <hardware-address> | Network hardware address argument |
Example
nsx-controller-1> get cgroups with mac af:bb:cc:dd:ee:ff
id: af:bb:cc:dd:ee:ff, type: MacAddress
id: 5539c4dc-621e-4d8b-8a40-2ee299f1ec73, type: Container, name: testNSGroup6
id: 141e822d-c0eb-4bb3-ba8d-61c58379c928, type: LogicalSwitch
id: 34adf781-4fc1-4418-a63d-72e2d4fb9786, type: LogicalSwitchPort
Mode
Basic
Availability
Manager
Display container groups with the specified network interface.
| Option | Description |
|---|---|
| <vif> | VIF ID |
Example
nsx-controller-1> get cgroups with vif vif2
id: 5539c4dc-621e-4d8b-8a40-2ee299f1ec73, type: Container, name: testNSGroup6
id: 141e822d-c0eb-4bb3-ba8d-61c58379c928, type: LogicalSwitch
id: vif2, type: Vif
id: 34adf781-4fc1-4418-a63d-72e2d4fb9786, type: LogicalSwitchPort
Mode
Basic
Availability
Manager
Show status to display datetime stamp in command output.
Example
nsx> get cli-output datetime
Output datetime is: enabled
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, ESXi, KVM, NSX Cloud VM, Manager, NSX on VMC
Show status to display deprecate warning in command output.
Example
nsx> get cli-output deprecate-warning
Output deprecate warning is: enabled
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, ESXi, KVM, NSX Cloud VM, Manager, NSX on VMC
Show status to display ESXio node data in ESXi host command output.
Applicable only when ESXio nodes are registered with ESXi host.
Example
nsx> get cli-output esxio
Output ESXio command data is enabled
Mode
Basic
Availability
ESXi
Show inactivity timeout in seconds.
Example
nsx> get cli-timeout
1200 seconds
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display the current date and time.
Example
nsx> get clock
Wed Nov 17 2021 UTC 09:57:07.472
Timezone: UTC (UTC, +0000)
NTP Sync Status: yes
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display cluster api-service configuration.
Example
nsx> get cluster api-service
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Get Cluster Config.
Example
nsx-manager-1> get cluster config
Cluster Id: 00a87b36-6b1f-450d-9de9-05e1fe3e1f1f
Cluster Configuration Version: 0
Number of nodes in the cluster: 1
Node UUID: 5df23b42-71bb-3b6b-9b5f-66deacc47aa7
Node Status: JOINED
ENTITY UUID IPV4 ADDRESS IPV6 ADDRESS PORT FQDN
HTTPS 88fbb26b-4da2-41de-a6e0-4dc323e4f3a5 10.192.229.12 not configured 443 manager1
ASYNC_REPLICATOR da9ffe6f-fdc3-466f-9b5e-9570cca12f03 10.192.229.12 not configured - manager1
CONTROLLER 877895e5-d595-4c9e-811d-3688a3227992 10.192.229.12 not configured - manager1
CLUSTER_BOOT_MANAGER 0e876772-c552-430a-9555-d04be3ff55f5 10.192.229.12 not configured - manager1
CM-INVENTORY 4097a372-f0dd-4619-b508-2bbf137cdddf 10.192.229.12 not configured - manager1
Mode
Basic
Availability
Global Manager, Manager
Get status of all the groups.
Example
nsx-manager-1> get cluster status
Cluster Id: 00a87b36-6b1f-450d-9de9-05e1fe3e1f1f
Overall Status: STABLE
Group Type: DATASTORE
Group Status: STABLE
Members:
UUID FQDN IPV4 IPV6 STATUS
5df23b42-71bb-3b6b-9b5f-66deacc47aa7 manager1 10.192.229.12 not configured UP
Group Type: CLUSTER_BOOT_MANAGER
Group Status: STABLE
Members:
UUID FQDN IPV4 IPV6 STATUS
5df23b42-71bb-3b6b-9b5f-66deacc47aa7 manager1 10.192.229.12 not configured UP
Group Type: CONTROLLER
Group Status: STABLE
Members:
UUID FQDN IPV4 IPV6 STATUS
877895e5-d595-4c9e-811d-3688a3227992 manager1 10.192.229.12 not configured UP UP
Mode
Basic
Availability
Global Manager, Manager
Get status of all the groups. Show leadership if there is any.
Example
nsx-manager-1> get cluster status verbose
Cluster Id: 00a87b36-6b1f-450d-9de9-05e1fe3e1f1f
Overall Status: STABLE
Group Type: DATASTORE
Group Status: STABLE
Members:
UUID FQDN IPV4 IPV6 STATUS
5df23b42-71bb-3b6b-9b5f-66deacc47aa7 manager1 10.192.229.12 not configured UP
Group Type: CLUSTER_BOOT_MANAGER
Group Status: STABLE
Members:
UUID FQDN IPV4 IPV6 STATUS
5df23b42-71bb-3b6b-9b5f-66deacc47aa7 manager1 10.192.229.12 not configured UP
Current occupied weight by each member:
UUID CATEGORY OCCUPIED WEIGHT
5df23b42-71bb-3b6b-9b5f-66deacc47aa7 SMALL 1
5df23b42-71bb-3b6b-9b5f-66deacc47aa7 MEDIUM 0
5df23b42-71bb-3b6b-9b5f-66deacc47aa7 LARGE 0
Leaders:
SERVICE WEIGHT WEIGHT CATEGORY LEADER LEASE VERSION
cluster-manager 1 SMALL 5df23b42-71bb-3b6b-9b5f-66deacc47aa7 129
Group Type: CONTROLLER
Group Status: STABLE
Members:
UUID FQDN IPV4 IPV6 STATUS
877895e5-d595-4c9e-811d-3688a3227992 manager1 10.192.229.12 not configured UP
Current occupied weight by each member:
UUID CATEGORY OCCUPIED WEIGHT
877895e5-d595-4c9e-811d-3688a3227992 SMALL 1
877895e5-d595-4c9e-811d-3688a3227992 MEDIUM 0
877895e5-d595-4c9e-811d-3688a3227992 LARGE 0
Leaders:
SERVICE WEIGHT WEIGHT CATEGORY LEADER LEASE VERSION
ShardingService 1 SMALL 877895e5-d595-4c9e-811d-3688a3227992 90 UP
Mode
Basic
Availability
Global Manager, Manager
Get Cluster Virtual IP.
Example
nsx-manager-1> get cluster vip
Virtual IP address: 10.10.10.10
Virtual IPv6 address: not configured
Assigned to: ['10.1.1.1', 'fd01:1:2:2919:0:4dff:fed7:8001']
or
nsx-manager-1> get cluster vip
Virtual IP address: 10.10.10.10
Virtual IPv6 address: fd01:1:2:2919:0:4dff:fed7:8005
Assigned to: ['10.1.1.1', 'fd01:1:2:2919:0:4dff:fed7:8001']
Mode
Basic
Availability
Global Manager, Manager
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.
To show all command history set size to 0.
Note:Outputs command history from version 3.2.0 and above.
Example
nsx> get command history
1 Wed Mar 03 2021 UTC 08:45:44.633 set cli-output datetime disable
2 Wed Mar 03 2021 UTC 08:46:22.816 set eula accepted
3 Wed Mar 03 2021 UTC 08:49:34.778 get hostname | json
4 Wed Mar 03 2021 UTC 09:05:10.189 get version | json
5 Wed Mar 03 2021 UTC 00:25:51.951 get management-cluster status | json
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, ESXi, KVM, NSX Cloud VM, Manager, NSX on VMC
Display configuration settings in command line syntax.
Example
nsx> get configuration
!
set route prefix 0.0.0.0/0 gateway 192.168.110.1 interface eth0
set route prefix 192.168.110.0/24 interface eth0
set search-domains example.com
set timezone Etc/UTC
set name-servers 192.168.110.10
set ntp-server 0.ubuntu.pool.ntp.org
set ntp-server 1.ubuntu.pool.ntp.org
set ntp-server 2.ubuntu.pool.ntp.org
set ntp-server 3.ubuntu.pool.ntp.org
set ntp-server ntp.ubuntu.com
set hostname nsx
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display the controllers connected to this node.
Example
nsx> get controllers
Controller IP Port SSL Status Is Physical Master Session State Controller FQDN Failure Reason
NA 1235 enabled not used false null CCP1.COM NA
10.160.193.174 1235 enabled not used false null NA NA
10.191.192.160 1235 enabled disconnected true down NA CONTROLLER_REJECTED_HOST_CERT
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Get core dump generation and rotation configurations
Example
nsx> get core-dump config
Core dump files global limit: 2
Core dump files global frquency threshold: 600
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display information about the core dump files in the system.
Example
nsx> get core-dumps
Directory: /var/log/core
24950960 Jun 10 2020 12:24:27 UTC core.nginx.1559278043.gz
24932275 Jun 10 2020 12:24:39 UTC core.dp-fp:1.1575263711.2688.0.11.g
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, ESXi, KVM, NSX Cloud VM, Manager, NSX on VMC
Display the system CPU information.
Example
nsx-manager-1> get cpu-stats
processor : 0
vendor_id : GenuineIntel
cpu family : 6
model : 62
model name : Intel(R) Xeon(R) CPU E5-2440 v2 @ 1.90GHz
stepping : 4
microcode : 0x427
cpu MHz : 1900.000
cache size : 20480 KB
physical id : 0
siblings : 1
core id : 0
cpu cores : 1
apicid : 0
initial apicid : 0
fpu : yes
fpu_exception : yes
cpuid level : 13
wp : yes
flags : fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush dts mmx fxsr sse sse2 ss syscall nx rdtscp lm constant_tsc arch_perfmon pebs bts nopl xtopology tsc_reliable nonstop_tsc aperfmperf pni pclmulqdq ssse3 cx16 pcid sse4_1 sse4_2 x2apic popcnt tsc_deadline_timer aes xsave avx f16c rdrand hypervisor lahf_lm ida arat pln pts dtherm fsgsbase tsc_adjust smep
bogomips : 3800.00
clflush size : 64
cache_alignment : 64
address sizes : 42 bits physical, 48 bits virtual
power management:
processor : 1
vendor_id : GenuineIntel
cpu family : 6
model : 62
model name : Intel(R) Xeon(R) CPU E5-2440 v2 @ 1.90GHz
stepping : 4
microcode : 0x427
cpu MHz : 1900.000
cache size : 20480 KB
physical id : 2
siblings : 1
core id : 0
cpu cores : 1
apicid : 2
initial apicid : 2
fpu : yes
fpu_exception : yes
cpuid level : 13
wp : yes
flags : fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush dts mmx fxsr sse sse2 ss syscall nx rdtscp lm constant_tsc arch_perfmon pebs bts nopl xtopology tsc_reliable nonstop_tsc aperfmperf pni pclmulqdq ssse3 cx16 pcid sse4_1 sse4_2 x2apic popcnt tsc_deadline_timer aes xsave avx f16c rdrand hypervisor lahf_lm ida arat pln pts dtherm fsgsbase tsc_adjust smep
bogomips : 3800.00
clflush size : 64
cache_alignment : 64
address sizes : 42 bits physical, 48 bits virtual
power management:
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display information about the current interface.
Example
nsx-edge-1(path)> get current
{
"admin": "up",
"enable-firewall": false,
"enable-span": false,
"force-reassemble": false,
"ifuid": 289,
"ifuuid": "de650f56-276d-46ef-959e-960752acfe19",
"internal_operation": "up",
"op_state": "up",
"ipns": [
"192.168.130.3/24"
],
"lrouter": "f2a25dd6-4ceb-4bf5-8ad5-3e80d2970d60",
"mac": "02:50:56:00:00:04",
"mtu": 1600,
"peer": "54710465-99a0-481b-ac04-2ff4eda2f270",
"redirect-to-kernel": true,
"stats": {
"rx_bytes": 1564840,
"rx_drop_blocked": 0,
"rx_drop_dst_unsupported": 0,
"rx_drop_firewall": 0,
"rx_drop_ipv6": 0,
"rx_drop_kni": 0,
"rx_drop_l4port_unsupported": 0,
"rx_drop_malformed": 0,
"rx_drop_no_receiver": 0,
"rx_drop_no_route": 0,
"rx_drop_proto_unsupported": 0,
"rx_drop_rpf_check": 0,
"rx_drop_ttl_exceeded": 3,
"rx_drops": 3,
"rx_frag_error": 0,
"rx_frag_ok": 0,
"rx_frag_timeout": 0,
"rx_frags": 0,
"rx_pkts": 23609,
"tx_bytes": 957372,
"tx_drop_blocked": 0,
"tx_drop_firewall": 0,
"tx_drop_frag_needed": 0,
"tx_drop_no_arp": 0,
"tx_drops": 0,
"tx_frag_error": 0,
"tx_frag_ok": 0,
"tx_pkts": 14312
},
"ttl": 1,
"type": "lif",
"urpf-mode": "STRICT_MODE"
}
or
nsx-edge-1(path)> get current
{
"ifuid": 285,
"ifuuid": "9eff9e4e-9157-4107-a0dd-c79350dce6f7",
"lswitch": "d5af58f5-0616-46fd-af83-242d82983c65",
"peer": "140ca8de-61e0-4bba-b429-6a3791b0846a",
"stats": {
"rx_bytes": 9150,
"rx_drop_l2_loop": 0,
"rx_drop_malformed": 0,
"rx_drop_no_match": 0,
"rx_drops": 0,
"rx_pkts": 127,
"tx_bytes": 2807,
"tx_drop_no_mem": 0,
"tx_drops": 0,
"tx_pkts": 38
}
}
Mode
Path
Availability
Autonomous Edge, Edge
Display the datum ID(s) and span(s) for the specified message ID.
| Option | Description |
|---|---|
| <data-id> | ID of the datum Allowed pattern: ^((?!with$).)+$ |
Example
nsx-controller-1> get data c22a70f9-c592-49fb-9df7-33b161160354
id: c22a70f9-c592-49fb-9df7-33b161160354, type: vmware.nsx.nestdb.RuleSectionMsg
span: 7c72c4ae-8fe8-4449-a4e2-c5e53ab0bb4f, 6ca7e1fc-1690-450f-aad3-a2f642fb70c5
Mode
Basic
Availability
Manager
Display datum ID(s) for the specified receiver.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get data with receiver 7c72c4ae-8fe8-4449-a4e2-c5e53ab0bb4f
id: c22a70f9-c592-49fb-9df7-33b161160354, type: vmware.nsx.nestdb.RuleSectionMsg
id: 7c72c4ae-8fe8-4449-a4e2-c5e53ab0bb4f, type: vmware.nsx.nestdb.TransportNodeConfigMsg
id: 4e5d3a8c-5be8-4df6-9a0f-b0458715b036, type: vmware.nsx.nestdb.IpfixConfigurationMsg
id: 73f0fe85-4b28-42d3-8b7c-94cec3879451, type: vmware.nsx.nestdb.RuleSectionMsg
id: 00000000-0000-0000-0000-000000000001, type: vmware.nsx.nestdb.RuleMsg
id: 00000000-0000-0000-0000-000000000002, type: vmware.nsx.nestdb.RuleMsg
status: synced
Mode
Basic
Availability
Manager
Display Data Plane Development Kit (DPDK) configurations, which include fastpath cores, hugepage reserved, NUMA, physical port bindings, etc.
Example
nsx-edge-1> get dataplane
Bfd_ring_size : 512
Corelist : 0
Ctrl_prio_on : True
Fc_max_mem_percore : 394
Fc_mega_cache_size : 262144
Fc_mega_hard_timeout_ms: 423
Fc_mega_soft_timeout_ms: 353
Fc_micro_cache_size: 262144
Firewall_flow_cache_on: 1
Firewall_max_purge_rate: 5
Firewall_max_sessions: 8388608
Firewall_purge_timeout_ms: 10
Firewall_timer_resolution_ms: 50
Flow_cache_mega : True
Flow_cache_micro : True
Hugepage_mem : 1974
Intr_mode_on : True
Ip_reass4_gc_period: 2
Ip_reass4_interfrag_ms: 1000
Ip_reass4_max_ms : 5000
Ip_reass4_maxq_len : 45
Ip_reass4_qhash_order: 8
Ip_reass4_qlist_order: 9
Lacp_ring_size : 512
Learning_ring_size : 512
Link_speed : 0
Mainloop_sleep_threshold: 10
Mainloop_wait_timeout_ms: 1
Mbuf_pool_size : 48128
N_mem_channel : 3
Numa_on : True
Pkt_queue_limit : 0
Pkt_queue_rx_burst_size: 128
Pkt_seg_pnic_limit : 24
Prio_rx_queue_per_core: 8
Rss : c0=0:2:1
Rx_queue_per_core : 8
Rx_ring_size : 512
Slowpath_ring_size : 512
Stt_frag_queue_expire_ms: 3000
Stt_mbuf_queued_limit: 16000
Stt_reass_gc_period_ms: 3000
Tx_ring_size : 512
Devices:
Device_id : 0x07b0
Name : fp-eth0
Numa_node : -1
Pci : 0000:0b:00.00
Vendor : 0x15ad
Device_id : 0x07b0
Name : fp-eth1
Numa_node : -1
Pci : 0000:13:00.00
Vendor : 0x15ad
Device_id : 0x07b0
Name : fp-eth2
Numa_node : -1
Pci : 0000:1b:00.00
Vendor : 0x15ad
Mode
Basic
Availability
Autonomous Edge, Edge
Display data plane cpu statistics.
Example
nsx-edge-1> get dataplane cpu stats
CPU Usage
Core : 0
Crypto : 0 pps
Intercore : 0 pps
Kni : 0 pps
Rx : 0 pps
Slowpath : 0 pps
Tx : 0 pps
Usage : 0.0%
Mode
Basic
Availability
Autonomous Edge, Edge
Display verbose data plane cpu statistics.
Example
nsx-edge-1> get dataplane cpu stats verbose
CPU Usage
Busy_pollrounds : 0
Core : 0
Cpu_type : datapath_core
Crypto : 0 pps
Idle_pollrounds : 1001
Intercore : 0 pps
Kni : 0 pps
Rx : 0 pps
Rx_pkts/pollround : 0.000000
Slowpath : 0 pps
Tx : 0 pps
Usage : 0.0%
Core : 1
Cpu_type : controlpath_core
Usage : 100.0%
Mode
Basic
Availability
Autonomous Edge, Edge
Get the list of supported devices on the system.
Example
edge> get dataplane device list
System datapath-supported devices:
0000:03:00.0 - VMXNET3 Ethernet Controller | Vendor: VMware
^ Kernel interfaces detected: eth0
0000:0b:00.0 - VMXNET3 Ethernet Controller | Vendor: VMware
0000:13:00.0 - VMXNET3 Ethernet Controller | Vendor: VMware
0000:04:00.0 - Ethernet Controller XL710 for 40GbE QSFP+ | Vendor: Intel Corporation
0000:1b:00.0 - VMXNET3 Ethernet Controller | Vendor: VMware
Mode
Basic
Availability
Autonomous Edge, Edge
Display the flow cache configurations.
Example
nsx-edge-1> get dataplane flow-cache config
Enabled : true
Mega_hard_timeout_ms: 4944
Mega_size : 262144
Mega_soft_timeout_ms: 4874
Micro_size : 262144
Mode
Basic
Availability
Autonomous Edge, Edge
Display flow cache statistics for all fastpath cores.
Example
nsx-edge-1> get dataplane flow-cache stats
Micro
Core : 0
Total : 0/262144
Dont cache : 0
Hit rate : 0%
Hits : 0
Insertions : 0
Misses : 1602651
Skipped : 1018653
Bucket collisions : 0
Key collisions : 0
Mega
Core : 0
Total : 0/262144
Dont cache : 2693444
Hit rate : 0%
Hits : 0
Insertions : 0
Misses : 1602651
Skipped : 1018653
Bucket collisions : 0
Key collisions : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display the flow cache statistics for the specified fastpath cores.
| Option | Description |
|---|---|
| <lcore-list-all> | Specify a list of lcore ids or "all" Allowed pattern: ^([0-9]+,)*([0-9]+)$|(all)$ |
Example
nsx-edge-1> get dataplane flow-cache stats 0
Micro
Core : 0
Total : 0/262144
Dont cache : 0
Hit rate : 0%
Hits : 0
Insertions : 0
Misses : 1602797
Skipped : 1018748
Bucket collisions : 0
Key collisions : 0
Mega
Core : 0
Total : 0/262144
Dont cache : 2693695
Hit rate : 0%
Hits : 0
Insertions : 0
Misses : 1602797
Skipped : 1018748
Bucket collisions : 0
Key collisions : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display geneve critical bit configurations.
Example
nsx-edge-1> get dataplane geneve-cbit config
Geneve_cbit_set : True
Mode
Basic
Availability
Autonomous Edge, Edge
Display l2vpn pmtu message generation settings.
Example
nsx-edge-1> get dataplane l2vpn-pmtu config
Enabled : true
Mode
Basic
Availability
Autonomous Edge, Edge
Display data plane memory statistics.
Example
nsx-edge-1> get dataplane memory stats
Memory Usage
Available_entries : 55712
Available_entries_in_cache : 39
Cache_size_per_core : 128
Name : mbuf_pool_socket_0
Per_core_cache
Available_entries : 39
Core_id : 0
Size : 56704
Available_entries : 17407
Cache_size_per_core : 0
Name : sp_pktmbuf_pool
Size : 17408
Mode
Basic
Availability
Autonomous Edge, Edge
Display data plane performance statistics.
| Option | Description |
|---|---|
| <interval> | Specify sample interval |
Example
nsx-edge-1> get dataplane perfstats 2
[
{
"CpuStats": [
{
"core": "0",
"tx": "0 pps",
"kni": "0 pps",
"rx": "0 pps",
"intercore": "0 pps",
"usage": "0%",
"slowpath": "0 pps"
},
{
"core": "1",
"tx": "0 pps",
"kni": "0 pps",
"rx": "0 pps",
"intercore": "0 pps",
"usage": "0%",
"slowpath": "0 pps"
},
{
"core": "2",
"tx": "0 pps",
"kni": "0 pps",
"rx": "0 pps",
"intercore": "0 pps",
"usage": "0%",
"slowpath": "0 pps"
},
{
"core": "3",
"tx": "0 pps",
"kni": "0 pps",
"rx": "0 pps",
"intercore": "0 pps",
"usage": "0%",
"slowpath": "0 pps"
}
]
},
{
"PortStats": [
{
"RxPkts": 5.0,
"RxTput": 375.0,
"TxThput": 309.0,
"PortID": "fp-eth0",
"TxPkts": 4.0
},
{
"RxPkts": 0.0,
"RxTput": 0.0,
"TxThput": 0.0,
"PortID": "fp-eth1",
"TxPkts": 0.0
},
{
"RxPkts": 0.0,
"RxTput": 0.0,
"TxThput": 0.0,
"PortID": "fp-eth2",
"TxPkts": 0.0
}
]
},
{
"FlowCacheStats": {
"micro": [
{
"core": "0",
"hits": "0",
"skipped": "1235795",
"insertions": "0",
"active": "0/262144",
"misses": "0",
"bucket collisions": "0",
"dont cache": "0",
"key collisions": "0",
"hit rate": "n/a"
},
{
"core": "1",
"hits": "0",
"skipped": "19380",
"insertions": "0",
"active": "0/262144",
"misses": "1104864",
"bucket collisions": "0",
"dont cache": "0",
"key collisions": "0",
"hit rate": "0%"
},
{
"core": "2",
"hits": "0",
"skipped": "9701",
"insertions": "0",
"active": "0/262144",
"misses": "2754887",
"bucket collisions": "0",
"dont cache": "0",
"key collisions": "0",
"hit rate": "0%"
},
{
"core": "3",
"hits": "0",
"skipped": "8",
"insertions": "0",
"active": "0/262144",
"misses": "904935",
"bucket collisions": "0",
"dont cache": "0",
"key collisions": "0",
"hit rate": "0%"
}
],
"mega": [
{
"core": "0",
"hits": "0",
"skipped": "1235795",
"insertions": "0",
"active": "0/262144",
"misses": "0",
"bucket collisions": "0",
"dont cache": "6567381",
"key collisions": "0",
"hit rate": "n/a"
},
{
"core": "1",
"hits": "0",
"skipped": "19380",
"insertions": "0",
"active": "0/262144",
"misses": "1104864",
"bucket collisions": "0",
"dont cache": "2932004",
"key collisions": "0",
"hit rate": "0%"
},
{
"core": "2",
"hits": "0",
"skipped": "9701",
"insertions": "0",
"active": "0/262144",
"misses": "2754887",
"bucket collisions": "0",
"dont cache": "3457790",
"key collisions": "0",
"hit rate": "0%"
},
{
"core": "3",
"hits": "0",
"skipped": "8",
"insertions": "0",
"active": "0/262144",
"misses": "904935",
"bucket collisions": "0",
"dont cache": "2503080",
"key collisions": "0",
"hit rate": "0%"
}
]
}
},
{
"NUMAStats": "CPU model not supported"
},
{
"PerfStats": "CPU model not supported"
}
]
Mode
Basic
Availability
Autonomous Edge, Edge
Display dataplane pmtu learning settings.
Example
nsx-edge-1> get dataplane pmtu-learning config
Enabled : true
Mode
Basic
Availability
Autonomous Edge, Edge
Get admin and operational state of QAT crypto acceleration.
Example
nsx-edge-1> get dataplane qat
QAT present, enabled, running
Mode
Basic
Availability
Autonomous Edge, Edge
Calculate all nics throughput given an interval
| Option | Description |
|---|---|
| <time> | Time measurement in seconds Allowed pattern: [1-9][0-9]*$ |
Example
nsx-edge-1> get dataplane throughput 1
fp-eth0:
Rx gbps : 0.0
Rx k err/s : 0.0
Rx mb/s : 0.0
Rx k_err/s : 0.0
Rx k_miss/s : 0.0
Rx k_no_mbufs/s : 0.0
Rx kpps : 0.01
Tx gbps : 0.0
Tx k drops/s : 0.0
Tx mb/s : 0.0
Tx kpps : 0.01
fp-eth1:
Rx gbps : 0.0
Rx k err/s : 0.0
Rx mb/s : 0.0
Rx k_err/s : 0.0
Rx k_miss/s : 0.0
Rx k_no_mbufs/s : 0.0
Rx kpps : 0.01
Tx gbps : 0.0
Tx k drops/s : 0.0
Tx mb/s : 0.0
Tx kpps : 0.0
Mode
Basic
Availability
Autonomous Edge, Edge
Display a specific DHCP IP pool.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get dhcp ip-pool 31b79159-c160-40ba-a9d7-be37186ac658
DHCP_ID: efc4fc20-e00d-416d-819a-88eff8674602
ERROR_THRESHOLD: 100
ID: 31b79159-c160-40ba-a9d7-be37186ac658
OPTIONS:
GENERIC_OPTIONS:
CODE: 51
VALUES:
86400
CODE: 3
VALUES:
192.168.1.1
RANGE:
END:
IPV4: 192.168.1.200
START:
IPV4: 192.168.1.100
WARNING_THRESHOLD: 80
Mode
Basic
Availability
Autonomous Edge, Edge
Display all DHCP IP pools.
Example
nsx-edge-1> get dhcp ip-pools
DHCP_ID: efc4fc20-e00d-416d-819a-88eff8674602
ERROR_THRESHOLD: 100
ID: 31b79159-c160-40ba-a9d7-be37186ac658
OPTIONS:
GENERIC_OPTIONS:
CODE: 51
VALUES:
86400
CODE: 3
VALUES:
192.168.1.1
RANGE:
END:
IPV4: 192.168.1.200
START:
IPV4: 192.168.1.100
WARNING_THRESHOLD: 80
Mode
Basic
Availability
Autonomous Edge, Edge
Display DHCP IP pools which matched a specific server UUID.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get dhcp ip-pools server-uuid efc4fc20-e00d-416d-819a-88eff8674602
DHCP_ID: efc4fc20-e00d-416d-819a-88eff8674602
ERROR_THRESHOLD: 100
ID: 31b79159-c160-40ba-a9d7-be37186ac658
OPTIONS:
GENERIC_OPTIONS:
CODE: 51
VALUES:
86400
CODE: 3
VALUES:
192.168.1.1
RANGE:
END:
IPV4: 192.168.1.200
START:
IPV4: 192.168.1.100
WARNING_THRESHOLD: 80
Mode
Basic
Availability
Autonomous Edge, Edge
Display a specific DHCPv6 IP pool.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get dhcp ipv6-ip-pool e1df2e11-282b-4790-99c8-7df094424c5c
DHCP_ID: bac6fff3-64b7-4ec3-9063-ac4cdfd7a097
ID: e1df2e11-282b-4790-99c8-7df094424c5c
NA_EXCLUDE_RANGE:
END:
IPV6: 1300:1222::1999
START:
IPV6: 1300:1222::1001
END:
IPV6: 1400:1222::6999
START:
IPV6: 1400:1222::6001
NA_LEASE_TIME: 16000
NA_PREFERRED_TIME: 1970-01-01 00:00:12 (timestamp: 12000)
NA_RANGE:
END:
IPV6: 1300:1222::2999
START:
IPV6: 1300:1222::1222
END:
IPV6: 1300:1222::6999
START:
IPV6: 1300:1222::6031
V6_OPTIONS:
DNS_SERVER:
IPV6: 1546:2005::10
IPV6: 1546:2005::111
DOMAIN_NAME:
abc.org
def.org
SNTP_SERVER:
IPV6: 1546:2005::100
IPV6: 1546:2005::200
Mode
Basic
Availability
Autonomous Edge, Edge
Display all DHCPv6 IP pools.
Example
nsx-edge-1> get dhcp ipv6-ip-pools
DHCP_ID: bac6fff3-64b7-4ec3-9063-ac4cdfd7a097
ID: e1df2e11-282b-4790-99c8-7df094424c5c
NA_EXCLUDE_RANGE:
END:
IPV6: 1300:1222::1999
START:
IPV6: 1300:1222::1001
END:
IPV6: 1400:1222::6999
START:
IPV6: 1400:1222::6001
NA_LEASE_TIME: 16000
NA_PREFERRED_TIME: 1970-01-01 00:00:12 (timestamp: 12000)
NA_RANGE:
END:
IPV6: 1300:1222::2999
START:
IPV6: 1300:1222::1222
END:
IPV6: 1300:1222::6999
START:
IPV6: 1300:1222::6031
V6_OPTIONS:
DNS_SERVER:
IPV6: 1546:2005::10
IPV6: 1546:2005::111
DOMAIN_NAME:
abc.org
def.org
SNTP_SERVER:
IPV6: 1546:2005::100
IPV6: 1546:2005::200
Mode
Basic
Availability
Autonomous Edge, Edge
Display DHCPv6 IP pools which match a specific server UUID.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get dhcp ipv6-ip-pools server-uuid e1df2e11-282b-4790-99c8-7df094424c5c
DHCP_ID: bac6fff3-64b7-4ec3-9063-ac4cdfd7a097
ID: e1df2e11-282b-4790-99c8-7df094424c5c
NA_EXCLUDE_RANGE:
END:
IPV6: 1300:1222::1999
START:
IPV6: 1300:1222::1001
END:
IPV6: 1400:1222::6999
START:
IPV6: 1400:1222::6001
NA_LEASE_TIME: 16000
NA_PREFERRED_TIME: 1970-01-01 00:00:12 (timestamp: 12000)
NA_RANGE:
END:
IPV6: 1300:1222::2999
START:
IPV6: 1300:1222::1222
END:
IPV6: 1300:1222::6999
START:
IPV6: 1300:1222::6031
V6_OPTIONS:
DNS_SERVER:
IPV6: 1546:2005::10
IPV6: 1546:2005::111
DOMAIN_NAME:
abc.org
def.org
SNTP_SERVER:
IPV6: 1546:2005::100
IPV6: 1546:2005::200
Mode
Basic
Availability
Autonomous Edge, Edge
Display all non-released DHCPv6 leases by search string.
| Option | Description |
|---|---|
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
Example
nsx-edge-1> get dhcp ipv6-lease 2b2d9a19-eb4c-4be3-8399-9698321ef9cd
DHCP_IP_DUID: 2b2d9a19-eb4c-4be3-8399-9698321ef9cd_582c0f59-db80-440b-a417-329c965d31c9_1300:1222::199a_pool_lease_000124e7ead2000c298ecc78_IA_NA_697224312
DUID_IAID:
DUID: 000124e7ead2000c298ecc78
IA_TYPE: IA_NA
IAID: 697224312
EXPIRE_TIME: 2019-08-16 03:08:49.293000 (timestamp: 1565924929293)
IP_WITH_PREFIX:
IPV6: 1300:1222::199a
PREFIX_LENGTH: 64
LEASE_TIME: 120
PARENT_ID: 582c0f59-db80-440b-a417-329c965d31c9
START_TIME: 2019-08-16 03:06:49.293000 (timestamp: 1565924809293)
TYPE: POOL
Mode
Basic
Availability
Autonomous Edge, Edge
Display all DHCPv6 leases(both released and non-released) by search string.
| Option | Description |
|---|---|
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
Example
nsx-edge-1> get dhcp ipv6-lease 000124e7ead2000c298ecc78 all
DHCP_IP_DUID: 2b2d9a19-eb4c-4be3-8399-9698321ef9cd_582c0f59-db80-440b-a417-329c965d31c9_1300:1222::199a_pool_lease_000124e7ead2000c298ecc78_IA_NA_697224312
DUID_IAID:
DUID: 000124e7ead2000c298ecc78
IA_TYPE: IA_NA
IAID: 697224312
EXPIRE_TIME: 2019-08-16 03:08:49.293000 (timestamp: 1565924929293)
IP_WITH_PREFIX:
IPV6: 1300:1222::199a
PREFIX_LENGTH: 64
LEASE_TIME: 120
PARENT_ID: 582c0f59-db80-440b-a417-329c965d31c9
START_TIME: 2019-08-16 03:06:49.293000 (timestamp: 1565924809293)
TYPE: POOL
Mode
Basic
Availability
Autonomous Edge, Edge
Display all non-released DHCPv6 leases.
Example
nsx-edge-1> get dhcp ipv6-leases
DUID_IAID:
DUID:
IA_TYPE: IA_NA
IAID: 701847352
EXPIRE_TIME: 2019-07-18 07:06:40.103000 (timestamp: 1563433600103)
IP_WITH_PREFIX:
IPV6: 1300:1222::199a
PREFIX_LENGTH: 0
LEASE_TIME: 16000
PARENT_ID: e1df2e11-282b-4790-99c8-7df094424c5c
START_TIME: 2019-07-18 02:40:00.103000 (timestamp: 1563417600103)
TYPE: POOL
Mode
Basic
Availability
Autonomous Edge, Edge
Display all DHCPv6 leases.
Example
nsx-edge-1> get dhcp ipv6-leases all
DUID_IAID:
DUID:
IA_TYPE: IA_NA
IAID: 701847352
EXPIRE_TIME: 2019-07-18 07:06:40.103000 (timestamp: 1563433600103)
IP_WITH_PREFIX:
IPV6: 1300:1222::199a
PREFIX_LENGTH: 0
LEASE_TIME: 16000
PARENT_ID: e1df2e11-282b-4790-99c8-7df094424c5c
START_TIME: 2019-07-18 02:40:00.103000 (timestamp: 1563417600103)
TYPE: POOL
Mode
Basic
Availability
Autonomous Edge, Edge
Display a specific DHCPv6 static binding.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get dhcp ipv6-static-binding 71e7d2e0-2002-4c71-803c-e1ea9865cd81
DHCP_ID: bac6fff3-64b7-4ec3-9063-ac4cdfd7a097
ID: 71e7d2e0-2002-4c71-803c-e1ea9865cd81
MAC:
MAC: 00:50:56:c0:00:08
NA:
IPV6: 1300:1222::1011
IPV6: 1300:1222::2022
NA_LEASE_TIME: 12200
V6_OPTIONS:
DNS_SERVER:
IPV6: 1234:2005::10
IPV6: 1234:2005::111
DOMAIN_NAME:
abc.net
def.net
SNTP_SERVER:
IPV6: 1234:2005::100
IPV6: 1234:2005::200
IPV6: 1300:1222::1011
IPV6: 1300:1222::2022
Mode
Basic
Availability
Autonomous Edge, Edge
Display all DHCPv6 static bindings.
Example
nsx-edge-1> get dhcp ipv6-static-bindings
DHCP_ID: bac6fff3-64b7-4ec3-9063-ac4cdfd7a097
ID: 71e7d2e0-2002-4c71-803c-e1ea9865cd81
MAC:
MAC: 00:50:56:c0:00:08
NA:
IPV6: 1300:1222::1011
IPV6: 1300:1222::2022
NA_LEASE_TIME: 12200
V6_OPTIONS:
DNS_SERVER:
IPV6: 1234:2005::10
IPV6: 1234:2005::111
DOMAIN_NAME:
abc.net
def.net
SNTP_SERVER:
IPV6: 1234:2005::100
IPV6: 1234:2005::200
IPV6: 1300:1222::1011
IPV6: 1300:1222::2022
Mode
Basic
Availability
Autonomous Edge, Edge
Display DHCPv6 static bindings which match a specific server UUID.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get dhcp ipv6-static-bindings server-uuid bac6fff3-64b7-4ec3-9063-ac4cdfd7a097
DHCP_ID: bac6fff3-64b7-4ec3-9063-ac4cdfd7a097
ID: 71e7d2e0-2002-4c71-803c-e1ea9865cd81
MAC:
MAC: 00:50:56:c0:00:08
NA:
IPV6: 1300:1222::1011
IPV6: 1300:1222::2022
NA_LEASE_TIME: 12200
V6_OPTIONS:
DNS_SERVER:
IPV6: 1234:2005::10
IPV6: 1234:2005::111
DOMAIN_NAME:
abc.net
def.net
SNTP_SERVER:
IPV6: 1234:2005::100
IPV6: 1234:2005::200
IPV6: 1300:1222::1011
IPV6: 1300:1222::2022
Mode
Basic
Availability
Autonomous Edge, Edge
Display a specific DHCP lease. You can specify a DHCP server's UUID, or a MAC address, or an IP address.
| Option | Description |
|---|---|
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
Example
nsx-edge-1> get dhcp lease efc4fc20-e00d-416d-819a-88eff8674602
DHCP_ID: efc4fc20-e00d-416d-819a-88eff8674602
DHCP_SUBNET_MAC: efc4fc20-e00d-416d-819a-88eff8674602_192.168.1.100_00:0c:29:03:9c:b2
EXPIRE_TIME: 2016-10-11 23:48:07.136000 (timestamp: 1476229687136)
IP:
IPV4: 192.168.1.100
LEASE_TIME: 86400
MAC:
MAC: 00:0c:29:03:9c:b2
START_TIME: 2016-10-10 23:48:07.136000 (timestamp: 1476143287136)
SUBNET: 192.168.1.0
nsx-edge-1> get dhcp lease 00:0c:29:03:9c:b2
DHCP_ID: efc4fc20-e00d-416d-819a-88eff8674602
DHCP_SUBNET_MAC: efc4fc20-e00d-416d-819a-88eff8674602_192.168.1.100_00:0c:29:03:9c:b2
EXPIRE_TIME: 2016-10-12 19:53:13.057000 (timestamp: 1476301993057)
IP:
IPV4: 192.168.1.100
LEASE_TIME: 86400
MAC:
MAC: 00:0c:29:03:9c:b2
START_TIME: 2016-10-11 19:53:13.057000 (timestamp: 1476215593057)
SUBNET: 192.168.1.0
nsx-edge-1> get dhcp lease 192.168.1.100
DHCP_ID: efc4fc20-e00d-416d-819a-88eff8674602
DHCP_SUBNET_MAC: efc4fc20-e00d-416d-819a-88eff8674602_192.168.1.100_00:0c:29:03:9c:b2
EXPIRE_TIME: 2016-10-12 19:53:13.057000 (timestamp: 1476301993057)
IP:
IPV4: 192.168.1.100
LEASE_TIME: 86400
MAC:
MAC: 00:0c:29:03:9c:b2
START_TIME: 2016-10-11 19:53:13.057000 (timestamp: 1476215593057)
SUBNET: 192.168.1.0
Mode
Basic
Availability
Autonomous Edge, Edge
Display a specific DHCP lease. You can specify a DHCP server's UUID, or a MAC address, or an IP address.
| Option | Description |
|---|---|
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
Example
nsx-edge-1> get dhcp lease efc4fc20-e00d-416d-819a-88eff8674602
DHCP_ID: efc4fc20-e00d-416d-819a-88eff8674602
DHCP_SUBNET_MAC: efc4fc20-e00d-416d-819a-88eff8674602_192.168.1.100_00:0c:29:03:9c:b2
EXPIRE_TIME: 2016-10-11 23:48:07.136000 (timestamp: 1476229687136)
IP:
IPV4: 192.168.1.100
LEASE_TIME: 0
MAC:
MAC: 00:0c:29:03:9c:b2
START_TIME: 2016-10-10 23:48:07.136000 (timestamp: 1476143287136)
SUBNET: 192.168.1.0
nsx-edge-1> get dhcp lease 00:0c:29:03:9c:b2
DHCP_ID: efc4fc20-e00d-416d-819a-88eff8674602
DHCP_SUBNET_MAC: efc4fc20-e00d-416d-819a-88eff8674602_192.168.1.100_00:0c:29:03:9c:b2
EXPIRE_TIME: 2016-10-12 19:53:13.057000 (timestamp: 1476301993057)
IP:
IPV4: 192.168.1.100
LEASE_TIME: 86400
MAC:
MAC: 00:0c:29:03:9c:b2
START_TIME: 2016-10-11 19:53:13.057000 (timestamp: 1476215593057)
SUBNET: 192.168.1.0
nsx-edge-1> get dhcp lease 192.168.1.100
DHCP_ID: efc4fc20-e00d-416d-819a-88eff8674602
DHCP_SUBNET_MAC: efc4fc20-e00d-416d-819a-88eff8674602_192.168.1.100_00:0c:29:03:9c:b2
EXPIRE_TIME: 2016-10-12 19:53:13.057000 (timestamp: 1476301993057)
IP:
IPV4: 192.168.1.100
LEASE_TIME: 86400
MAC:
MAC: 00:0c:29:03:9c:b2
START_TIME: 2016-10-11 19:53:13.057000 (timestamp: 1476215593057)
SUBNET: 192.168.1.0
Mode
Basic
Availability
Autonomous Edge, Edge
Display all non-released DHCP leases.
Example
nsx-edge-1> get dhcp leases
DHCP_ID: efc4fc20-e00d-416d-819a-88eff8674602
DHCP_SUBNET_MAC: efc4fc20-e00d-416d-819a-88eff8674602_192.168.1.100_00:0c:29:03:9c:b2
EXPIRE_TIME: 2016-10-11 23:48:07.136000 (timestamp: 1476229687136)
IP:
IPV4: 192.168.1.100
LEASE_TIME: 86400
MAC:
MAC: 00:0c:29:03:9c:b2
START_TIME: 2016-10-10 23:48:07.136000 (timestamp: 1476143287136)
SUBNET: 192.168.1.0
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IP leases under a DHCP server/subnet
| Option | Description |
|---|---|
| <dhcp-uuid-arg> | DHCP server/subnet UUID Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get dhcp leases 9e0b012c-c93c-4693-9c32-f9e29b7aa928
SubnetPort-ID MAC Subnet IP Type State Start-Time Lease-Time Expire-Time
954f9702-3854-4bda-8bf5-d9c2914ca570 00:50:56:85:95:e9 10.2.0.0 10.2.0.15 Static Active 2024-11-21 13:39:14 86400 2024-11-22 13:39:14
00:00:00:00:00:00 10.2.0.0 10.2.0.1 Dynamic Expiring 2024-11-21 16:10:01 86400 2024-11-22 16:10:01
b3eebfe3-12c2-4c63-9b2c-997175ab229f 00:10:56:98:7d:a5 10.2.0.0 10.2.0.17 Static Active 2024-11-21 13:39:14 86400 2024-11-22 13:39:14
69824af1-2926-469e-8ce3-b7d4b315695a 00:50:56:85:3a:0d 10.2.0.0 10.2.0.2 Dynamic Active 2024-11-21 13:39:14 86400 2024-11-22 13:39:14
5539c4dc-621e-4d8b-8a40-2ee299f1ec73 00:00:00:00:00:00 10.2.0.0 10.2.0.3 Dynamic Expiring 2024-11-21 07:18:01 86400 2024-11-22 07:18:01
Mode
Basic
Availability
Manager
Display all DHCP leases.
Example
nsx-edge-1> get dhcp leases
DHCP_ID: efc4fc20-e00d-416d-819a-88eff8674602
DHCP_SUBNET_MAC: efc4fc20-e00d-416d-819a-88eff8674602_192.168.1.100_00:0c:29:03:9c:b2
EXPIRE_TIME: 2016-10-11 23:48:07.136000 (timestamp: 1476229687136)
IP:
IPV4: 192.168.1.100
LEASE_TIME: 0
MAC:
MAC: 00:0c:29:03:9c:b2
START_TIME: 2016-10-10 23:48:07.136000 (timestamp: 1476143287136)
SUBNET: 192.168.1.0
Mode
Basic
Availability
Autonomous Edge, Edge
Display the DHCP Server IPv6 Stats Entries.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get dhcp server f587ea74-4e67-4097-bca1-baf510837643 ipv6-stats
DHCP_SERVER_ID: f587ea74-4e67-4097-bca1-baf510837643
ERROR_MSG:
INVALID_CONTENT: 0
INVALID_TYPE: 0
MALFORMED_OPTS: 0
SIZE_EXCEEDED: 0
TOTAL_NUM: 0
TRUNCATED: 0
RCVD_MSG:
CONFIRM: 0
DECLINE: 0
INFO_REQ: 0
REBIND: 0
RELAY_FORW: 0
RELEASE: 0
RENEW: 0
REQUEST: 3
SOLICIT: 3
TOTAL_NUM: 6
RCVD_RELAY_MSG:
CONFIRM: 0
DECLINE: 0
INFO_REQ: 0
REBIND: 0
RELEASE: 0
RENEW: 0
REQUEST: 0
SOLICIT: 0
TOTAL_NUM: 0
REPLY_TO:
CONFIRM:
NOADDRAVAIL: 0
NOBINDING: 0
NOTONLINK: 0
TOTAL_NUM: 0
DECLINE:
NOADDRAVAIL: 0
NOBINDING: 0
NOTONLINK: 0
TOTAL_NUM: 0
INFO_REQ:
NOADDRAVAIL: 0
NOBINDING: 0
NOTONLINK: 0
TOTAL_NUM: 0
REBIND:
NOADDRAVAIL: 0
NOBINDING: 0
NOTONLINK: 0
TOTAL_NUM: 0
RELAY_FORW:
NOADDRAVAIL: 0
NOBINDING: 0
NOTONLINK: 0
TOTAL_NUM: 0
RELEASE:
NOADDRAVAIL: 0
NOBINDING: 0
NOTONLINK: 0
TOTAL_NUM: 0
RENEW:
NOADDRAVAIL: 0
NOBINDING: 0
NOTONLINK: 0
TOTAL_NUM: 0
REQUEST:
NOADDRAVAIL: 0
NOBINDING: 0
NOTONLINK: 0
TOTAL_NUM: 3
SOLICIT:
NOADDRAVAIL: 0
NOBINDING: 0
NOTONLINK: 0
TOTAL_NUM: 3
TOTAL_NUM: 6
TIMESTAMP: 2020-07-07 06:52:23.32
Mode
Availability
Edge
Display the DHCP Server IPv4 Stats Entries.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get dhcp server 9effbeb4-971d-43b4-9769-3dce3bf49449 stats
ACKS: 32
DECLINES: 0
DHCP_SERVER_ID: 9effbeb4-971d-43b4-9769-3dce3bf49449
DISCOVERS: 1
ERRORS: 0
INFORMS: 0
NACKS: 0
OFFERS: 1
POOL_USAGE:
ALLOCATED_NUM: 1
DHCP_IP_POOL_ID: cde58ce0-282f-4fed-9a15-dcdb3ecd3cf0
POOL_SIZE: 2
RELEASES: 0
REQUESTS: 32
TIMESTAMP: 2020-07-06 03:59:48.54
Mode
Availability
Edge
Display a specific DHCP server. Optionally specify an argument to display only the status or the synchronization information.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get dhcp server efc4fc20-e00d-416d-819a-88eff8674602
EDGE_CLUSTER_ID: 46944f73-89d0-40b8-86f2-6fd651ba4fb9
EDGE_NODE_ID:
0e10a15f-ca0d-47a7-92ff-9b0aa8d18b4d
b084f07f-bd1f-4d91-bf48-775b896296d5
ID: efc4fc20-e00d-416d-819a-88eff8674602
OPTIONS:
GENERIC_OPTIONS:
CODE: 54
VALUES:
192.168.1.2
CODE: 1
VALUES:
255.255.255.0
SERVER_MAC:
MAC: 00:50:56:98:7d:d7
SERVER_PREFIX:
IPV4: 192.168.1.2
PREFIX_LENGTH: 24
nsx-edge-1> get dhcp server efc4fc20-e00d-416d-819a-88eff8674602 status
DHCP_ID: efc4fc20-e00d-416d-819a-88eff8674602
STATUS: READY
nsx-edge-1> get dhcp server efc4fc20-e00d-416d-819a-88eff8674602 sync
DHCP_ID: efc4fc20-e00d-416d-819a-88eff8674602
LAST_ERROR_TIME: N/A
LAST_SYNC_TIME: N/A
STATUS: OK
Mode
Basic
Availability
Autonomous Edge, Edge
Display all DHCP servers/subnets enabled with DHCP
Example
nsx-controller-1> get dhcp servers
Subnet-Path DHCP Server-ID Subnet-ID VNI
/orgs/default/projects/default/vpcs/vpc-1/subnets/subnet-1-1 8eeb7875-ef19-4d91-9e5d-a5690914338f 9e0b012c-c93c-4693-9c32-f9e29b7aa928 69632
Mode
Basic
Availability
Manager
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.
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.
Example
nsx-edge-1> get dhcp servers
EDGE_CLUSTER_ID: 46944f73-89d0-40b8-86f2-6fd651ba4fb9
EDGE_NODE_ID:
0e10a15f-ca0d-47a7-92ff-9b0aa8d18b4d
b084f07f-bd1f-4d91-bf48-775b896296d5
ID: efc4fc20-e00d-416d-819a-88eff8674602
OPTIONS:
GENERIC_OPTIONS:
CODE: 54
VALUES:
192.168.1.2
CODE: 1
VALUES:
255.255.255.0
SERVER_MAC:
MAC: 00:50:56:98:7d:d7
SERVER_PREFIX:
IPV4: 192.168.1.2
PREFIX_LENGTH: 24
nsx-edge-1> get dhcp servers status
DHCP_ID: efc4fc20-e00d-416d-819a-88eff8674602
STATUS: READY
nsx-edge-1> get dhcp servers sync
DHCP_ID: efc4fc20-e00d-416d-819a-88eff8674602
LAST_ERROR_TIME: N/A
LAST_SYNC_TIME: N/A
STATUS: OK
Mode
Basic
Availability
Autonomous Edge, Edge
Display a specific DHCP static binding.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get dhcp static-binding 3773289c-32f6-4892-a94e-c74a47bf1e71
DHCP_ID: 8bc04d52-b1f9-4258-8d13-b8fdbf031a0d
ID: 3773289c-32f6-4892-a94e-c74a47bf1e71
MAC:
MAC: 12:34:56:78:9a:bc
OPTIONS:
GENERIC_OPTIONS:
CODE: 3
VALUES:
192.168.150.1
CODE: 12
VALUES:
machine-1
CODE: 51
VALUES:
86400
PREFIX:
IPV4: 192.168.150.201
PREFIX_LENGTH: 24
Mode
Basic
Availability
Autonomous Edge, Edge
Display all DHCP static bindings.
Example
nsx-edge-1> get dhcp static-bindings
DHCP_ID: 8bc04d52-b1f9-4258-8d13-b8fdbf031a0d
ID: 3773289c-32f6-4892-a94e-c74a47bf1e71
MAC:
MAC: 12:34:56:78:9a:bc
OPTIONS:
GENERIC_OPTIONS:
CODE: 3
VALUES:
192.168.150.1
CODE: 12
VALUES:
machine-1
CODE: 51
VALUES:
86400
PREFIX:
IPV4: 192.168.150.201
PREFIX_LENGTH: 24
Mode
Basic
Availability
Autonomous Edge, Edge
Display a specific DHCP static bindings which matched a specific server UUID.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get dhcp static-bindings server-uuid 8bc04d52-b1f9-4258-8d13-b8fdbf031a0d
DHCP_ID: 8bc04d52-b1f9-4258-8d13-b8fdbf031a0d
ID: 3773289c-32f6-4892-a94e-c74a47bf1e71
MAC:
MAC: 12:34:56:78:9a:bc
OPTIONS:
GENERIC_OPTIONS:
CODE: 3
VALUES:
192.168.150.1
CODE: 12
VALUES:
machine-1
CODE: 51
VALUES:
86400
PREFIX:
IPV4: 192.168.150.201
PREFIX_LENGTH: 24
Mode
Basic
Availability
Autonomous Edge, Edge
Display the dynamic IP pool usage for a DHCP server/subnet
| Option | Description |
|---|---|
| <dhcp-uuid-arg> | DHCP server/subnet UUID Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get dhcp stats 9e0b012c-c93c-4693-9c32-f9e29b7aa928
Total dynamic IP pool size: 10
Allocated dynamic IP count: 2
Consumed dynamic IP count: 2
Mode
Basic
Availability
Manager
Display DHCP server config for a host switch and dvport
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get dhcp-server config nsxvswitch b65dcac9-6611-41ce-b96c-69255120b473 ipv4
DHCP Server Config
------------------------------------------------------------
Status : Enabled
Server IP : 10.6.0.34
Server MAC : 00:50:56:98:7d:d7
Server NetMask : 255.255.255.224
Desired Client IP : 10.6.0.59
Client MAC : 00:50:56:94:b5:34
Client Requested IP : 10.6.0.59
Server State : Ack Sent
Options Count : 8
List of Configured Option Codes :
1 Subnet Mask : 255.255.255.224
3 Routers : 10.6.0.33
26 Interface MTU : 1500
51 Lease Time : 60
54 Server Identifier : 10.6.0.34
67 Boot File Name : /boot/file/name
121 Classless Static Routes : 10.0.1.0/24 via 10.5.0.97
129.0.1.0/24 via 10.5.0.97
0.0.0.0/0 via 10.6.0.33
249 MS Classless Routes : 10.0.1.0/24 via 10.5.0.97
129.0.1.0/24 via 10.5.0.97
0.0.0.0/0 via 10.6.0.33
Mode
Basic
Availability
ESXi
Display DHCP server stats for a host switch and dvport
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get dhcp-server stats nsxvswitch b65dcac9-6611-41ce-b96c-69255120b473 ipv4
DHCP Server Stats
------------------------------------------------------------
Invalid Hw Addr Type Rx Count : 0
Invalid Options Rx Count : 0
Malformed Packet Rx Count : 0
ARP Reply Failure Count : 0
Forged MAC Rx Drop Count : 0
Packet Rx Drop Count : 0
Relay Packet Rx Drop Count : 0
Packet Alloc Failure Count : 857
Discover Packet Rx : 3
Offer Packet Tx : 3
Request Packet Rx : 3648
Ack Packet Tx : 3648
Nak Packet Tx : 0
Decline Packet Rx : 0
Release Packet Rx : 2
Inform Packet Rx : 0
Mode
Basic
Availability
ESXi
Get edge config diagnosis
Example
nsx-edge-1> get diagnosis config
Passed:
nsxa-state, nsxa-edge-cluster, nsxa-lrouter, nsxa-service-router, nestdb
Failed:
Warning:
nsxa-edge-cluster : no peers
Mode
Basic
Availability
Autonomous Edge, Edge
Get runtime federation health check report
Example
nsx-edge-1> get diagnosis health-check
Time: 2020-05-05 00:04:29.351395
Errors:
Error: Preferred-site route verification failed for SR 4f925560-7ddd-45ea-96ff-f5477e0db1d1
Reason: Preferred-site route not learnt from BGP for SR 4f925560-7ddd-45ea-96ff-f5477e0db1d1
Info:
RTEP-groups consistency verification succeeded
Mode
Basic
Availability
Autonomous Edge, Edge
Check for any inconsistency on local edge
Example
nsx-edge-1> get diagnosis inconsistency
1. Checking routing is up on T0 SR/RTEP
Tier0 SR c154f2bf-4c61-40ea-9c4b-7e03967a1325 routing is down
2. Checking no xtep-group is empty
Remote RTEP group 4441344 is empty for lswitch 736d49c1-67d8-42dd-aa7e-c2964931d127
Mode
Basic
Availability
Autonomous Edge, Edge
Get diagnosis analysis
Example
nsx-edge-c0-1> get diagnosis log
2018-01-03T20:04:14.767Z host-326432070547636738750820273082671025578 NSX 6190 SYSTEM [nsx@4413 comp="nsx-edge" subcomp="lb-dispatcher.nestdb" level="INFO"] nsx-agent nestdb thread started
2018-01-03T20:04:14.767431Z host-326432070547636738750820273082671025578 NSX 5929 - [nsx@4413 comp="nsx-edge" subcomp="nestdb" tid="5929" level="INFO"] CreateVDb: main_vdb
2018-01-03T20:04:14.767467Z host-326432070547636738750820273082671025578 NSX 5929 - [nsx@4413 comp="nsx-edge" subcomp="nestdb" tid="5929" level="ERROR" errorCode="NST0601"] CreateVDb failed: Attempt to create main VDb
***********************************************************************
ERROR:2018-01-03T20:04:14.767523Z host-326432070547636738750820273082671025578 NSX 5929 - [nsx@4413 comp="nsx-edge" subcomp="nsx-rpc" tid="5929" level="ERROR" errorCode="RPC102"] Server:UnaryCall[Service[nestdb::NestDbServer, vmware.nsx.nestdb.NestDb/CreateVDb, RMT_SIMPLE], 0x0000, LOCAL_ERROR] Is in error state (INVALID_ARGUMENT: Attempt to create main VDb, status is reported to the Client)
***********************************************************************
2018-01-03T20:04:14.767728Z host-326432070547636738750820273082671025578 NSX 6190 - [nsx@4413 comp="nsx-edge" subcomp="nsx-rpc" tid="6192" level="ERROR" errorCode="RPC102"] Client:UnaryCall[RpcMethod[vmware.nsx.nestdb.NestDb/CreateVDb, RMT_SIMPLE], 0x0000, REMOTE_ERROR] Is in error state (INVALID_ARGUMENT reported by Server)
2018-01-03T20:04:14.767741Z host-326432070547636738750820273082671025578 NSX 5929 - [nsx@4413 comp="nsx-edge" subcomp="nestdb" tid="5929" level="INFO"] GetVDbId:
2018-01-03T20:04:14.767Z host-326432070547636738750820273082671025578 NSX 6190 SYSTEM [nsx@4413 comp="nsx-edge" subcomp="lb-dispatcher.nestdb" level="WARN"] Failed to create vdb object. The vdb may already exist. RPC status 2: INVALID_ARGUMENT
Mode
Basic
Availability
Autonomous Edge, Edge
Get number of diagnosis entries
| Option | Description |
|---|---|
| <log-num> | Specify number of log entries Allowed pattern: ^([0-9]+)$ |
Example
nsx-edge-c0-1> get diagnosis log limit 1
2018-01-03T20:04:16.548319+00:00 host-326432070547636738750820273082671025578 cfgAgent 6075 - - [DEBUG] Attempting to send data to client 11
2018-01-03T20:04:16.548798+00:00 host-326432070547636738750820273082671025578 cfgAgent 6075 - - [DEBUG] Sent Data to Client 11
2018-01-03T20:04:17.102262+00:00 host-326432070547636738750820273082671025578 NSX 5838 - [nsx@4413 comp="nsx-manager" subcomp="node-mgmt" username="root" level="INFO" audit="True"] 127.0.0.1 - - [2018-01-03 20:04:17] 'GET /api/v1/node/configuration' 200 1201 "" "curl/7.47.0" 0.144964
***********************************************************************
ERROR:2018-01-03T20:04:17.421993+00:00 host-326432070547636738750820273082671025578 NSX 5838 - [nsx@4413 comp="nsx-manager" subcomp="node-mgmt" username="root" level="ERROR" errorCode="NODE10"] Error setting system time, rc: 1, err: Failed to create bus connection: No such file or directory
***********************************************************************
2018-01-03T20:04:17.526811Z host-326432070547636738750820273082671025578 NSX 6075 - [nsx@4413 comp="nsx-controller" subcomp="cfgAgent" tid="71757700" level="verbose"] Checking global lock, current checked count: 1
2018-01-03T20:04:17.577539Z host-326432070547636738750820273082671025578 NSX 6075 - [nsx@4413 comp="nsx-controller" subcomp="cfgAgent" tid="71757700" level="verbose"] TCP connection started: 127.0.0.1:0::00000000-0000-0000-0000-000000000000:1234
2018-01-03T20:04:17.577589Z host-326432070547636738750820273082671025578 NSX 6075 - [nsx@4413 comp="nsx-controller" subcomp="cfgAgent" tid="71757700" level="warning"] socket async connect callback failed. Error code: Connection refused, system
Mode
Basic
Availability
Autonomous Edge, Edge
Get two number of diagnosis entries
| Option | Description |
|---|---|
| <log-num> | Specify number of log entries Allowed pattern: ^([0-9]+)$ |
| <context-line-num> | Specify the numbers of context logs before and after the error log Allowed pattern: ^([0-9]+)$ |
Example
nsx-edge-c0-1> get diagnosis log limit 1 context 1
2018-01-03T20:04:17.102262+00:00 host-326432070547636738750820273082671025578 NSX 5838 - [nsx@4413 comp="nsx-manager" subcomp="node-mgmt" username="root" level="INFO" audit="True"] 127.0.0.1 - - [2018-01-03 20:04:17] 'GET /api/v1/node/configuration' 200 1201 "" "curl/7.47.0" 0.144964
***********************************************************************
ERROR:2018-01-03T20:04:17.421993+00:00 host-326432070547636738750820273082671025578 NSX 5838 - [nsx@4413 comp="nsx-manager" subcomp="node-mgmt" username="root" level="ERROR" errorCode="NODE10"] Error setting system time, rc: 1, err: Failed to create bus connection: No such file or directory
***********************************************************************
2018-01-03T20:04:17.526811Z host-326432070547636738750820273082671025578 NSX 6075 - [nsx@4413 comp="nsx-controller" subcomp="cfgAgent" tid="71757700" level="verbose"] Checking global lock, current checked count: 1
Mode
Basic
Availability
Autonomous Edge, Edge
Get logical topology on edge
Example
nsx-edge-1> get diagnosis topology
Edge node
=========
UUID: 5214.*f675 / status: Up
MGMT 10.172.153.228 / VTEP 26.23.26.4
Loss of all tunnels events: (none)
Max BFD rx packet gap: 887 ms @ 2019-01-11 18:20:01
peer edge ca17.*e06c
--> 10.172.155.100 (mgm BFD) Dn/Dn tx/rx: 654437/650396
--> 26.23.26.3 (tun BFD) Dn/Dn tx/rx: 654495/650490
peer edge cc02.*2111
--> 10.172.154.85 (mgm BFD) Up/Up tx/rx: 654514/654360
--> 27.23.27.3 (tun BFD) Up/Up tx/rx: 654498/654290
Mode
Basic
Availability
Autonomous Edge, Edge
Display the DNS Forwarder Cache Entries.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get dns-forwarder 9b032ded-a109-42ee-b49b-ae05e7b9edf6 cache
CACHE:
Cache size: 150
Cache insertions 0
Cache-Live-freed 0.
Queries forwarded 0,
Queries answered locally 0Host Address Flags Expires
ERR_MSG:
UUID: 9b032ded-a109-42ee-b49b-ae05e7b9edf6
Mode
Basic
Availability
Autonomous Edge, Edge
Display the DNS Forwarder Config.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get dns-forwarder 7f304144-9df2-477f-ad36-89232200a6a7 config
CACHE_SIZE: 1024
DEFAULT_ZONE:
SOURCE_IP:
IPV4: 11.11.11.11
UPSTREAM_SERVERS:
IPV4: 10.117.0.1
ID: 7f304144-9df2-477f-ad36-89232200a6a7
LISTENER_IP:
IPV4: 11.11.11.11
LOG_LEVEL: LB_LOG_LEVEL_INFO
LOGICAL_ROUTER_ID: a5e4fb83-ed0a-45ef-9407-b73740ca9277
SR_CLUSTER_ID: 00002000-0000-0000-0000-000000000001
Mode
Basic
Availability
Autonomous Edge, Edge
Display the DNS Forwarder Stats Entries.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get dns-forwarder 9b032ded-a109-42ee-b49b-ae05e7b9edf6 stats
STATS:
CACHED_ENTRIES: 3
CONDITIONAL_FORWARDER_STATISTICS:
DOMAIN_NAMES:
vmc.example.com
UPSTREAM_STATISTICS:
QUERIES_FAILED: 0
QUERIES_SUCCEEDED: 2
UPSTREAM_SERVER: 3.3.5.10
DOMAIN_NAMES:
2.199.199.in-addr.arpa
UPSTREAM_STATISTICS:
QUERIES_FAILED: 0
QUERIES_SUCCEEDED: 0
UPSTREAM_SERVER: 3.3.5.20
CONFIGURED_CACHE_SIZE: 300
DEFAULT_FORWARDER_STATISTICS:
DOMAIN_NAMES:
UPSTREAM_STATISTICS:
QUERIES_FAILED: 0
QUERIES_SUCCEEDED: 3
UPSTREAM_SERVER: 1.1.5.10
QUERIES_FAILED: 2
QUERIES_SUCCEEDED: 1
UPSTREAM_SERVER: 1.1.5.20
QUERIES_ANSWERED_LOCALLY: 1
QUERIES_FORWARDED: 5
RECEIVED_QUERIES_NUMBER: 6
TIME_STAMP: 2018-07-24 10:05:19.895000 (timestamp: 1532426719895)
USED_CACHE_SIZE: 0
UUID: 9b032ded-a109-42ee-b49b-ae05e7b9edf6
Mode
Basic
Availability
Autonomous Edge, Edge
Display DNS Forwarder Status
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get dns-forwarder 7f304144-9df2-477f-ad36-89232200a6a7 status
ID : 7f304144-9df2-477f-ad36-89232200a6a7
STATUS : up
ERR_MSG :
Mode
Basic
Availability
Autonomous Edge, Edge
Display the DNS Forwarder Entries.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get dns-forwarder 9b032ded-a109-42ee-b49b-ae05e7b9edf6 table
ERR_MSG:
TABLE:
Domain-name Forwarder-Source-Address DNS-Server-Address Number-of-Queries Failed-Queries
(null) 10.117.0.1 11.11.11.13 0 0
UUID: 9b032ded-a109-42ee-b49b-ae05e7b9edf6
Mode
Basic
Availability
Autonomous Edge, Edge
Live debugging the DNS Forwarder
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <ip-address> | Network IP address argument |
| <hostname-or-ip-address> | A hostname or IP address |
Mode
Basic
Availability
Autonomous Edge, Edge
Display the DNS Forwarder Cache Entries Per SR.
Example
nsx-edge-1(tier0_sr)> get dns-forwarder cache
CACHE:
Cache size: 150
Cache insertions 0
Cache-Live-freed 0.
Queries forwarded 0,
Queries answered locally 0Host Address Flags Expires
ERR_MSG:
UUID: 9b032ded-a109-42ee-b49b-ae05e7b9edf6
Mode
Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Live debugging the DNS Forwarder
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| <hostname-or-ip-address> | A hostname or IP address |
Mode
Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display the DNS Forwarder Stats Entries Per SR.
Example
nsx-edge-1(tier0_sr)> get dns-forwarder stats
STATS:
CACHED_ENTRIES: 3
CONDITIONAL_FORWARDER_STATISTICS:
DOMAIN_NAMES:
vmc.example.com
UPSTREAM_STATISTICS:
QUERIES_FAILED: 0
QUERIES_SUCCEEDED: 2
UPSTREAM_SERVER: 3.3.5.10
DOMAIN_NAMES:
2.199.199.in-addr.arpa
UPSTREAM_STATISTICS:
QUERIES_FAILED: 0
QUERIES_SUCCEEDED: 0
UPSTREAM_SERVER: 3.3.5.20
CONFIGURED_CACHE_SIZE: 300
DEFAULT_FORWARDER_STATISTICS:
DOMAIN_NAMES:
UPSTREAM_STATISTICS:
QUERIES_FAILED: 0
QUERIES_SUCCEEDED: 3
UPSTREAM_SERVER: 1.1.5.10
QUERIES_FAILED: 2
QUERIES_SUCCEEDED: 1
UPSTREAM_SERVER: 1.1.5.20
QUERIES_ANSWERED_LOCALLY: 1
QUERIES_FORWARDED: 5
RECEIVED_QUERIES_NUMBER: 6
TIME_STAMP: 2018-07-24 10:05:19.895000 (timestamp: 1532426719895)
USED_CACHE_SIZE: 0
UUID: 630ccdc4-4b8e-4d2e-9242-b27b689e0feb
Mode
Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display the DNS Forwarder Entries Per SR.
Example
nsx-edge-1(tier0_sr)> get dns-forwarder status
ERR_MSG:
STATUS: up
UUID: 14590164-e8fc-4949-bad7-fe6909fb1099
Mode
Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display the DNS Forwarder Entries Per SR.
Example
nsx-edge-1(tier0_sr)> get dns-forwarder table
ERR_MSG:
TABLE:
Domain-name Forwarder-Source-Address DNS-Server-Address Number-of-Queries Failed-Queries
(null) 10.117.0.1 11.11.11.13 0 0
UUID: 9b032ded-a109-42ee-b49b-ae05e7b9edf6
Mode
Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display the DNS Forwarders Config.
Example
nsx-edge-1> get dns-forwarders config
CACHE_SIZE: 1024
DEFAULT_ZONE:
SOURCE_IP:
IPV4: 11.11.11.11
UPSTREAM_SERVERS:
IPV4: 10.117.0.1
ID: 7f304144-9df2-477f-ad36-89232200a6a7
LISTENER_IP:
IPV4: 11.11.11.11
LOG_LEVEL: LB_LOG_LEVEL_INFO
LOGICAL_ROUTER_ID: a5e4fb83-ed0a-45ef-9407-b73740ca9277
SR_CLUSTER_ID: 00002000-0000-0000-0000-000000000001
Mode
Basic
Availability
Autonomous Edge, Edge
Display DNS Forwarder Status
Example
nsx-edge-1> get dns-forwarders status
ERR_MSG:
STATUS: up
UUID: 14590164-e8fc-4949-bad7-fe6909fb1099
ERR_MSG:
STATUS: up
UUID: 9b032ded-a109-42ee-b49b-ae05e7b9edf6
Mode
Basic
Availability
Autonomous Edge, Edge
List all the docker containers in the system (equivalent of 'docker ps -a').
Example
loaclhost> get docker-containers
ID NAME TAG STATUS
d53656a836 sec-mon nsx-security-monitor:current running
Mode
Basic
Availability
List docker images in the system (equivalent of 'docker images').
Example
loaclhost> get docker-images
ID TAGS
d53656a836 nsx-security-monitor:current
Mode
Basic
Availability
Display information about the specified domain object.
| Option | Description |
|---|---|
| <uuid> | Domain object identifier |
Example
nsx-controller-1> get domain-object 348e20a9-8b6e-4209-81df-779bff97781d
id: 348e20a9-8b6e-4209-81df-779bff97781d
type: RuleSection
content: com.vmware.nsx.ccp.domain.entity.RuleSection@1642d5b0[message=priority: 2305843009213693951
name: "Default Layer2 Section"
version: "0"
,id=348e20a9-8b6e-4209-81df-779bff97781d,resolver=com.vmware.nsx.falcon.FalconImpl@6306e14c]
nsx-controller-1> get domain-object "d8cad454-b1f6-49a2-aeea-c123124fbbc0:host-18"
id: d8cad454-b1f6-49a2-aeea-c123124fbbc0:host-18
type: DiscoveredNode
content: com.vmware.nsx.ccp.domain.entity.DiscoveredNode@2350ae24[objectId=d8cad454-b1f6-49a2-aeea-c123124fbbc0:host-18,resolver=com.vmware.nsx.falcon.FalconImpl@57da957e]
Mode
Basic
Availability
Manager
Display domain objects of the specified type.
| Option | Description |
|---|---|
| <domain_object_type> | Domain object type Allowed values: AbstractProfile, AggregatedSecurityFeatureToggle, AntreaCluster, ArpTableConfig, BaremetalController, BareMetalServer, BfdConfig, BfdGlobalConfig, BfdHealthMonitoringConfig, BgpConfig, BgpNeighbor, BmsInterface, BmsInterfaceTag, BmsTag, BridgeEndpoint, BridgeEndpointProfile, CaBundle, Certificate, CertificateRevocationList, Cif, ClusterVersion, CommunityList, ComputedDadState, Container, ContextProfile, CryptoServiceKey, DadProfileConfig, DadStateRequest, DataCollectionConfig, DfwFirewallConfiguration, DhcpIpPool, DhcpRelay, DhcpStaticBinding, Dhcpv6IpPool, Dhcpv6StaticBinding, DirectoryGroup, DistinguishedNameObject, DnsForwarder, DTGWRoutingDomain, EastWestSiPolicy, EdgeClusterConfig, EdgeNode, EventConfig, EvpnService, EvpnTunnelEndpoint, EwSiRedirectionPolicy, ExcludeList, FederationDrPolicy, FederationGlobalConfig, FirewallExcludeList, FQDNAnalysisConfig, GiSolutionInfo, GlobalCollectionConfiguration, GlobalConfig, GlobalRouting, Hypervisor, IdentityIpSet, IdsSignatures, InstanceEndpoint, InstanceRuntime, IpDiscoveryProfile, IpfixCollectorConfiguration, IpfixDfwConfiguration, IpReputationChunkParent, IPReputationFeedConfig, IpsecDpdProfile, IpsecIkeProfile, IpsecLocalEndpoint, IpsecPeerEndpoint, IpsecTunnelProfile, IpsecVpnServiceBinding, IpsecVpnSession, IpSpec, L2VpnService, L2VpnSession, L3SiRedirectionPolicy, L7AccessEntry, L7AccessProfile, Layer3SiPolicy, LoadBalancerApplicationProfile, LoadBalancerApplicationRule, LoadBalancerCertificate, LoadBalancerClientSslProfile, LoadBalancerMonitor, LoadBalancerPersistenceProfile, LoadBalancerPool, LoadBalancerServerSslProfile, LoadBalancerService, LoadBalancerVirtualServer, LogicalDhcpServer, LogicalMDProxyServer, LogicalPortEipBinding, LogicalRouter, LogicalRouterBfdPeer, LogicalRouterPort, LogicalRouterPortDadState, LogicalServiceRouterCluster, LogicalSwitch, LogicalSwitchPort, LogicalSwitchPortBindings, LogRouterInterfaceGroup, LogRouterQosProfileConfig, LogSwitchProxyState, LogSwitchState, MacAddress, MacDiscoveryProfile, MplsVrfConfig, MulticastConfig, MulticastStaticRoute, NdraProfileConfig, NestDbCifState, NestDbVifState, NorthSouthSiPolicy, NsgMembershipStatus, NsSiRedirectionPolicy, OpaqueLogicalSwitch, OspfAreaConfig, OspfConfig, OspfInterfaceConfig, ParentLogicalRouter, PersistedBindings, PimConfig, PortMirrorSession, PrecedenceAppliedTo, PrefixList, PublicCloudGatewayNode, QosProfile, Redistribution, RedistributionRuleList, RemoteLogSwitchState, RemoteSiteContainer, RemoteSiteRtep, RouteMap, RouteNextHop, RoutingDomainState, Rule, RuleSection, SectionPriority, SectionPublish, SegmentSecurityProfile, Service, ServiceAttachment, ServiceChain, ServiceConfigProfile, ServiceEntry, ServiceInstance, ServicePath, ServiceProfile, ServiceVM, ServiceVmStatus, ShardingTable, SiExcludeList, SiRedirectionPolicy, SiService, SiStatusConfiguration, StaticMime, StaticRoute, TgwContainer, TlsActionProfile, TlsInspectionCertificate, TlsState, TransportNode, TransportNodeConnectionStatus, UrlCategorizationConfig, UserDefinedFeatureStackCollectionConfiguration, Vif, VifTnBindingExpiration, VmConfig, VmProperties, VmTags, Vni, VtepGroupState |
Example
nsx-controller-1> get domain-objects RuleSection
id: 348e20a9-8b6e-4209-81df-779bff97781d, type: RuleSection
id: a9ccd570-9b6f-42e9-a372-162c4b00238e, type: RuleSection
id: 00003200-0000-0000-0000-000000000001, type: RuleSection
id: 00003200-0000-0000-0000-000000000002, type: RuleSection
Mode
Basic
Availability
Manager
Display domain objects of the specified type with the specified component name
| Option | Description |
|---|---|
| <objects_type_with_component_name> | Object type with component name Allowed values: rule, rulesection |
| <component-name> | Component name Allowed values: dfw |
Example
nsx-controller-1> get domain-objects rule dfw
id: 00000000-0000-0000-0000-000000000401, type: Rule, rule config message id: 1025, section: 17df3754-73df-4809-8820-fe01ee57d02a
id: 00000000-0000-0000-0000-000000000402, type: Rule, rule config message id: 1026, section: ba6ae44f-4ea2-4167-a298-75849a458273
Mode
Basic
Availability
Manager
Display NSX DPI Lib Log Level.
Example
> get dpi lib-dfw logging-level all
NSX DPI DFW Library Log Level
--------------------------------------------------
address: noise
api: noise
cache: noise
cmd: noise
filter: noise
flow: noise
io: noise
ipfix: noise
lexer: noise
library: noise
misc: noise
msgbuf: noise
netx: noise
parser: noise
protobuf: noise
protocol: noise
rule: noise
trie: noise
util: noise
Mode
Basic
Availability
ESXi
Display NSX DPI Log Level.
Example
> get dpi logging-level
NSX DPI Log Level
--------------------------------------------------
info
Mode
Basic
Availability
ESXi
Display NSX DPI Statistics.
Example
> get dpi stats
NSX DPI Statistics
--------------------------------------------------
Mode
Basic
Availability
ESXi
Display the Edge cluster state history.
Example
nsx-edge-1> get edge-cluster history state
State : Disabled
Time : 2016-09-12 18:07:03.20
Event : Init
Reason : Init
State : Offline
Time : 2016-09-20 10:19:24.22
Event : Config Updated
Reason : Config
State : Discover
Time : 2016-09-20 10:19:24.22
Event : Config Updated
Reason : Config
State : StateSync
Time : 2016-09-20 10:19:25.19
Event : BFD State Updated
Reason : Updated
State : Inactive
Time : 2016-09-20 10:19:30.50
Event : State Sync Completed
Reason : Updated
State : Active
Time : 2016-09-20 10:19:30.50
Event : State Sync Completed
Reason : Updated
State : Inactive
Time : 2016-10-10 13:53:30.88
Event : Node State Changed
Reason : Tunnels Down
Mode
Basic
Availability
Autonomous Edge, Edge
Display the Edge cluster status.
Example
nsx-edge-1> get edge-cluster status
High Availability State : Inactive
Since : 2016-10-10 13:53:30.88
Edge Node Id : f9933e11-96a5-48fa-9f64-9c3b789d530c
Edge Node Status : Down
Admin State : Up
Vtep State : Up
Configuration : applied
Health Check Config :
Interval : 1000 msec
Deadtime : 3000 msec
Max Hops : 255
Service Status :
Datapath Config Channel : Up
Datapath Status Channel : Up
Routing Status Channel : Up
Routing Status : Down
Peer Status :
Node Id : 14693d4d-de8b-417e-a53c-315702fc72c5
Node Status : Admin Down
Healthcheck Sessions :
Interface : eth0
Session : 192.168.110.111:192.168.110.112
Status : Admin Down
Interface : vtep-0
Device : fp-eth0
Session : 192.168.150.201:192.168.150.202
Status : Unreachable
Mode
Basic
Availability
Autonomous Edge, Edge
Get IDS Event Engine config stats.
Example
rahum-svc> get edgeids event-config stats
--------------------------------------------------
NSX Intrusion Detection Event Config Statistics
--------------------------------------------------
Kafka Info
Kafka Broker Cnt 1
Ids Topics 1
Nestdb messages
Pace Config Present 0
Cmn Agent Config Present 1
Ids Evt Config Present 1
--------------------------------------------------
Mode
Availability
Edge
Get IDS Engine Event stats.
Example
rahum-svc> get edgeids events stats
--------------------------------------------------
NSX Intrusion Detection Service Statistics
--------------------------------------------------
Total 2
Critical 2
Non-Critical 0
Protos to MP
Sent 2
Dropped 0
Alerts to MP
Sent 2
Dropped 0
Event Drops Reason
Queue Full 0
Rate Limited 110
Kafka Info
Ids Events Delivered 1
Ids Events Not Delivered 0
Kafka Event Queue
Dropped 0
--------------------------------------------------
Mode
Availability
Edge
Show the current device affinity of enhanced datapath.
Example
esx-1> get ens dev affinity list
Dev Name : vmnic1
Affinity : 0
esx-1>
Mode
Basic
Availability
ESXi
Show flow stats for an ENS switch with switch ID
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
Example
esx-1> get ens flow-stats 0
numFlows : 0
numModel2Flows : 0
hits : 0
miss : 1738
slowpath : 12334
fpoHits : 0
localHits : 0
firstLookupHits : 0
firstLookupLocalCacheHits : 0
actionAllocFails : 0
actionGroupAllocFails : 0
keyInsertFailCount : 0
latSampleCount : 0
fpoCTHwPktQueued : 0
fpoCTHwPktDrop : 0
fpoCTPktsInjectedToHW : 0
fpoCTPktsContinuedInSW : 0
fpoCTHwContextFailed : 0
fpoCTHwFlowInval : 0
fpoMarkMismatched : 0
fpoPnicMismatched : 0
fpoDelayMarkMatching : 0
fpoEphemeralFlows : 0
fpoTransientFlows : 0
fpoBackoffTimes : 0
esx-1>
Mode
Basic
Availability
ESXi
Show flow stats for an ENS fastpath with switch ID and lcore ID
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
| <lcore-ID> | Lcore ID Allowed pattern: ^([0-9]|[1-5][0-9]|6[0-3])$ |
Example
esx-1> get ens flow-stats 0 0
lcoreID : 0
numFlows : 0
numModel2Flows : 0
hits : 0
miss : 1738
slowpath : 12334
fpoHits : 0
localHits : 0
firstLookupHits : 0
firstLookupLocalCacheHits : 0
actionAllocFails : 0
actionGroupAllocFails : 0
keyInsertFailCount : 0
latSampleCount : 0
fpoCTHwPktQueued : 0
fpoCTHwPktDrop : 0
fpoCTPktsInjectedToHW : 0
fpoCTPktsContinuedInSW : 0
fpoCTHwContextFailed : 0
fpoCTHwFlowInval : 0
fpoMarkMismatched : 0
fpoPnicMismatched : 0
fpoDelayMarkMatching : 0
fpoEphemeralFlows : 0
fpoTransientFlows : 0
fpoBackoffTimes : 0
esx-1>
Mode
Basic
Availability
ESXi
Dump Flow Table for all lcores of requested switch ID
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
Example
esx-1> get ens flow-table dump
FT dstMAC srcMAC VLAN srcPort srcIP dstIP proto VNI srcPort/type dstPort/code swHits swBytes hwHits hwBytes Actions
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
L4 00:0c:29:3a:fa:62 00:0c:29:19:77:a1 0 1 192.168.0.2 192.168.0.1 6 0 32932 5201 16 1386 0 0 bmap:0x80 inval(s):121 cg:12 dp:0 len:704;
L4 00:0c:29:19:77:a1 00:0c:29:3a:fa:62 0 0 192.168.0.1 192.168.0.2 6 0 5201 32932 13 1069 0 0 bmap:0x80 inval(s):122 cg:12 dp:0x1 len:704;
L4 00:0c:29:19:77:a1 00:0c:29:3a:fa:62 0 0 192.168.0.1 192.168.0.2 6 0 5201 32938 200862 13257252 0 0 bmap:0x80 inval(s):115 cg:12 dp:0x1 len:704;
L4 00:0c:29:3a:fa:62 00:0c:29:19:77:a1 0 1 192.168.0.2 192.168.0.1 6 0 32938 5201 608926 39616303361 0 0 bmap:0x80 inval(s):103 cg:12 dp:0 len:704;
Mode
Basic
Availability
ESXi
Dump Flow Table for a specific lcore from specific switch
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
| <lcore-ID> | Lcore ID Allowed pattern: ^([0-9]|[1-5][0-9]|6[0-3])$ |
Example
esx-1> get ens flow-table dump 0 1
key : L4 00:0c:29:19:77:a1 00:0c:29:3a:fa:62 0 0 192.168.0.2 192.168.0.1 6 0 5201 33176
actions : bmap:0x80 inval(s):1034 cg:12 dp:0x1 len:704;
swHits : 201315
swBytes : 13287234
hwHits : 0
hwBytes : 0
key : L4 00:0c:29:19:77:a1 00:0c:29:3a:fa:62 0 0 192.168.0.2 192.168.0.1 6 0 5201 33168
actions : bmap:0x80 inval(s):1051 cg:12 dp:0x1 len:704;
swHits : 13
swBytes : 1067
hwHits : 0
hwBytes : 0
esx-1>
Mode
Basic
Availability
ESXi
Get flow table size
Example
esx-1> get ens flow-table size
Flow table size is 65536
esx-1>
Mode
Basic
Availability
ESXi
Get flow timeout in seconds
Example
esx-1> get ens flow-table timeout
Flow timeout in 90 seconds
esx-1>
Mode
Basic
Availability
ESXi
Get global FPO configuration
Example
esx-1> get ens fpo
FPO is globally enabled
esx-1>
Mode
Basic
Availability
ESXi
Get FPO stats for a datapath with switch ID and lcore ID
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
| <lcore-ID> | Lcore ID Allowed pattern: ^([0-9]|[1-5][0-9]|6[0-3])$ |
Example
esx-1> get ens fpo stats 1 0
lcoreID : 1
hits : 0
markMismatched : 0
pnicMismatched : 0
delayMarkMatching : 0
ephemeralFlows : 0
transientFlows : 0
ctHWPktQueued : 0
ctPktsInjectedtoHW : 0
ctPktsContinuedInSW : 0
ctHwContextFailed : 0
esx-1>
Mode
Basic
Availability
ESXi
Get FPO stats for a datapath with uplink name
| Option | Description |
|---|---|
| <uplink> | Uplink identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get ens fpo stats vmnic1
FPO Call Ring Full : 0
Flow Creation Ring Full : 0
Flow Destroy Ring Full : 0
Flow Update Ring Full : 0
Bulk ResOps Ring Full : 0
FPO Call Session Mismatch : 0
Device Capacity Exceeded : 0
Succeeded Flow Validations : 0
Succeeded Flow Creations : 0
Succeeded Flow Destroys : 0
Succeeded Flow Queries : 0
Succeeded Flow Flushes : 0
Failed Flow Validations : 0
Failed Flow Creations : 0
Failed Flow Destroys : 0
Failed Flow Queries : 0
Failed Flow Flushes : 0
Pending FPO Flows : 0
Succeeded Bulk Res Allocs : 0
Succeeded Bulk Res Frees : 0
Succeeded Bulk Res Queries : 0
Succeeded Bulk Res Sets : 0
Succeeded Bulk Res Resets : 0
Failed Bulk Res Allocs : 0
Failed Bulk Res Frees : 0
Failed Bulk Res Queries : 0
Failed Bulk Res Sets : 0
Failed Bulk Res Resets : 0
Succeeded CT Creates : 0
Succeeded CT Destroys : 0
Succeeded CT Modifies : 0
Succeeded CT Queries : 0
Failed CT Creates : 0
Failed CT Destroys : 0
Failed CT Modifies : 0
Failed CT Queries : 0
FPO Uplink Enable Calls : 1
FPO Uplink Disable Calls : 0
FPO Calls in Disabled State : 0
esx-1>
Mode
Basic
Availability
ESXi
Get FPO status for an uplink
| Option | Description |
|---|---|
| <uplink> | Uplink identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get ens fpo status vmnic1
FPO Models : None
Groups Supported : 1
Priorities Supported : 1
Mark Action Bits : 32
Flows Supported : 0
Counters Supported : 0
Max Flow Key Length in Bits : 384
Max Decrement TTL Action : 0
Current Offloaded Flows : 0
Actions Supported : 243
esx-1>
Mode
Basic
Availability
ESXi
Get HW flow cache counters on smart NIC
Example
esx-1> get ens hw-flow-stats processed
HwNumFlowTables : 4
HwFlowTableSize : 262144
HwNumFlows : 0
hwNumFlowsCreated : 24
HwHits : 0
HwInsertionErrors : 0
HwRedirect : 0
HwFlowMissUnicast : 0
HwFlowMissBcastMcast : 2649
SwNumFlows : 0
HwFlowTableOccupancyPct : 0
esx-1>
Mode
Basic
Availability
ESXi
Get the lcore latency config data
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
Example
esx-1> get ens latency lcore config 0
Latency measurement for all lcores is enabled
Sample Rate: 3
esx-1>
Mode
Basic
Availability
ESXi
Dump the lcore latency stats data
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
Example
esx-1> get ens latency lcore dump 0
Latency histogram after cumulating all lcores result
Latency Uplink Tx Polling ports Scheduling the lcore ENS Slowpath
TotalSamples 653315 1008090 77522 13
minLatency 10 1 1 10
maxLatency 504 562 60 62
mean 12 4 1 38
32us 649769 1007761 77521 3
64us 2711 164 1 10
96us 446 122 0 0
128us 160 17 0 0
160us 75 15 0 0
192us 46 3 0 0
256us 49 2 0 0
512us 59 5 0 0
1024us 0 1 0 0
2048us 0 0 0 0
4096us 0 0 0 0
MAX 0 0 0 0
esx-1>
Mode
Basic
Availability
ESXi
Dump latency histos for all vmxnet3 vnics and all lcores of this switch
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
Example
esx-1> get ens latency system dump 0
Latency histogram after cumulating all lcores result
Latency Uplink Tx Polling ports Scheduling the lcore ENS Slowpath
TotalSamples 653315 1008090 77522 13
minLatency 10 1 1 10
maxLatency 504 562 60 62
mean 12 4 1 38
32us 649769 1007761 77521 3
64us 2711 164 1 10
96us 446 122 0 0
128us 160 17 0 0
160us 75 15 0 0
192us 46 3 0 0
256us 49 2 0 0
512us 59 5 0 0
1024us 0 1 0 0
2048us 0 0 0 0
4096us 0 0 0 0
MAX 0 0 0 0
PortID: 0 SampleRate: 48000 enableE2E: enabled
Latency txLatencyHisto rxLatencyHisto vmRxLatencyHisto intrLatencyHisto
TotalSamples 53786 78435 64896 43897
minLatency 2 8 1 10
maxLatency 304 578 71 92
mean 13 15 4 38
32us 49769 67962 57321 42115
64us 2732 3578 2689 2187
96us 356 422 311 245
128us 160 170 154 122
160us 74 77 45 24
192us 22 38 28 12
256us 10 12 8 0
512us 4 5 0 0
1024us 0 0 0 0
2048us 0 0 0 0
4096us 0 0 0 0
MAX 0 0 0 0
esx-1>
Mode
Basic
Availability
ESXi
Show the current mode of enhanced datapath lcore assignment.
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
Example
esx-1> get ens lcore-assignment-mode nsxvswitch
LCore assignment mode for nsxvswitch is vNIC count
Mode
Basic
Availability
ESXi
List all ports in all switches
Example
esx-1> get ens port list
portID ensPID TxQ RxQ hwMAC numMACs type Queue Placement(tx|rx)
------------------------------------------------------------------------------
2281701393 0 23 23 e4:43:4b:99:ea:22 0 UPLINK 0 - - - - - - - - - - - - - - - - - - - - - - |0 0 0 0 0 0 0 0 0 - - - - - - - - - - - - - -
esx-1>
Mode
Basic
Availability
ESXi
List all ports in a specified ENS switch
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
Example
esx-1> get ens port list 0
Port ID : 2315255824
Ens Port ID : 0
Num TxQ : 23
Num RxQ : 23
Hardware MAC : e4:43:4b:99:ea:22
Num MACs : 0
Client Type : UPLINK
txQLM : [0, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255]
rxQLM : [0, 0, 0, 0, 0, 0, 0, 0, 0, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255]
esx-1>
Mode
Basic
Availability
ESXi
Get the netq information for a port
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
| <ens-port-id> | ENS port ID in ENS switch Allowed pattern: ^[0-9]+$ |
Example
esx-1> get ens port netq 0
isUplink : 1
isFlowFilter : 0
swID : 0
ensPortID : 0
filters : []
esx-1>
Mode
Basic
Availability
ESXi
Get PRP config for a switch
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
Example
esx-1> get ens prp config 0
PRP Config for switch 0
PRP uplink(channel) vmnic128
LanA uplink1 vmnic4
LanA uplink2 None
LanA policy Active_Standby
LanA status UP
LanB uplink1 vmnic5
LanB uplink2 None
LanB policy Active_Standby
LanB status UP
Red Box MAC 2c:ea:7f:72:61:21
Default Supervision Multicast 01:15:4e:00:01:00
esx-1>
Mode
Basic
Availability
ESXi
List all active PRP nodes
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
Example
esx-1> get ens prp node 0
NodeIndex Node MAC vlanID Type Red Box MAC CurrLcore vDAN MAC sanA sanB supSeqA supAAge(s) supSeqB supBAge(s) NodeAge(s)
================================================================================================================================================
0 00:50:56:66:85:80 0 SAN - - - 1 1 - - - - 45
1 00:50:56:64:e8:c3 0 SAN - - - 1 1 - - - - 45
2 00:50:56:59:50:8e 0 SAN - - - 1 0 - - - - 44
3 00:50:56:5c:13:95 0 SAN - - - 0 1 - - - - 44
4 00:50:56:62:f5:bd 0 SAN - - - 0 1 - - - - 44
5 00:50:56:57:85:33 0 SAN - - - 0 1 - - - - 44
Total PRP Nodes: 6
esx-1>
Mode
Basic
Availability
ESXi
Get a PRP node information
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
| <vlan-id> | VLAN ID Allowed pattern: ^[0-9]+$ |
| <mac-addr> | MAC address |
Example
esx-1> get ens prp node 0 0 00:0c:29:d0:2c:88
Fri Jun 28 2024 UTC 22:13:14.641
NodeIndex 8
Node MAC 00:0c:29:d0:2c:88
Node VLANID 0
Node Type DAN
Associated vDAN MAC 00:0c:29:40:75:e0
Red Box MAX 00:0c:29:4e:1f:c1
Operation mode Duplicate_Discard
Last supervision seq from LANA 54
Last supervision seq from LANB 54
Last received seq from LANA 144
Last received seq from LANB 144
Number of Lcore move 0
Number vDAN change 0
Number of VLAN change 0
Current LcoreID 0
Last LANA supervision frame age(s) 1
Last LANB supervision frame age(s) 1
Last LANA received frame age(ms) 194
Last LANB received frame age(ms) 194
LANA
prpRxPkts 82
nonPRPRxPkts 0
rxBytes 8160
dupDrops 0
outOfOrderDrops 0
wrongLANDrops 137
supRxPkts 55
LANB
prpRxPkts 82
nonPRPRxPkts 0
rxBytes 8160
dupDrops 82
outOfOrderDrops 0
wrongLANDrops 137
supRxPkts 55
Node creation time Fri Jun 28 22:11:22 2024
esx-1>
Mode
Basic
Availability
ESXi
List PRP per lcore stats
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
| <lcore-aggr> | 0 for printing all lcore stats, 1 for aggreated stats Allowed pattern: ^[01]$ |
Example
esx-1> get ens prp stats lcore 0 0
Stats Name lcore 0 lcore 1
==============================================================
txPkts 3 0
txBytes 180 0
rxPkts 9 0
rxBytes 540 0
txDrops 0 0
LAN A
==============================================================
prpTxPkts 0 0
prpTxBytes 0 0
nonPRPTxPkts 3 0
nonPRPTxBytes 180 0
supTxPkts 0 0
supTxDrops 0 0
txDrops 0 0
prpRxPkts 0 0
prpRxBytes 0 0
nonPRPRxPkts 3 0
nonPRPRxBytes 180 0
supRxPkts 14 0
linkLocalPkts 0 0
wrongLANDrops 14 0
dupPRPDrops 0 0
outOfOrderDrops 0 0
rxQueueFullDrops 0 0
invalidSupDrops 0 0
reverseFilterDrops 0 0
loopbackDrops 0 0
ctxSwitchDrops 0 0
otherDrops 0 0
ctxSwitchPkts 0 0
processWithLockPkts 0 0
LAN B
==============================================================
prpTxPkts 0 0
prpTxBytes 0 0
nonPRPTxPkts 0 0
nonPRPTxBytes 0 0
supTxPkts 0 0
supTxDrops 0 0
txDrops 0 0
prpRxPkts 0 0
prpRxBytes 0 0
nonPRPRxPkts 6 0
nonPRPRxBytes 360 0
supRxPkts 14 0
linkLocalPkts 0 0
wrongLANDrops 14 0
dupPRPDrops 0 0
outOfOrderDrops 0 0
rxQueueFullDrops 0 0
invalidSupDrops 0 0
reverseFilterDrops 0 0
loopbackDrops 0 0
ctxSwitchDrops 0 0
otherDrops 0 0
ctxSwitchPkts 0 0
processWithLockPkts 0 0
Internal Stats
==============================================================
mbufAllocFailure 0 0
mbufAllocs 0 0
tsoPkts 0 0
tsoDrops 0 0
numPnicTxGT128US 0 0
numPRPTxGT128US 0 0
numPollIVGT256US 1 0
rxMbufWithSGs 0 0
multiplePollRequired 0 0
numPRPRxGT128US 0 0
numRxDelayGT128US 0 0
numRxDelayGT256US 0 0
nodeLimitExceeded 0 0
nodeCreateFailed 0 0
numNodeLcoreMoved 0 0
numNodeVLANChanged 0 0
numNodeDestChanged 0 0
maxPktsPerTx 1 0
maxPktsPerRx 1 0
maxRxQSize 0 0
maxPRPTxTimeInUS 1 0
maxPnicTxTimeInUS 29 0
maxPRPRxTimeInUS 4 0
maxPseudoRxDelayInUS 0 0
maxPollIVTimeInUS 462 191
esx-1>
Mode
Basic
Availability
ESXi
List all active PRP nodes stats
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
Example
esx-1> get ens prp stats node 0
Tue Jul 09 2024 UTC 21:11:24.041
NodeIdx NodeMAC VlanID Type NodeAge(s) LAN prpRxPkts nonPRPRxPkts rxBytes DupDrops supRxPkts OutOfOrderDrops wrongLANDrops
================================================================================================================================================================
0 00:0c:29:d0:2c:88 4095 DAN 46 lanA 0 0 0 0 23 0 23
lanB 0 0 0 0 23 0 23
1 00:50:56:52:6c:bd 0 SAN 45 lanA 0 0 0 0 0 0 0
lanB 0 4 240 0 0 0 0
2 00:50:56:5d:2c:a9 0 SAN 45 lanA 0 0 0 0 0 0 0
lanB 0 4 240 0 0 0 0
3 00:50:56:57:b8:b9 0 SAN 45 lanA 0 4 240 0 0 0 0
lanB 0 0 0 0 0 0 0
Total PRP Nodes: 4
esx-1>
Mode
Basic
Availability
ESXi
List vDAN stats
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
Example
esx-1> get ens prp stats vdan 0
vdanIndex vDAN MAC vlanID fcPortID vDANAge(s) LAN prpTxPkts nonPRPPkts txBytes txDrops supTxPkts
======================================================================================================================
0 00:0c:29:40:75:e0 0 3 4 lanA 11 0 1018 0 3
lanB 11 0 1018 0 3
Total PRP vDANs: 1
esx-1>
Mode
Basic
Availability
ESXi
List active vDANs
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
Example
esx-1> get ens prp vdan list 0
vDANIndex MAC Addr vlanID fcPortID SupMcastMAC SupSeqN SupAge(s) CurrLcore lanAUplink lanBUplink vDANAge(s)
==========================================================================================================================
0 00:0c:29:8e:7c:99 3898 3 01:15:4e:00:01:00 11 0 0 vmnic1 vmnic3 22
Total PRP vDANs: 1
esx-1>
Mode
Basic
Availability
ESXi
List all ENS switches
Example
esx-1> get ens switch list
name : ens
swID : 0
maxPorts : 128
numActivePorts : 1
numPorts : 1
mtu : 1500
numLcores : 1
lcoreIDs : 0
esx-1>
Mode
Basic
Availability
ESXi
List latest Telemetry related infra-counters.
Example
ens w1-hs5-c2703.eng.vmware.com> get ens telemetry-infra-counters
------------------------------------------------------------------------------------------------------------------------------------------------------------------
localhost
------------------------------------------------------------------------------------------------------------------------------------------------------------------
Fri Jan 19 2024 UTC 19:34:44.121
TELEMETRY INFRA COUNTERS
Counter Category: Network-Thread-Utilizaiton
----------------------------------------------------------------------
Counter Name Counter Value
======================================================================
cnt 164
sum 0.24
min 0.0
max 0.05
pct99 0
pct97 0
pct95 0
pct90 0
pct85 0
pct80 0
pct70 0
pct50 0
pct25 0
Mode
Basic
Availability
ESXi
Dump thread load balancer statistics
Example
esx-1> get ens tlb stats
Start to read TLB stats from ENS Switch ID 0
Read stats at 2024-01-11T21:23:40
Threads:
ctx_id : 0
cpuInPCT : 0
cpuBiased : 0
deltaPkts : 44
deltaBytes : 4400
elements : []
esx-1>
Mode
Basic
Availability
ESXi
Dump thread load balancer statistics for a specific switch
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
Example
esx-1> get ens tlb stats 1
Start to read TLB stats from ENS Switch ID 1
Read stats at 2024-01-11T21:23:40
Threads:
ctx_id : 0
cpuInPCT : 0
cpuBiased : 0
deltaPkts : 42
deltaBytes : 4200
elements : []
esx-1>
Mode
Basic
Availability
ESXi
Get the current thread load balancer status
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
Example
esx-1> get ens tlb status nsxvswitch
Automatic thread load balancing is enabled, metric cpu
esx-1>
Mode
Basic
Availability
ESXi
Get the RSS setting of an uplink
| Option | Description |
|---|---|
| <uplink> | Uplink identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get ens uplink rss list vmnic1
ID : 0
Type : DFTRSS
PriQ : 0
NumQ : 8
HashFunc : 2
HashType : 63
KeySize : 40
IndSize : 128
MemAff : 0
SecQs : [0, 1, 2, 3, 4, 5, 6, 7]
esx-1>
Mode
Basic
Availability
ESXi
Get the stats and private stats of an uplink port
| Option | Description |
|---|---|
| <uplink> | Uplink identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get ens uplink stats vmnic1
Uplink Stats:
rxPkts: 0
txPkts: 0
rxBytes: 5666
txBytes: 320
rxErrors: 0
txErrors: 0
rxDrops: 0
txDrops: 0
rxMulticastPkts: 51
rxBroadcastPkts: 24
txMulticastPkts: 0
txBroadcastPkts: 5
collisions: 0
rxLengthErrors: 0
rxOverflowErrors: 0
rxCRCErrors: 0
rxFrameAlignErrors: 0
rxFifoErrors: 0
rxMissErrors: 0
txAbortedErrors: 0
txCarrierErrors: 0
txFifoErrors: 0
txHeartbeatErrors: 0
txWindowErrors: 0
Uplink Private Stats:
Number of packets assigned to an invalid queue: 0
rxq0: pkts=68 bytes=4288 rxTail=68 numHold=2 noBuf=0 csumErr=0
rxq1: pkts=5 bytes=438 rxTail=5 numHold=5 noBuf=0 csumErr=0
rxq2: pkts=1 bytes=90 rxTail=1 numHold=1 noBuf=0 csumErr=0
rxq3: pkts=1 bytes=342 rxTail=1 numHold=1 noBuf=0 csumErr=0
rxq4: pkts=0 bytes=0 rxTail=0 numHold=0 noBuf=0 csumErr=0
rxq5: pkts=0 bytes=0 rxTail=0 numHold=0 noBuf=0 csumErr=0
rxq6: pkts=0 bytes=0 rxTail=0 numHold=0 noBuf=0 csumErr=0
rxq7: pkts=0 bytes=0 rxTail=0 numHold=0 noBuf=0 csumErr=0
rxq8: pkts=0 bytes=0 rxTail=0 numHold=0 noBuf=0 csumErr=0
rxq9: pkts=0 bytes=0 rxTail=0 numHold=0 noBuf=0 csumErr=0
rxq10: pkts=0 bytes=0 rxTail=0 numHold=0 noBuf=0 csumErr=0
rxq11: pkts=0 bytes=0 rxTail=0 numHold=0 noBuf=0 csumErr=0
rxq12: pkts=0 bytes=0 rxTail=0 numHold=0 noBuf=0 csumErr=0
rxq13: pkts=0 bytes=0 rxTail=0 numHold=0 noBuf=0 csumErr=0
rxq14: pkts=0 bytes=0 rxTail=0 numHold=0 noBuf=0 csumErr=0
rxq15: pkts=0 bytes=0 rxTail=0 numHold=0 noBuf=0 csumErr=0
rxq16: pkts=0 bytes=0 rxTail=0 numHold=0 noBuf=0 csumErr=0
rxq17: pkts=0 bytes=0 rxTail=0 numHold=0 noBuf=0 csumErr=0
rxq18: pkts=0 bytes=0 rxTail=0 numHold=0 noBuf=0 csumErr=0
rxq19: pkts=0 bytes=0 rxTail=0 numHold=0 noBuf=0 csumErr=0
rxq20: pkts=0 bytes=0 rxTail=0 numHold=0 noBuf=0 csumErr=0
rxq21: pkts=0 bytes=0 rxTail=0 numHold=0 noBuf=0 csumErr=0
rxq22: pkts=0 bytes=0 rxTail=0 numHold=0 noBuf=0 csumErr=0
txq0: pkts=5 bytes=300 txTail=5 toClean=5 pending=0
txq1: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq2: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq3: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq4: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq5: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq6: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq7: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq8: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq9: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq10: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq11: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq12: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq13: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq14: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq15: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq16: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq17: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq18: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq19: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq20: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq21: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
txq22: pkts=0 bytes=0 txTail=0 toClean=0 pending=0
ENS Rx Queue Remap: 0 1 2 3 4 5 6 7 8 -1 -1 -1 -1 -1 -1 -1 -1 -1 -1 -1 -1 -1 -1
RxXon: 0
RxXoff: 0
TxXon: 0
TxXoff: 0
esx-1>
Mode
Basic
Availability
ESXi
Display the list of registered ESXio nodes with Transport host node.
Example
esx-nsx-cli> get esxio nodes
UUID Device alias Transport Address State
* 02b9e95c-51fd-5cd4-bff6-2bc2ac7b595c vmdpu0 169.254.100.2 Managed
c482e10a-4c4e-5d88-ac82-f8cc43be7351 vmdpu1 169.254.100.3 Managed
Mode
Basic
Availability
ESXi
Show the content of End User License Agreement
Mode
Basic
Availability
Global Manager, Manager
Show the acceptance of End User License Agreement
Mode
Basic
Availability
Global Manager, Manager
Display EVPN All VNIs ARP information.
Example
nsx-edge-1(tier0_sr)>get evpn arp
VNI 3000 #ARP (IPv4 and IPv6, local and remote) 1
IP Type State MAC Remote VTEP
fe80::e84d:80ff:feae:3d32 local active ea:4d:80:ae:3d:32
Mode
Tier0_sr
Availability
Edge
Display EVPN VNI ARP information.
| Option | Description |
|---|---|
| <vni> | vni Allowed pattern: ^[0-9]+$ |
Example
nsx-edge-1(tier0_sr)>get evpn arp
VNI 3000 #MACs (local and remote) 1
MAC Type Intf/Remote VTEP VLAN
ea:4d:80:ae:3d:32 local Br_l2_3000 1 0/0
Mode
Tier0_sr
Availability
Edge
Display EVPN deployment Mode information.
Example
EVPN-M0-EDGE-ONE(tier0_sr)> get evpn deployment-mode
EVPN Deploy Mode: inline
L2 VNIs: 1
L3 VNIs: 1
Advertise gateway mac-ip: No
Advertise svi mac-ip: No
Duplicate address detection: Enable
Detection max-moves 5, time 180
Mode
Tier0_sr
Availability
Edge
Display EVPN Ethernet Segment information.
Example
nsx-edge-1(tier0_sr)>get evpn es
Type: L local, R remote
ESI Type ES-IF VTEPs
03:11:22:33:44:55:02:00:00:01 R - 192.168.1.2,192.168.1.3
Mode
Tier0_sr
Availability
Edge
Display particular EVPN Ethernet Segment information.
| Option | Description |
|---|---|
| <esi> | Ethernet Segment Identifier (ESI) |
Example
nsx-edge-1(tier0_sr)>get evpn es 03:11:22:33:44:55:02:00:00:01
ESI: 03:11:22:33:44:55:02:00:00:01
Type: Remote
Interface: -
State: down
Ready for BGP: no
VNI Count: 0
MAC Count: 1
Nexthop group: 0x2000001
VTEPs:
192.168.1.2 nh: 0x1000004
Mode
Tier0_sr
Availability
Edge
Display EVPN VNI MAC information.
Example
nsx-edge-1(tier0_sr)> get evpn mac
VNI 3000 #ARP (IPv4 and IPv6, local and remote) 1
IP Type State MAC Remote VTEP
fe80::e84d:80ff:feae:3d32 local active ea:4d:80:ae:3d:32
Mode
Tier0_sr
Availability
Edge
Display EVPN VNI MAC information.
| Option | Description |
|---|---|
| <vni> | vni Allowed pattern: ^[0-9]+$ |
Example
nsx-edge-1(tier0_sr)> get evpn mac
VNI 3000 #ARP (IPv4 and IPv6, local and remote) 1
IP Type State MAC Remote VTEP
fe80::e84d:80ff:feae:3d32 local active ea:4d:80:ae:3d:32
Mode
Tier0_sr
Availability
Edge
Display router MACs for all VNIs.
Example
EVPN-M0-EDGE-ONE(tier0_sr)> get evpn rmac
VNI 10001 #RMACs 1
RMAC Remote VTEP
92:fc:ee:ac:51:61 5.1.1.2
Mode
Tier0_sr
Availability
Edge
Display all EVPN VNI information.
Example
EVPN-M0-EDGE-ONE(tier0_sr)> get evpn vni
VNI: 100000
Type: L3
Tenant VRF: vrf-2
Local Vtep Ip: 70.1.1.1
Vxlan-Intf: vxlan-100000
SVI-If: kni-275
State: Up
VNI Filter: none
Router MAC: 02:50:56:56:54:00
L2 VNIs:
Mode
Tier0_sr
Availability
Edge
Display information about the specified file in the filestore.
| Option | Description |
|---|---|
| <filename> | Existing file argument |
Example
nsx> get file support-bundle-0.tgz
Directory of filestore:/
-rw- 24932275 Feb 05 2016 05:58:46 UTC support-bundle-0.tgz
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, NSX Cloud VM, Manager, NSX on VMC
Display the file thumbprint.
| Option | Description |
|---|---|
| <filename> | Existing file argument |
Example
nsx> get file support-bundle-0.tgz thumbprint
SHA1SUM: d0fc5c741bdc0be8eacce3e8f581b74c32bc4d62
SHA256SUM: 13cfaccbfc44193eaee3a729b6c4a810b276df6d8086fc82ed1720d23906473d
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, NSX Cloud VM, Manager, NSX on VMC
Display information about the files in the filestore.
Example
nsx> get files
Directory of filestore:/
-rw- 24950960 Feb 05 2016 05:59:23 UTC support-bundle-1.tgz
-rw- 24932275 Feb 05 2016 05:58:46 UTC support-bundle-0.tgz
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, NSX Cloud VM, Manager, NSX on VMC
Display the file system information.
Example
nsx-manager-1> get filesystem-stats
Filesystem Size Used Avail Use% Mounted on
udev 7.9G 4.0K 7.9G 1% /dev
tmpfs 1.6G 768K 1.6G 1% /run
/dev/sda2 19G 2.2G 16G 13% /
none 4.0K 0 4.0K 0% /sys/fs/cgroup
none 5.0M 0 5.0M 0% /run/lock
none 7.9G 4.0K 7.9G 1% /run/shm
none 100M 0 100M 0% /run/user
/dev/mapper/nsx-repository 19G 302M 18G 2% /repository
/dev/mapper/nsx-tmp 3.7G 8.0M 3.5G 1% /tmp
/dev/sda1 945M 6.0M 874M 1% /boot
/dev/mapper/nsx-config 19G 44M 18G 1% /config
/dev/mapper/nsx-config__bak 19G 44M 18G 1% /config_bak
/dev/mapper/nsx-image 19G 44M 18G 1% /image
/dev/sda3 19G 44M 18G 1% /os_bak
/dev/mapper/nsx-var+log 9.3G 623M 8.2G 7% /var/log
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display the specified firewall address set for the logical router interface.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
Example
nsx-edge-1> get firewall e159f0db-d8e4-4973-9cbb-8cc30def2c3e addrset name srcep
Addrset count: 1
Name : srcep
Address(es) : 11.1.1.1,11.1.2.1
Mode
Basic
Availability
Autonomous Edge, Edge
Display all the firewall address sets for the logical router interface.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
Example
nsx-edge-1> get firewall e159f0db-d8e4-4973-9cbb-8cc30def2c3e addrset sets
Addrset count: 2
Name : dstep
Address(es) : 11.1.1.1,11.1.2.1
Name : srcep
Address(es) : 10.1.1.1,10.1.1.10
Mode
Basic
Availability
Autonomous Edge, Edge
Display the specified firewall attribute set for the logical router interface.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
Example
nsx-edge-1> get firewall e159f0db-d8e4-4973-9cbb-8cc30def2c3e attrset name attriSet1
Container count: 1
Name : attriSet1
Element(s) : APP_ID : 1, APP_ID : 2
Mode
Basic
Availability
Autonomous Edge, Edge
Display all the firewall attribute sets for the logical router interface.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
Example
nsx-edge-1> get firewall e159f0db-d8e4-4973-9cbb-8cc30def2c3e attrset sets
Container count: 2
Name : attriSet1
Element(s) : APP_ID : 1, APP_ID : 2
Name : attriSet2
Element(s) : TLS_VERSION : 1.1, TLS_VERSION : 1.2
Mode
Basic
Availability
Autonomous Edge, Edge
Display the firewall connections on the specified logical router interface.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
Example
nsx-edge-1> get firewall e159f0db-d8e4-4973-9cbb-8cc30def2c3e connection
Connection count: 1
0x00001c0c08000007: 192.168.130.254:57336 -> 172.16.10.11:80 (80.80.80.11:80) in protocol tcp state ESTABLISHED:ESTABLISHED
Mode
Basic
Availability
Autonomous Edge, Edge
Display the firewall connection count.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
Example
nsx-edge-1> get firewall e159f0db-d8e4-4973-9cbb-8cc30def2c3e connection count
Connection count: 1
Mode
Basic
Availability
Autonomous Edge, Edge
Display the firewall connections on the specified logical router interface.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
Example
nsx-edge-1> get firewall e159f0db-d8e4-4973-9cbb-8cc30def2c3e connection raw
Connection count: 1
0x00001c0c08000007 af 2 ethertype 0x0000 proto icmp 192.168.1.1 -> 172.16.10.11 (80.80.80.11) dir 1 2418 0 6e 0 f-0 n-420 flg:200000040909
Mode
Basic
Availability
Autonomous Edge, Edge
Display the state of the firewall connections.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
Example
nsx-edge-1> get firewall e159f0db-d8e4-4973-9cbb-8cc30def2c3e connection state
Connection count: 1
192.168.130.254:57101 -> 172.16.10.11:80 (80.80.80.11:80) in protocol tcp state ESTABLISHED:ESTABLISHED f-0 n-421
Mode
Basic
Availability
Autonomous Edge, Edge
Display firewall interface statistics for the specified logical router interface.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
Example
nsx-edge-1> get firewall e159f0db-d8e4-4973-9cbb-8cc30def2c3e interface stats
Failed IP option : 0
Failed NAT translation : 0
Failed SYN proxy : 0
Failed Spoofguard : 0
Failed bad offset : 0
Failed bad timestamp : 0
Failed checksum : 0
Failed congestion : 0
Failed expected state : 0
Failed fragment : 0
Failed memory allocation : 0
Failed normalization : 0
Failed short header : 0
Failed source limit : 0
Failed state insertion : 0
Failed state limit : 0
Firewall deletions : 13
Firewall insertions : 15
Firewall lookups : 0
Found match : 67
Input bytes allowed : 5741
Input bytes dropped : 0
Input packets allowed : 61
Input packets dropped : 0
Number of state collisions : 0
Number of states : 2
Output bytes allowed : 12628
Output bytes dropped : 0
Output packets allowed : 138
Output packets dropped : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display the active/standby configuration for the firewall on the specified logical router interface.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
Example
nsx-edge-1> get firewall e159f0db-d8e4-4973-9cbb-8cc30def2c3e sync config
HA mode : primary-active
Firewall enabled : true
Sync pending : false
Bulk sync pending : false Last status: ok
Local VTEP IP : 192.168.250.62
Peer VTEP IP : 192.168.250.63
Local context : 56eead22-3bb9-4586-8de3-9412941f9116
Peer context : 56eead22-3bb9-4586-8de3-9412941f9116
Mode
Basic
Availability
Autonomous Edge, Edge
Display the firewall synchronization statistics.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
Example
nsx-edge-1> get firewall e159f0db-d8e4-4973-9cbb-8cc30def2c3e sync stats
bad-action : 0
bad-c-delete : 0
bad-c-update : 0
bad-delete : 0
bad-header : 0
bad-len : 0
bad-request : 0
bad-rule-id : 0
bad-stale-c-update : 0
bad-stale-update : 0
bad-state-c-update : 0
bad-state-insert : 0
bad-state-update : 0
bad-total : 0
bad-ttl : 0
bad-update : 0
bad-val : 0
bad-version : 0
failed-module-insert : 0
failed-no-mem : 0
failed-no-module : 0
failed-output : 0
input-ipv4 : 5
output-ipv4 : 138
send-bulk-update : 0
send-c-delete : 13
send-c-update : 135
send-update : 0
state-c-delete : 0
state-c-update : 0
state-delete : 0
state-insert : 0
state-request : 2
state-update : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display the fixed timeouts for connection events.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
Example
nsx-edge-1> get firewall e159f0db-d8e4-4973-9cbb-8cc30def2c3e timeouts
Timeout count: 12
dfw.icmp.error_reply : 10
dfw.icmp.first_packet : 20
dfw.ip.frag : 30
dfw.tcp.closed : 5
dfw.tcp.closing : 900
dfw.tcp.established : 7200
dfw.tcp.fin_wait : 7
dfw.tcp.first_packet : 120
dfw.tcp.opening : 30
dfw.udp.first_packet : 60
dfw.udp.multiple : 60
dfw.udp.single : 30
Mode
Basic
Availability
Autonomous Edge, Edge
Display specific firewall L7 profile information on given Logical Router UUID.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get firewall fb83ef2e-7367-47b4-8a88-0a41fffdc5ee l7-profile 00000000-0000-0007-0000-000000000001
UUID : 00000000-0000-0007-0000-000000000001
Entry count : 2
Entry ID : 00000000-0000-0003-0000-000000000002
Element(s) : APP_ID:APP_ETH
Action : REJECT
Log : True
Entry ID : 00000000-0000-0003-0000-000000000001
Element(s) : CUSTOM_URL:www.news.com, CUSTOM_URL:www.facebook.com
Action : REJECT
Log : True
Default action : ALLOW
Default log : False
Mode
Basic
Availability
Autonomous Edge, Edge
Display specific firewall L7 profile entry stats information on given Logical Router UUID.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get firewall fb83ef2e-7367-47b4-8a88-0a41fffdc5ee l7-profile 00000000-0000-0007-0000-000000000001 stats
UUID : 00000000-0000-0007-0000-000000000001
Entry count : 2
Entry ID : 00000000-0000-0003-0000-000000000002
Evaluations : 0
Entry ID : 00000000-0000-0003-0000-000000000001
Evaluations : 0
Default Evaluations : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display all firewall L7 profiles information on given Logical Router UUID.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get firewall fb83ef2e-7367-47b4-8a88-0a41fffdc5ee l7-profiles
UUID : 00000000-0000-0007-0000-000000000001
Entry count : 2
Entry ID : 00000000-0000-0003-0000-000000000002
Element(s) : APP_ID:APP_ETH
Action : REJECT
Log : True
Entry ID : 00000000-0000-0003-0000-000000000001
Element(s) : CUSTOM_URL:www.news.com, CUSTOM_URL:www.facebook.com
Action : REJECT
Log : True
Default action : ALLOW
Default log : False
UUID : 00000000-0000-0008-0000-000000000002
Entry count : 1
Entry ID : 00000000-0000-0003-0000-000000000003
Element(s) : APP_ID:APP_TCP, APP_ID:APP_IPP
Action : ALLOW
Log : True
Default action : ALLOW
Default log : False
Mode
Basic
Availability
Autonomous Edge, Edge
Display all firewall L7 profile entry stats information on given Logical Router UUID.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get firewall fb83ef2e-7367-47b4-8a88-0a41fffdc5ee l7-profiles stats
UUID : 00000000-0000-0007-0000-000000000001
Entry count : 2
Entry ID : 00000000-0000-0003-0000-000000000002
Evaluations : 0
Entry ID : 00000000-0000-0003-0000-000000000001
Evaluations : 0
Default Evaluations : 0
UUID : 00000000-0000-0008-0000-000000000002
Entry count : 1
Entry ID : 00000000-0000-0003-0000-000000000003
Evaluations : 0
Default Evaluations : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display IKE policy for the specified logical router interface.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| <rule-id> | Rule ID Allowed pattern: ^[1-9][0-9]*$ |
Example
nsx-edge-1> get firewall e159f0db-d8e4-4973-9cbb-8cc30def2c3e ike policy 2052
Policy count: 1
Rule ID : 2052
Policy : in protocol any from ip 2.2.2.0/24 to ip 1.1.1.0/24 encrypt keypolicy 00000000-0000-0000-0b00-000000000000
Mode
Basic
Availability
Autonomous Edge, Edge
Display firewall rules with expanded address sets for the specified logical router interface.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
Example
nsx-edge-1> get firewall e159f0db-d8e4-4973-9cbb-8cc30def2c3e ruleset rules
DNAT rule count: 1
Rule ID : 2053
Rule : in protocol any from any to ip 80.80.80.11 dnat ip 172.16.10.11
SNAT rule count: 1
Rule ID : 2052
Rule : out protocol any from ip 172.16.10.11 to any snat ip 80.80.80.11
Mode
Basic
Availability
Autonomous Edge, Edge
Display firewall rule statistics for the specified logical router interface.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
Example
nsx-edge-1> get firewall e159f0db-d8e4-4973-9cbb-8cc30def2c3e ruleset stats
DNAT rule count: 1
Rule ID : 2053
Input bytes : 1367
Output bytes : 2374
Input packets : 24
Output packets : 19
Evaluations : 8
Active connections : 1
L7 profile allow : 0
L7 profile reject : 0
L7 profile reject page : 0
SNAT rule count: 1
Rule ID : 2052
Input bytes : 4478
Output bytes : 6106
Input packets : 39
Output packets : 68
Evaluations : 7
Active connections : 0
L7 profile allow : 0
L7 profile reject : 0
L7 profile reject page : 0
Firewall rule count: 2
Rule ID : 1004
Input bytes : 0
Output bytes : 0
Input packets : 0
Output packets : 0
Evaluations : 0
Hits : 0
Active connections : 0
L7 profile allow : 0
L7 profile reject : 0
L7 profile reject page : 0
Rule ID : 1014
Input bytes : 0
Output bytes : 0
Input packets : 0
Output packets : 0
Evaluations : 0
Hits : 0
Active connections : 0
L7 profile allow : 0
L7 profile reject : 0
L7 profile reject page : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display firewall address sets
| Option | Description |
|---|---|
| <vifuuid> | UUID argument |
Example
> get firewall e0b4c45b-7df8-40d5-a229-2b2a5be2d4d0 addrset
Firewall Address Sets
--------------------------------------------------
Mode
Basic
Availability
ESXi, KVM
Display firewall fqdn attribute of profiles.
| Option | Description |
|---|---|
| <vifuuid> | UUID argument |
Example
> get firewall 89e14dfc-98a8-47bc-adb1-ed26091123ee fqdn
Firewall Profile FQDN
----------------------------------------------------------------------
Profiles count : 1
Profile UUID : 941e03a3-1da9-43ba-963e-9e6e467e9ce0
FQDN count : 2
FQDN UUID : 2b90ce0d-f1d2-4092-adb8-1e61b5c05ca8
Value : .*\.office\.com
IP set : 192.168.11.1, 2001::192:168:11:1
FQDN UUID : 15d3bd4f-3e23-41ef-955f-5d2c3df49c3c
Value : .*\.outlook\.com
IP set : 192.168.22.1, 2001::192:168:22:1
Mode
Basic
Availability
KVM
Display firewall attribute profiles.
| Option | Description |
|---|---|
| <vifuuid> | UUID argument |
Example
> get firewall e0b4c45b-7df8-40d5-a229-2b2a5be2d4d0 profiles
Firewall Profiles
--------------------------------------------------
Profiles count : 1
UUID : 35ab482b-1c37-4168-a7d4-176a0c91788e
Attribute count : 2
APP_ID : APP_NTP
APP_ID : APP_SVN
Mode
Basic
Availability
ESXi, KVM
Display firewall rules
| Option | Description |
|---|---|
| <vifuuid> | UUID argument |
Example
> get firewall e0b4c45b-7df8-40d5-a229-2b2a5be2d4d0 ruleset rules
Firewall Rules
--------------------------------------------------
VIF UUID : e0b4c45b-7df8-40d5-a229-2b2a5be2d4d0
Ruleset UUID : 3d04fa69-5faa-4127-b55f-c08c5de5a134
Rule count : 4
rule 1031 inout protocol any from any to any accept;
rule 1032 inout protocol any from any to any accept;
rule 1033 inout protocol any from any to any accept;
rule 1034 inout protocol any from any to any accept;
Mode
Basic
Availability
ESXi, KVM
Display the logical router or switch interfaces which have firewall rules.
Example
nsx-edge-1> get firewall interfaces
Interface : e159f0db-d8e4-4973-9cbb-8cc30def2c3e
Type : UPLINK
Sync enabled : true
Name : lrp265
VRF ID : 22
Context entity : 627171f9-ba99-4d81-971e-54ec857b9693
Context name : SR-Tier0-LR-1
Mode
Basic
Availability
Autonomous Edge, Edge
Display firewall addresses for the specified address set.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
host-1> get firewall addrset name 986cf106-b987-48bb-bdaa-8b55e1e82756
Address Count: 2
Address : ip 14.14.14.14
Address : ip 12.12.12.12
Mode
Basic
Availability
NSX Cloud VM
Display firewall address sets for the available virtual interface.
Example
host-1> get firewall addrset sets
VIF ID : eni-d36ce980
Addrset Count : 1
Addrset UUID : 986cf106-b987-48bb-bdaa-8b55e1e82756
Address Count : 2
Address : 14.14.14.14
Address : 12.12.12.12
Mode
Basic
Availability
NSX Cloud VM
Display the state of the firewall connections in the VRF context.
Example
nsx-edge-1(vrf)> get firewall connection state
Connection count: 1
192.168.130.254:57101 -> 172.16.10.11:80 (80.80.80.11:80) in protocol tcp state ESTABLISHED:ESTABLISHED f-0 n-421
Mode
VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display firewall fqdn attribute of profiles.
| Option | Description |
|---|---|
| <context-profile-id> | Context profile ID argument Allowed pattern: ^[0-9a-zA-Z-]+$ |
Example
host> get firewall context-profile 5fe464fd-6c50-4c12-92cc-91a52ea83cbf fqdn
Context Profile ID: 5fe464fd-6c50-4c12-92cc-91a52ea83cbf
FQDN count : 2
FQDN ID : 45e5a417-8f50-4a24-b564-7c8676dff34b
Value : www.youtube.com
IP set : 216.58.193.78, 172.217.14.206, 172.217.3.174, 2607:f8b0:400a:808::200e, 172.217.3.206
FQDN ID : b264e526-f47d-4c95-9427-c835c4dd02c8
Value : m.facebook.com
Mode
Basic
Availability
NSX Cloud VM
Display firewall fqdn attribute of profiles.
Example
host> get firewall context-profiles
Context Profile ID: 5fe464fd-6c50-4c12-92cc-91a52ea83cbf
Attribute count : 3
APP ID : APP_HTTP
FQDN : www.youtube.com
FQDN : m.facebook.com
Context Profile ID: bf41df9f-2d79-4f73-b582-f87085935dbe
Attribute count : 1
APP ID : APP_DNS
Mode
Basic
Availability
NSX Cloud VM
Display firewall exclude interfaces.
Example
host-1> get firewall exclude
VIF count: 1
VIF ID : eni-d36ce980
Mode
Basic
Availability
NSX Cloud VM
Display the firewall exclusion list.
Example
nsx-manager-1> get firewall exclude-list
target_id target_type target_display_name
---------- ------------ --------------------
954dd9f7-0280-4aff-aebd-8323fd00d770 LogicalSwitch ls01
3b30045a-9166-43b6-85a0-a07d23af5e01 LogicalPort lport02
2 row (s)
Mode
Basic
Availability
Manager
Display firewall exclusions.
Example
esx-1> get firewall exclusion
Firewall Exclusion
----------------------------------------------------------------------
None
Mode
Basic
Availability
ESXi, KVM
Display firewall interface statistics for the specified logical router interface in the VRF context.
Example
nsx-edge-1(vrf)> get firewall interface stats
Failed IP option : 0
Failed NAT translation : 0
Failed SYN proxy : 0
Failed Spoofguard : 0
Failed bad offset : 0
Failed bad timestamp : 0
Failed checksum : 0
Failed congestion : 0
Failed expected state : 0
Failed fragment : 0
Failed memory allocation : 0
Failed normalization : 0
Failed short header : 0
Failed source limit : 0
Failed state insertion : 0
Failed state limit : 0
Firewall deletions : 13
Firewall insertions : 15
Firewall lookups : 0
Found match : 67
Input bytes allowed : 5741
Input bytes dropped : 0
Input packets allowed : 61
Input packets dropped : 0
Number of state collisions : 0
Number of states : 2
Output bytes allowed : 12628
Output bytes dropped : 0
Output packets allowed : 138
Output packets dropped : 0
Mode
VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display the logical router or switch interfaces which have firewall rules.
Example
nsx-edge-1(vrf)> get firewall interfaces
Interface : e159f0db-d8e4-4973-9cbb-8cc30def2c3e
Type : UPLINK
Sync enabled : true
Name : lrp265
VRF ID : 22
Context entity : 627171f9-ba99-4d81-971e-54ec857b9693
Context name : SR-Tier0-LR-1
Mode
VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display sync configuration for logical router interfaces with firewall rules.
Example
nsx-edge-1> get firewall interfaces sync
Total count: 1
Interface : e159f0db-d8e4-4973-9cbb-8cc30def2c3e
HA mode : primary-active
Firewall enabled : true
Sync pending : false
Bulk sync pending : false Last status: ok
Local VTEP IP : 192.168.250.62
Peer VTEP IP : 192.168.250.63
Local context : 56eead22-3bb9-4586-8de3-9412941f9116
Peer context : 56eead22-3bb9-4586-8de3-9412941f9116
Mode
Basic
Availability
Autonomous Edge, Edge
Display firewall ipfix containers.
Example
esx-1> get firewall ipfix-containers
Firewall IPFIX Containers
----------------------------------------------------------------------
Container UUID VIF UUID
daa4a875-9050... 1b78faa3-d8b9...
879e25c1-cf28... 14417daf-ce52...
a0286cfe-73d2... 36124bcf-5bdf...
14417daf-ce52...
e30a0072-1930...
e5e6fee8-61f7...
Mode
Basic
Availability
ESXi, KVM, NSX Cloud VM
Display firewall ipfix filters.
Example
esx-1> get firewall ipfix-filters
Firewall IPFIX VIFs
----------------------------------------------------------------------
e0b4c45b-7df8-40d5-a229-2b2a5be2d4d0
e30a0072-1930-48a0-adaa-9412e758eea7
Mode
Basic
Availability
ESXi, KVM, NSX Cloud VM
Display firewall ipfix profile configration.
Example
esx-1> get firewall ipfix-profiles
Firewall IPFIX Profiles
----------------------------------------------------------------------
UUID Priority Timeout Domain ID AppliedTo Count Collector UUID
0a988e9e-725d... 10 5 100 8 035cad05-0dc8...
6f25a736-646e... 0 3 1 2 188da901-1bd0...
Mode
Basic
Availability
ESXi, KVM, NSX Cloud VM
Display firewall ipfix statistics.
Example
esx-1> get firewall ipfix-stats
Firewall IPFIX Statistics
----------------------------------------------------------------------
Collector config: 188da901-1bd0-402b-9b57-3521cb59910b
IP address port # bytes sent sequence # sent errors
10.2.117.211 2828 38016 355 0
Collector config: 035cad05-0dc8-44a8-b320-d6ebb8112515
IP address port # bytes sent sequence # sent errors
2.2.2.2 200 344 0 0
1.1.1.1 100 344 0 0
Mode
Basic
Availability
ESXi, KVM, NSX Cloud VM
Display specific firewall L7 profile information based on UUID.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get firewall l7-profile 00000000-0000-0007-0000-000000000001
UUID : 00000000-0000-0007-0000-000000000001
Entry count : 2
Entry ID : 00000000-0000-0003-0000-000000000002
Element(s) : APP_ID:APP_ETH
Action : REJECT
Log : True
Entry ID : 00000000-0000-0003-0000-000000000001
Element(s) : CUSTOM_URL:www.news.com, CUSTOM_URL:www.facebook.com
Action : REJECT
Log : True
Default action : ALLOW
Default log : False
Mode
Basic
Availability
Autonomous Edge, Edge
Display specific firewall L7 profile entry stats information based on UUID.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get firewall l7-profile 00000000-0000-0007-0000-000000000001 stats
UUID : 00000000-0000-0007-0000-000000000001
Entry count : 2
Entry ID : 00000000-0000-0003-0000-000000000002
Evaluations : 0
Entry ID : 00000000-0000-0003-0000-000000000001
Evaluations : 0
Default Evaluations : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display all firewall L7 profiles information.
Example
nsx-edge-1> get firewall l7-profiles
UUID : 00000000-0000-0007-0000-000000000001
Entry count : 2
Entry ID : 00000000-0000-0003-0000-000000000002
Element(s) : APP_ID:APP_ETH
Action : REJECT
Log : True
Entry ID : 00000000-0000-0003-0000-000000000001
Element(s) : CUSTOM_URL:www.news.com, CUSTOM_URL:www.facebook.com
Action : REJECT
Log : True
Default action : ALLOW
Default log : False
UUID : 00000000-0000-0008-0000-000000000002
Entry count : 1
Entry ID : 00000000-0000-0003-0000-000000000003
Element(s) : APP_ID:APP_TCP, APP_ID:APP_IPP
Action : ALLOW
Log : True
Default action : ALLOW
Default log : False
Mode
Basic
Availability
Autonomous Edge, Edge
Display all firewall L7 profile entry stats information.
Example
nsx-edge-1> get firewall l7-profiles stats
UUID : 00000000-0000-0007-0000-000000000001
Entry count : 2
Entry ID : 00000000-0000-0003-0000-000000000002
Evaluations : 0
Entry ID : 00000000-0000-0003-0000-000000000001
Evaluations : 0
Default Evaluations : 0
UUID : 00000000-0000-0008-0000-000000000002
Entry count : 1
Entry ID : 00000000-0000-0003-0000-000000000003
Evaluations : 0
Default Evaluations : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display the contents of the DFW packet log file.
Example
2018-07-17T18:41:20.708Z f1007e48 INET match PASS 2 OUT 84 ICMP 1.1.1.10->1.1.3.10
2018-07-17T18:41:20.716Z a8de7313 INET match PASS 2 IN 84 ICMP 1.1.1.10->1.1.3.10
.
.
.
Mode
Basic
Availability
ESXi, KVM
Display last lines of the DFW packet log file.
| Option | Description |
|---|---|
| <lines> | Line count, up to 80 |
Example
.
.
.
2018-07-17T18:41:20.708Z f1007e48 INET match PASS 2 OUT 84 ICMP 1.1.1.10->1.1.3.10
2018-07-17T18:41:20.716Z a8de7313 INET match PASS 2 IN 84 ICMP 1.1.1.10->1.1.3.10
Mode
Basic
Availability
ESXi, KVM
Display firewall rule statistics.
Example
sc-rdops-vm09-dhcp-1-10.eng.vmware.com> get firewall rule-stats
Firewall Rule Statistics
------------------------------------------------------------------------------------------
RuleId Packets Bytes Sessions hits
1 0 0 0 0
2 511 33276 0 511
Mode
Basic
Availability
ESXi, KVM, NSX Cloud VM
Display total firewall rule statistics.
Example
sc-rdops-vm09-dhcp-1-10.eng.vmware.com> get firewall rule-stats total
Firewall Rule Statistics
------------------------------------------------------------------------------------------
RuleId Packets Bytes Sessions hits
1 0 0 0 0
2 511 33276 0 511
Mode
Basic
Availability
ESXi, KVM, NSX Cloud VM
Display the summary of firewall rules.
Example
host-1> get firewall rules
VIF ID : eni-d36ce980
Rule Count : 2
Ruleset UUID : e83c8855-2541-4965-90dd-522435853409
Rule ID : 1025
Rule : inout protocol any from any to addrset 986cf106-b987-48bb-bdaa-8b55e1e82756 accept
Rule ID : 2
Rule : inout protocol any from any to any accept
Rule UUID : 8f03714c-4d60-48d2-9767-7654d90c079e
Rule ID : 1
Rule : inout ethertype any stateless from any to any accept
Mode
Basic
Availability
NSX Cloud VM
Display the firewall status.
Example
nsx-manager-1> get firewall status
context global_status _revision
------- ------------- ---------
logical_routers ENABLED 0
transport_nodes ENABLED 0
2 row(s)
or
esx-1> get firewall status
Firewall Status
----------------------------------------------------------------------
enabled
Mode
Basic
Availability
ESXi, KVM, Manager
Display the firewall summary.
Example
nsx-manager-1> get firewall summary
section_type section_count rule_count
------------ ------------- ----------
L2DFW 1 1
L3DFW 1 1
2 row(s)
Mode
Basic
Availability
Manager
Display the active/standby configuration for the firewall on the specified logical router interface.
Example
nsx-edge-1(vrf)> get firewall sync config
HA mode : primary-active
Firewall enabled : true
Sync pending : false
Bulk sync pending : false Last status: ok
Local VTEP IP : 192.168.250.62
Peer VTEP IP : 192.168.250.63
Local context : 56eead22-3bb9-4586-8de3-9412941f9116
Peer context : 56eead22-3bb9-4586-8de3-9412941f9116
Mode
VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display the firewall synchronization statistics in the VRF context.
Example
nsx-edge-1(vrf)> get firewall sync stats
bad-action : 0
bad-c-delete : 0
bad-c-update : 0
bad-delete : 0
bad-header : 0
bad-len : 0
bad-request : 0
bad-rule-id : 0
bad-stale-c-update : 0
bad-stale-update : 0
bad-state-c-update : 0
bad-state-insert : 0
bad-state-update : 0
bad-total : 0
bad-ttl : 0
bad-update : 0
bad-val : 0
bad-version : 0
failed-module-insert : 0
failed-no-mem : 0
failed-no-module : 0
failed-output : 0
input-ipv4 : 5
output-ipv4 : 138
send-bulk-update : 0
send-c-delete : 13
send-c-update : 135
send-update : 0
state-c-delete : 0
state-c-update : 0
state-delete : 0
state-insert : 0
state-request : 2
state-update : 0
Mode
VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display firewall threshold alarms.
Example
esx> get firewall threshold-alarms
Firewall Threshold Alarms
-------------------------------------------------------------------
# Name Threshold Alarm Enabed Alarm Raised
1 dfw-session 80 True False
2 vsip-state 75 True False
3 vsip-module 75 True False
4 vsip-rules 75 True False
5 vsip-flow 75 True False
6 vsip-attr 75 True False
7 vsip-fqdn 75 True False
8 vsip-si 75 True False
9 vsip-fprules 75 True False
10 dfw-cpu 75 True False
Mode
Basic
Availability
ESXi
Display firewall thresholds.
Example
kvm> get firewall thresholds
Firewall Threshold Monitors
-------------------------------------------------------------------------------------------
# Name Raised Threshold CurrValue CurrSize MaxSize PeakEver EverTime(ago)
1 total-cpu False 90 0 -- -- 0 --:--:--
2 total-memory False 90 2 2 MB 96 MB 2 05:42:08
or
esx> get firewall thresholds
Firewall Threshold Monitors
-------------------------------------------------------------------------------------------
# Name Raised Threshold CurrValue CurrSize MaxSize PeakEver EverTime(ago)
1 dfw-cpu False 90 0 -- -- 0 --:--:--
2 vsip-attr False 90 2 2 MB 96 MB 2 05:42:08
3 vsip-flow False 90 0 0 MB 168 MB 0 --:--:--
4 vsip-fqdn False 90 0 0 MB 96 MB 0 --:--:--
5 vsip-module False 90 4 22 MB 512 MB 4 05:42:08
6 vsip-rules False 90 0 0 MB 128 MB 0 --:--:--
7 vsip-state False 90 0 0 MB 192 MB 0 --:--:--
Mode
Basic
Availability
ESXi, KVM
Display firewall VIFs
Example
> get firewall vifs
Firewall VIFs
--------------------------------------------------
VIF count: 2
1. e0b4c45b-7df8-40d5-a229-2b2a5be2d4d0
2. e30a0072-1930-48a0-adaa-9412e758eea7
Mode
Basic
Availability
ESXi, KVM
Display firewall vsipioctl fqdn entries with no debug.
| Option | Description |
|---|---|
| <vsip_commands> | non-debug mode vsipioctl commands Allowed values: getfqdnentries |
| <vsip_param> | parameter expression Allowed pattern: .* |
Example
esx> get firewall vsipioctl getfilters
Filter Name : nic-279709-eth1-vmware-sfw.2
VM UUID : 2f 0e e6 c6 37 bb 43 d1-b9 26 b6 d9 9b 0b fc 19
VNIC Index : 1
VNIC UUID : 2f0ee6c6-37bb-43d1-b926-b6d99b0bfc19.001
VIF ID : e446f58a-3993-4015-bd9c-f4635b565278
LSP ID : c142f928-4e20-47a7-9c06-1b1175e339de
Service Profile : --NOT SET--
Filter Rule Config : configured
Filter Hash : 45228
Mode
Basic
Availability
ESXi
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.
Example
nsx-edge-1(path)> get forwarding
IP Neighbor Table:
IP UUID MAC State Last Update Time
IP Forwarding Table:
IP Prefix Type UUID Gateway IP Gateway MAC
0.0.0.0/0 route 2a7bf881-1f89-4833-833e-47673b79901a 169.0.0.2
80.80.80.11/32 route 3eb2d5aa-3d11-4de3-98df-3cdebf5094e0 100.64.1.3
100.64.1.0/32 route 01f737d3-a66a-5b14-9ff7-6fc64af6a613
100.64.1.0/31 route bbf5b23c-3f0a-4afe-b3b3-b19814d4dd2a
100.64.1.2/32 route 01f737d3-a66a-5b14-9ff7-6fc64af6a613
100.64.1.2/31 route 3eb2d5aa-3d11-4de3-98df-3cdebf5094e0
169.0.0.0/28 route 2a7bf881-1f89-4833-833e-47673b79901a
169.0.0.1/32 route 01f737d3-a66a-5b14-9ff7-6fc64af6a613
172.16.10.0/24 route bbf5b23c-3f0a-4afe-b3b3-b19814d4dd2a 100.64.1.1
172.16.20.0/24 route bbf5b23c-3f0a-4afe-b3b3-b19814d4dd2a 100.64.1.1
172.16.30.0/24 route bbf5b23c-3f0a-4afe-b3b3-b19814d4dd2a 100.64.1.1
172.16.40.0/24 route 3eb2d5aa-3d11-4de3-98df-3cdebf5094e0 100.64.1.3
192.168.130.0/24 route 2a7bf881-1f89-4833-833e-47673b79901a 169.0.0.2
192.168.130.3/32 route 2a7bf881-1f89-4833-833e-47673b79901a 169.0.0.2
or
nsx-edge-1(path)> get forwarding
MAC Table:
MAC UUID Source
02:50:56:00:00:00 5b2068d0-8c28-4427-8be4-48f422f92309 controller
02:50:56:00:00:02 eb3bd495-9ce3-40b4-a955-c2ddc4893cfa controller
02:50:56:56:44:52 5b2068d0-8c28-4427-8be4-48f422f92309 controller
Replication Tunnels:
UUID Local VTEP Remote VTEP MTEP
704d9577-39d4-5b7c-b890-5e5e0bba8d0e 192.168.250.62 192.168.250.63 False
Mode
Path
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <prefix> | Network Address argument |
Example
nsx-edge-1(tier0_sr)> get forwarding
Logical Router
UUID VRF LR-ID Name Type
e9d3379d-aba7-4459-9262-18bc95eaeec1 1 1 SERVICE_ROUTER_TIER0
IPv4 Forwarding Table
IP Prefix Gateway IP Type UUID Gateway MAC
127.0.0.1/32 route 4b115e5f-1395-54c3-aaf0-0de5736f99df
172.20.1.0/24 route 6c427841-e151-4479-9184-4196cfcef3b6
172.20.1.60/32 route 4b115e5f-1395-54c3-aaf0-0de5736f99df
172.24.4.1/32 172.20.1.50 route 6c427841-e151-4479-9184-4196cfcef3b6
or
nsx-edge-1(tier0_sr)> get forwarding 172.16.110.0/24
Logical Router
UUID VRF Name Type
e9d3379d-aba7-4459-9262-18bc95eaeec1 1 SERVICE_ROUTER_TIER0
IPv4 Forwarding Table
IP Prefix Gateway IP Type UUID Gateway MAC
172.24.4.1/32 172.20.1.50 route 6c427841-e151-4479-9184-4196cfcef3b6
Mode
VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display information about the specified gateway.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get gateway 736a80e3-23f6-5a2d-81d6-bbefb2786666
Gateway
UUID VRF Gateway-ID Name Type Ports Neighbors
736a80e3-23f6-5a2d-81d6-bbefb2786666 0 0 R1 TUNNEL 3 4/50000
Mode
Basic
Availability
Autonomous Edge, Edge
Display parameters defined in global gateway BFD
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge> get gateway 463c9dd1-986b-4947-895b-1126bd53abc8 bfd-config
Gateway
UUID : d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8
vrf : 6
Gateway-ID : 6
name : R1
type : SERVICE_ROUTER_TIER0
BFD global configuration
Enabled : True
Min RX Interval: 1000
Min TX Interval: 1000
Min RX TTL : 255
Multiplier : 3
Port : 4451c48f-8cff-4444-8e10-bff403783dca
BFD session configuration
Source : 192.168.50.1
Peer : 192.168.50.10
Enabled : True
Min RX Interval: 1000
Min TX Interval: 1000
RX TTL : 255
Multiplier : 3
Source : 192.168.50.1
Peer : 192.168.50.20
Enabled : True
Min RX Interval: 3000
Min TX Interval: 3000
RX TTL : 255
Multiplier : 5
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about IGMP reports snooped in the Gateway
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
pnq4-hs1-a0212> get gateway 8d96679c-bf01-4656-ac0a-7964c9d4ca05 igmp-snooping-table
Thu Jul 09 2020 UTC 23:15:48.323
Receiving Interface
UUID VRF Group Origin / VTEP IP Timeout Uptime
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 239.49.49.49 EDGE 138.1.1.4 119 0:05:49
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 224.0.0.22 EDGE 138.1.1.4 18 0:11:18
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 224.0.0.22 EDGE 138.1.1.5 122 2:39:49
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 224.0.0.2 EDGE 138.1.1.5 127 2:39:44
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 235.1.1.15 EDGE 138.1.1.4 119 2:39:44
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 224.0.0.13 EDGE 138.1.1.5 120 2:39:46
49acf593-91c7-4607-b91a-f7f8d40152d7 3 239.13.13.13 Local 135 0:00:08
49acf593-91c7-4607-b91a-f7f8d40152d7 3 239.13.13.15 Local 129 0:00:14
49acf593-91c7-4607-b91a-f7f8d40152d7 3 239.13.13.14 Local 122 0:10:25
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 239.49.49.49 EDGE 138.1.1.5 124 2:39:53
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 224.0.0.2 EDGE 138.1.1.4 122 0:08:20
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about IGMP reports snooped in the Gateway filtered by multicast group
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
Example
pnq4-hs1-a0212> get gateway 8d96679c-bf01-4656-ac0a-7964c9d4ca05 igmp-snooping-table 239.49.49.49
Thu Jul 09 2020 UTC 23:18:07.006
Receiving Interface
UUID VRF Group Origin / VTEP IP Timeout Uptime
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 239.49.49.49 EDGE 138.1.1.4 59 0:08:08
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 239.49.49.49 EDGE 138.1.1.5 136 2:42:12
Mode
Basic
Availability
Autonomous Edge, Edge
Display interface information for the specified gateway.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get gateway d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 interfaces
Gateway
UUID VRF Gateway-ID Name Type
736a80e3-23f6-5a2d-81d6-bbefb2786666 0 0 R1 TUNNEL
interfaces
interface : 9fd3c667-32db-5921-aaad-7a88c80b5e9f
ifuid : 258
mode : blackhole
interface : 34ca595f-fa62-5ed4-afcc-a6ef0195d4ed
ifuid : 261
mode : lif
IP/Mask : 142.134.61.36/24
MAC : 00:0c:29:5a:96:2b
VLAN id : untagged
Segment port: 238d7422-e488-5cee-9639-1894b8ab56e2
urpf-mode : NONE
admin : up
op_state : up
MTU : 1600
arp_proxy : 40.40.10.60, 40.40.10.50, 40.40.10.55
: 40.40.10.100, 40.40.10.110
interface : f322c6ca-4298-568b-81c7-a006ba6e6c88
ifuid : 257
mode : cpu
Mode
Basic
Availability
Autonomous Edge, Edge
Display the interface statistics for the specified gateway.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get gateway e9d3379d-aba7-4459-9262-18bc95eaeec1 interfaces stats
Gateway
UUID : e9d3379d-aba7-4459-9262-18bc95eaeec1
VRF : 1
Gateway-ID : 1
name : R2
type : SERVICE_ROUTER_TIER0
Statistics
Interface Type RX PKTS TX PKTS RX BYTES TX BYTES RX Drops TX Drops
b83cb77f-ca34-595c-a3e1-76278f0dcb00 blackhole 0 0 0 0 0 0
4b115e5f-1395-54c3-aaf0-0de5736f99df cpu 8 0 648 0 8 0
6c427841-e151-4479-9184-4196cfcef3b6 lif 5563 11 1902546 462 5563 0
081e2e50-2f0e-42e1-8764-80a127dd3918 lif 0 0 0 0 0 0
00003300-0000-0000-0000-000000000002 loopback 8 0 648 0 8 0
Total 5579 11 1903842 462 5579 0
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge> get gateway 3b5a8fa4-30f0-41cd-90d0-a68f9cac54dd mfib
Gateway
UUID VRF Gateway-ID Name Type
3b5a8fa4-30f0-41cd-90d0-a68f9cac54dd 1 2 SR-Tier0-LR-1 SERVICE_ROUTER_TIER0
IPv4 Multicast Forwarding Table
Source IP Group IP Incoming UUID Outgoing UUID/VTEP/MTEP/UMG
40.40.40.1 237.0.0.1 cc8bd3c5-6558-49b4-90f5-dd180e3fdf0f 77f6b2fe-0c3d-4c56-91d6-a008ab3bfdcb
100.1.2.1
239.100.100.100
40.40.40.10 237.0.0.1 77f6b2fe-0c3d-4c56-91d6-a008ab3bfdcb cc8bd3c5-6558-49b4-90f5-dd180e3fdf0f
0.0.0.0 0.0.0.0 none 0000000a-0000-0000-0000-000000000000
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
Example
nsx-edge> get gateway 3b5a8fa4-30f0-41cd-90d0-a68f9cac54dd mfib
Gateway
UUID VRF Gateway-ID Name Type
3b5a8fa4-30f0-41cd-90d0-a68f9cac54dd 1 2 SR-Tier0-LR-1 SERVICE_ROUTER_TIER0
IPv4 Multicast Forwarding Table
Source IP Group IP Incoming UUID Outgoing UUID/VTEP/MTEP/UMG
40.40.40.1 237.0.0.1 cc8bd3c5-6558-49b4-90f5-dd180e3fdf0f 77f6b2fe-0c3d-4c56-91d6-a008ab3bfdcb
100.1.2.1
239.100.100.100
40.40.40.10 237.0.0.1 77f6b2fe-0c3d-4c56-91d6-a008ab3bfdcb cc8bd3c5-6558-49b4-90f5-dd180e3fdf0f
nsx-edge> get gateway 6263fe96-0ecf-4b3b-ad2d-3c0447de038b mfib
Gateway
UUID VRF Gateway-ID Name Type
6263fe96-0ecf-4b3b-ad2d-3c0447de038b 2 2 SR-tier0 SERVICE_ROUTER_TIER0
IPv4 Multicast Forwarding Table
Source IP Group IP Incoming UUID Outgoing UUID/VTEP/MTEP/UMG
2.1.4.11 237.0.0.16 b9267b0d-5d4b-48c5-8ae4-38ab95de40bf 0ef83a9d-5014-4b3e-bcef-32109a34237b
1.1.8.10 237.0.0.12 0ef83a9d-5014-4b3e-bcef-32109a34237b b9267b0d-5d4b-48c5-8ae4-38ab95de40bf
nsx-edge> get gateway 6263fe96-0ecf-4b3b-ad2d-3c0447de038b mfib 237.0.0.12
Gateway
UUID VRF Gateway-ID Name Type
6263fe96-0ecf-4b3b-ad2d-3c0447de038b 2 2 SR-tier0 SERVICE_ROUTER_TIER0
IPv4 Multicast Forwarding Table
Source IP Group IP Incoming UUID Outgoing UUID/VTEP/MTEP/UMG
1.1.8.10 237.0.0.12 0ef83a9d-5014-4b3e-bcef-32109a34237b b9267b0d-5d4b-48c5-8ae4-38ab95de40bf
Mode
Basic
Availability
Autonomous Edge, Edge
Display the neighbor table for the specified gateway.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get gateway d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 neighbors
Gateway
UUID : d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8
VRF : 6
Gateway-ID : 6
name : R3
type : DISTRIBUTED_ROUTER
Neighbors
interface : c66fc321-df74-4aaa-835e-95dc815fe7ae
IP : 172.16.130.13
MAC : 00:50:56:8e:3e:0b
state : perm
interface : f6ef3b50-64a0-4948-ab9e-9135963d4b8b
IP : 169.0.0.2
MAC : 02:50:56:00:00:05
state : reach
timeout : 7
interface : be290c92-74ed-437c-bbf1-dd78673b6a5a
IP : 172.16.120.11
MAC : 00:50:56:8e:15:e5
state : reach
timeout : 24
interface : 3c139373-f8f7-441e-aac4-146d9b5ff3a6
IP : 172.16.110.11
MAC : 00:50:56:8e:91:12
state : perm
Mode
Basic
Availability
Autonomous Edge, Edge
Display the neighbor table and statistics for the specified gateway.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get gateway d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 neighbors stats
Gateway
UUID : d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8
VRF : 6
Gateway-ID : 6
name : R3
type : DISTRIBUTED_ROUTER
Neighbors
interface : c66fc321-df74-4aaa-835e-95dc815fe7ae
IP : 172.16.130.13
MAC : 00:50:56:8e:3e:0b
state : perm
statistics
TX-Packets : 0
TX-Fails : 0
TX-Solicits : 0
TX-Solicit-Fails : 0
RX-Solicits : 0
RX-Unsolicits : 0
interface : f6ef3b50-64a0-4948-ab9e-9135963d4b8b
IP : 169.0.0.2
MAC : 02:50:56:00:00:05
state : reach
timeout : 325
statistics
TX-Packets : 1
TX-Fails : 0
TX-Solicits : 239
TX-Solicit-Fails : 0
RX-Solicits : 241
RX-Unsolicits : 0
interface : be290c92-74ed-437c-bbf1-dd78673b6a5a
IP : 172.16.120.11
MAC : 00:50:56:8e:15:e5
state : reach
timeout : 378
statistics
TX-Packets : 6
TX-Fails : 0
TX-Solicits : 261
TX-Solicit-Fails : 0
RX-Solicits : 233
RX-Unsolicits : 0
interface : 3c139373-f8f7-441e-aac4-146d9b5ff3a6
IP : 172.16.110.11
MAC : 00:50:56:8e:91:12
state : perm
statistics
TX-Packets : 0
TX-Fails : 0
TX-Solicits : 0
TX-Solicit-Fails : 0
RX-Solicits : 0
RX-Unsolicits : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display QoS config for the specified gateway.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get gateway 736a80e3-23f6-5a2d-81d6-bbefb2786666 qos-config
Gateway
UUID : 736a80e3-23f6-5a2d-81d6-bbefb2786666
Direction : Egress
Rate (Mbps) : 10
Burst (bytes) : 1000
Direction : Ingress
Rate (Mbps) : 100
Burst (bytes) : 5000
Mode
Basic
Availability
Autonomous Edge, Edge
Display statistics for the specified gateway.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get gateway 736a80e3-23f6-5a2d-81d6-bbefb2786666 stats
Gateway
UUID : 736a80e3-23f6-5a2d-81d6-bbefb2786666
VRF : 0
Gateway-ID : 0
name : R1
type : TUNNEL
Statistics
Dropped No Memory : 0
Dropped No Route : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display tenant context information for the specified gateway.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
Edge3> get gateway 4e416838-219b-4a91-88cf-b73448e319a8 tenant-context
Sat Jul 15 2023 UTC 00:05:34.788
org : default
proj : maroon
vpc :
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about the specified Gateway.
| Option | Description |
|---|---|
| <uuid> | Gateway identifier |
Example
nsx-controller-1> get gateway db6760b3-d9e2-44ef-b1c4-f56138665d71
GW-ID GW-Name Router-Type ClusterId UUID
0x5 SR-46740ffe-9bf1-406e-816d-e200a45f0707 SERVICE_ROUTER_TIER1 00002000-0000-0000-0000-000000000001 db6760b3-d9e2-44ef-b1c4-f56138665d71
Mode
Basic
Availability
Manager
Display the routing table for the specified Gateway.
| Option | Description |
|---|---|
| <uuid> | Gateway identifier |
| <route> | Logical Router route description Allowed values: route |
Example
nsx-controller-1> get gateway db6760b3-d9e2-44ef-b1c4-f56138665d71 route
Gateway/Cluster-UUID Destination Next-Hop GW-Port-Id Blackhole Blackhole-Action Route-Type Admin-Distance Admin-State-Up Route-UUID
b9486c73-7959-4adf-9370-f46b8c031f51 fe80::/64 N/A c248635f-1213-45e7-9e40-5bb4c95363fa false N/A ROUTE_TYPE_CONNECTED 0 false 59d966a3-3edd-511d-adc3-fe9e0166e0b1
b9486c73-7959-4adf-9370-f46b8c031f51 169.254.0.0/24 N/A c248635f-1213-45e7-9e40-5bb4c95363fa false N/A ROUTE_TYPE_CONNECTED 0 false 4f1515fc-771c-544a-93fe-1e981d461d5d
Mode
Basic
Availability
Manager
Display a specific IPv4 route on the specified Gateway.
| Option | Description |
|---|---|
| <uuid> | Gateway identifier |
| <route> | Logical Router route description Allowed values: route |
| <prefix> | Network Address argument |
Example
nsx-controller-1> get gateway db6760b3-d9e2-44ef-b1c4-f56138665d71 route 172.16.120.0/24
Gateway/Cluster-UUID Destination Next-Hop GW-Port-Id Blackhole Blackhole-Action Route-Type Admin-Distance Admin-State-Up Route-UUID
b9486c73-7959-4adf-9370-f46b8c031f51 172.16.120.0/24 N/A c248635f-1213-45e7-9e40-5bb4c95363fa false N/A ROUTE_TYPE_CONNECTED 0 false 4f1515fc-771c-544a-93fe-1e981d461d5d
Mode
Basic
Availability
Manager
Display information about a specific interface on the specified Gateway
| Option | Description |
|---|---|
| <uuid> | Gateway identifier |
| <interface-id> | Gateway interface id Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get gateway db6760b3-d9e2-44ef-b1c4-f56138665d71 interface 8b06827f-6325-4afd-b56d-6260ebf0a1a0
UUID: 8b06827f-6325-4afd-b56d-6260ebf0a1a0
Interface-Name: bp-sr0-port
Gateway-Id: 0x5
Id: 15240
Type: VXSTT
AdminStateUp: true
UrpfMode: PORT_CHECK
Subnets:
169.0.0.2/28
Mac: 02:50:56:00:00:06
Mtu: 0
Multicast-IP: 0.0.0.1
Flags: 0x204
DHCP-Server-IP:
Mode
Basic
Availability
Manager
Display all interfaces on the specified gateway.
| Option | Description |
|---|---|
| <uuid> | Gateway identifier |
Example
nsx-controller-1> get gateway db6760b3-d9e2-44ef-b1c4-f56138665d71 interfaces
Interface IP[] Urpf-Mode Admin-State-Up UUID
sr-0-loopback-port 127.0.0.1/8 NONE true 00003300-0000-0000-0000-000000000005
bp-sr0-port 169.0.0.2/28 PORT_CHECK true 8b06827f-6325-4afd-b56d-6260ebf0a1a0
97458be5-bf5e-44f8-a6b0-9fc32be347fc 100.64.1.1/31 PORT_CHECK true 97458be5-bf5e-44f8-a6b0-9fc32be347fc
Mode
Basic
Availability
Manager
Get all routing Config entities on the specified Service Gateway.
| Option | Description |
|---|---|
| <uuid> | Gateway identifier |
Mode
Basic
Availability
Manager
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.| Option | Description |
|---|---|
| <uuid> | UUID argument |
Example
nsx-edge-1> get gateway 4e425c9e-09c6-4021-bbc7-fab2895a2c09 high-availability history state
State : Down
Event : Init
Resources :
Time : 2016-02-02 18:41:22.80
State : Active
Event : Node Up
Resources : 0
Time : 2016-02-02 18:41:26.91
Mode
Basic
Availability
Autonomous Edge, Edge
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.| Option | Description |
|---|---|
| <uuid> | UUID argument |
Example
nsx-edge-1> get gateway 4e425c9e-09c6-4021-bbc7-fab2895a2c09 high-availability history state details
State : Down
Event : Init
Reason : Initialize
Resources :
Time : 2016-02-02 18:41:22.80
State : Active
Event : Node Up
Reason : Initialize
Resources : 0
Time : 2016-02-02 18:41:26.91
Mode
Basic
Availability
Autonomous Edge, Edge
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.| Option | Description |
|---|---|
| <uuid> | UUID argument |
Example
nsx-edge-1> get gateway 4e425c9e-09c6-4021-bbc7-fab2895a2c09 high-availability status
Service Gateway
UUID : 4e425c9e-09c6-4021-bbc7-fab2895a2c09
state : Active
type : TIER0
mode : A/A
rank : 0
service count : 1
service score : 1
HA ports state
UUID : 733d7ed3-1daa-4c28-bc0a-77e3736fea14
op_state : Up
addresses : 169.0.0.2/28
Sub-cluster Information
UUID : 6c3089d1-dac5-43ce-b8bb-91e6bb36345d
Peer SR UUID : 44e3ee5f-36ea-4703-80ad-0e6b50af552a
Peer Node UUID : 3b34da96-ed06-11e8-9814-020063efb6dc
Peer Routers
Node UUID : 3b34da96-ed06-11e8-9814-020063efb6dc
HA state : Active
Node UUID : 2e7dcee8-ed06-11e8-b593-020063334468
HA state : Active
Mode
Basic
Availability
Autonomous Edge, Edge
Display the service groups state for the gateway
| Option | Description |
|---|---|
| <uuid> | UUID argument |
Example
nsx-edge-1> get gateway 4e425c9e-09c6-4021-bbc7-fab2895a2c09 service-groups
Service-Group : a97dea09-a9a9-446d-bd8f-4d6d4f2bc070
Id : 1
Local State : Active
Peer State : Standby
State History
State : Down
Event : Init
Resources :
Time : 2022-01-21 09:31:15.22
State : Standby
Event : Service Router Up
Resources :
Time : 2022-01-21 09:31:15.22
State : Active
Event : Service Router Up
Resources : 0
Time : 2022-01-21 09:31:15.68
Mode
Basic
Availability
Autonomous Edge, Edge
Display the service groups state for the gateway
| Option | Description |
|---|---|
| <uuid> | UUID argument |
Example
nsx-edge-1> get gateway 4e425c9e-09c6-4021-bbc7-fab2895a2c09 service-groups details
Service-Group : a97dea09-a9a9-446d-bd8f-4d6d4f2bc070
Id : 1
Local State : Active
Peer State : Standby
State History
State : Down
Event : Init
Reason : Initialize
Resources :
Time : 2022-01-21 09:31:15.22
State : Standby
Event : Service Router Up
Reason : Service Router Up
Resources :
Time : 2022-01-21 09:31:15.22
State : Active
Event : Service Router Up
Reason : Service Router Up
Resources : 0
Time : 2022-01-21 09:31:15.68
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about the specified gateway.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
kvm-1> get gateway 091a05dc-8080-41a2-a56f-baf6d32fb512
Gateway
==================================================
UUID : 091a05dc-8080-41a2-a56f-baf6d32fb512
ID : 32769
Max Neighbors : 50000
Current Neighbors : 1
Interfaces :
100.64.1.1/31 (02:50:56:00:00:03)
172.16.30.1/24 (02:50:56:56:44:52)
172.16.10.1/24 (02:50:56:56:44:52)
172.16.20.1/24 (02:50:56:56:44:52)
or
esx-1> get gateway d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8
Gateway
-------------------------------------------------------------------------------------
VDR UUID : d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8
LIF number : 4
IPv4 Route number : 7
IPv6 Route number : 5
State : ['Enabled']
Role : VPC DR
Policy Path : /orgs/default/projects/default/vpcs/vpc1
Controller IP : 192.168.110.108
Control plane IP : 192.168.210.51
Control plane active : True
Next hop number : 1
Generation number : 0
Edge active : False
Current Neighbors : 20
Max Neighbors : 50000
Neighbor Limit Overridden : False
Multicast Routing Enable : False
ECMP Mode : L3
Mode
Basic
Availability
ESXi, KVM, NSX Cloud VM
Display forwarding for the specified gateway.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
kvm-1> get gateway 3f37a518-0b5a-4833-be11-0f6df5e96421 forwarding
Gateway Forwarding Table
==============================================================================================================
Prefix Gateway Interface
100.64.1.0/31 0.0.0.0 7f475e70-6919-42f4-a9ab-7c8381ef93c2
192.168.10.0/24 0.0.0.0 4891b955-a8cf-4e2f-b87f-ea1fc6c3b7a8
192.168.20.0/24 0.0.0.0 a12f6616-31bd-4d75-8972-bc75f3fe4392
0.0.0.0/0 100.64.1.0 7f475e70-6919-42f4-a9ab-7c8381ef93c2
2000:20::/64 :: a12f6616-31bd-4d75-8972-bc75f3fe4392
2000:10::/64 :: 4891b955-a8cf-4e2f-b87f-ea1fc6c3b7a8
fc88:474c:60c:2800::/64 :: 7f475e70-6919-42f4-a9ab-7c8381ef93c2
::/0 fc88:474c:60c:2800::1 7f475e70-6919-42f4-a9ab-7c8381ef93c2
or
esx-1> get gateway d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 forwarding
Gateway Forwarding Table
-----------------------------------------------------------------------------------------------------
Flags Legend: [U: Up], [G: Gateway], [C: Connected], [I: Interface]
[H: Host], [R: Reject], [B: Blackhole], [F: Soft Flush], [E: ECMP]
[S1|S2|S3: TGW Private|Public|External Route Scope]
Network Gateway Type Interface UUID
=====================================================================================================
172.16.10.0/26 100.64.0.1 UGS1 47b3683e-3d26-5d7b-8c68-d5c28980bc70
172.16.10.64/26 100.64.0.3 UGS1 3b2115c7-23ef-5aaf-9ad2-085684c2fb92
192.168.1.0/24 0.0.0.0 UCI 1c1a47f7-d314-4e74-a198-5568540e4284
192.168.2.0/24 0.0.0.0 UCI 53a15328-e7cb-4c97-b147-e7ee833754db
2000::1/64 :: UCI 1c1a47f7-d314-4e74-a198-5568540e4284
3000::1/64 :: UCI 53a15328-e7cb-4c97-b147-e7ee833754db
Mode
Basic
Availability
ESXi, KVM, NSX Cloud VM
Display forwarding for the specified gateway filtered on prefix.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <prefix> | Network Address argument |
Example
esx-1> get gateway d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 forwarding 192.168.1.0/24
Gateway Forwarding Table
-----------------------------------------------------------------------------------------------------
Flags Legend: [U: Up], [G: Gateway], [C: Connected], [I: Interface]
[H: Host], [R: Reject], [B: Blackhole], [F: Soft Flush], [E: ECMP]
[S1|S2|S3: TGW Private|Public|External Route Scope]
Network Gateway Type Interface UUID
=====================================================================================================
192.168.1.0/24 0.0.0.0 UCI 1c1a47f7-d314-4e74-a198-5568540e4284
Mode
Basic
Availability
ESXi
Display forwarding for the specified gateway, filtered by prefix.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <prefix> | Network Address argument |
Example
kvm-1> get gateway 091a05dc-8080-41a2-a56f-baf6d32fb512 forwarding fc88:474c:60c:2800::/64
Gateway Forwarding Table
==============================================================================================================
Prefix Gateway Interface
fc88:474c:60c:2800::/64 :: 7f475e70-6919-42f4-a9ab-7c8381ef93c2
Mode
Basic
Availability
KVM, NSX Cloud VM
Display IPv4 forwarding for the specified gateway.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
kvm-1> get gateway 3f37a518-0b5a-4833-be11-0f6df5e96421 forwarding ipv4
Gateway Forwarding Table
==============================================================================================================
Prefix Gateway Interface
100.64.1.0/31 0.0.0.0 7f475e70-6919-42f4-a9ab-7c8381ef93c2
192.168.10.0/24 0.0.0.0 4891b955-a8cf-4e2f-b87f-ea1fc6c3b7a8
192.168.20.0/24 0.0.0.0 a12f6616-31bd-4d75-8972-bc75f3fe4392
or
esx-1> get gateway d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 forwarding
Gateway Forwarding Table - IPv4
------------------------------------------------------------------------------------------------------
Flags Legend: [U: Up], [G: Gateway], [C: Connected], [I: Interface]
[H: Host], [R: Reject], [B: Blackhole], [F: Soft Flush], [E: ECMP]
[S1|S2|S3: TGW Private|Public|External Route Scope]
Network Gateway Type Interface UUID
=====================================================================================================
172.16.10.0/26 100.64.0.1 UGS1 47b3683e-3d26-5d7b-8c68-d5c28980bc70
172.16.10.64/26 100.64.0.3 UGS1 3b2115c7-23ef-5aaf-9ad2-085684c2fb92
192.168.1.0/24 0.0.0.0 UCI 1c1a47f7-d314-4e74-a198-5568540e4284
192.168.2.0/24 0.0.0.0 UCI 53a15328-e7cb-4c97-b147-e7ee833754db
Mode
Basic
Availability
ESXi, KVM, NSX Cloud VM
Display IPv6 forwarding for the specified gateway.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
kvm-1> get gateway 091a05dc-8080-41a2-a56f-baf6d32fb512 forwarding ipv6
Gateway Forwarding Table
==============================================================================================================
Prefix Gateway Interface
2000:20::/64 :: a12f6616-31bd-4d75-8972-bc75f3fe4392
2000:10::/64 :: 4891b955-a8cf-4e2f-b87f-ea1fc6c3b7a8
fc88:474c:60c:2800::/64 :: 7f475e70-6919-42f4-a9ab-7c8381ef93c2
::/0 fc88:474c:60c:2800::1 7f475e70-6919-42f4-a9ab-7c8381ef93c2
or
esx-1> get gateway d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 forwarding
Gateway Forwarding Table - IPv6
-------------------------------------------------------------------------------------------------------
Flags Legend: [U: Up], [G: Gateway], [C: Connected], [I: Interface]
[H: Host], [R: Reject], [B: Blackhole], [F: Soft Flush], [E: ECMP]
Network Gateway Type Interface UUID
=====================================================================================================
2000::1/64 :: UCI 1c1a47f7-d314-4e74-a198-5568540e4284
3000::1/64 :: UCI 53a15328-e7cb-4c97-b147-e7ee833754db
Mode
Basic
Availability
ESXi, KVM, NSX Cloud VM
Display Mcast Groups for the specified gateway.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
esx-1> get gateway 95a67044-9353-4e69-aa45-a1d29480eef5 igmp membership
Mcast groups with Local or Remote Receivers
==============================================================
Number of Local Receiver Entries : 1
Number of Remote Receiver Entries : 1
Number of Multicast Groups : 1
==============================================================
Multicast group IP Replication IP
---------------------------------------
237.0.0.10 230.0.0.220
Local Receivers :
1)
Lif Name : b151ed17-c023-4b1c-a487-f2418198fe02
VNI Type : 2
VNI : 69643
Expire Time(sec) : 183
Up Time(sec) : 1643380
---------------------------------------
Remote Receivers :
VTEP count: 1
1)
Label: 12342
Subnet IP: 200.200.200.10
VTEP IP: 200.200.200.21
VTEP Mac: 30:30:3a:31:31:3a
Is MTEP: True
MTEP Favourable: True
Up Time(sec): 8
Expire Time(sec): 252
==============================================================
Mode
Basic
Availability
ESXi
Display Mcast Groups for the specified gateway.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <ip-address> | Network IP address argument |
Example
esx-1> get gateway 95a67044-9353-4e69-aa45-a1d29480eef5 igmp membership 237.0.0.10
Mcast groups with Local or Remote Receivers
==============================================================
Number of Local Receiver Entries : 1
Number of Remote Receiver Entries : 1
Number of Multicast Groups : 1
==============================================================
Multicast group IP Replication IP
---------------------------------------
237.0.0.10 230.0.0.220
Local Receivers :
1)
Lif Name : b151ed17-c023-4b1c-a487-f2418198fe02
VNI Type : 2
VNI : 69643
Expire Time(sec) : 183
Up Time(sec) : 1643380
---------------------------------------
Remote Receivers :
VTEP count: 1
1)
Label: 12342
Subnet IP: 200.200.200.10
VTEP IP: 200.200.200.21
VTEP Mac: 30:30:3a:31:31:3a
Is MTEP: True
MTEP Favourable: True
Up Time(sec): 8
Expire Time(sec): 252
==============================================================
Mode
Basic
Availability
ESXi
Display information for the specified gateway instance.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
esx-1> get gateway d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 interface c66fc321-df74-4aaa-835e-95dc815fe7ae
Gateway Interface
---------------------------------------------------------------------------
LIF UUID : c66fc321-df74-4aaa-835e-95dc815fe7ae
Name : vpc1-private-subnet1-gateway-interface
Subnet Access Mode : PRIVATE
Mode : ['Routing']
Overlay VNI : 27530
IP : 172.16.130.1
IP mask : 255.255.255.0
Mac : 02:50:56:56:44:52
Connected DVS : nsxvswitch
Control plane enable : True
Replication Mode : 0.0.0.1
Multicast Routing : ['Enabled', 'Oper Up', 'Local VM Present']
State : ['Enabled']
Flags : 0x2388
DHCP relay : Not enable
Mode
Basic
Availability
ESXi
Display interface information for the specified gateway and port.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
kvm-1> get gateway 091a05dc-8080-41a2-a56f-baf6d32fb512 interface e1ce6498-b3ca-4000-a0f4-0734415044cf
Gateway Interfaces
============================================================
Interface UUID : e1ce6498-b3ca-4000-a0f4-0734415044cf
IP/Mask : 100.64.1.1/31
MAC Address : 02:50:56:00:00:03
VNI : 58248
Flag : 1
DHCP relay : 192.168.33.1, 2001::192:168:33:1
RA-mode : SLAAC_DNS_THROUGH_RA(M=0, O=0)
DAD-mode : Loose
============================================================
Mode
Basic
Availability
KVM, NSX Cloud VM
Display policy table reference information for the specified gateway instance.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
esx-1> get gateway 22cf7bdd-dd1e-41d6-b3bd-67c566b86fb5 interface 8d0979da-5d73-4717-b711-f44a19007b44 policy-table-ref
Gateway Interface Policy Table Reference
--------------------------------------------------------------------------------
Policy Table ID Next Hop Type
================================================================================
2 00:50:56:6c:f1:31 proximity routing
Mode
Basic
Availability
ESXi
Display interface instance stats for a gateway.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
esx1> get gateway a485769d-dc65-4197-b3c9-9a200033e3ea interface e2f2ee21-871a-4c39-8640-2501b9bb871d stats
Gateway Interface Stats
---------------------------------------------------------------------------
RX Unicast Packets : 0
RX Unicast Bytes : 0
TX Unicast Packets : 0
TX Unicast Bytes : 0
RX Broadcast Packets : 0
RX Broadcast Bytes : 0
TX Broadcast Packets : 4
TX Broadcast Bytes : 240
RX Multicast Packets : 0
RX Multicast Bytes : 0
RX Packets System Error : 0
TX Ref Errors : 0
Packets Deferred Free : 0
RX Packets Dropped : 0
LIF IPv4 Net Statistics
IP & ARP packets RX : 0
IP & ARP packets TX : 4
...
IPv6 Route not found to Dest : 0
Neighbor not found : 0
Mode
Basic
Availability
ESXi
Display interface statistics for the specified gateway and port.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
kvm> get gateway 96252d7f-1d01-40e7-8f1e-6e3305f22af5 interface 7edd998a-0dfd-4c36-92eb-1bd1d48976ec stats
Gateway Interface Stats
---------------------------------------------------------------------------
IPv4 Packets RX : 4791
IPv4 Packets TX : 0
IPv4 RX Packets Drops : 0
IPv4 TX Packets Drops : 0
IPv4 TTL Zero Drops : 0
IPv4 uRPF Drops : 0
IPv6 Packets RX : 56520
IPv6 Packets TX : 56432
IPv6 RX Packets Drops : 56459
IPv6 TX Packets Drops : 0
IPv6 TTL Zero Drops : 0
IPV6 uRPF Drops : 0
RS RX Packets : 4
RA TX Packets : 4170
Redirect TX Packets : 2
Mode
Basic
Availability
KVM, NSX Cloud VM
Display interface statistics for the specified gateway and port.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <ip-version> | Internet Protocol Version (IPV4 or IPV6) Allowed values: ipv4, ipv6 |
Example
kvm> get gateway 96252d7f-1d01-40e7-8f1e-6e3305f22af5 interface 7edd998a-0dfd-4c36-92eb-1bd1d48976ec stats ipv4
Gateway Interface Stats
---------------------------------------------------------------------------
IPv4 Packets RX : 4791
IPv4 Packets TX : 0
IPv4 RX Packets Drops : 0
IPv4 TX Packets Drops : 0
IPv4 TTL Zero Drops : 0
IPv4 uRPF Drops : 0
kvm> get gateway 96252d7f-1d01-40e7-8f1e-6e3305f22af5 interface 7edd998a-0dfd-4c36-92eb-1bd1d48976ec stats ipv6
Gateway Interface Stats
---------------------------------------------------------------------------
IPv6 Packets RX : 56520
IPv6 Packets TX : 56432
IPv6 RX Packets Drops : 56459
IPv6 TX Packets Drops : 0
IPv6 TTL Zero Drops : 0
IPV6 uRPF Drops : 0
RS RX Packets : 4
RA TX Packets : 4170
Redirect TX Packets : 2
Mode
Basic
Availability
KVM, NSX Cloud VM
Display interface instance stats for a gateway (ipv4).
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
esx1> get gateway a485769d-dc65-4197-b3c9-9a200033e3ea interface e2f2ee21-871a-4c39-8640-2501b9bb871d stats ipv4
Gateway Interface Stats
---------------------------------------------------------------------------
RX Unicast Packets : 0
RX Unicast Bytes : 0
TX Unicast Packets : 0
TX Unicast Bytes : 0
RX Broadcast Packets : 0
RX Broadcast Bytes : 0
TX Broadcast Packets : 4
TX Broadcast Bytes : 240
RX Multicast Packets : 0
RX Multicast Bytes : 0
RX Packets System Error : 0
TX Ref Errors : 0
Packets Deferred Free : 0
RX Packets Dropped : 0
LIF IPv4 Net Statistics
IP & ARP packets RX : 0
IP & ARP packets TX : 4
...
Route not found to Dest : 0
Neighbor not found : 0
Mode
Basic
Availability
ESXi
Display interface instance stats for a gateway (ipv6).
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
esx1> get gateway a485769d-dc65-4197-b3c9-9a200033e3ea interface e2f2ee21-871a-4c39-8640-2501b9bb871d stats ipv6
Gatewayr Interface Stats
---------------------------------------------------------------------------
RX Unicast Packets : 0
RX Unicast Bytes : 0
TX Unicast Packets : 0
TX Unicast Bytes : 0
RX Broadcast Packets : 0
RX Broadcast Bytes : 0
TX Broadcast Packets : 4
TX Broadcast Bytes : 240
RX Multicast Packets : 0
RX Multicast Bytes : 0
RX Packets System Error : 0
TX Ref Errors : 0
Packets Deferred Free : 0
RX Packets Dropped : 0
LIF IPv6 Net Statistics
IPv6 packets RX : 0
IPv6 packets TX : 0
...
IPv6 Route not found to Dest : 0
Neighbor not found : 0
Mode
Basic
Availability
ESXi
Display interface information for the specified gateway.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
kvm-1> get gateway 091a05dc-8080-41a2-a56f-baf6d32fb512 interfaces
Gateway Interfaces
============================================================
Interface UUID : e1ce6498-b3ca-4000-a0f4-0734415044cf
IP/Mask : 100.64.1.1/31
MAC Address : 02:50:56:00:00:03
VNI : 58248
Flag : 1
DHCP relay : Not enabled
RA-mode : RA_DISABLED
DAD-mode : Loose
============================================================
Interface UUID : d7c184c8-bf63-47c8-bf48-01836d0380e5
IP/Mask : 172.16.30.1/24
MAC Address : 02:50:56:56:44:52
VNI : 31624
Flag : 0
DHCP relay : 192.168.33.1, 2001::192:168:33:1
RA-mode : RA_DISABLED
DAD-mode : Loose
============================================================
Interface UUID : 07607708-9bc7-46fc-8d14-fc016b9297da
IP/Mask : 172.16.10.1/24
MAC Address : 02:50:56:56:44:52
VNI : 54152
Flag : 0
DHCP relay : Not enabled
RA-mode : RA_DISABLED
DAD-mode : Loose
============================================================
Interface UUID : b2d3d312-962e-4a79-864c-09304195b88a
IP/Mask : 172.16.20.1/24
MAC Address : 02:50:56:56:44:52
VNI : 52104
Flag : 0
DHCP relay : 192.168.33.1, 2001::192:168:33:1
RA-mode : RA_DISABLED
DAD-mode : Loose
============================================================
or
esx-1> get gateway d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 interfaces
Gateway Interfaces
---------------------------------------------------------------------------
LIF UUID : c66fc321-df74-4aaa-835e-95dc815fe7ae
Name : vpc1-private-subnet1-gateway-interface
Subnet Access Mode : PRIVATE
Mode : ['Routing']
Overlay VNI : 27530
IP : 172.16.130.1
IP mask : 255.255.255.0
Mac : 02:50:56:56:44:52
Connected DVS : nsxvswitch
Control plane enable : True
Replication Mode : 0.0.0.1
Multicast Routing : ['Enabled', 'Oper Up', 'Local VM Present']
State : ['Enabled']
Flags : 0x2288
DHCP relay : Not enable
LIF UUID : be290c92-74ed-437c-bbf1-dd78673b6a5a
Name : vpc1-project-subnet1-gateway-interface
Subnet Access Mode : TGW-PRIVATE
Mode : ['Routing']
Overlay VNI : 25480
IP : 172.16.120.1
IP mask : 255.255.255.0
Mac : 02:50:56:56:44:52
Connected DVS : nsxvswitch
Control plane enable : True
Replication Mode : 0.0.0.1
Multicast Routing : ['Enabled', 'Oper Up']
State : ['Enabled']
Flags : 0x2288
DHCP relay : Not enable
LIF UUID : f6ef3b50-64a0-4948-ab9e-9135963d4b8b
Name :
Subnet Access Mode : NONE
Mode : ['Routing-Backplane']
Overlay VNI : 37768
IP : 169.0.0.1
IP mask : 255.255.255.240
Mac : 02:50:56:56:44:52
Connected DVS : nsxvswitch
Control plane enable : True
Replication Mode : 0.0.0.1
Multicast Routing : ['Enabled', 'Oper Up']
State : ['Enabled']
Flags : 0x12308
DHCP relay : Not enable
LIF UUID : 3c139373-f8f7-441e-aac4-146d9b5ff3a6
Name : vpc1-public-subnet1-gateway-interface
Subnet Access Mode : PUBLIC
Mode : ['Routing']
Overlay VNI : 11145
IP : 172.16.110.1
IP mask : 255.255.255.0
Mac : 02:50:56:56:44:52
Connected DVS : nsxvswitch
Control plane enable : True
Replication Mode : 0.0.0.1
Multicast Routing : ['Enabled', 'Oper Up']
State : ['Enabled']
Flags : 0x2388
DHCP relay : Not enable
Mode
Basic
Availability
ESXi, KVM, NSX Cloud VM
Display neighbor information (ARP/ND cache) for the specified gateway, using IP or MAC.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <ip-or-mac-address> | IP or MAC address |
Example
kvm-1> get gateway 1904e13f-757a-4f44-9f85-cb84678a1a16 neighbor 192.168.1.1
Gateway Forwarding Table
============================================================
Prefix MAC State Timeout
192.168.1.1/24 02:50:56:56:44:52 Up 10
or
esx-1> get gateway d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 neighbor 172.16.130.1
Gateway Neighbors
--------------------------------------------------------------------------------------------------------------
Flags Legend: [S: Static], [V: Valid], [P: Proxy], [I: Interface]
[N: Nascent], [L: Local], [D: Deleted], [K: linKlif]
Network Mac Flags State Uptime SrcPort Refcnt Lif UUID
========================================================================================================================================
172.16.130.1 00:0c:29:74:3c:0e VL 503 97 50331655 11 176a992c-5977-4011-9ad2-c0d1e807e1a6
Mode
Basic
Availability
ESXi, KVM, NSX Cloud VM
Display neighbor information (ARP cache) for the specified gateway.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
kvm-1> get gateway 1904e13f-757a-4f44-9f85-cb84678a1a16 neighbors
Gateway Forwarding Table
============================================================
Prefix MAC State Timeout
192.168.1.1/24 02:50:56:56:44:52 Up 10
or
esx-1> get gateway d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 neighbors
Gateway Neighbors
--------------------------------------------------------------------------------------------------------------
Flags Legend: [S: Static], [V: Valid], [P: Proxy], [I: Interface]
[N: Nascent], [L: Local], [D: Deleted], [K: linKlif]
Network Mac Flags State Uptime SrcPort Refcnt Lif UUID
========================================================================================================================================
172.16.130.1 02:50:56:56:44:52 VI permanent 453 0 1 c66fc321-df74-4aaa-835e-95dc815fe7ae
172.16.130.12 00:00:00:00:00:00 NP 0 2 0 2 c66fc321-df74-4aaa-835e-95dc815fe7ae
172.16.120.1 02:50:56:56:44:52 VI permanent 453 0 1 be290c92-74ed-437c-bbf1-dd78673b6a5a
169.0.0.1 02:50:56:56:44:52 VI permanent 453 0 1 f6ef3b50-64a0-4948-ab9e-9135963d4b8b
169.0.0.2 02:50:56:00:00:05 V 498 255 83886128 2 f6ef3b50-64a0-4948-ab9e-9135963d4b8b
172.16.110.1 02:50:56:56:44:52 VI permanent 453 0 1 3c139373-f8f7-441e-aac4-146d9b5ff3a6
172.16.110.11 00:50:56:8e:91:12 VL 488 265 83886132 18 3c139373-f8f7-441e-aac4-146d9b5ff3a6
2000:1::1 02:50:56:56:44:52 VI permanent 453 0 1 c66fc321-df74-4aaa-835e-95dc815fe7ae
2000:130::12 00:00:00:00:00:00 N 0 2 0 2 c66fc321-df74-4aaa-835e-95dc815fe7ae
fe8089db:00000000:005056ff:fe564452 02:50:56:56:44:52 VI permanent 453 0 1 1c1a47f7-d314-4e74-a198-5568540e4284
Mode
Basic
Availability
ESXi, KVM, NSX Cloud VM
Display BFD sessions in a gateway
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge> get gateway 463c9dd1-986b-4947-895b-1126bd53abc8 bfd-session
BFD Session
Dest_port : 3784
Diag : No Diagnostic
Encap : vlan
Forwarding : last false (current false)
Interface : 4451c48f-8cff-4444-8e10-bff403783dca
Last_cp_diag : No Diagnostic
Last_cp_rmt_diag : No Diagnostic
Last_cp_rmt_state : admin_down
Last_cp_state : admin_down
Last_fwd_state : NONE
Local_address : 192.168.50.1
Local_discr : 2830404107
Min_rx_ttl : 255
Multiplier : 5
Prev_failure_diag : No Diagnostic
Received_remote_diag : No Diagnostic
Received_remote_state : down
Remote_address : 192.168.50.20
Remote_admin_down : false
Remote_diag : No Diagnostic
Remote_discr : 0
Remote_min_rx_interval : 0
Remote_min_tx_interval : 0
Remote_multiplier : 0
Remote_state : down
Rx_cfg_min : 3000
Rx_interval : 3000
Session_type : LR_PORT
State : down
Tx_cfg_min : 3000
Tx_interval : 3000
Mode
Basic
Availability
Autonomous Edge, Edge
Display the forwarding table for the specified gateway. Optionally specify a prefix to display only the entry that matches that network.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <prefix> | Network Address argument |
Example
nsx-edge-1> get gateway 736a80e3-23f6-5a2d-81d6-bbefb2786666 forwarding
Gateway
UUID VRF Gateway-ID Name Type
736a80e3-23f6-5a2d-81d6-bbefb2786666 0 0 R1 TUNNEL
IPv4 Forwarding Table
IP Prefix Gateway IP Type UUID Gateway MAC
142.134.61.0/24 route 34ca595f-fa62-5ed4-afcc-a6ef0195d4ed
142.134.61.36/32 route f322c6ca-4298-568b-81c7-a006ba6e6c88
or
nsx-edge-1> get gateway 736a80e3-23f6-5a2d-81d6-bbefb2786666 forwarding 142.134.61.0/24
Gateway
UUID VRF Gateway-ID Name Type
736a80e3-23f6-5a2d-81d6-bbefb2786666 0 0 R1 TUNNEL
IPv4 Forwarding Table
IP Prefix Gateway IP Type UUID Gateway MAC
142.134.61.0/24 route 34ca595f-fa62-5ed4-afcc-a6ef0195d4ed
Mode
Basic
Availability
Autonomous Edge, Edge
Display parameters defined in global gateway BFD
Example
nsx-edge(tier0_sr)> get gateway bfd-config
Gateway
UUID : d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8
vrf : 6
Gateway-ID : 6
name :
type : SERVICE_ROUTER_TIER0
BFD global configuration
Enabled : True
Min RX Interval: 1000
Min TX Interval: 1000
Min RX TTL : 255
Multiplier : 3
Port : 4451c48f-8cff-4444-8e10-bff403783dca
BFD session configuration
Source : 192.168.50.1
Peer : 192.168.50.10
Enabled : True
Min RX Interval: 1000
Min TX Interval: 1000
RX TTL : 255
Multiplier : 3
Source : 192.168.50.1
Peer : 192.168.50.20
Enabled : True
Min RX Interval: 3000
Min TX Interval: 3000
RX TTL : 255
Multiplier : 5
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display BFD sessions in a gateway
Example
nsx-edge(tier0_sr)> get gateway bfd-sessions
BFD Session
Dest_port : 3784
Diag : No Diagnostic
Encap : vlan
Forwarding : last false (current false)
Interface : 4451c48f-8cff-4444-8e10-bff403783dca
Last_cp_diag : No Diagnostic
Last_cp_rmt_diag : No Diagnostic
Last_cp_rmt_state : admin_down
Last_cp_state : admin_down
Last_fwd_state : NONE
Local_address : 192.168.50.1
Local_discr : 2830404107
Min_rx_ttl : 255
Multiplier : 5
Prev_failure_diag : No Diagnostic
Received_remote_diag : No Diagnostic
Received_remote_state : down
Remote_address : 192.168.50.20
Remote_admin_down : false
Remote_diag : No Diagnostic
Remote_discr : 0
Remote_min_rx_interval : 0
Remote_min_tx_interval : 0
Remote_multiplier : 0
Remote_state : down
Rx_cfg_min : 3000
Rx_interval : 3000
Session_type : LR_PORT
State : down
Tx_cfg_min : 3000
Tx_interval : 3000
.
.
.
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Dump the host's public cloud gateway certificate
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
host-1> get gateway certificate 13.14.41.34
Public Cloud Gateway : 13.14.41.34
Certificate Thumbprint : 2A0489D8990FFB51D9F72190FBCC4052E42BB31F
SHA : sha256
Mode
Basic
Availability
NSX Cloud VM
Dump the host's public cloud gateway certificates.
Example
host-1> get gateway certificates
Public Cloud Gateway : 13.14.41.34
Certificate Thumbprint : 2A0489D8990FFB51D9F72190FBCC4052E42BB31F
SHA : sha256
Public Cloud Gateway : 13.14.41.35
Certificate Thumbprint : 345489B8990FDB51D9A72190FB0A7042842BB32C
SHA : sha256
Mode
Basic
Availability
NSX Cloud VM
Dump the host's public cloud gateway connection status.
Example
host-1> get gateway connection status
Public Cloud Gateway : 13.14.41.34:5555
Connection Status : ESTABLISHED
Connection Time : Thu Jun 15 19:12:34 2017
Last Known Error : None
Mode
Basic
Availability
NSX Cloud VM
Display the forwarding table for the gateway in the VRF context. Optionally specify a prefix to display only the entry that matches that network.
| Option | Description |
|---|---|
| <prefix> | Network Address argument |
Example
nsx-edge-1(tier0_sr)> get gateway forwarding e9d3379d-aba7-4459-9262-18bc95eaeec1
Gateway
UUID VRF Gateway-ID Name Type
e9d3379d-aba7-4459-9262-18bc95eaeec1 1 1 SERVICE_ROUTER_TIER0
IPv4 Forwarding Table
IP Prefix Gateway IP Type UUID Gateway MAC
127.0.0.1/32 route 4b115e5f-1395-54c3-aaf0-0de5736f99df
172.20.1.0/24 route 6c427841-e151-4479-9184-4196cfcef3b6
172.20.1.60/32 route 4b115e5f-1395-54c3-aaf0-0de5736f99df
172.24.4.1/32 172.20.1.50 route 6c427841-e151-4479-9184-4196cfcef3b6
or
nsx-edge-1(tier0_sr)> get gateway forwarding 172.16.110.0/24
Gateway
UUID VRF Name Type
e9d3379d-aba7-4459-9262-18bc95eaeec1 1 SERVICE_ROUTER_TIER0
IPv4 Forwarding Table
IP Prefix Gateway IP Type UUID Gateway MAC
172.24.4.1/32 172.20.1.50 route 6c427841-e151-4479-9184-4196cfcef3b6
Mode
VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display the high availability state history for the gateway in the VRF context.
Example
nsx-edge-1(tier0_sr)> get gateway high-availability history state
State : Down
Event : Init
Resources :
Time : 2016-02-02 18:41:22.80
State : Active
Event : Node Up
Resources : 0
Time : 2016-02-02 18:41:26.91
Mode
Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display the high availability status for the gateway in the VRF context.
Example
nsx-edge-1(tier1_sr)> get gateway high-availability status
Service Router
UUID : 4e425c9e-09c6-4021-bbc7-fab2895a2c09
state : Active
type : TIER1
mode : A/S
failover mode : Non-preemptive
rank : 0
service count : 1
service score : 0
HA ports state
UUID : 733d7ed3-1daa-4c28-bc0a-77e3736fea14
op_state : Up
addresses : 169.0.0.2/28
Sub-cluster Information
UUID : 6c3089d1-dac5-43ce-b8bb-91e6bb36345d
Peer SR UUID : 44e3ee5f-36ea-4703-80ad-0e6b50af552a
Peer Node UUID : 3b34da96-ed06-11e8-9814-020063efb6dc
Peer Routers
Node UUID : e13dbba8-542e-11e9-a177-020021d58d1d
HA state : Standby
Mode
Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display interface information for the specified gateway.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get gateway interface 34ca595f-fa62-5ed4-afcc-a6ef0195d4ed
interface : 34ca595f-fa62-5ed4-afcc-a6ef0195d4ed
ifuid : 261
VRF : 736a80e3-23f6-5a2d-81d6-bbefb2786666
mode : lif
IP/Mask : 142.134.61.36/24
MAC : 00:0c:29:5a:96:2b
VLAN id : untagged
Segment port: 238d7422-e488-5cee-9639-1894b8ab56e2
urpf-mode : NONE
admin : up
op_state : up
MTU : 1600
arp_proxy : 40.40.10.60, 40.40.10.50, 40.40.10.55
: 40.40.10.100, 40.40.10.110
Mode
Basic
Availability
Autonomous Edge, Edge
Display ARP proxy for a gateway port.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get gateway interface 1faf61ce-9da1-4aad-a8c6-80abd02c7e33 arp-proxy
interface : 1faf61ce-9da1-4aad-a8c6-80abd02c7e33
ifuid : 274
VRF : be3543f5-7b8c-4888-b9ef-5a5ffbf09686
name : UPLINK_PLR_SR1
mode : lif
MAC : 02:00:29:10:43:07
admin : up
op_state : up
arp_proxy : 40.40.10.60, 40.40.10.50, 40.40.10.55
: 40.40.10.100, 40.40.10.110
Mode
Basic
Availability
Autonomous Edge, Edge
Display interface-group info for gateway interface
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get gateway interface e13dbba8-542e-11e9-a177-020021d58d1d interface-groups high-availability
Group UUID : 4e425c9e-09c6-4021-bbc7-fab2895a2c09
Port UUID : e13dbba8-542e-11e9-a177-020021d58d1d
Members
SR UUID : e0e7c638-aa8c-4354-b8a9-0aa0fbbfdb05
Port UUID : e13dbba8-542e-11e9-a177-020021d58d1d
Port MAC : 02:50:56:56:00:02
State : Active
SR UUID : 44e3ee5f-36ea-4703-80ad-0e6b50af552a
Port UUID : c23bc228-f5ec-4ad4-b596-fc0dcccd6922
Port MAC : 02:50:56:56:00:03
State : Active
SR UUID : 79ac0bb6-6ddb-45be-82bd-baf83fdfc788
Port UUID : 628f3976-472a-4543-906c-b6b07c4ffb74
Port MAC : 02:50:56:56:00:04
State : Down
Mode
Basic
Availability
Autonomous Edge, Edge
Display the neighbor table for the specified gateway interface.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get gateway interface 3c139373-f8f7-441e-aac4-146d9b5ff3a6 neighbors
interface : 3c139373-f8f7-441e-aac4-146d9b5ff3a6
IP : 172.16.110.12
MAC : 00:0c:29:4d:09:19
state : perm
interface : 3c139373-f8f7-441e-aac4-146d9b5ff3a6
IP : 172.16.110.11
MAC : 00:50:56:8e:91:12
state : perm
Mode
Basic
Availability
Autonomous Edge, Edge
Display shadow port mac list for gateway port
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get gateway interface 5b5aa5f4-9408-4963-a913-705254359134 shadow-macs
Logical Router Interface
UUID : 5b5aa5f4-9408-4963-a913-705254359134
Shadow MACs:
02:50:56:56:00:01
02:50:56:56:00:03
02:50:56:56:00:06
02:50:56:56:00:08
Mode
Basic
Availability
Autonomous Edge, Edge
Get the shadow port MAC address selected for specific IP address
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get gateway interface 5b5aa5f4-9408-4963-a913-705254359134 shadow-macs ip 40.40.40.10
Logical Router Interface
UUID : 5b5aa5f4-9408-4963-a913-705254359134
Shadow MACs:
02:50:56:56:00:01
02:50:56:56:00:03
02:50:56:56:00:06
02:50:56:56:00:08
Selected MAC: 02:50:56:56:00:03
Mode
Basic
Availability
Autonomous Edge, Edge
Get the shadow port MAC address selected for specific source and destination IP addresses
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get gateway interface 5b5aa5f4-9408-4963-a913-705254359134 shadow-macs source-ip 40.40.40.10 dest-ip 30.30.30.10
Logical Router Interface
UUID : 5b5aa5f4-9408-4963-a913-705254359134
Shadow MACs:
02:50:56:56:00:01
02:50:56:56:00:03
02:50:56:56:00:06
02:50:56:56:00:08
Selected MAC: 02:50:56:56:00:03
Mode
Basic
Availability
Autonomous Edge, Edge
Display statistics for the specified gateway interface.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get gateway interface 6c427841-e151-4479-9184-4196cfcef3b6 stats
interface : 6c427841-e151-4479-9184-4196cfcef3b6
ifuid : 266
VRF : e9d3379d-aba7-4459-9262-18bc95eaeec1
IP/Mask : 172.20.1.60/24
MAC : 00:0c:29:5a:96:2b
VLAN id : 101
Segment port: 986ab7c0-acda-465f-8cda-1b9b84cd2518
urpf-mode : STRICT_MODE
admin : up
op_state : up
MTU : 1600
statistics
RX-Packets : 1331
RX-Bytes : 455202
RX-Drops : 1331
Blocked : 0
DST-Unsupported: 1331
Firewall : 0
Malformed : 0
No-Receiver : 0
No-Route : 0
RPF-Check : 0
Protocol-Unsupported: 0
IPv6 : 0
Port-Unsupported: 0
TTL-Exceeded: 0
Kni : 0
IPsec : 0
IPsec-NoSA : 0
IPsec-NoVTI : 0
TX-Packets : 11
TX-Bytes : 462
TX-Drops : 0
Blocked : 0
Firewall : 0
Frag-Needed : 0
No-ARP : 0
No-Memory : 0
No-Linked-Port: 0
IPsec : 0
IPsec-NoSA : 0
IPsec-NoVTI : 0
IPsec-Policy-Error: 0
IPsec-Policy-Block: 0
IP Ressemble
Fragments-OK: 0
Fragemnts-Error: 0
Fragments-Timeout: 0
IP Fragment
Fragments-OK: 0
Fragments-Error: 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display information for all gateway interfaces.
Example
nsx-edge-1> get gateway interfaces
interface : 9fd3c667-32db-5921-aaad-7a88c80b5e9f
ifuid : 258
VRF : 736a80e3-23f6-5a2d-81d6-bbefb2786666
mode : blackhole
interface : 34ca595f-fa62-5ed4-afcc-a6ef0195d4ed
ifuid : 261
VRF : 736a80e3-23f6-5a2d-81d6-bbefb2786666
mode : lif
IP/Mask : 142.134.61.36/24
MAC : 00:0c:29:5a:96:2b
VLAN id : untagged
Segment port: 238d7422-e488-5cee-9639-1894b8ab56e2
urpf-mode : NONE
admin : up
op_state : up
MTU : 1600
arp_proxy : 40.40.10.60, 40.40.10.50, 40.40.10.55
: 40.40.10.100, 40.40.10.110
interface : f322c6ca-4298-568b-81c7-a006ba6e6c88
ifuid : 257
VRF : 736a80e3-23f6-5a2d-81d6-bbefb2786666
mode : cpu
interface : b83cb77f-ca34-595c-a3e1-76278f0dcb00
ifuid : 265
VRF : e9d3379d-aba7-4459-9262-18bc95eaeec1
mode : blackhole
interface : 4b115e5f-1395-54c3-aaf0-0de5736f99df
ifuid : 264
VRF : e9d3379d-aba7-4459-9262-18bc95eaeec1
mode : cpu
interface : 6c427841-e151-4479-9184-4196cfcef3b6
ifuid : 266
VRF : e9d3379d-aba7-4459-9262-18bc95eaeec1
mode : lif
IP/Mask : 172.20.1.60/24
MAC : 00:0c:29:5a:96:2b
VLAN id : 101
Segment port: 986ab7c0-acda-465f-8cda-1b9b84cd2518
urpf-mode : STRICT_MODE
admin : up
op_state : up
MTU : 1600
arp_proxy : 40.40.10.60, 40.40.10.50, 40.40.10.55
: 40.40.10.100, 40.40.10.110
Mode
Basic
Availability
Autonomous Edge, Edge
Display interface information for the gateway in the VRF context.
Example
nsx-edge-1(vrf)> get gateway interfaces
UUID VRF Gateway-ID Name Type
736a80e3-23f6-5a2d-81d6-bbefb2786666 0 0 R1 TUNNEL
interfaces
interface : 9fd3c667-32db-5921-aaad-7a88c80b5e9f
ifuid : 258
mode : blackhole
interface : 34ca595f-fa62-5ed4-afcc-a6ef0195d4ed
ifuid : 261
mode : lif
IP/Mask : 142.134.61.36/24
MAC : 00:0c:29:5a:96:2b
VLAN id : untagged
Segment port: 238d7422-e488-5cee-9639-1894b8ab56e2
urpf-mode : NONE
admin : up
op_state : up
MTU : 1600
arp_proxy : 40.40.10.60, 40.40.10.50, 40.40.10.55
: 40.40.10.100, 40.40.10.110
interface : f322c6ca-4298-568b-81c7-a006ba6e6c88
ifuid : 257
mode : cpu
Mode
VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display statistics for all gateway interfaces.
Example
nsx-edge-1> get gateway interfaces stats
interface : 34ca595f-fa62-5ed4-afcc-a6ef0195d4ed
ifuid : 261
VRF : 736a80e3-23f6-5a2d-81d6-bbefb2786666
IP/Mask : 142.134.61.36/24
MAC : 00:0c:29:5a:96:2b
VLAN id : untagged
Segment port: 238d7422-e488-5cee-9639-1894b8ab56e2
urpf-mode : NONE
admin : up
op_state : up
MTU : 1600
statistics
RX-Packets : 768
RX-Bytes : 53788
RX-Drops : 210
Blocked : 0
DST-Unsupported: 21
Firewall : 0
Malformed : 0
No-Receiver : 0
No-Route : 0
RPF-Check : 0
Protocol-Unsupported: 101
IPv6 : 87
Port-Unsupported: 0
TTL-Exceeded: 0
Kni : 0
Rate-Limit : 0
IPsec : 0
IPsec-NoSA : 0
IPsec-NoVTI : 0
TX-Packets : 11
TX-Bytes : 462
TX-Drops : 0
Blocked : 0
Firewall : 0
Frag-Needed : 0
No-ARP : 0
No-Memory : 0
No-Linked-Port: 0
Rate-Limit : 0
IPsec : 0
IPsec-NoSA : 0
IPsec-NoVTI : 0
IPsec-Policy-Error: 0
IPsec-Policy-Block: 0
IP Ressemble
Fragments-OK: 0
Fragemnts-Error: 0
Fragments-Timeout: 0
IP Fragment
Fragments-OK: 0
Fragments-Error: 0
interface : 6c427841-e151-4479-9184-4196cfcef3b6
ifuid : 266
VRF : e9d3379d-aba7-4459-9262-18bc95eaeec1
IP/Mask : 172.20.1.60/24
MAC : 00:0c:29:5a:96:2b
VLAN id : 101
Segment port: 986ab7c0-acda-465f-8cda-1b9b84cd2518
urpf-mode : STRICT_MODE
admin : up
op_state : up
MTU : 1600
statistics
RX-Packets : 1313
RX-Bytes : 449046
RX-Drops : 1313
Blocked : 0
DST-Unsupported: 1313
Firewall : 0
Malformed : 0
No-Receiver : 0
No-Route : 0
RPF-Check : 0
Protocol-Unsupported: 0
IPv6 : 0
Port-Unsupported: 0
TTL-Exceeded: 0
Kni : 0
IPsec : 0
IPsec-NoSA : 0
IPsec-NoVTI : 0
TX-Packets : 11
TX-Bytes : 462
TX-Drops : 0
Blocked : 0
Firewall : 0
Frag-Needed : 0
No-ARP : 0
No-Memory : 0
No-Linked-Port: 0
IPsec : 0
IPsec-NoSA : 0
IPsec-NoVTI : 0
IPsec-Policy-Error: 0
IPsec-Policy-Block: 0
IP Ressemble
Fragments-OK: 0
Fragemnts-Error: 0
Fragments-Timeout: 0
IP Fragment
Fragments-OK: 0
Fragments-Error: 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display the interface statistics for the gateway in the VRF context.
Example
nsx-edge-1(tier0_sr)> get gateway interfaces stats
Gateway
UUID : e9d3379d-aba7-4459-9262-18bc95eaeec1
VRF : 1
Gateway-ID : 1
name : R2
type : SERVICE_ROUTER_TIER0
Statistics
Interface Type RX PKTS TX PKTS RX BYTES TX BYTES RX Drops TX Drops
b83cb77f-ca34-595c-a3e1-76278f0dcb00 blackhole 0 0 0 0 0 0
4b115e5f-1395-54c3-aaf0-0de5736f99df cpu 8 0 648 0 8 0
6c427841-e151-4479-9184-4196cfcef3b6 lif 5601 11 1915542 462 5601 0
081e2e50-2f0e-42e1-8764-80a127dd3918 lif 0 0 0 0 0 0
00003300-0000-0000-0000-000000000002 loopback 8 0 648 0 8 0
Total 5617 11 1916838 462 5617 0
Mode
VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display the multicast forwarding table for the gateway in the VRF context.
Example
nsx-edge(tier0_sr)> get gateway mfib
Gateway
UUID VRF Gateway-ID Name Type
3b5a8fa4-30f0-41cd-90d0-a68f9cac54dd 1 2 SR-Tier0-LR-1 SERVICE_ROUTER_TIER0
IPv4 Multicast Forwarding Table
Source IP Group IP Incoming UUID Outgoing UUID/VTEP/MTEP/UMG
40.40.40.1 237.0.0.1 cc8bd3c5-6558-49b4-90f5-dd180e3fdf0f 77f6b2fe-0c3d-4c56-91d6-a008ab3bfdcb
100.1.2.1
239.100.100.100
40.40.40.10 237.0.0.1 77f6b2fe-0c3d-4c56-91d6-a008ab3bfdcb cc8bd3c5-6558-49b4-90f5-dd180e3fdf0f
0.0.0.0 0.0.0.0 none 0000000a-0000-0000-0000-000000000000
Mode
Tier0_sr, VRF, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge(tier0_sr)> get gateway mfib
Gateway
UUID VRF Gateway-ID Name Type
6263fe96-0ecf-4b3b-ad2d-3c0447de038b 2 2 SR-tier0 SERVICE_ROUTER_TIER0
IPv4 Multicast Forwarding Table
Source IP Group IP Incoming UUID Outgoing UUID/VTEP/MTEP/UMG
2.1.4.11 237.0.0.16 b9267b0d-5d4b-48c5-8ae4-38ab95de40bf 0ef83a9d-5014-4b3e-bcef-32109a34237b
1.1.8.10 237.0.0.12 0ef83a9d-5014-4b3e-bcef-32109a34237b b9267b0d-5d4b-48c5-8ae4-38ab95de40bf
nsx-edge(tier0_sr)> get mfib 237.0.0.12
Gateway
UUID VRF Gateway-ID Name Type
6263fe96-0ecf-4b3b-ad2d-3c0447de038b 2 2 SR-tier0 SERVICE_ROUTER_TIER0
IPv4 Multicast Forwarding Table
Source IP Group IP Incoming UUID Outgoing UUID/VTEP/MTEP/UMG
1.1.8.10 237.0.0.12 0ef83a9d-5014-4b3e-bcef-32109a34237b b9267b0d-5d4b-48c5-8ae4-38ab95de40bf
Mode
Tier0_sr, VRF, Tier1_sr
Availability
Autonomous Edge, Edge
Display the neighbors table for all gateway interfaces.
Example
nsx-edge-1> get gateway neighbors
interface : 8d655fb8-fc5e-5c08-90f5-15de973a9c77
IP : 192.168.250.61
MAC : 00:50:56:62:58:be
state : reach
timeout : 287
interface : 4b3be9e1-1363-4a85-ac13-8f7ad5b1e842
IP : 192.168.130.1
MAC : 68:ef:bd:4e:98:7f
state : reach
timeout : 309
interface : ef76622f-52ea-425f-b7c9-6264bf11b667
IP : 169.0.0.2
MAC : 02:50:56:00:00:02
state : reach
timeout : 425
interface : c66fc321-df74-4aaa-835e-95dc815fe7ae
IP : 172.16.130.13
MAC : 00:50:56:8e:3e:0b
state : perm
interface : f6ef3b50-64a0-4948-ab9e-9135963d4b8b
IP : 169.0.0.2
MAC : 02:50:56:00:00:05
state : reach
timeout : 397
.
.
.
Mode
Basic
Availability
Autonomous Edge, Edge
Display the neighbor table for the gateway in the VRF context.
Example
nsx-edge-1(vrf)> get gateway neighbors
Gateway
UUID : d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8
VRF : 6
Gateway-ID : 6
name : R3
type : DISTRIBUTED_ROUTER
Neighbors
interface : c66fc321-df74-4aaa-835e-95dc815fe7ae
IP : 172.16.130.13
MAC : 00:50:56:8e:3e:0b
state : perm
interface : f6ef3b50-64a0-4948-ab9e-9135963d4b8b
IP : 169.0.0.2
MAC : 02:50:56:00:00:05
state : reach
timeout : 429
interface : be290c92-74ed-437c-bbf1-dd78673b6a5a
IP : 172.16.120.11
MAC : 00:50:56:8e:15:e5
state : reach
timeout : 482
interface : 3c139373-f8f7-441e-aac4-146d9b5ff3a6
IP : 172.16.110.11
MAC : 00:50:56:8e:91:12
state : perm
Mode
VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display specific IPv4 routes from all the Gateway.
| Option | Description |
|---|---|
| <prefix> | Network Address argument |
Example
nsx-controller-1> get gateway routes 172.16.120.0/24
Gateway/Cluster-UUID Destination Next-Hop GW-Port-Id Blackhole Blackhole-Action Route-Type Admin-Distance Admin-State-Up Route-UUID
b9486c73-7959-4adf-9370-f46b8c031f51 172.16.120.0/24 N/A c248635f-1213-45e7-9e40-5bb4c95363fa false N/A ROUTE_TYPE_CONNECTED 0 false 4f1515fc-771c-544a-93fe-1e981d461d5d
Mode
Basic
Availability
Manager
Display statistics for the gateway in the VRF context.
Example
nsx-edge-1(vrf)> get gateway stats
Gateway
UUID : 736a80e3-23f6-5a2d-81d6-bbefb2786666
VRF : 0
Gateway-ID : 0
name : R1
type : TUNNEL
Statistics
Dropped No Memory : 0
Dropped No Route : 0
Mode
VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display tenant context information for the gateway in the VRF context.
Example
Edge3(tier0_sr[3])> get gateway tenant-context
Sat Jul 15 2023 UTC 00:05:53.365
org : default
proj : maroon
vpc :
Mode
VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display information about the specified proximity routing policy table.
| Option | Description |
|---|---|
| <policy-table-id> | Proximity routing policy table identifier UUID or ID |
Example
esx-1> get gateway-policy-table 2
Proximity Routing Policy Table
------------------------------------------------------------------------------------------
Flags Legend: [F: Soft Flush]
Network Action Type Hit Count
==========================================================================================
192.168.150.0/24 allow 0
192.168.151.0/24 deny 0
Mode
Basic
Availability
ESXi
Display information about proximity gateway policy tables on this hypervisor host.
Example
esx-1> get gateway-policy-tables
Proximity Routing Policy Tables Summary
---------------------------------------------------------------------------
Table UUID Table ID Reference Count
ea652563-8c90-4354-99b8-38ccf96d3622 4 0
2dd5ea46-6e19-4d38-8be8-e4ec63fa62af 2 0
Mode
Basic
Availability
ESXi
Display information about all gateways.
Example
nsx-controller-1> get gateways
GW-ID GW-Name Router-Type ClusterId UUID
0x5 SR-46740ffe-9bf1-406e-816d-e200a45f0707 SERVICE_ROUTER_TIER1 00002000-0000-0000-0000-000000000001 db6760b3-d9e2-44ef-b1c4-f56138665d71
0x2 DR-ef64d966-56f0-4f3f-bb02-16d07de74b5c DISTRIBUTED_ROUTER N/A ef64d966-56f0-4f3f-bb02-16d07de74b5c
0x1 DR-46740ffe-9bf1-406e-816d-e200a45f0707 DISTRIBUTED_ROUTER N/A 46740ffe-9bf1-406e-816d-e200a45f0707
0x3 SR-ef64d966-56f0-4f3f-bb02-16d07de74b5c SERVICE_ROUTER_TIER0 00002000-0000-0000-0000-000000000002 19772688-b220-4a34-94a3-8a094dcdd979
0x4 SR-ef64d966-56f0-4f3f-bb02-16d07de74b5c SERVICE_ROUTER_TIER0 00002000-0000-0000-0000-000000000002 2d1667ba-ed4a-49d0-8a1d-cd8a77c324bc
or
nsx-edge-1> get gateways
Gateway
UUID VRF Gateway-ID Name Type Ports Neighbors
736a80e3-23f6-5a2d-81d6-bbefb2786666 0 0 R1 TUNNEL 3 4/50000
e9d3379d-aba7-4459-9262-18bc95eaeec1 1 1 R2 SERVICE_ROUTER_TIER0 5 5/50000
Mode
Basic
Availability
Autonomous Edge, Edge, Manager
Display information about gateways on this hypervisor host.
Example
kvm-1> get gateways
Gateway Summary
==============================================================================================================
Gateway UUID ID Port Count Max Neighbors Current Neighbors
b8aba183-8776-42d8-8ec5-4eccf1ebbbd2 1 2 50000 1
or
esx-1> get gateways
Gateways Summary
-------------------------------------------------------------------------------------------
VDR UUID LIF num IPv4 Route num IPv6 Route num Max Neighbors Current Neighbors
d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 4 7 5 25000 15
Mode
Basic
Availability
ESXi, KVM
Display information about gateways asscociated with the VIF on this public cloud host.
Example
host-1> get gateways
Host Gateways Summary
======================================================================
Gateway UUID ID Port Count
091a05dc-8080-41a2-a56f-baf6d32fb512 32769 1
Mode
Basic
Availability
NSX Cloud VM
Display statistics for all gateways.
Example
nsx-edge-1> get gateways stats
Gateway
UUID : 736a80e3-23f6-5a2d-81d6-bbefb2786666
VRF : 0
Gateway-ID : 0
name : R1
type : TUNNEL
Statistics
Dropped No Memory : 0
Dropped No Route : 0
Gateway
UUID : e9d3379d-aba7-4459-9262-18bc95eaeec1
VRF : 1
Gateway-ID : 1
name : R2
type : SERVICE_ROUTER_TIER0
Statistics
Dropped No Memory : 0
Dropped No Route : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Get geneve critical bit.
| Option | Description |
|---|---|
| <dvs-name> | DVS name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get geneve-cbit dvs nsxvswitch
Geneve Critical Bit: false
Mode
Basic
Availability
ESXi
Display the TN TEP Groups configured for a specified host switch
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
Example
esx-1> get global-tep-group 1-vds-1217
Host Kernel Entry
===============================================================================================
TN TEP Group Label: 393185
Label VTEP IP Subnet IP VTEP MAC Encap Type VLAN Flags
99329 221.96.208.20 221.96.208.0 00:50:56:6d:d1:f5 GENEVE 0 S,V4
LCP Entry
===============================================================================================
TN TEP Group Label: 393185
Label VTEP IP Subnet IP VTEP MAC
99329 221.96.208.20 221.96.208.0 00:50:56:6d:d1:f5
Mode
Basic
Availability
ESXi
Display the Global VTEP table
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
Example
esx-1> get global-vtep-table nsxvswitch
Global VTEP Table
-----------------------------------------------------------------------------------------------
Legend: [S: MTEP Supported], [NS: MTEP Not supported]
Legend: [LP: MTEP Low Prio], [N: Nested TN], [H: HW VTEP]
Label VTEP IP Subnet IP VTEP MAC Encap Type VLAN Flags
===============================================================================================
12345 192.168.250.60 192.168.250.0 02:50:56:00:00:00 GENEVE 0 S
90214 192.168.250.61 192.168.250.0 00:50:56:62:58:be VXLAN 0 NS,H
Mode
Basic
Availability
ESXi
Display information about GRE keepalive. For GRE tunnel information use tunnel-ports CLI.
Example
nsx-edge-1> get gre-keepalive
GRE Keepalive Session
tunnel :
local_address : 192.168.250.60
remote_address : 192.168.250.61
tunnel_last_up_time : 2022-09-06 12:00:00
tunnel_last_down_time : 2022-09-06 11:59:50
keepalive_admin_down_time : 2022-08-29 12:00:05
keepalive : Enabled
keepalive_state : up
keepalive_intv : 10
keepalive_dead_mul : 3
keepalive_ack : Enabled
GRE Keepalive Session
tunnel :
local_address : 192.168.250.60
remote_address : 192.168.250.62
tunnel_last_up_time : 2022-09-06 12:00:00
tunnel_last_down_time : 2022-09-06 11:59:50
keepalive_admin_down_time : 2022-08-29 12:00:05
keepalive : Enabled
keepalive_state : up
keepalive_intv : 10
keepalive_dead_mul : 3
keepalive_ack : Enabled
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about the specified GRE keepalive.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get gre-keepalive local-ip 192.168.250.60 remote-ip 192.168.250.61
GRE Keepalive Session
tunnel :
local_address : 192.168.250.60
remote_address : 192.168.250.61
tunnel_last_up_time : 2022-09-06 12:00:00
tunnel_last_down_time : 2022-09-06 11:59:50
keepalive_admin_down_time : 2022-08-29 12:00:05
keepalive : Enabled
keepalive_state : up
keepalive_intv : 10
keepalive_dead_mul : 3
keepalive_ack : Enabled
Mode
Basic
Availability
Autonomous Edge, Edge
Display statistics for the specified GRE keepalive.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get gre-keepalive local-ip 192.168.250.60 remote-ip 192.168.250.61 stats
GRE Keepalive Session
tunnel :
local_address : 192.168.250.60
remote_address : 192.168.250.61
tunnel_up_count : 5
tunnel_last_up_time : 2022-09-06 12:00:00
tunnel_down_count : 5
tunnel_last_down_time : 2022-09-06 11:59:50
keepalive : Enabled
keepalive_state: up
keepalive_intv : 10
keepalive_dead_mul : 3
keepalive_tx : 100
keepalive_last_tx_time : 2022-08-29 12:00:00
keepalive_rx : 100
keepalive_last_rx_time : 2022-08-29 12:00:00
keepalive_ack : Enabled
keepalive_ack_sent : 50
keepalive_last_ack_time : 2022-09-02 12:00:00
keepalive_admin_down_count : 1
keepalive_admin_down_time : 2022-08-29 12:00:05
tunnel_flap_count : 10
rx_drop_count : 0
rx_drop_pkt_too_short : 0
rx_drop_pkt_len_unmatch : 0
rx_drop_admin_down : 0
rx_drop_ack_disabled : 0
rx_drop_state_unknown : 0
tx_error : 0
ack_error : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display statistics for GRE keepalive only. For GRE tunnel stats use tunnel-ports CLI.
Example
nsx-edge-1> get gre-keepalive stats
GRE Keepalive Global Counters
keepalive_session_count: 2
rx_drop_count : 0
rx_drop_null_gre_ka_session : 0
rx_drop_runt_pkt : 0
rx_drop_intf_type : 0
rx_drop_non_gre_ka : 0
rx_drop_ip_mismatch : 0
rx_drop_null_intf : 0
tx_drop_count : 0
tx_drop_no_route : 0
nsxa_connect_count : 1
nsxa_disconnect_count : 0
nsxa_msg_receive_count : 5
last_nsxa_msg_receive_time : 2022-09-06 11:59:50
nsxa_err_msg_receive_count : 0
nsxa_notify_sent_count : 5
nsxa_notify_drop_count : 0
nsxa_notify_retry_count : 0
nsxa_notify_qsize : 20
last_nsxa_notify_time : 2022-09-06 11:59:50
mon_to_cfg_notify_enq_count : 10
mon_to_cfg_notify_deq_count : 10
mon_to_cfg_queue_size : 20
mon_to_cfg_queue_max : 10
max_tx_intv : 10000
max_tx_intv_last : 2022-09-06 11:59:50
max_rx_enq_intv : 10000
max_rx_enq_intv_last : 2022-09-06 11:59:50
max_wakeup_intv : 10000
max_wakeup_intv_last : 2022-09-06 11:59:50
GRE Keepalive Session
tunnel :
local_address : 192.168.250.60
remote_address : 192.168.250.61
tunnel_up_count : 5
tunnel_last_up_time : 2022-09-06 12:00:00
tunnel_down_count : 5
tunnel_last_down_time : 2022-09-06 11:59:50
keepalive : Enabled
keepalive_state: up
keepalive_intv : 10
keepalive_dead_mul : 3
keepalive_tx : 100
keepalive_last_tx_time : 2022-08-29 12:00:00
keepalive_rx : 100
keepalive_last_rx_time : 2022-08-29 12:00:00
keepalive_ack : Enabled
keepalive_ack_sent : 50
keepalive_last_ack_time : 2022-09-02 12:00:00
keepalive_admin_down_count : 1
keepalive_admin_down_time : 2022-08-29 12:00:05
tunnel_flap_count : 10
rx_drop_count : 0
rx_drop_pkt_too_short : 0
rx_drop_pkt_len_unmatch : 0
rx_drop_admin_down : 0
rx_drop_ack_disabled : 0
rx_drop_state_unknown : 0
tx_error : 0
ack_error : 0
GRE Keepalive Session
tunnel :
local_address : 192.168.250.60
remote_address : 192.168.250.62
tunnel_up_count : 5
tunnel_last_up_time : 2022-09-06 12:00:00
tunnel_down_count : 5
tunnel_last_down_time : 2022-09-06 11:59:50
keepalive : Enabled
keepalive_state: up
keepalive_intv : 10
keepalive_dead_mul : 3
keepalive_tx : 100
keepalive_last_tx_time : 2022-08-29 12:00:00
keepalive_rx : 100
keepalive_last_rx_time : 2022-08-29 12:00:00
keepalive_ack : Enabled
keepalive_ack_sent : 50
keepalive_last_ack_time : 2022-09-02 12:00:00
keepalive_admin_down_count : 1
keepalive_admin_down_time : 2022-08-29 12:00:05
tunnel_flap_count : 10
rx_drop_count : 0
rx_drop_pkt_too_short : 0
rx_drop_pkt_len_unmatch : 0
rx_drop_admin_down : 0
rx_drop_ack_disabled : 0
rx_drop_state_unknown : 0
tx_error : 0
ack_error : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display the translations for the specified container group. Optionally specify a translation type to display translations of that type.
| Option | Description |
|---|---|
| <uuid> | Group identifier |
| <translation-type> | Translation type Allowed values: logical-objects, ips, vifs, macs, tns, vms, excluded-ips, directory-groups, bms, bmsi |
Example
nsx-controller-1> get group 5539c4dc-621e-4d8b-8a40-2ee299f1ec73 logical-objects
id: 5539c4dc-621e-4d8b-8a40-2ee299f1ec73, type: Group, name: testGroup6
id: 34adf781-4fc1-4418-a63d-72e2d4fb9786, type: SegmentPort
Mode
Basic
Availability
Manager
Display all groups.
Example
nsx-controller-1> get groups
id: 9e0b012c-c93c-4693-9c32-f9e29b7aa928, type: Group, name: Edge_Group, multitenancy_scope: /orgs/default/projects/project-1
id: 5539c4dc-621e-4d8b-8a40-2ee299f1ec73, type: Group, name: testGroup6, multitenancy_scope: /orgs/default/projects/project-2
id: 8eeb7875-ef19-4d91-9e5d-a5690914338f, type: Group, name: Service_Group, multitenancy_scope: /orgs/default/projects/project-1/vpcs/vpc-1
Mode
Basic
Availability
Manager
Display groups with the specified IP address.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-controller-1> get groups with ip 192.168.1.123
id: 5539c4dc-621e-4d8b-8a40-2ee299f1ec73, type: Group, name: testGroup6
id: 141e822d-c0eb-4bb3-ba8d-61c58379c928, type: Segment
id: 192.168.1.123/32, type: IpSpec
id: 34adf781-4fc1-4418-a63d-72e2d4fb9786, type: SegmentPOrt
Mode
Basic
Availability
Manager
Display groups with the specified MAC address.
| Option | Description |
|---|---|
| <hardware-address> | Network hardware address argument |
Example
nsx-controller-1> get group with mac af:bb:cc:dd:ee:ff
id: af:bb:cc:dd:ee:ff, type: MacAddress
id: 5539c4dc-621e-4d8b-8a40-2ee299f1ec73, type: Group, name: testGroup6
id: 141e822d-c0eb-4bb3-ba8d-61c58379c928, type: Segment
id: 34adf781-4fc1-4418-a63d-72e2d4fb9786, type: SegmentPort
Mode
Basic
Availability
Manager
Display groups with the specified network interface.
| Option | Description |
|---|---|
| <vif> | VIF ID |
Example
nsx-controller-1> get groups with vif vif2
id: 5539c4dc-621e-4d8b-8a40-2ee299f1ec73, type: Group, name: testGroup6
id: 141e822d-c0eb-4bb3-ba8d-61c58379c928, type: Segment
id: vif2, type: Vif
id: 34adf781-4fc1-4418-a63d-72e2d4fb9786, type: SegmentPOrt
Mode
Basic
Availability
Manager
Display GRUB menu timeout.
Example
nsx-manager> get grub menu timeout
GRUB Menu Timeout = 4
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display information about the specified high-availability channel.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get high-availability channel local-ip 30.0.246.232 remote-ip 30.0.29.0
High-Availability Channel
Cfg_flags : 0x00000000
Ha_transport : 0bb0495e-b525-11e8-b7e8-020045ee019c
Channel_if_uuid : 0f02ccfe-0cbf-524a-ba32-6bedaa0429ec
Channel_sessions : 1
Channel_state : SYN
Ctl_req_seq : 1
Egress_inst_id : b75cdf09-e71f-4574-960a-45f7cc43300b
Ingress_inst_id : 00000000-0000-0000-0000-000000000000
Last_tx : 0x1eff538
Local_address : 30.0.246.232
Next_tx : 0x1eff894
Remote_address : 30.0.29.0
Mode
Basic
Availability
Autonomous Edge, Edge
Display statistics for the specified high-availability channel.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get high-availability channel local-ip 30.0.246.232 remote-ip 30.0.29.0 stats
High-Availability Session
Local_address : 30.0.246.232
Remote_address : 30.0.29.0
Rx_ack_packets : 0
Rx_drop : 0
Rx_drop_bad_version : 0
Rx_drop_inst_unmatch : 0
Rx_drop_intf_unmatch : 0
Rx_drop_ip_unmatch : 0
Rx_drop_pkt_len_unmatch : 0
Rx_drop_pkt_too_short : 0
Rx_drop_seq_unmatch : 0
Rx_drop_wait_syn_ack : 0
Rx_packets : 0
Tx_drop : 0
Tx_error : 0
Tx_packets : 754
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about high-availability channels.
Example
nsx-edge-1> get high-availability channels
High-Availability Channel
Cfg_flags : 0x00000000
Ha_transport : 0bb0495e-b525-11e8-b7e8-020045ee019c
Channel_if_uuid : 0f02ccfe-0cbf-524a-ba32-6bedaa0429ec
Channel_sessions : 1
Channel_state : SYN
Ctl_req_seq : 1
Egress_inst_id : b75cdf09-e71f-4574-960a-45f7cc43300b
Ingress_inst_id : 00000000-0000-0000-0000-000000000000
Last_tx : 0x1eb115c
Local_address : 30.0.246.232
Next_tx : 0x1eb1512
Remote_address : 30.0.29.0
Mode
Basic
Availability
Autonomous Edge, Edge
Display statistics for the high-availability channels.
Example
nsx-edge-1> get high-avaiability channels stats
High-Availability Session
Local_address : 30.0.246.232
Remote_address : 30.0.29.0
Rx_ack_packets : 0
Rx_drop : 0
Rx_drop_bad_version : 0
Rx_drop_inst_unmatch : 0
Rx_drop_intf_unmatch : 0
Rx_drop_ip_unmatch : 0
Rx_drop_pkt_len_unmatch : 0
Rx_drop_pkt_too_short : 0
Rx_drop_seq_unmatch : 0
Rx_drop_wait_syn_ack : 0
Rx_packets : 0
Tx_drop : 0
Tx_error : 0
Tx_packets : 476
Mode
Basic
Availability
Autonomous Edge, Edge
Display the high availability state history for the logical router in the VRF context.
Example
nsx-edge-1(tier0_sr)> get high-availability history state
State : Down
Event : Init
Resources :
Time : 2016-02-02 18:41:22.80
State : Active
Event : Node Up
Resources : 0
Time : 2016-02-02 18:41:26.91
Mode
Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display the high availability state history for the logical router in the VRF context.
Example
nsx-edge-1(tier0_sr)> get high-availability history state details
State : Down
Event : Init
Reason : Initialize
Resources :
Time : 2016-02-02 18:41:22.80
State : Active
Event : Node Up
Reason : Initialize
Resources : 0
Time : 2016-02-02 18:41:26.91
Mode
Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display information about the specified high-availability session.
| Option | Description |
|---|---|
| <service-id> | Service id (0-65535) |
Example
nsx-edge-1> get high-availability session local-service-id 5 peer-service-id 5
High-Availability Session
Cfg_flags : 0x00000000
Ha_transport : 0bb0495e-b525-11e8-b7e8-020045ee019c
Last_tx : 0x0
Local_address : 30.0.246.232
Local_service_id : 5
Next_tx : 0x0
Nsxa_req_ha_state : 1
Nsxa_req_msg_type : 0
Peer_ha_state : 255
Peer_service_id : 5
Remote_address : 30.0.29.0
Req_seq : 1
Req_state : active
Service_type : service-router
Mode
Basic
Availability
Autonomous Edge, Edge
Display statistics for the specified high-availability session.
| Option | Description |
|---|---|
| <service-id> | Service id (0-65535) |
Example
nsx-edge-1> get high-availability session local-service-id 5 peer-service-id 5
High-Availability Session
Cfg_flags : 0x00000000
Ha_transport : 0bb0495e-b525-11e8-b7e8-020045ee019c
Last_tx : 0x0
Local_address : 30.0.246.232
Local_service_id : 5
Next_tx : 0x0
Nsxa_req_ha_state : 1
Nsxa_req_msg_type : 0
Peer_ha_state : 255
Peer_service_id : 5
Remote_address : 30.0.29.0
Req_seq : 1
Req_state : active
Service_type : service-router
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about high-availability sessions.
Example
nsx-edge-1> get high-availability sessions
High-Availability Session
Cfg_flags : 0x00000000
Ha_transport : 0bb0495e-b525-11e8-b7e8-020045ee019c
Last_tx : 0x0
Local_address : 30.0.246.232
Local_service_id : 5
Next_tx : 0x0
Nsxa_req_ha_state : 1
Nsxa_req_msg_type : 0
Peer_ha_state : 255
Peer_service_id : 5
Remote_address : 30.0.29.0
Req_seq : 1
Req_state : active
Service_type : service-router
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about high-availability sessions by remote-ip of the channel
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get high-availability sessions remote-ip 30.0.29.0
High-Availability Session
Cfg_flags : 0x00000000
Ha_transport : 0bb0495e-b525-11e8-b7e8-020045ee019c
Last_tx : 0x0
Local_address : 30.0.246.232
Local_service_id : 5
Next_tx : 0x0
Nsxa_req_ha_state : 1
Nsxa_req_msg_type : 0
Peer_ha_state : 255
Peer_service_id : 5
Remote_address : 30.0.29.0
Req_seq : 1
Req_state : active
Service_type : service-router
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about high-availability sessions by service-type.
| Option | Description |
|---|---|
| <service-type> | Service type argument is one of {service-router} Allowed values: service-router, l2-bridge |
Example
nsx-edge-1> get high-availability sessions service-type service-router
High-Availability Session
Cfg_flags : 0x00000000
Ha_transport : 0bb0495e-b525-11e8-b7e8-020045ee019c
Last_tx : 0x0
Local_address : 30.0.246.232
Local_service_id : 5
Next_tx : 0x0
Nsxa_req_ha_state : 1
Nsxa_req_msg_type : 0
Peer_ha_state : 255
Peer_service_id : 5
Remote_address : 30.0.29.0
Req_seq : 1
Req_state : active
Service_type : service-router
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about high-availability sessions by service-type and remote-ip of the channel
| Option | Description |
|---|---|
| <service-type> | Service type argument is one of {service-router} Allowed values: service-router, l2-bridge |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get high-availability sessions service-type service-router remote-ip 30.0.29.0
High-Availability Session
Cfg_flags : 0x00000000
Ha_transport : 0bb0495e-b525-11e8-b7e8-020045ee019c
Last_tx : 0x0
Local_address : 30.0.246.232
Local_service_id : 5
Next_tx : 0x0
Nsxa_req_ha_state : 1
Nsxa_req_msg_type : 0
Peer_ha_state : 255
Peer_service_id : 5
Remote_address : 30.0.29.0
Req_seq : 1
Req_state : active
Service_type : service-router
Mode
Basic
Availability
Autonomous Edge, Edge
Display statistics for the high-availability sessions of specified service-type.
| Option | Description |
|---|---|
| <service-type> | Service type argument is one of {service-router} Allowed values: service-router, l2-bridge |
Example
nsx-edge-1> get high-availability session service-type service-router stats
High-Availability Session
Local_service_id : 5
Peer_service_id : 5
Rx_ack_packets : 0
Rx_drop : 0
Rx_drop_bad_version : 0
Rx_drop_inst_unmatch : 0
Rx_drop_intf_unmatch : 0
Rx_drop_ip_unmatch : 0
Rx_drop_pkt_len_unmatch : 0
Rx_drop_pkt_too_short : 0
Rx_drop_seq_unmatch : 0
Rx_packets : 0
Rx_packets_to_conf_thread : 0
Service_type : service-router
Tx_drop : 0
Tx_error : 0
Tx_packets : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Displays any high-availability sessions of a given type who have completed synchronization with peer
| Option | Description |
|---|---|
| <service-type> | Service type argument is one of {service-router} Allowed values: service-router, l2-bridge |
Example
nsx-edge-1> get high-availability sessions service-type service-router sync complete
Total : 2
UUID : e371701a-3e7d-4173-a0fc-7311d70f50e6
Type : TIER1
State : Active
UUID : 4e425c9e-09c6-4021-bbc7-fab2895a2c09
Type : TIER1
State : Standby
Mode
Basic
Availability
Autonomous Edge, Edge
Displays any high-availability sessions of a given type who have not yet completed synchronization with peer
| Option | Description |
|---|---|
| <service-type> | Service type argument is one of {service-router} Allowed values: service-router, l2-bridge |
Example
nsx-edge-1> get high-availability sessions service-type service-router sync in-progress
Total : 2
UUID : e371701a-3e7d-4173-a0fc-7311d70f50e6
Type : TIER1
State : Active, waiting for peer to confirm
UUID : 4e425c9e-09c6-4021-bbc7-fab2895a2c09
Type : TIER1
State : Down
Mode
Basic
Availability
Autonomous Edge, Edge
Display the synchronization status of high-availability sessions of a given type on current node
| Option | Description |
|---|---|
| <service-type> | Service type argument is one of {service-router} Allowed values: service-router, l2-bridge |
Example
nsx-edge-1> get high-availability service-type service-router sync summary
Overview
Sync in progress: 2
Sync done : 100
All sync done : false
Mode
Basic
Availability
Autonomous Edge, Edge
Display statistics for the high-availability sessions.
Example
nsx-edge-1> get high-availability sessions stats
High-Availability Global Counters
Ha_sessions : 1
Nsxa_err_msg_receive_count : 0
Nsxa_msg_receive_count : 0
Nsxa_notify_count : 0
Nsxa_notify_drop_count : 0
Rx_drop_bad_csum : 0
Rx_drop_bad_version : 0
Rx_drop_count : 0
Rx_drop_intf_type : 0
Rx_drop_non_app : 0
Rx_drop_non_udp : 0
Rx_drop_null_app_peer_session : 0
Rx_drop_null_app_session : 0
Rx_drop_null_intf : 0
Rx_drop_runt_pkt : 0
Rx_drop_udp_len : 0
Tx_drop_count : 0
Tx_drop_no_route : 0
High-Availability Session
Local_service_id : 5
Peer_service_id : 5
Rx_ack_packets : 0
Rx_drop : 0
Rx_drop_bad_version : 0
Rx_drop_inst_unmatch : 0
Rx_drop_intf_unmatch : 0
Rx_drop_ip_unmatch : 0
Rx_drop_pkt_len_unmatch : 0
Rx_drop_pkt_too_short : 0
Rx_drop_seq_unmatch : 0
Rx_packets : 0
Rx_packets_to_conf_thread : 0
Service_type : service-router
Tx_drop : 0
Tx_error : 0
Tx_packets : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display the high availability status for the logical router in the VRF context.
Example
nsx-edge-1(tier1_sr)> get high-availability status
Service Router
UUID : 4e425c9e-09c6-4021-bbc7-fab2895a2c09
state : Active
type : TIER1
mode : A/S
failover mode : Non-preemptive
rank : 0
service count : 1
service score : 0
HA ports state
UUID : 733d7ed3-1daa-4c28-bc0a-77e3736fea14
op_state : Up
addresses : 169.0.0.2/28
Sub-cluster Information
UUID : 6c3089d1-dac5-43ce-b8bb-91e6bb36345d
Peer SR UUID : 44e3ee5f-36ea-4703-80ad-0e6b50af552a
Peer Node UUID : 3b34da96-ed06-11e8-9814-020063efb6dc
Peer Routers
Node UUID : e13dbba8-542e-11e9-a177-020021d58d1d
HA state : Standby
Mode
Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display Tunnels info on the specified host switch.
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <bfd-cmd-type> | BFD command type Allowed values: tunnels, evpn-bfds, tunnel, evpn-bfd |
Example
esx-1> get host-switch tunnels
Local IP Remote IP Local State Remote State
10.0.0.1 20.0.0.1 Up Init
10.0.0.1 30.0.0.1 Up Up
10.0.0.1 40.0.0.1 Down Down
Mode
Basic
Availability
ESXi
Display Tunnel Detail info on the specified DVPort of the specified host switch.
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <bfd-cmd-type> | BFD command type Allowed values: tunnels, evpn-bfds, tunnel, evpn-bfd |
| <local_ip> | Local IP |
| <remote_ip> | Remote IP |
Example
esx-1> get host-switch tunnel 10.0.0.1 20.0.0.1
Local State :up
Remote State :up
Local Diag :None
Remote Diag :None
min_rx :100
min_tx :1000
local_disc :0xabcdef
remote_disc :0x123456
Tx Interval :1000
Rx Interval :100
mult :3
Mode
Basic
Availability
ESXi
Display IPFIX setting on the specified DVPort of the specified host switch
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get host-switch nsxvswitch dvport cdb36fdd-a3ec-494e-9b7b-60a8c6af5b70 ipfix setting
Host IPFIX setting
--------------------------------------------------------------------------
activeTimeout : 8
idleTimeout : 15
sampleRate : 1000
obsDomainID : 0
sourceIP : 0.0.0.0
internalFlowsOnly : False
vNICFlowOnly : False
virtualObsID :
collectors : 192.168.7.3 5003
Mode
Basic
Availability
ESXi
Display IPFIX stats on the specified DVPort of the specified host switch
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get host-switch nsxvswitch dvport cdb36fdd-a3ec-494e-9b7b-60a8c6af5b70 ipfix stats
Host IPFIX stats
--------------------------------------------------------------------------
flows : 0
currentFlows : 0
pktsSent : 10
pktsSenterrors : 0
sampleok : 0
ipv4ok : 0
ipv6ok : 0
sampleerrors : 0
unsupportedproto : 0
ipv4errors : 0
ipv6errors : 0
etherrors : 0
inputiferrors : 0
outputiferrors : 0
allocerrors : 0
ipv4headererrors : 0
ipv6headererrors : 0
ipv4unsupportedproto: 0
ipv6unsupportedproto: 0
ipv4missingfrags : 0
ipv6missingfrags : 0
pktattrerrors : 0
accesserrors : 0
Mode
Basic
Availability
ESXi
Display the mcast filter mode for the specified host switch and dvPort
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get host-switch nsxvswitch dvport 73c6d671-32e0-4e74-95a0-bf604c0e0669 mcast-filter
Host Switch DVPort Mcast Filter Entry
---------------------------------------------------------------------------
Legacy Filter Entry
===========================================================================
33:33:ff:69:ae:cd
33:33:00:00:00:01
01:00:5e:00:00:01
IGMP Filter Entry
===========================================================================
224.1.1.2
MLD Filter Entry
===========================================================================
Mode
Basic
Availability
ESXi
get host-switch <hs-name-arg> dvport <dvport-id-arg> mcast-filter <entry-mode-arg> <entry-group-arg>
Display the mcast filter stata of the specified entry
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| <entry-mode> | Mode of a mcast filter entry Allowed values: igmp, mld |
| <entry-group> | Group address of a mcast filter entry Allowed pattern: ^([A-Fa-f0-9.:]+)$ |
Example
esx-1> get host-switch nsxvswitch dvport 73c6d671-32e0-4e74-95a0-bf604c0e0669 mcast-filter igmp 224.1.1.2
Host Switch DVPort Mcast Filter Entry Status
---------------------------------------------------------------------------
VNI : 41864
version : 3
srcIPFilterMode : INCLUDE
updateTime : 35
srcIPs :
192.168.1.4
192.168.1.5
Mode
Basic
Availability
ESXi
Display IPFIX stats on the specified host switch
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
Example
esx-1> get host-switch nsxvswitch ipfix stats
Host IPFIX stats
--------------------------------------------------------------------------
flows : 0
currentFlows : 0
pktsSent : 10
pktsSenterrors : 0
sampleok : 0
ipv4ok : 0
ipv6ok : 0
sampleerrors : 0
unsupportedproto : 4
ipv4errors : 0
ipv6errors : 0
etherrors : 0
inputiferrors : 0
outputiferrors : 0
allocerrors : 0
ipv4headererrors : 0
ipv6headererrors : 0
ipv4unsupportedproto: 0
ipv6unsupportedproto: 0
ipv4missingfrags : 0
ipv6missingfrags : 0
pktattrerrors : 0
accesserrors : 0
worldstatus : OK
Mode
Basic
Availability
ESXi
Display the mcast filter mode for the specified host switch.
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
Example
esx-1> get Host-switch nsxvswitch mcast-filter
Host Switch Mcast Filter
---------------------------------------------------------------------------
Mode : Snooping
Mode
Basic
Availability
ESXi
Display the stats of mirror on the specified host switch.
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <mirror-session-id> | Mirror session identifier UUID Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get host-switch nsxvswitch mirror-session a779b62e-7711-47ad-8d54-
5cb166d061af
Mirror Session
==========================================================
UUID : a779b62e-7711-47ad-8d54-5cb166d061af
Direction : Both
Snap Length : 0
Source : 9484c882-76e6-4f9e-85c4-087968963769;34b19ace-8396-4
dd2-9b92-5867b1bf30ef;vmnic1(Encap)
Destination : 79b8f233-4c22-49ce-b270-3802796de856
EncapVlan :
OrigialVlan :
EncapType :
GreKey :
ERspanID :
TCP/IP stack :
Filter :
Source IPs : 10.1.1.1
: 2000:1/64
Destination IPs : 20.1.1.1
: 2000:2/64
IP Protocol : TCP
Source Ports : 234
Destination Ports : 2999-4000
Action : Mirror
Mode
Basic
Availability
ESXi
Display the mirror settings on the specified host switch.
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
Example
esx-1> get host-switch nsxvswitch mirror-sessions
Mirror Session Summary
============================================================
Mirror UUID Direction Snap Length
a779b62e-7711-47ad-8d54-5cb166d061af Both 0
Mode
Basic
Availability
ESXi
Display IPFIX stats on the specified uplink of the specified host switch
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <uplink> | Uplink identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get host-switch nsxvswitch uplink vmnic1 ipfix stats
Host IPFIX stats
--------------------------------------------------------------------------
flows : 0
currentFlows : 0
pktsSent : 0
pktsSenterrors : 0
sampleok : 0
ipv4ok : 0
ipv6ok : 0
sampleerrors : 0
unsupportedproto : 4
ipv4errors : 0
ipv6errors : 0
etherrors : 0
inputiferrors : 0
outputiferrors : 0
allocerrors : 0
ipv4headererrors : 0
ipv6headererrors : 0
ipv4unsupportedproto: 0
ipv6unsupportedproto: 0
ipv4missingfrags : 0
ipv6missingfrags : 0
pktattrerrors : 0
accesserrors : 0
Mode
Basic
Availability
ESXi
Display if host switch is getting upgraded.
Example
esx-1> get host-switch upgrade-status
Host Upgrade Status
===============================================================================================
Host Switch | UpgradeInProgress
===============================================================================================
nsxDefaultHostSwitch | true
Mode
Basic
Availability
ESXi
Display VLAN table for the host switch.
Example
nsx-edge-1> get host-switch vlan-table
VLAN : 100
MAC : 02:50:56:00:00:03
Ingress Port
name : fp-eth0
ID : 0
Egress Port
port : 783a05cd-033d-4891-ad11-7c082641e069
ifuid : 274
VLAN : 250
MAC : 04:00:c0:a8:fa:a2
Ingress Port
name : fp-eth1
ID : 1
Egress Port
port : 7bd1dd3d-97eb-5312-9d0d-b26c148a4fac
ifuid : 296
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about all host switches.
Example
nsx-edge-1> get host-switches
Host Switch : 8d4c2128-e748-4878-8314-ad8414f7f943
Switch Name : vlanswitch
Transport Zone : 4e9a90b7-96de-4102-a9bf-1f3733eb3375
Physical Port : fp-eth0
Uplink Name : uplink1
Host Switch : d7ea327f-2569-4b1c-b7cf-8cd4c85ebb18
Switch Name : hostswitch
Transport Zone : 9bc2392d-b7ee-4cf9-9200-7d082f199aef
Physical Port : fp-eth1
Uplink Name : uplink1
Transport VLAN : 250
Default Gateway : 192.168.250.1
Subnet Mask : 255.255.255.0
Local VTEP Device : fp-eth1
Local VTEP IP : 192.168.250.162
Mode
Basic
Availability
Autonomous Edge, Edge
Display the system hostname.
Example
nsx> get hostname
nsx
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display hugepage information, including total system memory, hugepage sizes supported and hugepage pools.
Example
nsx-edge-1> get hugepage
Total system memory
3949 MB
Hugepage sizes supported
2097152
Hugepage pools
Size Minimum Current Maximum Default
2097152 987 987 987 *
Mode
Basic
Availability
Autonomous Edge, Edge
Display the container interface (CIF) configuration for the specified app.
| Option | Description |
|---|---|
| <string> | Application ID Allowed pattern: ^.*$ |
Example
kvm-1> get hyperbus app-id c1-vm2ebc cif-config
AppID LSPID LRPID VIFID LSID MAC IP GatewayIP Vlan Version
c1-vm2ebc 939e3ef4-3f42-4a12-a125-24a9ef5035a9 00000000-0000-0000-0000-000000000000 b819f915-6f8f-4b9d-a816-9c7c3f44f830 db3d238f-4528-4fb3-9f94-bb2f61cc49b5 aa:bb:cc:dd:ee:11 192.168.102.11 0.0.0.0 11 1
Mode
Basic
Availability
ESXi, KVM
Display the container interface (CIF) configuration table.
Example
kvm-1> get hyperbus cif-table
Type AppID LSPID LRPID VIFID LSID MAC IP GatewayIP NsgStatus Vlan Version
Parent VIF 93d80cc9-9654-4300-93d2-8a27925feebd 00000000-0000-0000-0000-000000000000 b819f915-6f8f-4b9d-a816-9c7c3f44f830 775a3d45-063d-40b2-8a89-8e102fc7bbb9 00:00:00:00:00:00 0.0.0.0 0.0.0.0 NSG_NONE 0 1
Link LSP 0dd90579-e3cc-4f9c-b5f3-cfbe16d82d0d be3d0a5a-f80d-456f-89c7-33219090fdcb db3d238f-4528-4fb3-9f94-bb2f61cc49b5 00:00:00:00:00:00 0.0.0.0 192.168.102.1 NSG_NONE 0 1
Link LSP 22e38f1c-453a-4821-a0f1-de77af397000 3ad6ec1f-72f3-45ad-8201-eb8b67d25682 18f9821a-9844-4ba1-bb0e-b975eacbdabf 00:00:00:00:00:00 0.0.0.0 192.168.101.1 NSG_NONE 0 1
Child CIF c1-vm2ebc 939e3ef4-3f42-4a12-a125-24a9ef5035a9 00000000-0000-0000-0000-000000000000 b819f915-6f8f-4b9d-a816-9c7c3f44f830 db3d238f-4528-4fb3-9f94-bb2f61cc49b5 aa:bb:cc:dd:ee:11 192.168.102.11 0.0.0.0 NSG_NONE 11 1
Mode
Basic
Availability
ESXi, KVM
Display the virtual interface (VIF) connection information.
Example
kvm-1> get hyperbus connection info
VIFID Connection Status
db4f717e-d0dd-4552-a99b-5a5839f3e06d 169.254.1.10:2345 HEALTHY
or
esx-1> get hyperbus connection info
VIFID Connection Status HostSwitchID
da527051-fb35-4f54-8658-96d3802e2c24 169.254.1.10:2345 HEALTHY 75 eb 8c 05 46 95 4f a4-83 e5 52 f6 81 b9 8f ac
Mode
Basic
Availability
ESXi, KVM
Display the virtual interface (VIF) connection version information.
Example
esx-1> get hyperbus connection version
VIFID ValidatedVersion
0ddb322d-caf8-41de-9702-b4eecc674f58 VERSION_1_1
Mode
Basic
Availability
ESXi
Display the LIP allocation pool.
Example
sc2-rdops-vm06-dhcp-192-143.eng.vmware.com> get hyperbus lip ip-pool
HostSwitchID LIPStart LIPEnd
c1 88 7f ee da 08 47 a2-af fb c5 86 bd 96 df ce 169.254.1.10 169.254.255.255
Mode
Basic
Availability
ESXi, KVM
Display the container interface (CIF) configuration for the specified logical switch port.
| Option | Description |
|---|---|
| <logical-switch-port-ID> | Logical switch port ID Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
kvm-1> get hyperbus logical-switch-port 939e3ef4-3f42-4a12-a125-24a9ef5035a9 cif-config
Type AppID LSPID LRPID VIFID LSID MAC IP GatewayIP Vlan Version
Child CIF c1-vm2ebc 939e3ef4-3f42-4a12-a125-24a9ef5035a9 00000000-0000-0000-0000-000000000000 b819f915-6f8f-4b9d-a816-9c7c3f44f830 db3d238f-4528-4fb3-9f94-bb2f61cc49b5 aa:bb:cc:dd:ee:11 192.168.102.11 0.0.0.0 11 1
Mode
Basic
Availability
ESXi, KVM
Display the connection information for the specified virtual interface (VIF).
| Option | Description |
|---|---|
| <vif-ID> | VIF ID Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
kvm-1> get hyperbus vif-id db4f717e-d0dd-4552-a99b-5a5839f3e06d connection info
VIFID Connection Status
db4f717e-d0dd-4552-a99b-5a5839f3e06d 169.254.1.10:2345 HEALTHY
Mode
Basic
Availability
ESXi, KVM
Display the logical IP (LIP) for the specified virtual interface (VIF).
| Option | Description |
|---|---|
| <vif-ID> | VIF ID Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
kvm-1> get hyperbus vif-id db4f717e-d0dd-4552-a99b-5a5839f3e06d lip
VIFID LIP
db4f717e-d0dd-4552-a99b-5a5839f3e06d 169.254.1.10
Mode
Basic
Availability
ESXi, KVM
Display the VIF (virtual interface) LIP (logical IP) table.
Example
kvm-1> get hyperbus vif-lip-table
VIFID LIP State
db4f717e-d0dd-4552-a99b-5a5839f3e06d 169.254.1.10 LSP_ATTACHMENT/VIF_CONNECT
Mode
Basic
Availability
ESXi, KVM
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.
Example
kvm-1> get hyperbus vif-table
VIFID Version
b819f915-6f8f-4b9d-a816-9c7c3f44f830 1
c1-vm2ebc 1
Mode
Basic
Availability
ESXi, KVM
Display NSX IDS Engine Fast Log setting.
Example
nsx-esx> get ids engine logging-level
NSX IDS Engine Fast Log Setting
--------------------------------------------------
enabled
Mode
Basic
Availability
ESXi
Display IDS Engine Fast Log setting.
Example
> get ids engine fastlog
fast log is enabled, filename /var/log/fastlog_dpd.log
Mode
Availability
Edge
Displays all IDS global stats.
Example
nsx-edge-1> get ids engine global stats
NSX IDS Engine Statistics
--------------------------------------------------
uptime: 4604 (0 days 01:16:44)
app_layer:
---------
flow:
failed_tcp: 7
http: 81
tls: 10
tx:
http: 82
detect:
------
alert: 1
alerts_suppressed: 203
engines:
id: 0
last_reload: 2023-02-06T22:33:39.920050+0000
signatures_failed: 242
signatures_loaded: 11189
tcp:
---
memuse: 596882816
midstream_pickups: 1
overlap: 1
reassembly_memuse: 1019904
rst: 1180
sessions: 1273
syn: 1272
synack: 121
Mode
Availability
Edge
Displays the IDS logging level.
Example
nsx-edge-1> get ids engine logging-level
info
Mode
Availability
Edge
Display NSX IDS Engine Log Level.
Example
nsx-esx> get ids engine logging-level
NSX IDS Engine Log Level
--------------------------------------------------
info
Mode
Basic
Availability
ESXi
Displays the IDS profiles.
Example
nsx-edge-1> get ids engine profiles
1 profile(s) found
UUID Type Signature Count
b59b04be-11ba-4220-8b93-520308c99ac4 IDS 16060
Mode
Availability
Edge
Display NSX IDS Engine Profiles.
Example
> get ids engine profiles
NSX IDS Engine Profiles
--------------------------------------------------
Profile count: 1
1. 97f6465c-2201-4770-a157-a854041439a6
Mode
Basic
Availability
ESXi
Displays the IDS profiles for the specified signature.
| Option | Description |
|---|---|
| <ids-sig-id-arg> | Integer IDPS signature id Allowed pattern: ^[0-9]+$ |
Example
nsx-edge-1> get ids engine profiles signature 2031332
b59b04be-11ba-4220-8b93-520308c99ac4
ff3a4068-f24b-44cc-b294-a3c63ce8a7e9
Mode
Availability
Edge
Display NSX IDS Engine Profile statistics.
| Option | Description |
|---|---|
| <profileid> | Profile ID UUID argument |
Example
> get ids engine profilestats 132ae679-ee93-459f-9fa2-ac43ffe2b95b
NSX IDS Engine Profile Stats
------------------------------------------------------------
Profile ID: 132ae679-ee93-459f-9fa2-ac43ffe2b95b
Total Alerts: 59
Total Packets: 2065
Mode
Basic
Availability
ESXi
Display NSX IDS Engine Profile status
| Option | Description |
|---|---|
| <profileid> | Profile ID UUID argument |
Example
> get ids engine profilestatus 132ae679-ee93-459f-9fa2-ac43ffe2b95b
NSX IDS Engine Profile Status
------------------------------------------------------------
Profile ID: 132ae679-ee93-459f-9fa2-ac43ffe2b95b
Pcap Enabled: Yes
File Size: 65536
Total Packets: 15
Mode
Basic
Availability
ESXi
Display NSX IDS Engine Rules.
Example
> get ids engine rules
NSX IDS Engine Rules
--------------------------------------------------
Rule count: 1
1. 1001 Prevent
Mode
Basic
Availability
ESXi
Get Signature Action for a particular RuleID, ProfileID, SignID
| Option | Description |
|---|---|
| <ruleid> | Rule ID Integer argument |
| <profileid> | Profile ID UUID argument |
| <signid> | Signature ID Integer argument Allowed pattern: ^[0-9]+$ |
Example
> get ids engine signaction 1001 84f00f24-3177-401c-8c30-d70dbee48479 4100761
NSX IDS Engine Signature Action
---------------------------------------------
alert
Mode
Basic
Availability
ESXi
Checks for membership and action for a signature-profile pair.
| Option | Description |
|---|---|
| <ids-sig-id-arg> | Integer IDPS signature id Allowed pattern: ^[0-9]+$ |
| <context-profile-id> | Context profile ID argument Allowed pattern: ^[0-9a-zA-Z-]+$ |
Example
nsx-edge-1> get ids engine signature 2031332 profile b59b04be-11ba-4220-8b93-520308c99ac4 membership
Found, action: drop
Mode
Availability
Edge
Display NSX IDS Engine global statistics.
Example
> get ids engine stats
NSX IDS Engine Statistics
--------------------------------------------------
uptime: 9508 (0 days 02:38:28)
detect:
------
engines:
alerts: 10
id: 0
last_reload: 2024-03-26T20:01:13.783399+0000
packets_bypass: 0
packets_incoming: 1028
packets_outgoing: 1028
packets_reject: 0
signatures_failed: 0
signatures_loaded: 13059
pcaps:
-----
app_layer:
---------
flow:
dns_udp: 1
failed_tcp: 1
failed_udp: 10
smb: 15
pkts:
smb: 543
bytes:
smb: 287659
tx:
dns_udp: 2
smb: 213
flow_bypassed:
-------------
flow_mgr:
--------
closed_pruned: 15
flows_checked: 2
flows_notimeout: 2
new_pruned: 150
rows_checked: 65536
rows_maxlen: 1
rows_skipped: 65534
tcp:
---
memuse: 3031040
overlap: 10
reassembly_memuse: 499712
sessions: 16
syn: 17
synack: 17
http:
----
ftp:
---
Mode
Basic
Availability
ESXi
Displays the IDS Enable/Disable Status.
Example
nsx-edge-1> get ids engine status
UUID Enabled
b59b04be-11ba-4220-8b93-520308c99ac4 Yes
Mode
Availability
Edge
Display NSX IDS Engine Status.
Example
> get ids engine status
NSX IDS Engine Status
--------------------------------------------------
status: enabled
uptime: 181232 (2 days 02:20:32)
Mode
Basic
Availability
ESXi
Get IDS Event Engine queue stats.
Example
esx> get ids events queue stats
Fri Jan 10 2025 UTC 11:15:49.419
--------------------------------------------------
NSX-IDPS event processing queue stats
--------------------------------------------------
Queue name Current size Max size
-------------------------------------------------------
Critical events 5 1000
Non-Crit events 0 1000
Kafka events 0 500
Event logger 5 1000
Critical pcaps 3 500
Non-Crit pcaps 0 1000
Kafka pcaps 0 500
Mode
Basic
Availability
ESXi
Get IDS Event Engine stats.
Example
esx> get ids events stats
--------------------------------------------------
NSX Intrusion Detection Service Statistics
--------------------------------------------------
Total 2052
Critical 1640
Non-Critical 302
Protos to MP
Sent 1914
Dropped 0
Alerts to MP
Sent 1914
Dropped 0
Event Drops Reason
Queue full 0
Out of mem 0
Rate limited 110
Protos to Intelligence/NDR
Sent 0
Dropped 0
Alerts to Intelligence/NDR
Sent 0
Dropped 0
Intelligence/NDR Event Queue
Dropped 0
--------------------------------------------------
IDPS PCAP Transmission Statistics
--------------------------------------------------
Total 820
Critical 410
Non-Critical 410
Protos to MP
Sent 563
Dropped 0
Alerts to MP
Sent 563
Dropped 0
Pcaps Drop Reason
Queue full 0
Out of mem 0
Protos to Intelligence/NDR
Sent 0
Dropped 0
Alerts to Intelligence/NDR
Sent 0
Dropped 0
Delivery to Kafka
Succeeded 0
Failed 0
--------------------------------------------------
Mode
Basic
Availability
ESXi
Display NSX IDPS filter specific statistics.
| Option | Description |
|---|---|
| <filtername> | Filter name argument |
Example
> get idps filter stats nic-267112-eth1-vmware-sfw.2
NSX IDPS slowpath per filter stats
---------------------------------------------------------
filter_name: nic-266610-eth1-vmware-sfw.2
filter_oversub_bypass: 956
filter_oversub_drop: 0
filter_ids_in: 70780
filter_ids_out: 70780
Mode
Basic
Availability
ESXi
Display NSX IDS Log Level.
Example
> get ids logging-level
NSX IDS Log Level
--------------------------------------------------
info
Mode
Basic
Availability
ESXi
Display NSX IDS Profiles.
Example
> get ids profiles
NSX IDS Profiles
--------------------------------------------------
Profile count: 1
1. 97f6465c-2201-4770-a157-a854041439a6
Mode
Basic
Availability
ESXi
Display NSX IDS Rules.
Example
> get ids rules
NSX IDS Rules
--------------------------------------------------
Rule count: 1
1. 1001 Prevent
Mode
Basic
Availability
ESXi
Display NSX IDS Status.
Example
> get ids status
NSX IDS Status
--------------------------------------------------
atp_license_status: enabled
status: disabled
uptime: 181232 (2 days 02:20:32)
Mode
Basic
Availability
ESXi
Display information about all IGMP reports snooped by the Edge
Example
pnq4-hs1-a0212> get igmp-snooping-table
Thu Jul 09 2020 UTC 23:12:08.022
Receiving Interface
UUID VRF Group Origin / VTEP IP Timeout Uptime
cec29081-eb92-4adc-abe5-ce87d56683cc 1 239.13.13.15 ESX 101.101.101.2 130 0:00:13
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 239.49.49.49 EDGE 138.1.1.4 58 0:02:09
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 224.0.0.13 EDGE 138.1.1.4 132 0:05:42
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 224.0.0.22 EDGE 138.1.1.4 58 0:07:38
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 224.0.0.22 EDGE 138.1.1.5 129 2:36:09
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 224.0.0.2 EDGE 138.1.1.5 133 2:36:04
cec29081-eb92-4adc-abe5-ce87d56683cc 1 239.13.13.14 ESX 101.101.101.2 138 0:06:45
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 235.1.1.15 EDGE 138.1.1.4 134 2:36:04
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 224.0.0.13 EDGE 138.1.1.5 133 2:36:06
49acf593-91c7-4607-b91a-f7f8d40152d7 3 239.13.13.15 Local 130 0:00:13
49acf593-91c7-4607-b91a-f7f8d40152d7 3 239.13.13.13 Local 58 0:00:25
49acf593-91c7-4607-b91a-f7f8d40152d7 3 239.13.13.14 Local 138 0:06:45
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 239.49.49.49 EDGE 138.1.1.5 132 2:36:13
cec29081-eb92-4adc-abe5-ce87d56683cc 1 239.13.13.13 ESX 101.101.101.2 58 0:00:25
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 224.0.0.2 EDGE 138.1.1.4 58 0:04:40
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about all IGMP reports snooped in the LR
Example
pnq4-hs1-a0212(tier1_sr)> get igmp-snooping-table
Thu Jul 09 2020 UTC 23:19:30.319
Receiving Interface
UUID VRF Group Origin / VTEP IP Timeout Uptime
cec29081-eb92-4adc-abe5-ce87d56683cc 1 239.13.13.13 ESX 101.101.101.2 66 0:03:50
Mode
Tier0_sr, VRF, Tier1_sr
Availability
Autonomous Edge, Edge
Display information about all IGMP reports snooped in the LR
| Option | Description |
|---|---|
| <multicast-ip-address> | Multicast IP address argument |
Example
pnq4-hs1-a0212(vrf)> get igmp-snooping-table 239.13.13.13
Thu Jul 09 2020 UTC 23:21:51.925
Receiving Interface
UUID VRF Group Origin / VTEP IP Timeout Uptime
49acf593-91c7-4607-b91a-f7f8d40152d7 3 239.13.13.13 Local 116 0:06:11
Mode
Tier0_sr, VRF, Tier1_sr
Availability
Autonomous Edge, Edge
Display statistics about IGMP reports snooped by the Edge
Example
Edge-2> get igmp-snooping-table stats
Statistics
Total IGMP Packets Received : 629
Processed
IGMP Membership Reports V1/V2 : 472
IGMP General Queries : 157
IGMP Group-Specific Queries : 0
Dropped
Report Source Unresolved : 0
Report With Null Group : 0
Invalid Multicast Group : 0
Invalid/Unsupported Type : 0
Mode
Basic
Availability
Autonomous Edge, Edge
List all container images for given service.
| Option | Description |
|---|---|
| <image-name> | Edge service container image name |
Example
nsx-edge> get image nsx-edge-iked
Image Name Version Tag
nsx-edge-iked ob-13148208 previous
nsx-edge-iked ob-13129113 current
nsx-edge-iked ob-13094493
Mode
Basic
Availability
Autonomous Edge, Edge
List install history of container images for given service.
| Option | Description |
|---|---|
| <image-name> | Edge service container image name |
Example
nsx-edge> get image nsx-edge-datapath install history
Image Name Version Install time Uninstall time
nsx-edge-datapath ob-13336865 2019-04-16 23:16:47.502 UTC 2019-04-16 23:17:12.213 UTC
nsx-edge-datapath ob-13344839 2019-04-16 23:17:15.314 UTC 2019-04-16 23:16:44.372 UTC
Mode
Basic
Availability
Autonomous Edge, Edge
List all service container images.
Example
nsx-edge> get images
Image Name Version Tag
nsx-edge-iked ob-13148208 previous
nsx-edge-mdproxy ob-13135660 current
nsx-edge-iked ob-13129113 current
nsx-edge-dispatcher ob-13094493 current
nsx-edge-datapath ob-13094493 current
nsx-edge-frr ob-13094493 current
nsx-edge-lb ob-13094493 current
nsx-edge-iked ob-13094493
nsx-edge-nsxa ob-13094493 current
nsx-edge-mdproxy ob-13094493 previous
nsx-edge-dhcp ob-13094493 current
nsx-edge-dns ob-13094493 current
Mode
Basic
Availability
Autonomous Edge, Edge
List install history for all service container images.
Example
nsx-edge> get images install history
Image Name Version Install time Uninstall time
nsx-edge-nsxa ob-13336865 2019-04-16 23:14:45.050 UTC 2019-04-16 23:15:33.223 UTC
nsx-edge-nsxa ob-13344839 2019-04-16 22:52:17.530 UTC
nsx-edge-nsxa ob-13348244 2019-04-16 23:15:33.781 UTC 2019-04-16 23:14:44.427 UTC
nsx-edge-datapath ob-13336865 2019-04-16 23:16:47.502 UTC 2019-04-16 23:17:12.213 UTC
nsx-edge-datapath ob-13344839 2019-04-16 23:17:15.314 UTC 2019-04-16 23:16:44.372 UTC
Mode
Basic
Availability
Autonomous Edge, Edge
Display NSX Intelligence broker statistics.
Example
>get intelligence broker stats
NSX Intelligence Broker Statistics
--------------------------------------------------------------
Alarm active: False
Broker Node Broker State
ssl://30.30.0.37:9092/2 INIT
ssl://30.30.0.38:9092/0 INIT
ssl://30.30.0.36:9092/bootstrap UP
Mode
Basic
Availability
ESXi, KVM
Display NSX Intelligence flows configuration.
Example
> get intelligence flows config
Fri Jul 12 2024 UTC 01:01:14.484
NSX Intelligence Host Flows Configuration
----------------------------------------------------------------------
Enabled Max Active Max Nonactive Interval(min) Long Lived(min)
True 25000 30 5 3
Kafka broker: 10.216.36.209:9092
Prioritization mode: INTEL
LSP-based Profile mode: True
Affected LSP count: 3
1. db9db3c4-6f88-4718-a491-a51186f57481
2. 9943f3ef-b2d7-452d-ac37-f5e9962f0dd4
3. 45b0cbcd-f3df-4cc3-8eb0-f6226a8dd450
V4 Private IP count: 0
V4 Private CIDR count: 3
1. ip 172.16.0.0/12
2. ip 192.168.0.0/16
3. ip 10.0.0.0/8
V6 Private IP count: 0
V6 Private CIDR count: 2
1. ip fe80::/10
2. ip fc00::/7
Mode
Basic
Availability
ESXi, KVM
Display NSX Intelligence flows aggregation mask.
Example
>get intelligence flows mask
NSX Intelligence Host Flows Aggregation Masks
------------------------------------------------------------
1. Source IP
2. Destination IP
3. Protocol
4. Destination Port
5. Direction
6. Rule ID
7. SID and Hash
Mode
Basic
Availability
ESXi, KVM
Display NSX Intelligence flows metrics.
Example
>get intelligence flows metrics
NSX Intelligence Host Flows Metrics
--------------------------------------------------------------------------------
host uuid: a8dcd9f4-b48d-405c-bfc3-0f52db8f32e0
max long-active table size: 1
max terminated table size: 1
last collection time: 2024-04-13 19:54:48
Flow Type Total Count Last Count
long-active 1 0
overflow long-active 3 0
terminated 1 1
overflow terminated 3 0
Mode
Basic
Availability
ESXi, KVM
Display NSX Intelligence flows metrics for ports.
Example
>get intelligence flows metrics ports
Sat Jun 22 2024 UTC 17:39:12.235
NSX Intelligence Host Flows Metrics for Ports
--------------------------------------------------------------------------------
host uuid: 7adbf728-a83e-4c58-b417-d211fbbed439
max long-active table size: 100
max terminated table size: 100
last collection time: 2024-06-22 17:37:32
Port 1
----------------------------------------
LSP-UUID: 9bbdbcb9-b510-4183-a189-25e769439fe4
VM-UUID: eb19a84a-7062-4fb2-949f-3c727680dafa
Port 2
----------------------------------------
LSP-UUID: 06d67bd5-9da6-4c7d-8350-3a276d8ef6ae
VM-UUID: bb9cf6b1-e3bd-470f-9598-139a74728617
Port 3
----------------------------------------
LSP-UUID: 48fea1d7-3bf7-4dc1-bae8-1ebca9e5c091
VM-UUID: bb9cf6b1-e3bd-470f-9598-139a74728617
Port 4
----------------------------------------
LSP-UUID: c3430239-6fda-441c-9e55-9c872436e7ca
VM-UUID: 8923faab-1d08-4eb9-ab4b-a33ec12d6ac3
Port 5
----------------------------------------
LSP-UUID: 910ade99-48f6-4ec3-a76f-efadee0e992f
VM-UUID: 8923faab-1d08-4eb9-ab4b-a33ec12d6ac3
Flow Type Last Count (non zero)
long-active 1
Port 6
----------------------------------------
LSP-UUID: 1add1d03-97da-41df-bfea-c255de38e029
VM-UUID: eb19a84a-7062-4fb2-949f-3c727680dafa
Flow Type Last Count (non zero)
long-active 1
Mode
Basic
Availability
ESXi, KVM
Display NSX Intelligence flows statistics.
Example
>get intelligence flows stats
NSX Intelligence Host Flows Statistics
-----------------------------------------------------------------
Topic Items Sent Msgs Sent Bytes Sent
raw_flow 18 9 2955
Mode
Basic
Availability
ESXi, KVM
Display NSX Intelligence flows acknowledgement statistics.
Example
>get intelligence flows stats ack
NSX Intelligence Host Flows Acknowledgement Statistics
-----------------------------------------------------------------------------
host uuid: 09baa7ea-8f29-11ea-a374-0200921f33fe
host type: nsx-esx(4)
Topic Total Sent Total Ack'ed Last Sent Last Ack'ed Last Sent Time Last Ack Time
raw_flow 2 2 1 1 2024-06-28 03:17:17 2024-06-28 03:12:17
Mode
Basic
Availability
ESXi, KVM
Display information about the specified network interface.
| Option | Description |
|---|---|
| <interface-name> | Network interface argument |
Example
nsx-edge> get interface eth0
Interface: eth0
IPv4:
Address: 192.168.110.111/24
Default gateway: 192.168.110.1
Broadcast address: 0.0.0.0
IPv6:
Address: 2620:124:6020:c713:0:a:0:c51/128
Address: 2620:124:6020:c713:445:57ff:feca:bfc5/64
Address: fe80::445:57ff:feca:bfc5/64
Default gateway: fe80::50:56ff:fe56:4453
MAC address: 00:50:56:8e:e8:2e
MTU: 1500
Link status: up
Admin status: up
RX packets: 66493
RX bytes: 12712191
RX errors: 0
RX dropped: 0
TX packets: 58436
TX bytes: 15051574
TX errors: 0
TX dropped: 0
TX collisions: 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about the specified network interface.
| Option | Description |
|---|---|
| <interface-name> | Network interface argument |
Example
nsx-manager> get interface eth0
Interface: eth0
IPv4:
Address: 10.196.198.191/22
Default gateway: 10.196.199.253
Broadcast address: 10.196.199.255
IPv6:
Address: 2620:124:6020:c713:0:a:0:c51/128
Address: 2620:124:6020:c713:445:57ff:feca:bfc5/64
Address: fe80::445:57ff:feca:bfc5/64
Default gateway: fe80::50:56ff:fe56:4453
MAC address: 00:50:56:88:9f:a8
MTU: 1500
Link status: up
Admin status: up
RX packets: 413875
RX bytes: 25087126
RX errors: 0
RX dropped: 0
TX packets: 10014
TX bytes: 3264741
TX errors: 0
TX dropped: 0
TX collisions: 0
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Display the high availability status of interface-groups for the logical router in the VRF context.
Example
nsx-edge-1(tier1_sr)> get interface-groups high-availability
Group UUID : 4e425c9e-09c6-4021-bbc7-fab2895a2c09
Port UUID : e13dbba8-542e-11e9-a177-020021d58d1d
Members
SR UUID : e0e7c638-aa8c-4354-b8a9-0aa0fbbfdb05
Node UUID : 1e44a970-86e0-5a76-9e4f-ecc676b45148
Port UUID : e13dbba8-542e-11e9-a177-020021d58d1d
Port MAC : 02:50:56:56:00:02
State : Active
SR UUID : 44e3ee5f-36ea-4703-80ad-0e6b50af552a
Node UUID : 2d44a970-86e0-5a76-9e4f-ecc676b45158
Port UUID : c23bc228-f5ec-4ad4-b596-fc0dcccd6922
Port MAC : 02:50:56:56:00:03
State : Active
SR UUID : 79ac0bb6-6ddb-45be-82bd-baf83fdfc788
Node UUID : 3a44a970-86e0-5a76-9e4f-ecc676b45781
Port UUID : 628f3976-472a-4543-906c-b6b07c4ffb74
Port MAC : 02:50:56:56:00:04
State : Down
Mode
Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display information about all network interfaces.
Example
nsx-manager> get interfaces
Interface: eth0
IPv4:
Address: 10.196.198.191/22
Default gateway: 10.196.199.253
Broadcast address: 10.196.199.255
IPv6:
Address: 2620:124:6020:c713:0:a:0:c51/128
Address: 2620:124:6020:c713:445:57ff:feca:bfc5/64
Address: fe80::445:57ff:feca:bfc5/64
Default gateway: fe80::50:56ff:fe56:4453
MAC address: 00:50:56:88:9f:a8
MTU: 1500
Link status: up
Admin status: up
RX packets: 5726752
RX bytes: 344899492
RX errors: 0
RX dropped: 0
TX packets: 25417
TX bytes: 5233823
TX errors: 0
TX dropped: 0
TX collisions: 0
Interface: lo
IPv4 Address:
Address: 127.0.0.1/8
IPv6 Address:
- Address: ::1/128
MTU: 65536
Link status: up
Admin status: up
RX packets: 544402040
RX bytes: 221460310841
RX errors: 0
RX dropped: 0
TX packets: 544402040
TX bytes: 221460310841
TX errors: 0
TX dropped: 0
TX collisions: 0
or
nsx-edge> get interfaces
Interface: eth0
IPv4:
Address: 192.168.110.111/24
Default gateway: 192.168.110.1
Broadcast address: 0.0.0.0
IPv6:
Address: 2620:124:6020:c713:0:a:0:c51/128
Address: 2620:124:6020:c713:445:57ff:feca:bfc5/64
Address: fe80::445:57ff:feca:bfc5/64
Default gateway: fe80::50:56ff:fe56:4453
MAC address: 00:50:56:8e:e8:2e
MTU: 1500
Link status: up
Admin status: up
RX packets: 66307
RX bytes: 12698263
RX errors: 0
RX dropped: 0
TX packets: 58340
TX bytes: 15041724
TX errors: 0
TX dropped: 0
TX collisions: 0
Interface: lo
Address: 127.0.0.1/8
MTU: 65536
Link status: up
Admin status: up
RX packets: 221628
RX bytes: 54868485
RX errors: 0
RX dropped: 0
TX packets: 221628
TX bytes: 54868485
TX errors: 0
TX dropped: 0
TX collisions: 0
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display interface information for the logical router in the VRF context.
Example
nsx-edge-1(vrf)> get interfaces
UUID VRF LR-ID Name Type
736a80e3-23f6-5a2d-81d6-bbefb2786666 0 0 R1 TUNNEL
interfaces
interface : 9fd3c667-32db-5921-aaad-7a88c80b5e9f
ifuid : 258
mode : blackhole
interface : 34ca595f-fa62-5ed4-afcc-a6ef0195d4ed
ifuid : 261
mode : lif
IP/Mask : 142.134.61.36/24
MAC : 00:0c:29:5a:96:2b
VLAN id : untagged
LS port : 238d7422-e488-5cee-9639-1894b8ab56e2
urpf-mode : NONE
admin : up
op_state : up
MTU : 1600
arp_proxy : 40.40.10.60, 40.40.10.50, 40.40.10.55
: 40.40.10.100, 40.40.10.110
interface : f322c6ca-4298-568b-81c7-a006ba6e6c88
ifuid : 257
mode : cpu
Mode
VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display the interface statistics for the logical router in the VRF context.
Example
nsx-edge-1(tier0_sr)> get interfaces stats
Logical Router
UUID : e9d3379d-aba7-4459-9262-18bc95eaeec1
VRF : 1
LR-ID : 1
name : R2
type : SERVICE_ROUTER_TIER0
Statistics
Interface Type RX PKTS TX PKTS RX BYTES TX BYTES RX Drops TX Drops
b83cb77f-ca34-595c-a3e1-76278f0dcb00 blackhole 0 0 0 0 0 0
4b115e5f-1395-54c3-aaf0-0de5736f99df cpu 8 0 648 0 8 0
6c427841-e151-4479-9184-4196cfcef3b6 lif 5601 11 1915542 462 5601 0
081e2e50-2f0e-42e1-8764-80a127dd3918 lif 0 0 0 0 0 0
00003300-0000-0000-0000-000000000002 loopback 8 0 648 0 8 0
Total 5617 11 1916838 462 5617 0
Mode
VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display discovered bindings.
Example
kvm-1> get ip-discovery bindings
IP Discovery Bindings
--------------------------------------------------------------------------------------------------------------------------------------------
Logical Port Discovery Type IP MAC VLAN Expires In Sec
d722c9c8-cd9d-4218-91c0-2728ced19d74 ND_Snooping 5000::10 ca:2c:ff:ec:3c:87 0 403
d722c9c8-cd9d-4218-91c0-2728ced19d74 ND_Snooping fe80::c82c:ffff:feec:3c87 ca:2c:ff:ec:3c:87 0 413
d722c9c8-cd9d-4218-91c0-2728ced19d74 ARP_Snooping 172.16.1.10 ca:2c:ff:ec:3c:87 0 153
Mode
Basic
Availability
KVM
Display ip discovery bindings for a host switch and dvport.
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get ip-discovery bindings nsxvswitch nsxvswitch b65dcac9-6611-41ce-b96c-69255120b473
IP Discovery Bindings
----------------------------------------------------------------------------------------------------
Discovery Type IP MAC VLAN
ARP Snooping 192.168.1.10 00:50:56:a9:fb:f1 0
Mode
Basic
Availability
ESXi
Display ipv4 discovery bindings for a host switch and dvport.
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get ip-discovery bindings nsxvswitch b65dcac9-6611-41ce-b96c-69255120b473 ipv4
IP Discovery Bindings
----------------------------------------------------------------------------------------------------
Discovery Type IP MAC VLAN
ARP Snooping 192.168.1.10 00:50:56:a9:fb:f1 0
Mode
Basic
Availability
ESXi
Display ipv6 discovery bindings for a host switch and dvport.
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get ip-discovery bindings nsxvswitch b65dcac9-6611-41ce-b96c-69255120b473 ipv6
IP Discovery Bindings
----------------------------------------------------------------------------------------------------
Discovery Type IP MAC VLAN
ARP Snooping 2000::1 00:50:56:a9:fb:f1 0
Mode
Basic
Availability
ESXi
Display discovered bindings for a given logical port.
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
Example
kvm-1> get ip-discovery bindings d722c9c8-cd9d-4218-91c0-2728ced19d74
IP Discovery Bindings
--------------------------------------------------------------------------------------------------------------
Discovery Type IP MAC VLAN Expires In Sec
ND_Snooping 5000::10 ca:2c:ff:ec:3c:87 0 598
ARP_Snooping 172.16.1.10 ca:2c:ff:ec:3c:87 0 600
ND_Snooping fe80::c82c:ffff:feec:3c87 ca:2c:ff:ec:3c:87 0 598
Mode
Basic
Availability
KVM
Display discovered bindings for a given logical port and type.
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
| <ip-version> | Internet Protocol Version (IPV4 or IPV6) Allowed values: ipv4, ipv6 |
Example
kvm-1> get ip-discovery bindings d722c9c8-cd9d-4218-91c0-2728ced19d74 ipv4
IP Discovery Bindings
--------------------------------------------------------------------------------------------------------------
Discovery Type IP MAC VLAN Expires In Sec
ARP_Snooping 172.16.1.10 ca:2c:ff:ec:3c:87 0 600
kvm-1> get ip-discovery bindings d722c9c8-cd9d-4218-91c0-2728ced19d74 ipv6
IP Discovery Bindings
--------------------------------------------------------------------------------------------------------------
Discovery Type IP MAC VLAN Expires In Sec
ND_Snooping 5000::10 ca:2c:ff:ec:3c:87 0 598
Mode
Basic
Availability
KVM
Display ip-discovery profile for all logical ports.
Example
kvm-1> get ip-discovery config
IP Discovery Config
---------------------------------------------------------------------------
Logical Port : d722c9c8-cd9d-4218-91c0-2728ced19d74
ARP Snooping : Enabled
DHCPV4 Snooping : Enabled
ND Snooping : Disabled
DHCPV6 Snooping : Disabled
ARP/ND Expiry Timeout : 10 min
Logical Port : 0fe4864f-b2d9-4a91-af8b-9b92593f548e
ARP Snooping : Enabled
DHCPV4 Snooping : Enabled
ND Snooping : Disabled
DHCPV6 Snooping : Disabled
ARP/ND Expiry Timeout : 10 min
Mode
Basic
Availability
KVM
Display IP discovery config for a host switch and dvport.
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get ip-discovery config nsxvswitch b65dcac9-6611-41ce-b96c-69255120b473
IP Discovery Config
---------------------------------------------------------------------------
ARP Snooping : Enabled
DHCPV4 Snooping : Enabled
ND Snooping : Enabled
DHCPV6 snooping : Enabled
ARP/ND Expiry Timeout : 600
Mode
Basic
Availability
ESXi
Display ip-discovery config for a given logical port.
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
Example
kvm-1> get ip-discovery config 2339fe58-b71f-42d3-ae67-41957cbb18da
IP Discovery Config
---------------------------------------------------------------------------
ARP Snooping : Enabled
DHCPV4 Snooping : Enabled
ND Snooping : Disabled
DHCPV6 Snooping : Disabled
ARP/ND Expiry Timeout : 10 min
Mode
Basic
Availability
KVM
Display ignore bindings list.
Example
kvm-1> get ip-discovery ignore-list
IP Discovery Ignore List
--------------------------------------------------------------------------------------------------------------
LogicalPort IP MAC VLAN
2339fe58-b71f-42d3-ae67-41957cbb18da 6000::254 00:23:20:05:5f:5d 0
2339fe58-b71f-42d3-ae67-41957cbb18da 192.168.37.143 00:23:20:05:5f:5d 0
2339fe58-b71f-42d3-ae67-41957cbb18da 192.168.37.150 00:23:20:05:5f:5d 0
Mode
Basic
Availability
KVM
Display ip discovery ignore list for a host switch and dvport.
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get ip-discovery ignore-list nsxvswitch b65dcac9-6611-41ce-b96c-69255120b473
IP Discovery Ignore List
------------------------------------------------------------------------------------------------------------------------
Mode
Basic
Availability
ESXi
Display ignore bindings list for a given logical port.
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
Example
kvm-1> get ip-discovery ignore-list 2339fe58-b71f-42d3-ae67-41957cbb18da
IP Discovery Ignore List
---------------------------------------------------------------------------
IP MAC VLAN
6000::254 00:23:20:05:5f:5d 0
192.168.37.143 00:23:20:05:5f:5d 0
192.168.37.150 00:23:20:05:5f:5d 0
Mode
Basic
Availability
KVM
Display ignore bindings list for a given logical port and type.
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
| <ip-version> | Internet Protocol Version (IPV4 or IPV6) Allowed values: ipv4, ipv6 |
Example
kvm-1> get ip-discovery ignore-list 2339fe58-b71f-42d3-ae67-41957cbb18da ipv6
IP Discovery Ignore List
---------------------------------------------------------------------------
IP MAC VLAN
6000::254 00:23:20:05:5f:5d 0
Mode
Basic
Availability
KVM
Display ip-discovery ignore list stats for all logical ports.
Example
kvm-1> get ip-discovery ignore-list stats
IP Discovery Ignore List Stats
------------------------------------------------------------------------------------------
LogicalPort V4 Ignore Count V6 Ignore Count
2339fe58-b71f-42d3-ae67-41957cbb18da 0 0
Mode
Basic
Availability
KVM
Display ip discovery ignore list stats for a host switch and dvport.
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get ip-discovery ignore-list stats nsxvswitch b65dcac9-6611-41ce-b96c-69255120b473
IP Discovery Ignorelist Stats
------------------------------------------------------------------------------------------------------------------------
V4 Ignore Count : 0
V6 Ignore Count : 0
Mode
Basic
Availability
ESXi
Display ip-discovery ignore list stats for a given logical ports.
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
Example
kvm-1> get ip-discovery ignore-list stats 2339fe58-b71f-42d3-ae67-41957cbb18da
IP Discovery Ignore List Stats
--------------------------------------------------
V4 Ignore Count V6 Ignore Count
0 0
Mode
Basic
Availability
KVM
Display ip-discovery stats for all logical ports.
Example
kvm-1> get ip-discovery stats
IP Discovery Stats
---------------------------------------------------------------------------
Logical Port : 2339fe58-b71f-42d3-ae67-41957cbb18da
MAX ARP Entries : 3
Total Active ARP Entries : 0
Total Expired ARP Entries : 3
MAX DHCPV4 Entries : 128
Total DHCPV4 Entries : 0
MAX Pending DHCPV4 Reqs : 128
Total Pending DHCPV4 Reqs : 0
MAX ND Entries : 3
Total Active ND Entries : 0
Total Expired ND Entries : 0
MAX DHCPV6 Entries : 15
Total DHCPV6 Entries : 0
MAX Pending DHCPV6 Reqs : 15
Total Pending DHCPV6 Reqs : 0
Mode
Basic
Availability
KVM
Display ip discovery stats for a host switch and dvport.
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get ip-discovery stats nsxvswitch b65dcac9-6611-41ce-b96c-69255120b473
IP Discovery Stats
------------------------------------------------------------------------------------------------------------------------
MAX ARP Entries : 256
Total Active ARP Entries : 0
MAX DHCPV4 Entries : 128
Total DHCPV4 Entries : 0
MAX Pending DHCPV4 Reqs : 128
Total Pending DHCPV4 Reqs : 0
MAX ND Entries : 30
Total Active ND Entries : 0
MAX DHCPV6 Entries : 15
Total DHCPV6 Entries : 0
MAX Pending DHCPV6 Reqs : 15
Total Pending DHCPV6 Reqs : 0
Mode
Basic
Availability
ESXi
Display ip-discovery profile for a given logical port.
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
Example
kvm-1> get ip-discovery stats 2339fe58-b71f-42d3-ae67-41957cbb18da
IP Discovery Stats
---------------------------------------------------------------------------
MAX ARP Entries : 3
Total Active ARP Entries : 0
Total Expired ARP Entries : 3
MAX DHCPV4 Entries : 128
Total DHCPV4 Entries : 0
MAX Pending DHCPV4 Reqs : 128
Total Pending DHCPV4 Reqs : 0
MAX ND Entries : 3
Total Active ND Entries : 0
Total Expired ND Entries : 0
MAX DHCPV6 Entries : 15
Total DHCPV6 Entries : 0
MAX Pending DHCPV6 Reqs : 15
Total Pending DHCPV6 Reqs : 0
Mode
Basic
Availability
KVM
Display full information from a specific CA Certificate
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn ca-certificate 77d3d1fb-82f9-4805-b7db-848465304001
UUID : 77d3d1fb-82f9-4805-b7db-848465304001
Certificate:
Mode
Basic
Availability
Autonomous Edge, Edge
Display Subject Name from all CA Certificates.
Example
nsx-edge-1>get ipsecvpn ca-certificates
UUID : 77d3d1fb-82f9-4805-b7db-848465304001
Subject :
UUID : 77d3d1fb-82f9-4805-b7db-848465304002
Subject :
UUID : 77d3d1fb-82f9-4805-b7db-848465304003
Subject :
Mode
Basic
Availability
Autonomous Edge, Edge
Display full information from all CA Certificates.
Example
nsx-edge-1>get ipsecvpn ca-certificates verbose
UUID : 77d3d1fb-82f9-4805-b7db-848465304001
Certificate:
UUID : 77d3d1fb-82f9-4805-b7db-848465304001
Certificate:
UUID : 77d3d1fb-82f9-4805-b7db-848465304001
Certificate:
Mode
Basic
Availability
Autonomous Edge, Edge
Display complete information from a specific Certifiate.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn certificate 77d3d1fb-82f9-4805-b7db-848465304000
UUID : 77d3d1fb-82f9-4805-b7db-848465304000
Certificate:
Mode
Basic
Availability
Autonomous Edge, Edge
Display Subject Names from all Certificates.
Example
nsx-edge-1> get ipsecvpn certificates
UUID : 77d3d1fb-82f9-4805-b7db-848465304000
Subject : C=IN, ST=Maharashtra, O=VMware, OU=NSBU, CN=left
Mode
Basic
Availability
Autonomous Edge, Edge
Display complete information from all Certificates.
Example
nsx-edge-1> get ipsecvpn certificates verbose
UUID : 77d3d1fb-82f9-4805-b7db-848465304000
Mode
Basic
Availability
Autonomous Edge, Edge
Display all configured Dead Peer Detection profiles.
Example
nsx-edge-1> get ipsecvpn config dpd-profile
UUID : 00000000-0000-0001-0000-000000000001
Enabled : True
DPD Probe Interval : 200 sec
Mode
Basic
Availability
Autonomous Edge, Edge
Display configured Dead Peer Detection profile.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn config dpd-profile 78b17d39-22ad-47bb-a23d-bea7dc13bc44
Enabled : True
DPD Probe Interval : 200 sec
Mode
Basic
Availability
Autonomous Edge, Edge
Display all configured IKE profiles.
Example
nsx-edge-1> get ipsecvpn config ike-profile
UUID : 00000000-0000-0001-0000-000000000002
Authentication Algorithm : AUTH_HMAC_SHA256
Encryption Algorithm : ENCR_AES_128_CBC
SA Expiry Time : 200 sec
Mode
Basic
Availability
Autonomous Edge, Edge
Display configured IKE profile.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn config ike-profile 00000000-0000-0001-0000-000000000002
UUID : 00000000-0000-0001-0000-000000000002
Authentication Algorithm : AUTH_HMAC_SHA256
Encryption Algorithm : ENCR_AES_128_CBC
SA Expiry Time : 200 sec
Mode
Basic
Availability
Autonomous Edge, Edge
Display all configured IPSec local endpoint profiles.
Example
nsx-edge-1> get ipsecvpn config local-endpoint
UUID : 00000000-0000-0001-0000-000000000004
Local Address :
Ipv4 : 10.112.202.147
Local ID : local_edp_1
Local ID Type : IPSEC_IP_ADDR_TYPE
Certificate Authority :
UUID : 77d3d1fb-82f9-4805-b7db-848465304001
UUID : 77d3d1fb-82f9-4805-b7db-848465304002
UUID : 77d3d1fb-82f9-4805-b7db-848465304003
Certificate :
UUID : 77d3d1fb-82f9-4805-b7db-848465304000
Certificate Revocation List ID :
UUID : d812f9e9-f047-4eb7-876b-3e3b88332c10
Mode
Basic
Availability
Autonomous Edge, Edge
Display configured IPSec local endpoint profile.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn config local endpoint 78b17d39-22ad-47bb-a0da-792f7e89bc47
Local Address :
Ipv4 : 10.112.202.147
Local ID : local_edp_1
Local ID Type : IPSEC_IP_ADDR_TYPE
Certificate Authority :
UUID : 77d3d1fb-82f9-4805-b7db-848465304001
UUID : 77d3d1fb-82f9-4805-b7db-848465304002
UUID : 77d3d1fb-82f9-4805-b7db-848465304003
Certificate :
UUID : 77d3d1fb-82f9-4805-b7db-848465304000
Certificate Revocation List ID :
UUID : d812f9e9-f047-4eb7-876b-3e3b88332c10
Mode
Basic
Availability
Autonomous Edge, Edge
Display all CA-Certificates for a specific IPsec Local Endpoint.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn config local-endpoint 78b17d39-22ad-47bb-a0da-7922f7e89bc47 ca-certificates
UUID : 77d3d1fb-82f9-4805-b7db-848465304001
Certificate:
UUID : 77d3d1fb-82f9-4805-b7db-848465304002
Certificate:
UUID : 77d3d1fb-82f9-4805-b7db-848465304003
Certificate:
Mode
Basic
Availability
Autonomous Edge, Edge
Display Certificate for a specific IPsec Local Endpoint.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn config local-endpoint 78b17d39-22ad-47bb-a0da-792f7e89bc47 certificate
UUID : 77d3d1fb-82f9-4805-b7db-848465304000
Certificate:
Mode
Basic
Availability
Autonomous Edge, Edge
Display all CRLs for a specific IPsec Local Endpoint.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn config local-endpoint 78b17d39-22ad-47bb-a0da-7922f7e89bc47 crls
UUID : d812f9e9-f047-4eb7-876b-3e3b88332c10
Certificate Revocation List (CRL):
Mode
Basic
Availability
Autonomous Edge, Edge
Display all configured MultiPath Groups.
Example
nsx-edge-1> get ipsecvpn config multi-path-group
UUID : a8f5f7e8-2081-405b-93de-6eeff3f449f2
Enabled : True
Scheme : THRESHOLD_BASED
Scheme Value : 75
Source Port Pool Size : 4
UUID : 0487ebd9-31c2-46ae-8e37-ac1407b8a49a
Enabled : True
Scheme : THRESHOLD_BASED
Scheme Value : 80
Source Port Pool Size : 6
Mode
Basic
Availability
Autonomous Edge, Edge
Display configured MultiPath Group.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn config multi-path-group a8f5f7e8-2081-405b-93de-6eeff3f449f2
Thu Jan 07 2021 PST 23:56:36.841
Enabled : True
Scheme : THRESHOLD_BASED
Scheme Value : 75
Source Port Pool Size : 4
Mode
Basic
Availability
Autonomous Edge, Edge
Display all configured IPSec peer endpoint profiles.
Example
nsx-edge-1> get ipsecvpn config peer-endpoint
UUID : 00000000-0000-0001-0000-000000000005
Auth Mode : AUTH_MODE_PSK
DPD Profile :
UUID : 00000000-0000-0001-0000-000000000001
Enabled : True
DPD Probe Interval : 200 sec
IKE Profile :
UUID : 00000000-0000-0001-0000-000000000002
Authentication Algorithm : AUTH_HMAC_SHA256
Encryption Algorithm : ENCR_AES_128_CBC
SA Expiry Time : 200 sec
IKE Role : INITIATOR
Ipsec Tunnel Profile :
UUID : 00000000-0000-0001-0000-000000000003
AH Transport Protocol Enabled : False
Authentication Algorithm : AUTH_HMAC_SHA256
DF Policy : DF_COPY
Disable Anti Replay : True
Enable ESN : True
Encryption Algorithm : ENCR_AES_128_CBC
SA Expiry Time : 1200 sec
Transport Mode : False
Peer Address : 10.112.202.167
Peer ID : peer_edp_1
Peer ID Type : IPSEC_IP_ADDR_TYPE
Mode
Basic
Availability
Autonomous Edge, Edge
Display configured IPSec peer endpoint profile.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn config peer-endpoint 78b17d39-22ad-47bc-a0da-792f7e89bc46
Auth Mode : AUTH_MODE_PSK
DPD Profile :
UUID : 00000000-0000-0001-0000-000000000001
Enabled : True
DPD Probe Interval : 200 sec
IKE Profile :
UUID : 00000000-0000-0001-0000-000000000002
Authentication Algorithm : AUTH_HMAC_SHA256
Encryption Algorithm : ENCR_AES_128_CBC
SA Expiry Time : 200 sec
IKE Role : INITIATOR
Ipsec Tunnel Profile :
UUID : 00000000-0000-0001-0000-000000000003
AH Transport Protocol Enabled : False
Authentication Algorithm : AUTH_HMAC_SHA256
DF Policy : DF_COPY
Disable Anti Replay : True
Enable ESN : True
Encryption Algorithm : ENCR_AES_128_CBC
SA Expiry Time : 1200 sec
Transport Mode : False
Peer Address : 10.112.202.167
Peer ID : peer_edp_1
Peer ID Type : IPSEC_IP_ADDR_TYPE
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec Servicce configuration from NestDB.
Example
nsx-edge-1> get ipsecvpn config service
UUID : acaba146-31f7-4b35-bc19-f3055ea93db0
Enable : True
IKE LOG Level : LOG_LEVEL_INFO
IKE Rule Section ID : 00003500-0000-0000-0000-000000000004
Ipsec HA Sync Enabled : True
SR Cluster ID : 00002000-0000-0000-0000-000000000004
UUID : 3bfc5972-1cb7-43cf-a646-529473981971
Enable : True
IKE LOG Level : LOG_LEVEL_INFO
IKE Rule Section ID : 00003500-0000-0000-0000-000000000001
Ipsec HA Sync Enabled : True
SR Cluster ID : 00002000-0000-0000-0000-000000000001
Mode
Basic
Availability
Autonomous Edge, Edge
Display all configured IPSec VPN sessions.
Example
nsx-edge-1> get ipsecvpn config session
UUID : 00000000-0000-0000-0000-00000000000a
Enabled : True
IKE Session ID : 2
Local Endpoint Profile :
UUID : 00000000-0000-0000-0000-000000000004
Local Address :
Ipv4 : 10.109.24.20
Local ID : 174921748
Local ID Type : IPSEC_IP_ADDR_TYPE
Peer Endpoint Profile :
UUID : 00000000-0000-0000-0000-000000000005
Auth Mode : AUTH_MODE_PSK
DPD Profile :
UUID : 00000000-0000-0001-0000-000000000001
Enabled : True
DPD Probe Interval : 600 sec
IKE Profile :
UUID : 00000000-0000-0001-0000-000000000002
Authentication Algorithm : AUTH_HMAC_SHA256
Encryption Algorithm : ENCR_AES_128_CBC
IKE Version : 3
DH Group : DH_GROUP_5
SA Expiry Time : 1000 sec
IKE Role : INITIATOR
Ipsec Tunnel Profile :
UUID : 00000000-0000-0001-0000-000000000003
AH Transport Protocol Enabled : False
Authentication Algorithm : AUTH_HMAC_SHA256
DF Policy : DF_COPY
Disable Anti Replay : True
Enable ESN : False
Encryption Algorithm : ENCR_AES_128_CBC
SA Expiry Time : 1200 sec
Transport Mode : False
Peer Address : 10.109.24.22
Peer ID : 10.109.24.22
Peer ID Type : IPSEC_IP_ADDR_TYPE
Policy :
UUID : 00000000-0000-0000-0000-00000000000b
Action : VPN_ACTION_PROTECT
Applied TO :
Logical Router Port : 00000000-0000-0000-0000-00000000000c
IKE Rulefrom ID : 2
IKE Ruleto ID : 1
Local Subnet : 192.168.2.0/24
Peer Subnet : 172.16.2.0/24
Priority : 10
TCP MSS Direction : TCP_MSS_ADJUST_BOTH
TCP MSS Value : 1350
Type : POLICY_BASED_SESSION
VPN Service Profile :
UUID : 00000000-0000-0001-0000-000000000007
Enable : True
IKE State File Encryption PWD : XXXX
Ipsec HA Sync Enabled : True
SR Clustur ID : 00000000-0000-0001-0000-000000000006
Mode
Basic
Availability
Autonomous Edge, Edge
Display a configured IPSec VPN session.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn config session 00000000-0000-0000-0000-00000000000a
Enabled : True
IKE Session ID : 2
Local Endpoint Profile :
UUID : 00000000-0000-0000-0000-000000000004
Local Address :
Ipv4 : 10.109.24.20
Local ID : 174921748
Local ID Type : IPSEC_IP_ADDR_TYPE
Peer Endpoint Profile :
UUID : 00000000-0000-0000-0000-000000000005
Auth Mode : AUTH_MODE_PSK
DPD Profile :
UUID : 00000000-0000-0001-0000-000000000001
Enabled : True
DPD Probe Interval : 600 sec
IKE Profile :
UUID : 00000000-0000-0001-0000-000000000002
Authentication Algorithm : AUTH_HMAC_SHA256
Encryption Algorithm : ENCR_AES_128_CBC
IKE Version : 3
DH Group : DH_GROUP_5
SA Expiry Time : 1000 sec
IKE Role : INITIATOR
Ipsec Tunnel Profile :
UUID : 00000000-0000-0001-0000-000000000003
AH Transport Protocol Enabled : False
Authentication Algorithm : AUTH_HMAC_SHA256
DF Policy : DF_COPY
Disable Anti Replay : True
Enable ESN : False
Encryption Algorithm : ENCR_AES_128_CBC
SA Expiry Time : 1200 sec
Transport Mode : False
Peer Address : 10.109.24.22
Peer ID : 10.109.24.22
Peer ID Type : IPSEC_IP_ADDR_TYPE
Policy :
UUID : 00000000-0000-0000-0000-00000000000b
Action : VPN_ACTION_PROTECT
Applied TO :
Logical Router Port : 00000000-0000-0000-0000-00000000000c
IKE Rulefrom ID : 2
IKE Ruleto ID : 1
Local Subnet : 192.168.2.0/24
Peer Subnet : 172.16.2.0/24
Priority : 10
TCP MSS Direction : TCP_MSS_ADJUST_BOTH
TCP MSS Value : 1350
Type : POLICY_BASED_SESSION
VPN Service Profile :
UUID : 00000000-0000-0001-0000-000000000007
Enable : True
IKE State File Encryption PWD : XXXX
Ipsec HA Sync Enabled : True
SR Clustur ID : 00000000-0000-0001-0000-000000000006
Mode
Basic
Availability
Autonomous Edge, Edge
Display a configured IPSec VPN session with specific endpoints.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get ipsecvpn config session local-ip 10.109.24.20 remote-ip 10.109.24.20
UUID : 00000000-0000-0000-0000-00000000000a
Enabled : True
IKE Session ID : 2
Local Endpoint Profile :
UUID : 00000000-0000-0000-0000-000000000004
Local Address :
Ipv4 : 10.109.24.20
Local ID : 174921748
Local ID Type : IPSEC_IP_ADDR_TYPE
Peer Endpoint Profile :
UUID : 00000000-0000-0000-0000-000000000005
Auth Mode : AUTH_MODE_PSK
DPD Profile :
UUID : 00000000-0000-0001-0000-000000000001
Enabled : True
DPD Probe Interval : 600 sec
IKE Profile :
UUID : 00000000-0000-0001-0000-000000000002
Authentication Algorithm : AUTH_HMAC_SHA256
Encryption Algorithm : ENCR_AES_128_CBC
IKE Version : 3
DH Group : DH_GROUP_5
SA Expiry Time : 1000 sec
IKE Role : INITIATOR
Ipsec Tunnel Profile :
UUID : 00000000-0000-0001-0000-000000000003
AH Transport Protocol Enabled : False
Authentication Algorithm : AUTH_HMAC_SHA256
DF Policy : DF_COPY
Disable Anti Replay : True
Enable ESN : False
Encryption Algorithm : ENCR_AES_128_CBC
SA Expiry Time : 1200 sec
Transport Mode : False
Peer Address : 10.109.24.22
Peer ID : 10.109.24.22
Peer ID Type : IPSEC_IP_ADDR_TYPE
Policy :
UUID : 00000000-0000-0000-0000-00000000000b
Action : VPN_ACTION_PROTECT
Applied TO :
Logical Router Port : 00000000-0000-0000-0000-00000000000c
IKE Rulefrom ID : 2
IKE Ruleto ID : 1
Local Subnet : 192.168.2.0/24
Peer Subnet : 172.16.2.0/24
Priority : 10
TCP MSS Direction : TCP_MSS_ADJUST_BOTH
TCP MSS Value : 1350
Type : POLICY_BASED_SESSION
VPN Service Profile :
UUID : 00000000-0000-0001-0000-000000000007
Enable : True
IKE State File Encryption PWD : XXXX
Ipsec HA Sync Enabled : True
SR Clustur ID : 00000000-0000-0001-0000-000000000006
nsx-edge-2> get ipsecvpn config session local-ip 2001::1 remote-ip 2002::1
Fri Feb 04 2022 PST 00:53:06.257
UUID : 00000000-0000-0000-0000-000000000010
Compliance Suite : NONE
Enabled : True
History :
Reason :
Status : IKE_STATUS_NEGO
Time : 04-Feb-2022 08:47:10
Reason : Negotiation not started
Status : IKE_STATUS_DOWN
Time : 04-Feb-2022 08:47:10
IKE Session ID : 8193
Local Endpoint Profile :
UUID : 00000000-0000-0000-0000-00000000000e
Local Address : 2001::1
Local Endpoint State : 3
Local ID : 2001::1
Local ID Type : IPSEC_IP_ADDR_TYPE
Peer Endpoint Profile :
UUID : 00000000-0000-0000-0000-00000000000f
Auth Mode : AUTH_MODE_PSK
DPD Profile :
UUID : 00000000-0000-0000-0000-00000000000c
DPD Probe Interval : 300 sec
Enabled : True
IKE Profile :
UUID : 00000000-0000-0000-0000-00000000000b
Authentication Algorithm : AUTH_HMAC_SHA256
DH Group : DH_GROUP_14
Encryption Algorithm : ENCR_AES_128_CBC
IKE Version : IKE_FLEX
SA Expiry Time : 1000 sec
IKE Role : INITIATOR
Ipsec Tunnel Profile :
UUID : 00000000-0000-0000-0000-00000000000d
AH Transport Protocol Enabled : True
Authentication Algorithm : AUTH_HMAC_SHA256
DF Policy : DF_COPY
Disable Anti Replay : False
Enable ESN : False
Encryption Algorithm : ENCR_AES_128_CBC
PFS Group : DH_GROUP_14
SA Expiry Time : 1200 sec
Transport Mode : False
Peer Address : 2002::1
Peer ID : 2002::1
Peer ID Type : IPSEC_IP_ADDR_TYPE
Policy :
UUID : 00000000-0000-0000-0000-040500000000
Action : VPN_ACTION_PROTECT
Applied TO :
Container : 00001000-0000-0000-0000-000000000001
IKE Rulefrom ID : 2147484677
IKE Ruleto ID : 1029
Local Subnet : 192.168.2.0/24
Peer Subnet : 172.16.2.0/24
Priority : 100
Tunnel Last Status : IPSEC_STATUS_DOWN
Type : POLICY_BASED_SESSION
VPN Service Profile :
UUID : 00000000-0000-0000-0000-000000000011
Enable : True
IKE State File Encryption PWD : XXXX
Ipsec HA Sync Enabled : True
SR Cluster ID : 00000000-0000-0000-0000-000000000014
Sr-Id : 00000000-0000-000a-0000-000000000000
Mode
Basic
Availability
Autonomous Edge, Edge
Display all configured IPsec tunnel profiles.
Example
nsx-edge-1> get ipsecvpn config tunnel-profile
UUID : 00000000-0000-0001-0000-000000000003
AH Transport Protocol Enabled : False
Authentication Algorithm : AUTH_HMAC_SHA256
DF Policy : DF_COPY
Disable Anti Replay : True
Enable ESN : True
Encryption Algorithm : ENCR_AES_128_CBC
SA Expiry Time : 1200 sec
Transport Mode : False
Mode
Basic
Availability
Autonomous Edge, Edge
Display configured IPSec tunnel profile.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn config tunnel-profile 78b17d39-22ad-47bb-a0da-792f7e89bc58
AH Transport Protocol Enabled : False
Authentication Algorithm : AUTH_HMAC_SHA256
DF Policy : DF_COPY
Disable Anti Replay : True
Enable ESN : True
Encryption Algorithm : ENCR_AES_128_CBC
SA Expiry Time : 1200 sec
Transport Mode : False
Mode
Basic
Availability
Autonomous Edge, Edge
Display complete information from a specific CRL certificate.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn crl d812f9e9-f047-4eb7-876b-3e3b88332c10
UUID : d812f9e9-f047-4eb7-876b-3e3b88332c10
Certificate Revocation List (CRL):
Mode
Basic
Availability
Autonomous Edge, Edge
Display Issuer Name from all CRL certificates.
Example
nsx-edge-1> get ipsecvpn crls
UUID : d812f9e9-f047-4eb7-876b-3e3b88332c10
Issuer :
Mode
Basic
Availability
Autonomous Edge, Edge
Display complete information from all CRL certificates.
Example
nsx-edge-1> get ipsecvpn crls verbose
UUID : d812f9e9-f047-4eb7-876b-3e3b88332c10
Certificate Revocation List (CRL):
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IKE SAs.
Example
nsx-edge-1> get ipsecvpn ikesa
Total Number of IKE SAs: 3
IKE Version : IKEv2
IKE Status : Up
IKE Session ID : 8
Session Name : Tunnel-62791cf0-7a541cb-915a6e5d-b6ed32f6
Session Type : Policy Based
IKE SPI Initiator : 0x0c6a7a809f4a6e2f
IKE SPI Responder : 0x33bbea1267703b12
Role : Initiator
Number of Child SA Pairs : 1
Created Timestamp : 2017-12-21 07:34:58
IKE SA Uptime : 163 sec
IKE SA Lifetime : 1000 sec
DPD Probe Interval : 600 sec
IP Address:
Local : 10.109.24.20
Remote : 10.109.24.22
Identity:
Local : 10.109.24.20 (ipv4)
Remote : 10.109.24.22 (ipv4)
Algorithm:
Encryption : aes128-cbc
Authentication : hmac-sha2
PRF : hmac-sha2
DH Group : 14
Authentication Method : Pre-shared key
VMW Feature Capabilities:
Local : VMW_VENDOR_ID
Remote : VMW_VENDOR_ID
IKE Version : IKEv2
IKE Status : Up
IKE Session ID : 2
Session Name : Tunnel-0-0-0-10
Session Type : Policy Based
IKE SPI Initiator : 0x09e534520302be3f
IKE SPI Responder : 0x9822366f1e4dbe92
Role : Initiator
Number of Child SA Pairs : 1
Created Timestamp : 2017-12-21 03:51:49
IKE SA Uptime : 228 sec
IKE SA Lifetime : 1000 sec
DPD Probe Interval : 300 sec
IP Address:
Local : 2001::1
Remote : 2002::1
Identity:
Local : 2001::1 (ipv6)
Remote : 2002::1 (ipv6)
Algorithm:
Encryption : aes128-cbc
Authentication : hmac-sha2
PRF : hmac-sha2
DH Group : 14
Authentication Method : Pre-shared key
VMW Feature Capabilities:
Local : VMW_VENDOR_ID
Remote :
IKE Version : IKEv2
IKE Status : Up
IKE Session ID : 3
Session Name : Tunnel-0-0-0-10
Session Type : Route Based
IKE SPI Initiator : 0xc990242465c31506
IKE SPI Responder : 0x23e5fa8d8ac18952
Role : Initiator
Number of Child SA Pairs : 1
Created Timestamp : 2017-12-21 21:54:50
IKE SA Uptime : 89 sec
IKE SA Lifetime : 1000 sec
DPD Probe Interval : 300 sec
IP Address:
Local : 2004::1
Remote : 2003::1
Identity:
Local : 2004::1 (ipv6)
Remote : 2003::1 (ipv6)
Algorithm:
Encryption : aes128-cbc
Authentication : hmac-sha2
PRF : hmac-sha2
DH Group : 14
Authentication Method : Pre-shared key
VMW Feature Capabilities:
Local : VMW_VENDOR_ID
Remote :
----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IKE security associations in active state.
Example
nsx-edge-1> get ipsecvpn ikesa active
Total Number of Active IKE SAs: 1
IKE Version : IKEv2
IKE Status : Up
IKE Session ID : 2
Session Name : Tunnel-62791cf0-7a541cb-915a6e5d-b6ed32f6
Session Type : Policy Based
IKE SPI Initiator : 0x0c6a7a809f4a6e2f
IKE SPI Responder : 0x33bbea1267703b12
Role : Initiator
Number of Child SA Pairs : 2
Created Timestamp : 2017-09-25 03:02:45
IKE SA Uptime : 163 sec
IKE SA Lifetime : 1000 sec
DPD Probe Interval : 600 sec
IP Address:
Local : 10.112.202.147
Remote : 10.112.200.243
Identity:
Local : [email protected] (email)
Remote : [email protected] (email)
Algorithm:
Encryption : aes128-cbc
Authentication : hmac-sha2
PRF : hmac-sha2
DH Group : 14
Authentication Method : Pre-shared key
VMW Feature Capabilities:
Local : VMW_VENDOR_ID
Remote : VMW_VENDOR_ID
----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IKE security associations in active state.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn ikesa active logical-router d88806dc-0a12-41a5-ab18-fce703027b35
Total Number of Active IKE SAs: 1
IKE Version : IKEv2
IKE Status : Up
IKE Session ID : 2
Session Name : Tunnel-7acc1289-abd44ebf-84fcdf8a-1e541514
Session Type : Policy Based
IKE SPI Initiator : 0x91fb9d4b6d5572e9
IKE SPI Responder : 0x343ca26af10c7513
Role : Initiator
Number of Child SA Pairs : 1
Created Timestamp : 2019-03-19 10:56:05
IKE SA Uptime : 22852 sec
IKE SA Lifetime : 86400 sec
DPD Probe Interval : 60 sec
IP Address:
Local : 192.168.128.1
Remote : 1.1.5.100
Identity:
Local : 192.168.128.1 (ipv4)
Remote : 1.1.5.100 (ipv4)
Algorithm:
Encryption : aes128-cbc
Authentication : hmac-sha2
PRF : hmac-sha2
DH Group : 14
Authentication Method : Pre-shared key
----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IKE security association in active state on given Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <session-id> | IKE Session ID |
Example
nsx-edge-1> get ipsecvpn ikesa active logical-router sessionid 3
Total Number of Active IKE SAs: 1
IKE Version : IKEv2
IKE Status : Up
IKE Session ID : 3
Session Name : Tunnel-62791cf0-7a541cb-915a6e5d-b6ed32f6
Session Type : Policy Based
IKE SPI Initiator : 0x0c6a7a809f4a6e2f
IKE SPI Responder : 0x33bbea1267703b12
Role : Initiator
Number of Child SA Pairs : 2
Created Timestamp : 2017-09-25 03:02:45
IKE SA Uptime : 163 sec
IKE SA Lifetime : 1000 sec
DPD Probe Interval : 600 sec
IP Address:
Local : 10.112.202.147
Remote : 10.112.200.243
Identity:
Local : [email protected] (email)
Remote : [email protected] (email)
Algorithm:
Encryption : aes128-cbc
Authentication : hmac-sha2
PRF : hmac-sha2
DH Group : 14
Authentication Method : Pre-shared key
----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IKE security association in active state.
| Option | Description |
|---|---|
| <session-id> | IKE Session ID |
Example
nsx-edge-1> get ipsecvpn ikesa active sessionid 3
Total Number of Active IKE SAs: 1
IKE Version : IKEv2
IKE Status : Up
IKE Session ID : 3
Session Name : Tunnel-62791cf0-7a541cb-915a6e5d-b6ed32f6
Session Type : Policy Based
IKE SPI Initiator : 0x0c6a7a809f4a6e2f
IKE SPI Responder : 0x33bbea1267703b12
Role : Initiator
Number of Child SA Pairs : 2
Created Timestamp : 2017-09-25 03:02:45
IKE SA Uptime : 163 sec
IKE SA Lifetime : 1000 sec
DPD Probe Interval : 600 sec
IP Address:
Local : 10.112.202.147
Remote : 10.112.200.243
Identity:
Local : [email protected] (email)
Remote : [email protected] (email)
Algorithm:
Encryption : aes128-cbc
Authentication : hmac-sha2
PRF : hmac-sha2
DH Group : 14
Authentication Method : Pre-shared key
----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IKE SAs on given Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn ikesa logical-router
Total Number of IKE SAs: 1
IKE Version : IKEv2
IKE Status : Up
IKE Session ID : 8
Session Name : Tunnel-62791cf0-7a541cb-915a6e5d-b6ed32f6
Session Type : Policy Based
IKE SPI Initiator : 0x0c6a7a809f4a6e2f
IKE SPI Responder : 0x33bbea1267703b12
Role : Initiator
Number of Child SA Pairs : 1
Created Timestamp : 2017-12-21 07:34:58
IKE SA Uptime : 163 sec
IKE SA Lifetime : 1000 sec
DPD Probe Interval : 600 sec
IP Address:
Local : 10.109.24.20
Remote : 10.109.24.22
Identity:
Local : 10.109.24.20 (ipv4)
Remote : 10.109.24.22 (ipv4)
Algorithm:
Encryption : aes128-cbc
Authentication : hmac-sha2
PRF : hmac-sha2
DH Group : 14
Authentication Method : Pre-shared key
--------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display an IKE SA on given Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <session-id> | IKE Session ID |
Example
nsx-edge-1> get ipsecvpn ikesa sessionid 2
Total Number of IKE SAs: 1
IKE Version : IKEv2
IKE Status : Up
IKE Session ID : 2
Session Name : Tunnel-62791cf0-7a541cb-915a6e5d-b6ed32f6
Session Type : Policy Based
IKE SPI Initiator : 0x0c6a7a809f4a6e2f
IKE SPI Responder : 0x33bbea1267703b12
Role : Responder
Number of Child SA Pairs : 1
Created Timestamp : 2017-12-27 20:49:52
IKE SA Uptime : 163 sec
IKE SA Lifetime : 1000 sec
DPD Probe Interval : 600 sec
IP Address:
Local : 10.109.24.20
Remote : 10.109.24.22
Identity:
Local : 10.109.24.20 (ipv4)
Remote : 10.109.24.22 (ipv4)
Algorithm:
Encryption : aes128-cbc
Authentication : hmac-sha2
PRF : hmac-sha2
DH Group : 14
Authentication Method : Pre-shared key
----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IKE security associations in negotiating state.
Example
nsx-edge-1> get ipsecvpn ikesa negotiating
Total Number of Negotiating IKE SAs: 1
IKE Version : IKEv2
IKE Status : Negotiating (SSH_IKEV2_STATE_IKE_INIT_SA)
IKE Session ID : 2
Session Name : Tunnel-62791cf0-7a541cb-915a6e5d-b6ed32f6
Session Type : Policy Based
IKE SPI Initiator : 0x0c6a7a809f4a6e2f
IKE SPI Responder : 0x0
Role : Initiator
Number of Child SA Pairs : 2
IKE SA Lifetime : 0 sec
DPD Probe Interval : 600 sec
IP Address:
Local : 10.112.202.147
Remote : 10.112.200.243
Identity:
Local : Negotiating
Remote : Negotiating
Algorithm:
Encryption : Negotiating
Authentication : Negotiating
PRF : Negotiating
DH Group : Negotiating
Authentication Method : Negotiating
----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IKE security associations in negotiating state.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn ikesa negotiating logical-router 2ea7f52f-11db-4bca-9a8a-4775467806b7
Total Number of Negotiating IKE SAs: 1
IKE Version : IKEv2
IKE Status : Negotiating (IKEV2_STATE_IKE_INIT_SA)
IKE Session ID : 3
Session Name : Tunnel-61fbc9f7-f3134f29-82a0d8a3-58118369
Session Type : Policy Based
IKE SPI Initiator : 0x81c8fe04f0e7040b
IKE SPI Responder : 0x0000000000000000
Role : Initiator
Number of Child SA Pairs : 0
IKE SA Lifetime : 0 sec
DPD Probe Interval : 60 sec
IP Address:
Local : 5.5.5.5
Remote : 1.1.5.1
Identity:
Local : Negotiating
Remote : Negotiating
Algorithm:
Encryption : Negotiating
Authentication : Negotiating
PRF : Negotiating
DH Group : Negotiating
Authentication Method : Negotiating
----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
get ipsecvpn ikesa negotiating logical-router <uuid-string-arg> sessionid <ipsec-vpn-session-id-arg>
Display IKE security association in negotiating state.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <session-id> | IKE Session ID |
Example
nsx-edge-1> get ipsecvpn ikesa negotiating logical-router sessionid 2
Total Number of Negotiating IKE SAs: 1
IKE Version : IKEv2
IKE Status : Negotiating (SSH_IKEV2_STATE_IKE_INIT_SA)
IKE Session ID : 2
Session Name : Tunnel-62791cf0-7a541cb-915a6e5d-b6ed32f6
Session Type : Policy Based
IKE SPI Initiator : 0x0c6a7a809f4a6e2f
IKE SPI Responder : 0x0
Role : Initiator
Number of Child SA Pairs : 2
IKE SA Lifetime : 0 sec
DPD Probe Interval : 600 sec
IP Address:
Local : 10.112.202.147
Remote : 10.112.200.243
Identity:
Local : Negotiating
Remote : Negotiating
Algorithm:
Encryption : Negotiating
Authentication : Negotiating
PRF : Negotiating
DH Group : Negotiating
Authentication Method : Negotiating
----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IKE security association in negotiating state.
| Option | Description |
|---|---|
| <session-id> | IKE Session ID |
Example
nsx-edge-1> get ipsecvpn ikesa negotiating sessionid 2
Total Number of Negotiating IKE SAs: 1
IKE Version : IKEv2
IKE Status : Negotiating (SSH_IKEV2_STATE_IKE_INIT_SA)
IKE Session ID : 2
Session Name : Tunnel-62791cf0-7a541cb-915a6e5d-b6ed32f6
Session Type : Policy Based
IKE SPI Initiator : 0x0c6a7a809f4a6e2f
IKE SPI Responder : 0x0
Role : Initiator
Number of Child SA Pairs : 2
IKE SA Lifetime : 0 sec
DPD Probe Interval : 600 sec
IP Address:
Local : 10.112.202.147
Remote : 10.112.200.243
Identity:
Local : Negotiating
Remote : Negotiating
Algorithm:
Encryption : Negotiating
Authentication : Negotiating
PRF : Negotiating
DH Group : Negotiating
Authentication Method : Negotiating
----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display an IKE SA.
| Option | Description |
|---|---|
| <session-id> | IKE Session ID |
Example
nsx-edge-1> get ipsecvpn ikesa sessionid 2
Total Number of IKE SAs: 1
IKE Version : IKEv2
IKE Status : Up
IKE Session ID : 2
Session Name : Tunnel-62791cf0-7a541cb-915a6e5d-b6ed32f6
Session Type : Policy Based
IKE SPI Initiator : 0x0c6a7a809f4a6e2f
IKE SPI Responder : 0x33bbea1267703b12
Role : Responder
Number of Child SA Pairs : 1
Created Timestamp : 2017-12-27 20:49:52
IKE SA Uptime : 163 sec
IKE SA Lifetime : 1000 sec
DPD Probe Interval : 600 sec
IP Address:
Local : 10.109.24.20
Remote : 10.109.24.22
Identity:
Local : 10.109.24.20 (ipv4)
Remote : 10.109.24.22 (ipv4)
Algorithm:
Encryption : aes128-cbc
Authentication : hmac-sha2
PRF : hmac-sha2
DH Group : 14
Authentication Method : Pre-shared key
----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPSec SAs from control plane.
Example
nsx-edge-1> get ipsecvpn ipsecsa
Total Number of IPSec SA Pairs: 3
Session ID : 2
Created Timestamp : 2018-04-10 03:58:33
Local TS : ipv4(192.168.2.0-192.168.2.255)
Remote TS : ipv4(172.16.2.0-172.16.2.255)
SPI In : 0xd03e65b0 SPI Out : 0xcbebe1e9
Rule ID In : 22 Rule ID Out : 2147483670
SA Uptime : 184 sec SA Lifetime : 1200 sec
Local Endpoint : 10.0.0.1 Remote Endpoint: 10.1.0.1
Algorithm: aes128-cbc/hmac-sha2/14
NAT-T: False, ESN: False, DF-Policy: Copy
Anti-Replay Window Size: 960, Role: Initiator
Best Paths : 2
Path 1 : 5000 -> 4500
Path 3 : 5002 -> 4500
Session ID : 3
Created Timestamp : 2022-01-17 21:54:49
Local TS : ipv6(::-ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff)
Remote TS : ipv6(::-ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff)
SPI In : 0xe7e31100 SPI Out : 0xc9e75e32
Rule ID In : 1030 Rule ID Out : 2147484678
SA Uptime : 234 sec SA Lifetime : 1200 sec
Local Endpoint : 2004::1 Remote Endpoint: 2003::1
Algorithm: aes128-cbc/hmac-sha2
NAT-T: False, ESN: False, DF-Policy: Copy
Anti-Replay Window Size: 960, Role: Initiator
Session ID : 4
Created Timestamp : 2022-01-17 03:51:48
Local TS : ipv6(2010:50:56ff:fe56::-2010:50:56ff:fe56:ffff:ffff:ffff:ffff)
Remote TS : ipv6(3010:50:56ff:fe56::-3010:50:56ff:fe56:ffff:ffff:ffff:ffff)
SPI In : 0x619a9300 SPI Out : 0xc45d36d5
Rule ID In : 1029 Rule ID Out : 2147484677
SA Uptime : 232 sec SA Lifetime : 1200 sec
Local Endpoint : 2001::1 Remote Endpoint: 2002::1
Algorithm: aes128-cbc/hmac-sha2
NAT-T: False, ESN: False, DF-Policy: Copy
Anti-Replay Window Size: 960, Role: Initiator
-----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPSec SAs from control plane.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn ipsecsa logical-router d88806dc-0a12-41a5-ab18-fce703027b35
Total Number of IPSec SA Pairs: 1
Session ID : 2
Created Timestamp : 2018-04-10 03:58:33
Local TS : ipv4(192.168.2.0-192.168.2.255)
Remote TS : ipv4(172.16.2.0-172.16.2.255)
SPI In : 0xd03e65b0 SPI Out : 0xcbebe1e9
Rule ID In : 22 Rule ID Out : 2147483670
SA Uptime : 184 sec SA Lifetime : 1200 sec
Local Endpoint : 10.0.0.1 Remote Endpoint: 10.1.0.1
Algorithm: aes128-cbc/hmac-sha2/14
NAT-T: False, ESN: False, DF-Policy: Copy
Anti-Replay Window Size: 960, Role: Initiator
----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec SA with specific rule id from control plane.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <rule-id> | Rule ID |
Example
nsx-edge-1> get ipsecvpn ipsecsa ruleid 22
Total Number of IPSec SA Pairs: 1
Session ID : 2
Created Timestamp : 2018-04-10 03:58:33
Local TS : ipv4(192.168.2.0-192.168.2.255)
Remote TS : ipv4(172.16.2.0-172.16.2.255)
SPI In : 0xd03e65b0 SPI Out : 0xcbebe1e9
Rule ID In : 22 Rule ID Out : 2147483670
SA Uptime : 184 sec SA Lifetime : 1200 sec
Local Endpoint : 10.0.0.1 Remote Endpoint: 10.1.0.1
Algorithm: aes128-cbc/hmac-sha2/14
NAT-T: False, ESN: False, DF-Policy: Copy
Anti-Replay Window Size: 960, Role: Initiator
----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display an IPSec SA with specific session id from control plane.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <session-id> | IKE Session ID |
Example
nsx-edge-1> get ipsecvpn ipsecsa logical-router sessionid 2
Total Number of IPSec SA Pairs: 1
Session ID : 2
Created Timestamp : 2018-04-10 03:58:33
Local TS : ipv4(192.168.2.0-192.168.2.255)
Remote TS : ipv4(172.16.2.0-172.16.2.255)
SPI In : 0xd03e65b0 SPI Out : 0xcbebe1e9
Rule ID In : 22 Rule ID Out : 2147483670
SA Uptime : 184 sec SA Lifetime : 1200 sec
Local Endpoint : 10.0.0.1 Remote Endpoint: 10.1.0.1
Algorithm: aes128-cbc/hmac-sha2/14
NAT-T: False, ESN: False, DF-Policy: Copy
Anti-Replay Window Size: 960, Role: Initiator
----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec SA with specific rule id from control plane.
| Option | Description |
|---|---|
| <rule-id> | Rule ID |
Example
nsx-edge-1> get ipsecvpn ipsecsa ruleid 22
Total Number of IPSec SA Pairs: 1
Session ID : 2
Created Timestamp : 2018-04-10 03:58:33
Local TS : ipv4(192.168.2.0-192.168.2.255)
Remote TS : ipv4(172.16.2.0-172.16.2.255)
SPI In : 0xd03e65b0 SPI Out : 0xcbebe1e9
Rule ID In : 22 Rule ID Out : 2147483670
SA Uptime : 184 sec SA Lifetime : 1200 sec
Local Endpoint : 10.0.0.1 Remote Endpoint: 10.1.0.1
Algorithm: aes128-cbc/hmac-sha2/14
NAT-T: False, ESN: False, DF-Policy: Copy
Anti-Replay Window Size: 960, Role: Initiator
----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display an IPSec SA with specific session id from control plane.
| Option | Description |
|---|---|
| <session-id> | IKE Session ID |
Example
nsx-edge-1> get ipsecvpn ipsecsa sessionid 2
Total Number of IPSec SA Pairs: 1
Session ID : 2
Created Timestamp : 2018-04-10 03:58:33
Local TS : ipv4(192.168.2.0-192.168.2.255)
Remote TS : ipv4(172.16.2.0-172.16.2.255)
SPI In : 0xd03e65b0 SPI Out : 0xcbebe1e9
Rule ID In : 22 Rule ID Out : 2147483670
SA Uptime : 184 sec SA Lifetime : 1200 sec
Local Endpoint : 10.0.0.1 Remote Endpoint: 10.1.0.1
Algorithm: aes128-cbc/hmac-sha2/14
NAT-T: False, ESN: False, DF-Policy: Copy
Anti-Replay Window Size: 960, Role: Initiator
----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all active MultiPath Groups information.
Example
nsx-edge-1> get ipsecvpn multi-path-group
UUID : a8f5f7e8-2081-405b-93de-6eeff3f449f2
Enabled : True
Probe Config :
Packets Per Probe Path : 30
Probe Start Port : 5001
Source Port Pool Size : 4
Probe Cycle Interval : 90 sec
Probe Cycle Duration : 40 sec
Probe Request Interval : 1 sec
Scheme : Threshold_Based
Scheme Value : 81
Probe State : PROBE_REQUEST_INTERVAL_TIMER
Current Probe Cycle : 28
Current Probe Packet : 1
Active MultiPath Tunnels : 1
Tunnel ID : 8193
Probe Result :
Probe Cycle : 27
Result Time : 29-Jan-2021 11:49:48
Best Paths : 4
Path 1 : 5001->4500
Path 2 : 5002->4500
Path 3 : 5003->4500
Path 4 : 5004->4500
Mode
Basic
Availability
Autonomous Edge, Edge
Display active MultiPath Group information.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn multi-path-group a8f5f7e8-2081-405b-93de-6eeff3f449f2
Enabled : True
Probe Config :
Packets Per Probe Path : 30
Probe Start Port : 5001
Source Port Pool Size : 4
Probe Cycle Interval : 90 sec
Probe Cycle Duration : 40 sec
Probe Request Interval : 1 sec
Scheme : Threshold_Based
Scheme Value : 81
Probe State : PROBE_REQUEST_INTERVAL_TIMER
Current Probe Cycle : 28
Current Probe Packet : 1
Active MultiPath Tunnels : 1
Tunnel ID : 8193
Probe Result :
Probe Cycle : 27
Result Time : 29-Jan-2021 11:49:48
Best Paths : 4
Path 1 : 5001->4500
Path 2 : 5002->4500
Path 3 : 5003->4500
Path 4 : 5004->4500
Probe Cycle : 27
Result Time : 29-Jan-2021 11:49:48
Best Paths : 4
Path 1 : 5001->4500
Path 2 : 5002->4500
Path 3 : 5003->4500
Path 4 : 5004->4500
Mode
Basic
Availability
Autonomous Edge, Edge
Display active MultiPath tunnels probe history information.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn multi-path-group a8f5f7e8-2081-405b-93de-6eeff3f449f2 probe history
Tunnel ID : 8193
Probe Cycle : 29
Result Time : 29-Jan-2021 12:00:03
Best Paths : 2
Path 1 : 5001->4500
Path 2 : 5002->4500
Probe Cycle : 28
Result Time : 29-Jan-2021 11:57:23
Best Paths : 4
Path 1 : 5001->4500
Path 2 : 5002->4500
Path 3 : 5003->4500
Path 4 : 5004->4500
Mode
Basic
Availability
Autonomous Edge, Edge
Display active MultiPath group probe statistics.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn multi-path-group a8f5f7e8-2081-405b-93de-6eeff3f449f2 probe stats
Number of Probe Cycle : 30
Active MultiPath Tunnels : 1
Probe Requests : Probe Responses :
Received : 176 Received : 40
Sent : 48 Sent : 176
Dropped : 0 Dropped : 0
Probe Errors : 0 Probe Timeouts : 256
Mode
Basic
Availability
Autonomous Edge, Edge
Display active MultiPath Group verbose information.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn multi-path-group a8f5f7e8-2081-405b-93de-6eeff3f449f2 verbose
Enabled : True
Probe Config :
Packets Per Probe Path : 30
Probe Start Port : 5001
Source Port Pool Size : 4
Probe Cycle Interval : 90 sec
Probe Cycle Duration : 40 sec
Probe Request Interval : 1 sec
Scheme : Threshold_Based
Scheme Value : 81
Probe State : PROBE_REQUEST_INTERVAL_TIMER
Current Probe Cycle : 28
Current Probe Packet : 30
Active MultiPath Tunnels : 1
Tunnel ID : 8193
Number of IKE SAs : 1
Initiate Probe : True
Probe Paths : 4
Path Probe Path Rx Tx
Index Port Metric Probe Rsp Probe Req
1 5001 1090 30 30
2 5002 1090 30 30
3 5003 1090 30 30
4 5004 1090 30 30
Probe Result :
Probe Cycle : 27
Result Time : 19-Mar-2021 10:26:09
Threshold Metric : 1513.88888889
Best Paths : 4
Path 1 : 5001->4500
Path 2 : 5002->4500
Path 3 : 5003->4500
Path 4 : 5004->4500
Mode
Basic
Availability
Autonomous Edge, Edge
Display all active MultiPath tunnels probe history information.
Example
nsx-edge-1> get ipsecvpn multi-path-group probe history
Thu Jan 07 2021 PST 23:56:36.841
UUID : a8f5f7e8-2081-405b-93de-6eeff3f449f2
Tunnel ID : 8193
Probe Cycle : 29
Result Time : 29-Jan-2021 12:00:03
Best Paths : 2
Path 1 : 5001->4500
Path 2 : 5002->4500
Probe Cycle : 28
Result Time : 29-Jan-2021 11:57:23
Best Paths : 4
Path 1 : 5001->4500
Path 2 : 5002->4500
Path 3 : 5003->4500
Path 4 : 5004->4500
Mode
Basic
Availability
Autonomous Edge, Edge
Display all active MultiPath group probe statistics.
Example
nsx-edge-1> get ipsecvpn multi-path-group probe stats
UUID : a8f5f7e8-2081-405b-93de-6eeff3f449f2
Number of Probe Cycle : 30
Active MultiPath Tunnels : 1
Probe Requests : Probe Response :
Received : 176 Received : 40
Sent : 48 Sent : 176
Dropped : 0 Dropped : 0
Probe Errors : 0 Probe Timeouts : 256
Mode
Basic
Availability
Autonomous Edge, Edge
Display all active MultiPath Groups verbose information.
Example
nsx-edge-1> get ipsecvpn multi-path-group verbose
UUID : a8f5f7e8-2081-405b-93de-6eeff3f449f2
Enabled : True
Probe Config :
Packets Per Probe Path : 30
Probe Start Port : 5001
Source Port Pool Size : 4
Probe Cycle Interval : 90 sec
Probe Cycle Duration : 40 sec
Probe Request Interval : 1 sec
Scheme : Threshold_Based
Scheme Value : 81
Probe State : PROBE_REQUEST_INTERVAL_TIMER
Current Probe Cycle : 28
Current Probe Packet : 30
Active MultiPath Tunnels : 1
Tunnel ID : 8193
Number of IKE SAs : 1
Initiate Probe : True
Probe Paths : 4
Path Probe Path Rx Tx
Index Port Metric Probe Rsp Probe Req
1 5001 1090 30 30
2 5002 1090 30 30
3 5003 1090 30 30
4 5004 1090 30 30
Probe Result :
Probe Cycle : 27
Result Time : 19-Mar-2021 10:26:09
Threshold Metric : 1513.88888889
Best Paths : 4
Path 1 : 5001->4500
Path 2 : 5002->4500
Path 3 : 5003->4500
Path 4 : 5004->4500
Probe Cycle : 27
Result Time : 29-Jan-2021 11:49:48
Best Paths : 4
Path 1 : 5001->4500
Path 2 : 5002->4500
Path 3 : 5003->4500
Path 4 : 5004->4500
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPSec VPN policy rules.
Example
nsx-edge-1> get ipsecvpn policy
UUID : 00000000-0000-0000-0000-00000000000c
Rule :
ID : 1
Action : RA_ENCRYPT
Applied TO :
Logical Router Port : 00000000-0000-0000-0000-00000000000c
Component Name : CN_IKE
Direction : RD_OUT
From Address :
IP Address :
Ipv4 : 10.109.24.20
Prefix Length : 32
IS Stateful : True
Keypolicy ID : 00000000-0000-0000-0000-00000000000b
Lbrule : False
Priority : 10
Protocol :
DST Ports :
Range :
SRC Ports :
Range :
Section ID : 00000000-0000-0003-0000-000000000005
TAG : ipsec
TO Address :
IP Address :
Ipv4 : 10.109.24.22
Prefix Length : 32
Type : RT_LAYER3
Uuid : 00000000-0000-0000-0000-00000000000c
UUID : 00000000-0000-0000-0000-00000000000d
Rule :
ID : 1
Action : RA_ENCRYPT
Applied TO :
Logical Router Port : 00000000-0000-0000-0000-00000000000c
Component Name : CN_IKE
Direction : RD_IN
From Address :
IP Address :
Ipv4 : 10.109.24.22
Prefix Length : 32
IS Stateful : True
Keypolicy ID : 00000000-0000-0000-0000-00000000000b
Lbrule : False
Priority : 10
Protocol :
DST Ports :
Range :
SRC Ports :
Range :
Section ID : 00000000-0000-0003-0000-000000000005
TAG : ipsec
TO Address :
IP Address :
Ipv4 : 10.109.24.20
Prefix Length : 32
Type : RT_LAYER3
Uuid : 00000000-0000-0000-0000-00000000000d
UUID : 00000000-0000-0000-0000-040500000000
LOG Router ID : 00000000-0000-000a-0000-000000000000
Rule :
ID : 1029
Action : RA_ENCRYPT
Applied TO :
Container : 00001000-0000-0000-0000-000000000001
Component Name : CN_IKE
Direction : RD_OUT
From Address :
IP Address :
Ipv6 : 2010:50:56ff:fe56::
Prefix Length : 64
IS Stateful : True
Keypolicy ID : 00000000-0000-0000-0000-040500000000
Lbrule : False
Priority : 100
Protocol :
DST Ports :
Range :
SRC Ports :
Range :
Section ID : 00000000-0000-0000-0000-000000000012
TAG : ipsec
TO Address :
IP Address :
Ipv6 : 3010:50:56ff:fe56::
Prefix Length : 64
Type : RT_LAYER3
Uuid : 00000000-0000-0000-0000-040500000000
UUID : 00000000-0000-0000-8000-040500000000
LOG Router ID : 00000000-0000-000a-0000-000000000000
Rule :
ID : 2147484677
Action : RA_ENCRYPT
Applied TO :
Container : 00001000-0000-0000-0000-000000000001
Component Name : CN_IKE
Direction : RD_IN
From Address :
IP Address :
Ipv6 : 3010:50:56ff:fe56::
Prefix Length : 64
IS Stateful : True
Keypolicy ID : 00000000-0000-0000-0000-040500000000
Lbrule : False
Priority : 100
Protocol :
DST Ports :
Range :
SRC Ports :
Range :
Section ID : 00000000-0000-0000-0000-000000000012
TAG : ipsec
TO Address :
IP Address :
Ipv6 : 2010:50:56ff:fe56::
Prefix Length : 64
Type : RT_LAYER3
Uuid : 00000000-0000-0000-8000-040500000000
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPSec VPN policy rules for a LogicalRouter.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn policy logical-router d88806dc-0a12-41a5-ab18-fce703027b35
UUID : 00003400-0000-0402-0000-040300000000
LOG Router ID : d88806dc-0a12-41a5-ab18-fce703027b35
Rule :
ID : 1027
Action : RA_ENCRYPT
Applied TO :
Container : 00001000-0000-0000-0000-000000000001
Component Name : CN_IKE
Direction : RD_OUT
From Address :
IP Address :
Ipv4 : 192.168.100.0
Prefix Length : 24
IS Stateful : True
Keypolicy ID : 00003400-0000-0402-0000-040300000000
Lbrule : False
Priority : 100
Protocol :
DST Ports :
Range :
SRC Ports :
Range :
Section ID : 00003500-0000-0000-0000-000000000001
TAG : ipsec
TO Address :
IP Address :
Ipv4 : 2.2.5.0
Prefix Length : 24
Type : RT_LAYER3
Uuid : 00003400-0000-0402-0000-040300000000
UUID : 00003400-0000-0402-8000-040300000000
LOG Router ID : d88806dc-0a12-41a5-ab18-fce703027b35
Rule :
ID : 2147484675
Action : RA_ENCRYPT
Applied TO :
Container : 00001000-0000-0000-0000-000000000001
Component Name : CN_IKE
Direction : RD_IN
From Address :
IP Address :
Ipv4 : 2.2.5.0
Prefix Length : 24
IS Stateful : True
Keypolicy ID : 00003400-0000-0402-0000-040300000000
Lbrule : False
Priority : 100
Protocol :
DST Ports :
Range :
SRC Ports :
Range :
Section ID : 00003500-0000-0000-0000-000000000001
TAG : ipsec
Mode
Basic
Availability
Autonomous Edge, Edge
Display an IPSec policy rule for a LogicalRouter.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn policy logical-router d88806dc-0a12-41a5-ab18-fce703027b35
rules 00003400-0000-0402-8000-040300000000
UUID : 00003400-0000-0402-8000-040300000000
LOG Router ID : d88806dc-0a12-41a5-ab18-fce703027b35
Rule :
ID : 2147484675
Action : RA_ENCRYPT
Applied TO :
Container : 00001000-0000-0000-0000-000000000001
Component Name : CN_IKE
Direction : RD_IN
From Address :
IP Address :
Ipv4 : 2.2.5.0
Prefix Length : 24
IS Stateful : True
Keypolicy ID : 00003400-0000-0402-0000-040300000000
Lbrule : False
Priority : 100
Protocol :
DST Ports :
Range :
SRC Ports :
Range :
Section ID : 00003500-0000-0000-0000-000000000001
TAG : ipsec
TO Address :
IP Address :
Ipv4 : 192.168.100.0
Prefix Length : 24
Type : RT_LAYER3
Uuid : 00003400-0000-0402-8000-040300000000
Mode
Basic
Availability
Autonomous Edge, Edge
Display an IPSec policy rule.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn policy rules 00000000-0000-0000-0000-00000000000c
Rule :
ID : 1
Action : RA_ENCRYPT
Applied TO :
Logical Router Port : 00000000-0000-0000-0000-00000000000c
Component Name : CN_IKE
Direction : RD_OUT
From Address :
IP Address :
Ipv4 : 10.109.24.20
Prefix Length : 32
IS Stateful : True
Keypolicy ID : 00000000-0000-0000-0000-00000000000b
Lbrule : False
Priority : 10
Protocol :
DST Ports :
Range :
SRC Ports :
Range :
Section ID : 00000000-0000-0003-0000-000000000005
TAG : ipsec
TO Address :
IP Address :
Ipv4 : 10.109.24.22
Prefix Length : 32
Type : RT_LAYER3
Uuid : 00000000-0000-0000-0000-00000000000c
Mode
Basic
Availability
Autonomous Edge, Edge
Display summary of IPSec VPN policy rules.
Example
nsx-edge-1> get ipsecvpn policy summary
IPSec Security Policy count: 4
RuleId Dir Local Subnet Peer Subnet Action UUID
------------------------------------------------------------------------------------------------------------------------
1027 Out 192.168.100.0/24 2.2.5.0/24 Encrypt 00003400-0000-0402-0000-040300000000
2147484675 In 2.2.5.0/24 192.168.100.0/24 Encrypt 00003400-0000-0402-8000-040300000000
1032 Out 192.168.100.1/32 2.2.5.1/32 Bypass 00003400-0000-0407-0000-040800000000
2147484680 In 2.2.5.1/32 192.168.100.1/32 Bypass 00003400-0000-0407-8000-040800000000
1029 Out 2010:50:56ff:fe56::/64 3010:50:56ff:fe56::/64 Encrypt 00000000-0000-0000-0000-040500000000
2147484677 In 3010:50:56ff:fe56::/64 2010:50:56ff:fe56::/64 Encrypt 00000000-0000-0000-8000-040500000000
------------------------------------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display summary of IPSec VPN policy rules per logical router
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn policy summary logical-router a30de0cc-ff8d-47bb-a79b-d0104522bf05
IPSec Security Policy count: 2
RuleId Dir Local Subnet Peer Subnet Action UUID
------------------------------------------------------------------------------------------------------------------------
536870920 Out 192.168.2.0/24 192.168.7.0/24 Encrypt 00003400-2000-0002-2000-000800000000
2684354568 In 192.168.7.0/24 192.168.2.0/24 Encrypt 00003400-2000-0002-a000-000800000000
------------------------------------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPSec SAs present in Security Association Database(datapath).
Example
nsx-edge-1> get ipsecvpn sad
Total Number of IPSec SAs: 2
Inbound SAs:
Rule ID : 2147484675
Policy UUID : 00003400-0000-0800-0000-080b00000000
VRF ID : 1
SPI : 0xf835f82a
Created Timestamp : 2018-03-19 10:24:21
SA Uptime : 496 sec
SA Lifetime : 3600 sec
NAT-Traversal : False
ESN : False
DF Policy : clear
SA Hit : 1
Sequence Number (Recv) : 1234
Anti-Replay Window Size : 960
TCP MSS Value : 1350
Traffic Mode : Tunnel
Protocol : ESP
IP Address:
Source : 1.1.5.100
Destination : 192.168.128.1
Subnets:
Source : 2.2.5.0/24
Destination : 192.168.100.0/24
Algorithm:
Encryption : aes-128-cbc
Authentication : sha256-hmac
Multi-Path : Enabled
Path Index 0 : Seq Num (1)
Path Index 1 : Seq Num (3)
Path Index 2 : Seq Num (21)
Path Index 3 : Seq Num (10)
Path Index 4 : Seq Num (22)
Path Index 5 : Seq Num (4)
Path Index 6 : Seq Num (6)
Path Index 7 : Seq Num (0)
----------------------------------------
Outbound SAs:
Rule ID : 1027
Policy UUID : 00003400-0000-0800-0000-080b00000000
VRF ID : 1
SPI : 0xc3f194fa
Created Timestamp : 2018-03-19 10:24:21
SA Uptime : 496 sec
SA Lifetime : 3600 sec
NAT-Traversal : False
ESN : False
DF Policy : clear
SA Hit : 1
Sequence Number (Sent) : 1234
Anti-Replay Window Size : 960
TCP MSS Value : 1350
Traffic Mode : Tunnel
Protocol : ESP
IP Address:
Source : 192.168.128.1
Destination : 1.1.5.100
Subnets:
Source : 192.168.100.0/24
Destination : 2.2.5.0/24
Algorithm:
Encryption : aes-128-cbc
Authentication : sha256-hmac
Multi-Path : Enabled
Default Path : 4500->4500 (Seq Num : 0)
Active Paths : 4
Path Index 1 : 4500->5001 (Seq Num : 0)
Path Index 2 : 4500->5002 (Seq Num : 0)
Path Index 3 : 4500->5003 (Seq Num : 0)
Path Index 4 : 4500->5004 (Seq Num : 0)
----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec SA present in Security Association Database(datapath).
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn sad 00003400-0000-0402-0000-040300000000
Total Number of IPSec SAs: 2
Inbound SAs:
Rule ID : 2147484675
Policy UUID : 00003400-0000-0800-0000-080b00000000
VRF ID : 1
SPI : 0xf835f82a
Created Timestamp : 2018-03-19 10:24:21
SA Uptime : 496 sec
SA Lifetime : 3600 sec
NAT-Traversal : False
ESN : False
DF Policy : clear
SA Hit : 1
Sequence Number (Recv) : 1234
Anti-Replay Window Size : 960
TCP MSS Value : 1350
Traffic Mode : Tunnel
Protocol : ESP
IP Address:
Source : 1.1.5.100
Destination : 192.168.128.1
Subnets:
Source : 2.2.5.0/24
Destination : 192.168.100.0/24
Algorithm:
Encryption : aes-128-cbc
Authentication : sha256-hmac
Multi-Path : Disabled
----------------------------------------
Outbound SAs:
Rule ID : 1027
Policy UUID : 00003400-0000-0800-0000-080b00000000
VRF ID : 1
SPI : 0xc3f194fa
Created Timestamp : 2018-03-19 10:24:21
SA Uptime : 496 sec
SA Lifetime : 3600 sec
NAT-Traversal : False
ESN : False
DF Policy : clear
SA Hit : 1
Sequence Number (Sent) : 1234
Anti-Replay Window Size : 960
TCP MSS Value : 1350
Traffic Mode : Tunnel
Protocol : ESP
IP Address:
Source : 192.168.128.1
Destination : 1.1.5.100
Subnets:
Source : 192.168.100.0/24
Destination : 2.2.5.0/24
Algorithm:
Encryption : aes-128-cbc
Authentication : sha256-hmac
Multi-Path : Disabled
----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec SA present in Security Association Database(datapath).
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn sad logical-router d88806dc-0a12-41a5-ab18-fce703027b35
Total Number of IPSec SAs: 2
Inbound SAs:
Rule ID : 2147484675
Policy UUID : 00003400-0000-0800-0000-080b00000000
VRF ID : 2
SPI : 0x7bbde976
Created Timestamp : 2019-03-19 16:16:12
SA Uptime : 37 sec
SA Lifetime : 3600 sec
NAT-Traversal : False
ESN : False
DF Policy : clear
SA Hit : 0
Sequence Number (Recv) : 0
Anti-Replay Window Size : 960
TCP MSS Value : 0
Traffic Mode : Tunnel
Protocol : ESP
IP Address:
Source : 1.1.5.100
Destination : 192.168.128.1
Subnets:
Source : 2.2.5.0/24
Destination : 192.168.100.0/24
Algorithm:
Encryption : aes-128-cbc
Authentication : sha256-hmac
Multi-Path : Enabled
Path Index 0 : Seq Num (1)
Path Index 1 : Seq Num (10)
Path Index 2 : Seq Num (21)
Path Index 3 : Seq Num (20)
Path Index 4 : Seq Num (40)
Path Index 5 : Seq Num (6)
Path Index 6 : Seq Num (0)
Path Index 7 : Seq Num (0)
----------------------------------------
Outbound SAs:
Rule ID : 1027
Policy UUID : 00003400-0000-0800-0000-080b00000000
VRF ID : 2
SPI : 0xc9813c88
Created Timestamp : 2019-03-19 16:16:12
SA Uptime : 37 sec
SA Lifetime : 3600 sec
NAT-Traversal : False
ESN : False
DF Policy : clear
SA Hit : 0
Sequence Number (Sent) : 0
Anti-Replay Window Size : 960
TCP MSS Value : 0
Traffic Mode : Tunnel
Protocol : ESP
IP Address:
Source : 192.168.128.1
Destination : 1.1.5.100
Subnets:
Source : 192.168.100.0/24
Destination : 2.2.5.0/24
Algorithm:
Encryption : aes-128-cbc
Authentication : sha256-hmac
Multi-Path : Enabled
Default Path : 4500->4500 (Seq Num : 0)
----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec SA present in Security Association Database(datapath).
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn sad session 4414bbb7-401f-4fbf-9c8f-6253e90104c2
Total Number of IPSec SAs: 2
Outbound SAs:
Rule ID : 305634502
Policy UUID : fdc19389-518b-4f3c-9237-9cc6781ac0b5
VRF ID : 1
SPI : 0xcb5289fb
Created Timestamp : 2022-05-30 03:49:40
SA Uptime : 2662 sec
SA Lifetime : 3600 sec
NAT-Traversal : False
ESN : False
DF Policy : copy
SA Hit : 1
Sequence Number (Sent) : 13293
Anti-Replay Window Size : 960
TCP MSS Value : 0
Traffic Mode : Tunnel
Protocol : ESP
IP Address:
Source : 192.168.50.100
Destination : 20.20.20.101
Algorithm:
Encryption : aes-128-cbc
Authentication : sha256-hmac
Multi-Path : Disabled
----------------------------------------
Inbound SAs:
Rule ID : 2453118150
Policy UUID : fdc19389-518b-4f3c-9237-9cc6781ac0b5
VRF ID : 1
SPI : 0xeafaee00
Created Timestamp : 2022-05-30 03:49:40
SA Uptime : 2662 sec
SA Lifetime : 3600 sec
NAT-Traversal : False
ESN : False
DF Policy : copy
SA Hit : 1
Sequence Number (Recv) : 11664
Anti-Replay Window Size : 960
TCP MSS Value : 0
Traffic Mode : Tunnel
Protocol : ESP
IP Address:
Source : 20.20.20.101
Destination : 192.168.50.100
Algorithm:
Encryption : aes-128-cbc
Authentication : sha256-hmac
Multi-Path : Disabled
----------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display summary of all IPSec SAs present in Security Association Database(datapath).
Example
nsx-edge-1> get ipsecvpn sad summary
Outbound SAs (8):
----------------------------------------------------------------------------------------------------------------------------
VRF Rule ID Src IP Dest IP Src Subnet Dest Subnet SPI NAT Rem Life
----------------------------------------------------------------------------------------------------------------------------
1 536870916 192.168.125.1 1.1.5.100 192.168.101.0/24 192.168.1.0/24 0xc168f0ae N 1939 sec
1 536870914 192.168.125.1 1.1.5.100 192.168.100.0/24 192.168.1.0/24 0xcb2975e6 N 2310 sec
3 536870922 192.168.225.1 1.1.7.100 192.168.201.0/24 192.168.10.0/24 0xcab4429c N 3520 sec
3 536870920 192.168.225.1 1.1.7.100 192.168.200.0/24 192.168.10.0/24 0xc75fa5bc N 1068 sec
3 536870919 192.168.225.1 1.1.7.100 192.168.200.0/24 192.168.9.0/24 0xcd1139a0 N 1273 sec
1 536870915 192.168.125.1 1.1.5.100 192.168.100.0/24 192.168.2.0/24 0xc1377743 N 2865 sec
1 536870917 192.168.125.1 1.1.5.100 192.168.101.0/24 192.168.2.0/24 0xc952aaf9 N 2361 sec
3 536870921 192.168.225.1 1.1.7.100 192.168.201.0/24 192.168.9.0/24 0xc603a5f8 N 1541 sec
Inbound SAs (8):
----------------------------------------------------------------------------------------------------------------------------
VRF Rule ID Src IP Dest IP Src Subnet Dest Subnet SPI NAT Rem Life
----------------------------------------------------------------------------------------------------------------------------
1 2684354562 1.1.5.100 192.168.125.1 192.168.1.0/24 192.168.100.0/24 0xe301cd82 N 2310 sec
3 2684354567 1.1.7.100 192.168.225.1 192.168.9.0/24 192.168.200.0/24 0x1688744e N 1273 sec
3 2684354570 1.1.7.100 192.168.225.1 192.168.10.0/24 192.168.201.0/24 0x935893c N 3520 sec
1 2684354564 1.1.5.100 192.168.125.1 192.168.1.0/24 192.168.101.0/24 0x9e0cd678 N 1939 sec
1 2684354563 1.1.5.100 192.168.125.1 192.168.2.0/24 192.168.100.0/24 0x4d9bc8c4 N 2865 sec
3 2684354568 1.1.7.100 192.168.225.1 192.168.10.0/24 192.168.200.0/24 0xb365fa42 N 1068 sec
1 2684354565 1.1.5.100 192.168.125.1 192.168.2.0/24 192.168.101.0/24 0x3f14c2aa N 2361 sec
3 2684354569 1.1.7.100 192.168.225.1 192.168.9.0/24 192.168.201.0/24 0xd7f3416e N 1541 sec
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPSec Services Information.
Example
nsx-edge-1> get ipsecvpn service
Service ID: 3bfc5972-1cb7-43cf-a646-529473981971
Service State: Not Active Enabled:No Down Reason: VPN service disabled
SR ID : d88806dc-0a12-41a5-ab18-fce703027b35 SR State : Active
HA Sync Enabled: Yes
----------------------------------------------------------------------
Service ID: acaba146-31f7-4b35-bc19-f3055ea93db0
Service State: Active Enabled: Yes
SR ID : 2ea7f52f-11db-4bca-9a8a-4775467806b7 SR State : Active
HA Sync Enabled: Yes
----------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec Service Information.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn service
Service ID: acaba146-31f7-4b35-bc19-f3055ea93db0
Service State: Active Enabled: Yes
SR ID : 2ea7f52f-11db-4bca-9a8a-4775467806b7 SR State : Active
HA Sync Enabled: Yes
----------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPSec Service Information in detail.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn service verbose
Service ID: acaba146-31f7-4b35-bc19-f3055ea93db0
Service State: Active Enabled: Yes
SR ID : 2ea7f52f-11db-4bca-9a8a-4775467806b7 SR State : Active
HA Sync Enabled: Yes
Bypass Policies
Policy UUID: 00003400-0000-0404-0000-040500000000
Local Subnet: 192.168.100.5/32 Peer Subnet: 2.2.5.5/32
------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec Service Information in detail.
Example
nsx-edge-1> get ipsecvpn service verbose
Service ID: acaba146-31f7-4b35-bc19-f3055ea93db0
Service State: Active Enabled: Yes
SR ID : 2ea7f52f-11db-4bca-9a8a-4775467806b7 SR State : Active
HA Sync Enabled: Yes
Bypass Policies
Policy UUID: 00003400-0000-0404-0000-040500000000
Local Subnet: 192.168.100.5/32 Peer Subnet: 2.2.5.5/32
------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPSec VPN sessions.
Example
nsx-edge-1>get ipsecvpn session
Total Number of Sessions: 5
IKE Session ID : 3
UUID : 254d755e-e133-4831-89ab-41ef49c2bdc1
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.102
Local ID : 192.168.128.1 Peer ID : 1.1.5.102
Session Status : Down Down Reason : Timed out
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0404-0000-040500000000
ToRule ID : 1029 ToRule ID : 2147484677
Local Subnet : 192.170.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Down Down Reason : IKE SA down
------------------------------------------------------------------------------------------
IKE Session ID : 2
UUID : ffc00327-0d7b-4e4d-8676-3eb12c803ed6
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.100
Local ID : 192.168.128.1 Peer ID : 1.1.5.100
Session Status : Up
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0402-0000-040300000000
ToRule ID : 1027 FromRule ID : 2147484675
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Up
------------------------------------------------------------------------------------------
IKE Session ID : 4
UUID : aa2bcd92-35e0-4c99-a591-19b74c040cfd
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : Cert
Compliance Suite : PRIME
Local IP : 192.168.128.1 Peer IP : 1.1.5.101
Local ID : 192.168.128.1 Peer ID : C=IN, ST=Maharashtra, L=Pune, O=VMware, OU=NSBU, CN=VMwareSite2
Session Status : Up
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-048e-0000-048f00000000
ToRule ID : 1167 FromRule ID : 2147484815
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.6.0/24
Tunnel Status : Up
------------------------------------------------------------------------------------------
IKE Session ID : 5
UUID : 00000000-0000-0000-0000-000000000020
SR ID : 00000000-0000-000a-0000-000000000000
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 2001::1 Peer IP : 2002::1
Local ID : 2001::1 Peer ID : 2002::1
Session Status : Up
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00000000-0000-0000-0000-040500000000
ToRule ID : 1029 FromRule ID : 2147484677
Local Subnet : 2010:50:56ff:fe56::/64 Peer Subnet : 3010:50:56ff:fe56::/64
Tunnel Status : Up
------------------------------------------------------------------------------------------
IKE Session ID : 6
UUID : 00000000-0000-0000-0000-000000000010
SR ID : 00000000-0000-000a-0000-000000000000
Type : Route
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 2004::1 Peer IP : 2003::1
Local ID : 2004::1 Peer ID : 2003::1
Session Status : Up
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
VTI UUID : 00000000-0000-0000-0000-040500000000
ToRule ID : 1030 FromRule ID : 2147484678
Local Subnet : ::/0 Peer Subnet : ::/0
Tunnel Status : Up
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display specific IPSec VPN session.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1>get ipsecvpn session ffc00327-0d7b-4e4d-8676-3eb12c803ed6
Total Number of Sessions: 1
IKE Session ID : 2
UUID : ffc00327-0d7b-4e4d-8676-3eb12c803ed6
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.100
Local ID : 192.168.128.1 Peer ID : 1.1.5.100
Session Status : Up
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0402-0000-040300000000
ToRule ID : 1027 FromRule ID : 2147484675
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Up
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPsec VPN session history using session uuid as the filter
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn session d1092bd9-f6f5-4bdf-a144-f1afb3501346 history
Mon Apr 15 2024 UTC 05:01:52.507
Total Number of Sessions: 1
IKE Session ID : 8193
UUID : d1092bd9-f6f5-4bdf-a144-f1afb3501346
SR ID : 0b6bb35b-16df-42bc-a1d1-bdfa0429164e
Type : Route
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 1.1.1.10 Peer IP : 10.12.11.7
Local ID : 1.1.1.10 Peer ID : 10.12.11.7
Session Status : Negotiating Last Known Failure: Peer not responding
Last Updated : 15-Apr-2024 05:01:50
Session Status History
15-Apr-2024 05:00:31 : IKE_STATUS_DOWN (Peer not responding)
15-Apr-2024 04:59:41 : IKE_STATUS_NEGO
15-Apr-2024 04:58:22 : IKE_STATUS_DOWN (Peer not responding)
15-Apr-2024 04:57:33 : IKE_STATUS_NEGO
15-Apr-2024 04:56:14 : IKE_STATUS_DOWN (Peer not responding)
15-Apr-2024 04:55:24 : IKE_STATUS_NEGO
15-Apr-2024 04:54:06 : IKE_STATUS_DOWN (Peer not responding)
15-Apr-2024 04:53:16 : IKE_STATUS_NEGO
15-Apr-2024 04:51:59 : IKE_STATUS_DOWN (Peer not responding)
15-Apr-2024 04:51:09 : IKE_STATUS_NEGO
Policy Rules
VTI UUID : 0de1ced2-0932-47cd-936b-92ca5684464f
ToRule ID : 325817034 FromRule ID : 2473300682
Local Subnet : 0.0.0.0/0 Peer Subnet : 0.0.0.0/0
Tunnel Status : Down Down Reason : IKE SA down
Tunnel Status History
15-Apr-2024 05:00:31 : IPSEC_STATUS_DOWN (Peer not reachable)
15-Apr-2024 04:58:22 : IPSEC_STATUS_DOWN (IKE SA down)
15-Apr-2024 04:58:22 : IPSEC_STATUS_DOWN (Peer not reachable)
15-Apr-2024 04:56:14 : IPSEC_STATUS_DOWN (IKE SA down)
15-Apr-2024 04:56:14 : IPSEC_STATUS_DOWN (Peer not reachable)
Last Known Status : IPSEC_STATUS_DOWN
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPSec VPN sessions in active state.
Example
nsx-edge-1> get ipsecvpn session active
Total Number of Active Sessions: 1
IKE Session ID : 2
UUID : ffc00327-0d7b-4e4d-8676-3eb12c803ed6
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.100
Local ID : 192.168.128.1 Peer ID : 1.1.5.100
Session Status : Up
Policy Rules
Policy UUID : 00003400-0000-0402-0000-040300000000
ToRule ID : 1027 FromRule ID : 2147484675
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Up
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display an IPSec VPN session in active state.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn session active ffc00327-0d7b-4e4d-8676-3eb12c803ed6
Total Number of Active Sessions: 1
IKE Session ID : 2
UUID : ffc00327-0d7b-4e4d-8676-3eb12c803ed6
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.100
Local ID : 192.168.128.1 Peer ID : 1.1.5.100
Session Status : Up
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0402-0000-040300000000
ToRule ID : 1027 FromRule ID : 2147484675
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Up
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec VPN session in active state for specific endpoints.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get ipsecvpn session active local-ip 192.168.128.1 remote-ip 1.1.5.100
Total Number of Active Sessions: 1
IKE Session ID : 2
UUID : ffc00327-0d7b-4e4d-8676-3eb12c803ed6
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.100
Local ID : 192.168.128.1 Peer ID : 1.1.5.100
Session Status : Up
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0402-0000-040300000000
ToRule ID : 1027 FromRule ID : 2147484675
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Up
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display an IPSec VPN session in active state.
| Option | Description |
|---|---|
| <session-id> | IKE Session ID |
Example
nsx-edge-1> get ipsecvpn session active sessionid 2
Total Number of Sessions: 1
IKE Session ID : 2
UUID : ffc00327-0d7b-4e4d-8676-3eb12c803ed6
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.100
Local ID : 192.168.128.1 Peer ID : 1.1.5.100
Session Status : Up
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0402-0000-040300000000
ToRule ID : 1027 FromRule ID : 2147484675
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Up
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPsec VPN sessions in down state.
Example
nsx-edge-1> get ipsecvpn session down
Total Number of Down Sessions: 1
IKE Session ID : 3
UUID : 254d755e-e133-4831-89ab-41ef49c2bdc1
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.102
Local ID : 192.168.128.1 Peer ID : 1.1.5.102
Session Status : Down Down Reason : No proposal chosen
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0404-0000-040500000000
ToRule ID : 1027 FromRule ID : 2147484677
Local Subnet : 192.170.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Down Down Reason : IKE SA Down
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display an IPsec VPN session in down state.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn session down 254d755e-e133-4831-89ab-41ef49c2bdc1
Total Number of Down Sessions: 1
IKE Session ID : 3
UUID : 254d755e-e133-4831-89ab-41ef49c2bdc1
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.102
Local ID : 192.168.128.1 Peer ID : 1.1.5.102
Session Status : Down Down Reason : Timed out
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0404-0000-040500000000
ToRule ID : 1027 FromRuleId : 2147484677
Local Subnet : 192.170.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Down Down Reason : IKE SA Down
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPsec VPN session in down state for specific endpoints.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get ipsecvpn session down local-ip 192.168.128.1 remote-ip 1.1.5.102
Total Number of Down Sessions: 1
IKE Session ID : 3
UUID : 254d755e-e133-4831-89ab-41ef49c2bdc1
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.102
Local ID : 192.168.128.1 Peer ID : 1.1.5.102
Session Status : Down Down Reason : Timed out
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0404-0000-040500000000
ToRule ID : 1027 Rule ID FromRule ID : 2147484677
Local Subnet : 192.170.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Down Down Reason : IKE SA Down
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display an IPsec VPN session in down state.
| Option | Description |
|---|---|
| <session-id> | IKE Session ID |
Example
nsx-edge-1> get ipsecvpn session down sessionid 3
Total Number of Down Sessions: 1
IKE Session ID : 3
UUID : 254d755e-e133-4831-89ab-41ef49c2bdc1
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.102
Local ID : 192.168.128.1 Peer ID : 1.1.5.102
Session Status : Down Down Reason : Timed out
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0404-0000-040500000000
ToRule ID : 1029 FromRule ID : 2147484677
Local Subnet : 192.170.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Down Down Reason : IKE SA Down
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPsec VPN sessions history.
Example
nsx-edge-1> get ipsecvpn session history
Total Number of Sessions: 2
IKE Session ID : 2
UUID : 50736bc9-161a-4c32-9f8f-26fc08596810
SR ID : 1457c3cf-286c-4b83-b8ff-15ad40c4e858
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.100
Local ID : 192.168.128.1 Peer ID : 1.1.5.100
Session Status : Up
Last Updated : 08-Apr-2024 06:35:37
Session Status History
08-Apr-2024 06:35:37 : IKE_STATUS_NEGO
08-Apr-2024 06:35:13 : IKE_STATUS_DOWN (Peer sent delete)
08-Apr-2024 06:34:36 : IKE_STATUS_UP
08-Apr-2024 06:34:36 : IKE_STATUS_NEGO
08-Apr-2024 06:34:10 : IKE_STATUS_DOWN (IKE SA timer expired)
08-Apr-2024 06:33:40 : IKE_STATUS_UP
08-Apr-2024 06:33:39 : IKE_STATUS_NEGO
08-Apr-2024 06:33:18 : IKE_STATUS_DOWN (IKE SA timer expired)
08-Apr-2024 06:32:48 : IKE_STATUS_UP
08-Apr-2024 06:32:48 : IKE_STATUS_NEGO
Policy Rules
Policy UUID : 00003400-0000-0413-0000-041400000000
ToRule ID : 1044 FromRule ID : 2147484692
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Up
Tunnel Status History
08-Apr-2024 06:35:37 : IPSEC_STATUS_DOWN (IPSec negotiation not started)
08-Apr-2024 06:35:13 : IPSEC_STATUS_DOWN (IKE SA down)
08-Apr-2024 06:34:36 : IPSEC_STATUS_DOWN (No proposal chosen)
08-Apr-2024 06:34:36 : IPSEC_STATUS_DOWN (IPSec negotiation not started)
08-Apr-2024 06:34:10 : IPSEC_STATUS_DOWN (IKE SA down)
Last Known Status : IPSEC_STATUS_DOWN
------------------------------------------------------------------------------------------
IKE Session ID : 3
UUID : 7ec41071-e48a-4d5f-9c52-a110b5245ef9
SR ID : 1457c3cf-286c-4b83-b8ff-15ad40c4e858
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.2 Peer IP : 1.1.6.100
Local ID : 192.168.128.2 Peer ID : 1.1.6.100
Session Status : Up
Last Updated : 13-Jun-2019 15:43:55
Session Status History
08-Apr-2024 05:49:46 : IKE_STATUS_NEGO
08-Apr-2024 05:49:37 : IKE_STATUS_DOWN (Negotiation not started)
Policy Rules
Policy UUID : 00003400-0000-0413-0000-041400000000
ToRule ID : 1044 FromRule ID : 2147484692
Local Subnet : 192.168.101.0/24 Peer Subnet : 2.2.6.0/24
Tunnel Status : Up
Tunnel Status History
08-Apr-2024 05:49:41 : IPSEC_STATUS_DOWN (IPSec negotiation not started)
Last Known Status : IPSEC_STATUS_DOWN
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec VPN session for specific endpoints.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1>get ipsecvpn session local-ip 192.168.128.1 remote-ip 1.1.5.101
Total Number of Sessions: 1
IKE Session ID : 2
UUID : ffc00327-0d7b-4e4d-8676-3eb12c803ed6
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.100
Local ID : 192.168.128.1 Peer ID : 1.1.5.100
Session Status : Up
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0402-0000-040300000000
ToRule ID : 1027 FromRule ID : 2147484675
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Up
------------------------------------------------------------------------------------------
nsx-edge-2> get ipsecvpn session local-ip 2001::1 remote-ip 2002::1
Fri Feb 04 2022 PST 00:49:17.544
Total Number of Sessions: 1
IKE Session ID : 8193
UUID : 00000000-0000-0000-0000-000000000010
SR ID : 00000000-0000-000a-0000-000000000000
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 2001::1 Peer IP : 2002::1
Local ID : 2001::1 Peer ID : 2002::1
Session Status : Up
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00000000-0000-0000-0000-040500000000
ToRule ID : 1029 FromRule ID : 2147484677
Local Subnet : 192.168.2.0/24 Peer Subnet : 172.16.2.0/24
Tunnel Status : Up
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec VPN session history for specific endpoints.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get ipsecvpn session local-ip 192.168.50.100 remote-ip 20.20.20.101 history
Mon Apr 15 2024 UTC 05:03:52.394
Total Number of Sessions: 1
IKE Session ID : 1
UUID : 3230677c-a5ae-4003-a46b-ee4f9cec1ca9
SR ID : 0b6bb35b-16df-42bc-a1d1-bdfa0429164e
Type : Route
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.50.100 Peer IP : 20.20.20.101
Local ID : 192.168.50.100 Peer ID : 20.20.20.101
Session Status : Up
Last Updated : 08-Apr-2024 06:35:37
Session Status History
08-Apr-2024 06:35:37 : IKE_STATUS_NEGO
08-Apr-2024 06:35:13 : IKE_STATUS_DOWN (Peer sent delete)
08-Apr-2024 06:34:36 : IKE_STATUS_UP
08-Apr-2024 06:34:36 : IKE_STATUS_NEGO
08-Apr-2024 06:34:10 : IKE_STATUS_DOWN (IKE SA timer expired)
08-Apr-2024 06:33:40 : IKE_STATUS_UP
08-Apr-2024 06:33:39 : IKE_STATUS_NEGO
08-Apr-2024 06:33:18 : IKE_STATUS_DOWN (IKE SA timer expired)
08-Apr-2024 06:32:48 : IKE_STATUS_UP
08-Apr-2024 06:32:48 : IKE_STATUS_NEGO
Policy Rules
VTI UUID : 495900b3-fae5-46c5-ba58-0eb00a73f1ec
ToRule ID : 978849456 FromRule ID : 3126333104
Local Subnet : 0.0.0.0/0 Peer Subnet : 0.0.0.0/0
Tunnel Status : Up
Tunnel Status History
08-Apr-2024 06:35:37 : IPSEC_STATUS_DOWN (IPSec negotiation not started)
08-Apr-2024 06:35:13 : IPSEC_STATUS_DOWN (IKE SA down)
08-Apr-2024 06:34:36 : IPSEC_STATUS_DOWN (No proposal chosen)
08-Apr-2024 06:34:36 : IPSEC_STATUS_DOWN (IPSec negotiation not started)
08-Apr-2024 06:34:10 : IPSEC_STATUS_DOWN (IKE SA down)
Last Known Status : IPSEC_STATUS_DOWN
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPSec VPN sessions of Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1>get ipsecvpn session
Total Number of Sessions: 3
IKE Session ID : 3
UUID : 254d755e-e133-4831-89ab-41ef49c2bdc1
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.102
Local ID : 192.168.128.1 Peer ID : 1.1.5.102
Session Status : Down Down Reason : Timed out
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0404-0000-040500000000
ToRule ID : 1029 ToRule ID : 2147484677
Local Subnet : 192.170.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Down Down Reason : IKE SA down
------------------------------------------------------------------------------------------
IKE Session ID : 2
UUID : ffc00327-0d7b-4e4d-8676-3eb12c803ed6
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.100
Local ID : 192.168.128.1 Peer ID : 1.1.5.100
Session Status : Up
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0402-0000-040300000000
ToRule ID : 1027 FromRule ID : 2147484675
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Up
------------------------------------------------------------------------------------------
IKE Session ID : 4
UUID : aa2bcd92-35e0-4c99-a591-19b74c040cfd
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : Cert
Compliance Suite : PRIME
Local IP : 192.168.128.1 Peer IP : 1.1.5.101
Local ID : 192.168.128.1 Peer ID : C=IN, ST=Maharashtra, L=Pune, O=VMware, OU=NSBU, CN=VMwareSite2
Session Status : Up
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-048e-0000-048f00000000
ToRule ID : 1167 FromRule ID : 2147484815
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.6.0/24
Tunnel Status : Up
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display specific IPSec VPN session of Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1>get ipsecvpn session logical-router ffc00327-0d7b-4e4d-8676-3eb12c803ed6
Total Number of Sessions: 1
IKE Session ID : 2
UUID : ffc00327-0d7b-4e4d-8676-3eb12c803ed6
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.100
Local ID : 192.168.128.1 Peer ID : 1.1.5.100
Session Status : Up
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0402-0000-040300000000
ToRule ID : 1027 FromRule ID : 2147484675
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Up
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display an IPsec VPN session in negotiating state of Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn session logical-router negotiating 254d755e-e133-4831-89ab-41ef49c2bdc1
Total Number of Negotiating Sessions: 1
IKE Session ID : 3
UUID : 254d755e-e133-4831-89ab-41ef49c2bdc1
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.102
Local ID : 192.168.128.1 Peer ID : 1.1.5.102
Session Status : Negotiating Last Known Failure: Peer not reachable
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0404-0000-040500000000
ToRule ID : 1027 FromRule ID : 2147484677
Local Subnet : 192.170.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Down Down Reason : IKE SA Down
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPSec VPN sessions in active state of Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn session logical-router active
Total Number of Active Sessions: 1
IKE Session ID : 2
UUID : ffc00327-0d7b-4e4d-8676-3eb12c803ed6
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.100
Local ID : 192.168.128.1 Peer ID : 1.1.5.100
Session Status : Up
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0402-0000-040300000000
ToRule ID : 1027 FromRule ID : 2147484675
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Up
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display an IPSec VPN session in active state of Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn session logical-router active ffc00327-0d7b-4e4d-8676-3eb12c803ed6
Total Number of Active Sessions: 1
IKE Session ID : 2
UUID : ffc00327-0d7b-4e4d-8676-3eb12c803ed6
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.100
Local ID : 192.168.128.1 Peer ID : 1.1.5.100
Session Status : Up
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0402-0000-040300000000
ToRule ID : 1027 FromRule ID : 2147484675
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Up
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec VPN session in active state for specific endpoints of Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get ipsecvpn session logical-router active local-ip 192.168.128.1 remote-ip 1.1.5.100
Total Number of Active Sessions: 1
IKE Session ID : 2
UUID : ffc00327-0d7b-4e4d-8676-3eb12c803ed6
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.100
Local ID : 192.168.128.1 Peer ID : 1.1.5.100
Session Status : Up
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0402-0000-040300000000
ToRule ID : 1027 FromRule ID : 2147484675
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Up
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display an IPSec VPN session in active state of Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <session-id> | IKE Session ID |
Example
nsx-edge-1> get ipsecvpn session logical-router active sessionid 2
Total Number of Sessions: 1
IKE Session ID : 2
UUID : ffc00327-0d7b-4e4d-8676-3eb12c803ed6
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.100
Local ID : 192.168.128.1 Peer ID : 1.1.5.100
Session Status : Up
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0402-0000-040300000000
ToRule ID : 1027 FromRule ID : 2147484675
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Up
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPsec VPN sessions in down state of Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn session logical-router down
Total Number of Down Sessions: 1
IKE Session ID : 3
UUID : 254d755e-e133-4831-89ab-41ef49c2bdc1
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.102
Local ID : 192.168.128.1 Peer ID : 1.1.5.102
Session Status : Down Down Reason : No proposal chosen
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0404-0000-040500000000
ToRule ID : 1027 FromRule ID : 2147484677
Local Subnet : 192.170.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Down Down Reason : IKE SA Down
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display an IPsec VPN session in down state of Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn session logical-router down 254d755e-e133-4831-89ab-41ef49c2bdc1
Total Number of Down Sessions: 1
IKE Session ID : 3
UUID : 254d755e-e133-4831-89ab-41ef49c2bdc1
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.102
Local ID : 192.168.128.1 Peer ID : 1.1.5.102
Session Status : Down Down Reason : Timed out
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0404-0000-040500000000
ToRule ID : 1027 FromRuleId : 2147484677
Local Subnet : 192.170.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Down Down Reason : IKE SA Down
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPsec VPN session in down state for specific endpoints of Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get ipsecvpn session logical-router down local-ip 192.168.128.1 remote-ip 1.1.5.102
Total Number of Down Sessions: 1
IKE Session ID : 3
UUID : 254d755e-e133-4831-89ab-41ef49c2bdc1
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.102
Local ID : 192.168.128.1 Peer ID : 1.1.5.102
Session Status : Down Down Reason : Timed out
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0404-0000-040500000000
ToRule ID : 1027 Rule ID FromRule ID : 2147484677
Local Subnet : 192.170.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Down Down Reason : IKE SA Down
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display an IPsec VPN session in down state of Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <session-id> | IKE Session ID |
Example
nsx-edge-1> get ipsecvpn session logical-router down sessionid 3
Total Number of Down Sessions: 1
IKE Session ID : 3
UUID : 254d755e-e133-4831-89ab-41ef49c2bdc1
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.102
Local ID : 192.168.128.1 Peer ID : 1.1.5.102
Session Status : Down Down Reason : Timed out
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0404-0000-040500000000
ToRule ID : 1029 FromRule ID : 2147484677
Local Subnet : 192.170.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Down Down Reason : IKE SA Down
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec VPN session history for a Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn session logical-router df13f67b-f45d-464b-a12a-614e56d5c9be history
Total Number of Sessions: 1
IKE Session ID : 3
UUID : c2d0c110-3763-4bd8-a616-1397a1c29db1
SR ID : df13f67b-f45d-464b-a12a-614e56d5c9be
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.5 Peer IP : 1.1.5.1
Local ID : 192.168.128.5 Peer ID : 1.1.5.1
Session Status : Down Down Reason : Peer not responding
Last Updated : 17-Jun-2019 12:26:59
Session Status History
17-Jun-2019 12:26:51 : IKE_STATUS_NEGO
17-Jun-2019 12:25:30 : IKE_STATUS_DOWN (Peer not responding)
17-Jun-2019 12:22:40 : IKE_STATUS_NEGO
17-Jun-2019 12:21:18 : IKE_STATUS_DOWN (Peer not responding)
17-Jun-2019 12:18:29 : IKE_STATUS_NEGO
17-Jun-2019 12:17:07 : IKE_STATUS_DOWN (Peer not responding)
17-Jun-2019 12:14:17 : IKE_STATUS_NEGO
17-Jun-2019 12:12:56 : IKE_STATUS_DOWN (Peer not responding)
17-Jun-2019 12:10:07 : IKE_STATUS_NEGO
17-Jun-2019 12:10:07 : IKE_STATUS_DOWN (Negotiation not started)
Policy Rules
Policy UUID : 00003400-0000-0418-0000-041900000000
ToRule ID : 1049 FromRule ID : 2147484697
Local Subnet : 192.168.100.0/24 Peer Subnet : 5.5.5.0/24
Tunnel Status : Down Down Reason : IKE SA down
Tunnel Status History
Last Known Status : IPSEC_STATUS_DOWN
-----------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec VPN session for specific endpoints on Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1>get ipsecvpn session local-ip 192.168.128.1 remote-ip 1.1.5.101
Total Number of Sessions: 1
IKE Session ID : 2
UUID : ffc00327-0d7b-4e4d-8676-3eb12c803ed6
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.100
Local ID : 192.168.128.1 Peer ID : 1.1.5.100
Session Status : Up
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0402-0000-040300000000
ToRule ID : 1027 FromRule ID : 2147484675
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Up
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec VPN session history for specific endpoints on Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get ipsecvpn session logical-router 0b6bb35b-16df-42bc-a1d1-bdfa0429164e local-ip 192.168.50.100 remote-ip 20.20.20.101 history
Mon Apr 15 2024 UTC 05:07:38.309
Total Number of Sessions: 1
IKE Session ID : 1
UUID : 3230677c-a5ae-4003-a46b-ee4f9cec1ca9
SR ID : 0b6bb35b-16df-42bc-a1d1-bdfa0429164e
Type : Route
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.50.100 Peer IP : 20.20.20.101
Local ID : 192.168.50.100 Peer ID : 20.20.20.101
Session Status : Up
Last Updated : 08-Apr-2024 06:35:37
Session Status History
08-Apr-2024 06:35:37 : IKE_STATUS_NEGO
08-Apr-2024 06:35:13 : IKE_STATUS_DOWN (Peer sent delete)
08-Apr-2024 06:34:36 : IKE_STATUS_UP
08-Apr-2024 06:34:36 : IKE_STATUS_NEGO
08-Apr-2024 06:34:10 : IKE_STATUS_DOWN (IKE SA timer expired)
08-Apr-2024 06:33:40 : IKE_STATUS_UP
08-Apr-2024 06:33:39 : IKE_STATUS_NEGO
08-Apr-2024 06:33:18 : IKE_STATUS_DOWN (IKE SA timer expired)
08-Apr-2024 06:32:48 : IKE_STATUS_UP
08-Apr-2024 06:32:48 : IKE_STATUS_NEGO
Policy Rules
VTI UUID : 495900b3-fae5-46c5-ba58-0eb00a73f1ec
ToRule ID : 978849456 FromRule ID : 3126333104
Local Subnet : 0.0.0.0/0 Peer Subnet : 0.0.0.0/0
Tunnel Status : Up
Tunnel Status History
08-Apr-2024 06:35:37 : IPSEC_STATUS_DOWN (IPSec negotiation not started)
08-Apr-2024 06:35:13 : IPSEC_STATUS_DOWN (IKE SA down)
08-Apr-2024 06:34:36 : IPSEC_STATUS_DOWN (No proposal chosen)
08-Apr-2024 06:34:36 : IPSEC_STATUS_DOWN (IPSec negotiation not started)
08-Apr-2024 06:34:10 : IPSEC_STATUS_DOWN (IKE SA down)
Last Known Status : IPSEC_STATUS_DOWN
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPsec VPN sessions in negotiating state of Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn session logical-router negotiating
Total Number of Negotiating Sessions: 1
IKE Session ID : 3
UUID : 254d755e-e133-4831-89ab-41ef49c2bdc1
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.102
Local ID : 192.168.128.1 Peer ID : 1.1.5.102
Session Status : Negotiating Last Known Failure: Peer not reachable
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0404-0000-040500000000
ToRule ID : 1027 FromRule ID : 2147484677
Local Subnet : 192.170.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Down Down Reason : IKE SA Down
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPsec VPN session in negotiating state for specific endpoints.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get ipsecvpn session logical-router negotiating local-ip 192.168.128.1 remote-ip 1.1.5.102
Total Number of Negotiating Sessions: 1
IKE Session ID : 3
UUID : 254d755e-e133-4831-89ab-41ef49c2bdc1
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.102
Local ID : 192.168.128.1 Peer ID : 1.1.5.102
Session Status : Negotiating Last Known Failure: Peer not reachable
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0404-0000-040500000000
ToRule ID : 1027 FromRule ID :2147484677
Local Subnet : 192.170.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Down Down Reason : IKE SA Down
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPSec VPN sessions of Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <session-id> | IKE Session ID |
Example
nsx-edge-1>get ipsecvpn session sessionid 2
Total Number of Sessions: 1
IKE Session ID : 2
UUID : ffc00327-0d7b-4e4d-8676-3eb12c803ed6
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.100
Local ID : 192.168.128.1 Peer ID : 1.1.5.100
Session Status : Up
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0402-0000-040300000000
ToRule ID : 1027 FromRule ID : 2147484675
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Up
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec VPN session history of a specific session for a Logical Router
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <session-id> | IKE Session ID |
Example
nsx-edge-1> get ipsecvpn session logical-router 0b6bb35b-16df-42bc-a1d1-bdfa0429164e sessionid 8193 history
Mon Apr 15 2024 UTC 05:08:51.399
Total Number of Sessions: 1
IKE Session ID : 8193
UUID : d1092bd9-f6f5-4bdf-a144-f1afb3501346
SR ID : 0b6bb35b-16df-42bc-a1d1-bdfa0429164e
Type : Route
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 1.1.1.10 Peer IP : 10.12.11.7
Local ID : 1.1.1.10 Peer ID : 10.12.11.7
Session Status : Negotiating Last Known Failure: Peer not responding
Last Updated : 15-Apr-2024 05:08:15
Session Status History
15-Apr-2024 05:06:56 : IKE_STATUS_DOWN (Peer not responding)
15-Apr-2024 05:06:07 : IKE_STATUS_NEGO
15-Apr-2024 05:04:48 : IKE_STATUS_DOWN (Peer not responding)
15-Apr-2024 05:03:58 : IKE_STATUS_NEGO
15-Apr-2024 05:02:39 : IKE_STATUS_DOWN (Peer not responding)
15-Apr-2024 05:01:50 : IKE_STATUS_NEGO
15-Apr-2024 05:00:31 : IKE_STATUS_DOWN (Peer not responding)
15-Apr-2024 04:59:41 : IKE_STATUS_NEGO
15-Apr-2024 04:58:22 : IKE_STATUS_DOWN (Peer not responding)
15-Apr-2024 04:57:33 : IKE_STATUS_NEGO
Policy Rules
VTI UUID : 0de1ced2-0932-47cd-936b-92ca5684464f
ToRule ID : 325817034 FromRule ID : 2473300682
Local Subnet : 0.0.0.0/0 Peer Subnet : 0.0.0.0/0
Tunnel Status : Down Down Reason : IKE SA down
Tunnel Status History
15-Apr-2024 05:06:56 : IPSEC_STATUS_DOWN (Peer not reachable)
15-Apr-2024 05:04:48 : IPSEC_STATUS_DOWN (IKE SA down)
15-Apr-2024 05:04:48 : IPSEC_STATUS_DOWN (Peer not reachable)
15-Apr-2024 05:02:39 : IPSEC_STATUS_DOWN (IKE SA down)
15-Apr-2024 05:02:39 : IPSEC_STATUS_DOWN (Peer not reachable)
Last Known Status : IPSEC_STATUS_DOWN
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec VPN session status for a Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn session status
VPN Session Status
Total Configured Sessions : 2
Total UP Sessions : 1
Total Down Sessions : 1
Total Negotiating Sessions : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display summary of all IPSec VPN sessions for a Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn session summary
Version SID Compliance Suite Type Auth Status Local IP Peer IP Down Reason
----------------------------------------------------------------------------------------------------------------------------
IKEv2 4 None Policy PSK Down 192.168.128.1 1.1.5.102 Peer not reachable
IKEv1 6 FOUNDATION Policy Cert Up 192.168.128.1 1.1.5.104
----------------------------------------------------------------------------------------------------------------------------
SID: Session ID *: Last Known Failure
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPsec VPN sessions in negotiating state.
Example
nsx-edge-1> get ipsecvpn session negotiating
Total Number of Negotiating Sessions: 1
IKE Session ID : 3
UUID : 254d755e-e133-4831-89ab-41ef49c2bdc1
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.102
Local ID : 192.168.128.1 Peer ID : 1.1.5.102
Session Status : Negotiating Last Known Failure: Peer not reachable
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0404-0000-040500000000
ToRule ID : 1027 FromRule ID : 2147484677
Local Subnet : 192.170.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Down Down Reason : IKE SA Down
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display an IPsec VPN session in negotiating state.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn session negotiating 254d755e-e133-4831-89ab-41ef49c2bdc1
Total Number of Negotiating Sessions: 1
IKE Session ID : 3
UUID : 254d755e-e133-4831-89ab-41ef49c2bdc1
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.102
Local ID : 192.168.128.1 Peer ID : 1.1.5.102
Session Status : Negotiating Last Known Failure: Peer not reachable
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0404-0000-040500000000
ToRule ID : 1027 FromRule ID : 2147484677
Local Subnet : 192.170.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Down Down Reason : IKE SA Down
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPsec VPN session in negotiating state for specific endpoints of Logical Router.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get ipsecvpn session negotiating local-ip 192.168.128.1 remote-ip 1.1.5.102
Total Number of Negotiating Sessions: 1
IKE Session ID : 3
UUID : 254d755e-e133-4831-89ab-41ef49c2bdc1
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.102
Local ID : 192.168.128.1 Peer ID : 1.1.5.102
Session Status : Negotiating Last Known Failure: Peer not reachable
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0404-0000-040500000000
ToRule ID : 1027 FromRule ID :2147484677
Local Subnet : 192.170.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Down Down Reason : IKE SA Down
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display an IPsec VPN session in negotiating state of Logical Router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <session-id> | IKE Session ID |
Example
nsx-edge-1> get ipsecvpn session negotiating logical-router sessionid 3
Total Number of Negotiating Sessions: 1
IKE Session ID : 3
UUID : 254d755e-e133-4831-89ab-41ef49c2bdc1
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.102
Local ID : 192.168.128.1 Peer ID : 1.1.5.102
Session Status : Negotiating Last Known Failure: Peer not reachable
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0404-0000-040500000000
ToRule ID : 1029 FromRule ID : 2147484677
Local Subnet : 192.170.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Down Down Reason : IKE SA Down
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display an IPsec VPN session in negotiating state.
| Option | Description |
|---|---|
| <session-id> | IKE Session ID |
Example
nsx-edge-1> get ipsecvpn session negotiating sessionid 3
Total Number of Negotiating Sessions: 1
IKE Session ID : 3
UUID : 254d755e-e133-4831-89ab-41ef49c2bdc1
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.102
Local ID : 192.168.128.1 Peer ID : 1.1.5.102
Session Status : Negotiating Last Known Failure: Peer not reachable
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0404-0000-040500000000
ToRule ID : 1029 FromRule ID : 2147484677
Local Subnet : 192.170.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Down Down Reason : IKE SA Down
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPSec VPN sessions.
| Option | Description |
|---|---|
| <session-id> | IKE Session ID |
Example
nsx-edge-1>get ipsecvpn session sessionid 2
Total Number of Sessions: 1
IKE Session ID : 2
UUID : ffc00327-0d7b-4e4d-8676-3eb12c803ed6
SR ID : 34d18f5f-a2bf-4dc8-b9fa-dd0ef492aee8
Type : Policy
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.128.1 Peer IP : 1.1.5.100
Local ID : 192.168.128.1 Peer ID : 1.1.5.100
Session Status : Up
Last Updated : 12-Jun-2019 09:35:59
Policy Rules
Policy UUID : 00003400-0000-0402-0000-040300000000
ToRule ID : 1027 FromRule ID : 2147484675
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.5.0/24
Tunnel Status : Up
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPsec VPN session history with sessionid as the filter
| Option | Description |
|---|---|
| <session-id> | IKE Session ID |
Example
nsx-edge-1> get ipsecvpn session sessionid 1 history
Mon Apr 15 2024 UTC 04:25:48.055
Total Number of Sessions: 1
IKE Session ID : 1
UUID : 3230677c-a5ae-4003-a46b-ee4f9cec1ca9
SR ID : 0b6bb35b-16df-42bc-a1d1-bdfa0429164e
Type : Route
Auth Mode : PSK
Compliance Suite : NONE
Local IP : 192.168.50.100 Peer IP : 20.20.20.101
Local ID : 192.168.50.100 Peer ID : 20.20.20.101
Session Status : Up
Last Updated : 08-Apr-2024 06:35:37
Session Status History
08-Apr-2024 06:35:37 : IKE_STATUS_NEGO
08-Apr-2024 06:35:13 : IKE_STATUS_DOWN (Peer sent delete)
08-Apr-2024 06:34:36 : IKE_STATUS_UP
08-Apr-2024 06:34:36 : IKE_STATUS_NEGO
08-Apr-2024 06:34:10 : IKE_STATUS_DOWN (IKE SA timer expired)
08-Apr-2024 06:33:40 : IKE_STATUS_UP
08-Apr-2024 06:33:39 : IKE_STATUS_NEGO
08-Apr-2024 06:33:18 : IKE_STATUS_DOWN (IKE SA timer expired)
08-Apr-2024 06:32:48 : IKE_STATUS_UP
08-Apr-2024 06:32:48 : IKE_STATUS_NEGO
Policy Rules
VTI UUID : 495900b3-fae5-46c5-ba58-0eb00a73f1ec
ToRule ID : 978849456 FromRule ID : 3126333104
Local Subnet : 0.0.0.0/0 Peer Subnet : 0.0.0.0/0
Tunnel Status : Up
Tunnel Status History
08-Apr-2024 06:35:37 : IPSEC_STATUS_DOWN (IPSec negotiation not started)
08-Apr-2024 06:35:13 : IPSEC_STATUS_DOWN (IKE SA down)
08-Apr-2024 06:34:36 : IPSEC_STATUS_DOWN (No proposal chosen)
08-Apr-2024 06:34:36 : IPSEC_STATUS_DOWN (IPSec negotiation not started)
08-Apr-2024 06:34:10 : IPSEC_STATUS_DOWN (IKE SA down)
Last Known Status : IPSEC_STATUS_DOWN
------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec VPN session status.
Example
nsx-edge-1> get ipsecvpn session status
VPN Session Status
Total Configured Sessions : 2
Total UP Sessions : 1
Total Down Sessions : 1
Total Negotiating Sessions : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display summary of all IPSec VPN sessions.
Example
nsx-edge-1> get ipsecvpn session summary
Version SID Compliance Suite Type Auth Status Local IP Peer IP Down Reason
----------------------------------------------------------------------------------------------------------------------------
IKEv2 4 None Policy PSK Down 192.168.128.1 1.1.5.102 Peer not reachable
IKEv2 3 None Policy PSK Down 192.168.128.1 1.1.5.101 No proposal chosen
IKEv1 2 None Policy PSK Negotiating 192.168.128.1 1.1.5.100 Peer not reachable*
IKEv2 5 SUITE_B_GMAC_256 Policy Cert Up 192.168.128.1 1.1.5.103
IKEv1 6 FOUNDATION Policy Cert Up 192.168.128.1 1.1.5.104
IKEFlex 7 NONE Policy PSK Up 2001::1 2002::1
IKEFlex 8 NONE Route PSK Up 2004::1 2003::1
----------------------------------------------------------------------------------------------------------------------------
SID: Session ID *: Last Known Failure
Mode
Basic
Availability
Autonomous Edge, Edge
Display summary of all IPSec IPv4 VPN sessions.
Example
nsx-edge-1> get ipsecvpn session summary ipv4
Version SID Compliance Suite Type Auth Status Local IP Peer IP Down Reason
----------------------------------------------------------------------------------------------------------------------------
IKEv2 4 None Policy PSK Down 192.168.128.1 1.1.5.102 Peer not reachable
IKEv2 3 None Policy PSK Down 192.168.128.1 1.1.5.101 No proposal chosen
IKEv1 2 None Policy PSK Negotiating 192.168.128.1 1.1.5.100 Peer not reachable*
IKEv2 5 SUITE_B_GMAC_256 Policy Cert Up 192.168.128.1 1.1.5.103
IKEv1 6 FOUNDATION Policy Cert Up 192.168.128.1 1.1.5.104
---------------------------------------------------------------------------------------------------------------------------
SID: Session ID *: Last Known Failure
Mode
Basic
Availability
Autonomous Edge, Edge
Display summary of all IPSec IPv6 VPN sessions.
Example
nsx-edge-1> get ipsecvpn session summary ipv6
SID: Session ID *: Last Known Failure
Version SID Compliance Suite Type Auth Status Local IP Peer IP Down Reason
----------------------------------------------------------------------------------------------------------------------------------------------------------
IKEv2 8193 NONE Policy PSK Up 2001:0db8:85a3:0000:0000:8a2e:0370:7334 2001:87ef:85a3:2000:4e00:8a2e:0370:78ab
IKEv2 8194 NONE Policy PSK Down 2002::100:48:1:1 2002::103:48:1:1 No proposal chosen
IKEv1 3234 FOUNDATION Route Cert Up 2002::100:104:1:1 2002::103:104:1:1
----------------------------------------------------------------------------------------------------------------------------------------------------------
SID: Session ID *: Last Known Failure
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPSec VPN synced sessions.
Example
nsx-edge-1>get ipsecvpn sync-session
Session UUID : dd30c538-29a1-4476-9ccb-4c30df23a1fc
SR ID : 1cd7568e-0203-4529-a2cd-163f34979db8
IKE SPI Initiator : 0xe5d0e7c55f8b6dc4
IKE SPI Responder : 0xb20e17c140fb3151
IKE SA Data Length : 549
IPSec SAs:
Rule ID : 536870922
SPI In : 0xd65d9b04 SPI Out : 0xc3c32066 SA Data Length: 690
Rule ID : 536870921
SPI In : 0x91e3d340 SPI Out : 0xcb24ea99 SA Data Length: 690
Rule ID : 536870920
Rule ID : 536870919
Rule ID : 2684354568
SPI In : 0xb7b03774 SPI Out : 0xcaaedc65 SA Data Length: 690
Rule ID : 2684354567
SPI In : 0xadcb56de SPI Out : 0xcb94111a SA Data Length: 690
--------------------------------------------------------------------------------
Session UUID : 2ea828ac-277a-4529-aaa5-921eb44f26cb
SR ID : 056c95a7-1ff4-4086-8973-c33f58b037dd
IKE SPI Initiator : 0x5813c5c9d363db12
IKE SPI Responder : 0x366194f82933bab5
IKE SA Data Length : 549
IPSec SAs:
Rule ID : 536870917
SPI In : 0xcf0c00ac SPI Out : 0xc484a72e SA Data Length: 690
Rule ID : 536870916
SPI In : 0x60db4b58 SPI Out : 0xc15e0914 SA Data Length: 690
Rule ID : 536870915
SPI In : 0x6bd7cf20 SPI Out : 0xcf4a2100 SA Data Length: 690
Rule ID : 536870914
SPI In : 0x9c31acea SPI Out : 0xcd6bf611 SA Data Length: 690
--------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display specific IPSec VPN synced session.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1>get ipsecvpn sync-session session-uuid dd30c538-29a1-4476-9ccb-4c30df23a1fc
Session UUID : dd30c538-29a1-4476-9ccb-4c30df23a1fc
SR ID : 1cd7568e-0203-4529-a2cd-163f34979db8
IKE SPI Initiator : 0xe5d0e7c55f8b6dc4
IKE SPI Responder : 0xb20e17c140fb3151
IKE SA Data Length : 549
IPSec SAs:
Rule ID : 536870922
SPI In : 0xd65d9b04 SPI Out : 0xc3c32066 SA Data Length: 690
Rule ID : 536870921
SPI In : 0x91e3d340 SPI Out : 0xcb24ea99 SA Data Length: 690
Rule ID : 536870920
Rule ID : 536870919
Rule ID : 2684354568
SPI In : 0xb7b03774 SPI Out : 0xcaaedc65 SA Data Length: 690
Rule ID : 2684354567
SPI In : 0xadcb56de SPI Out : 0xcb94111a SA Data Length: 690
--------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec SA tunnel statistics and multipath statistics.
Example
nsx-edge-1> get ipsecvpn tunnel multipath stats
Interface UID : 274
Interface UUID : 621af021-cac1-48a6-a874-13844f2110a1
VTI UUID : 621af021-cac1-48a6-a874-13844f2110a1
Stats
Rx Pkts : 220 Tx Pkts : 240
Rx Bytes : 38774 Tx Bytes : 41488
Rx MSS Adjusted : 0 Tx MSS Adjusted : 0
Rx MSS Ignored : 0 Tx MSS Ignored : 0
Rx Drops : 0 Tx Drops : 0
Rx Drop Crypto Failure : 0 Tx Drop Crypto Failure : 0
Rx Drop Enqueue Failure : 0 Tx Drop Enqueue Failure : 0
Rx Drop State Mismatch : 0 Tx Drop State Mismatch : 0
Rx Drop Malformed : 0 Tx Drop Malformed : 0
Rx Drop Proto Not Supported : 0 Tx Drop Proto Not Supported : 0
Rx Drop Replay : 0 Tx Drop Seq Rollover : 0
Rx Drop Inner Malformed : 0 Tx Drop Fragmentation Needed : 0
Rx Drop Policy Nomatch : 0 Rekey Request Failure : 0
Rx Drop Auth Failure : 0
Rx Drop Zero Sequence Number : 0
Multipath Stats
Path Index Rx Pkts Tx Pkts Rx Drops Tx Drops
0 0 0 0 0
1 120 138 0 0
2 0 0 0 0
3 0 0 0 0
4 0 0 0 0
5 100 102 0 0
6 0 0 0 0
7 0 0 0 0
----------------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec tunnel statistics and multipath statistics.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn tunnel multipath stats 621af021-cac1-48a6-a874-13844f2110a1
Interface UID : 274
Interface UUID : 621af021-cac1-48a6-a874-13844f2110a1
VTI UUID : 621af021-cac1-48a6-a874-13844f2110a1
Stats
Rx Pkts : 130 Tx Pkts : 160
Rx Bytes : 1201 Tx Bytes : 34455
Rx MSS Adjusted : 0 Tx MSS Adjusted : 0
Rx MSS Ignored : 0 Tx MSS Ignored : 0
Rx Drops : 0 Tx Drops : 0
Rx Drop Crypto Failure : 0 Tx Drop Crypto Failure : 0
Rx Drop Enqueue Failure : 0 Tx Drop Enqueue Failure : 0
Rx Drop State Mismatch : 0 Tx Drop State Mismatch : 0
Rx Drop Malformed : 0 Tx Drop Malformed : 0
Rx Drop Proto Not Supported : 0 Tx Drop Proto Not Supported : 0
Rx Drop Replay : 0 Tx Drop Seq Rollover : 0
Rx Drop Inner Malformed : 0 Tx Drop Fragmentation Needed : 0
Rx Drop Policy Nomatch : 0 Rekey Request Failure : 0
Rx Drop Auth Failure : 0
Rx Drop Zero Sequence Number : 0
Multipath Stats
Path Index Rx Pkts Tx Pkts Rx Drops Tx Drops
0 0 0 0 0
1 90 100 0 0
2 0 0 0 0
3 0 0 0 0
4 40 60 0 0
5 0 0 0 0
6 0 0 0 0
7 0 0 0 0
----------------------------------------------------------------------------------------------------
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPSec SA tunnel statistics.
Example
nsx-edge-1> get ipsecvpn tunnel stats
Interface UID : 294
Interface UUID : 00003400-0000-0402-0000-040300000000
Policy UUID : 00003400-0000-0402-0000-040300000000
Policy Rule Information
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.5.0/24
Outbound Rule ID : 1027 Inbound Rule ID : 2147484675
Action : RA_ENCRYPT
Stats
Rx Pkts : 5 Tx Pkts : 5
Rx Bytes : 420 Tx Bytes : 420
Rx MSS Adjusted : 0 Tx MSS Adjusted : 0
Rx MSS Ignored : 0 Tx MSS Ignored : 0
Rx Drops : 0 Tx Drops : 0
Rx Drop Crypto Failure : 0 Tx Drop Crypto Failure : 0
Rx Drop Enqueue Failure : 0 Tx Drop Enqueue Failure : 0
Rx Drop State Mismatch : 0 Tx Drop State Mismatch : 0
Rx Drop Malformed : 0 Tx Drop Malformed : 0
Rx Drop Proto Not Supported : 0 Tx Drop Proto Not Supported : 0
Rx Drop Replay : 0 Tx Drop Seq Rollover : 0
Rx Drop Inner Malformed : 0 Tx Drop Fragmentation Needed : 0
Rx Drop Policy Nomatch : 0 Rekey Request Failure : 0
Rx Drop Auth Failure : 0
Rx Drop Zero Sequence Number : 0
----------------------------------------------------------------------------------------------------
Interface UID : 295
Interface UUID : 00003400-0000-0404-0000-040500000000
Policy UUID : 00003400-0000-0404-0000-040500000000
Policy Rule Information
Local Subnet : 192.168.200.0/24 Peer Subnet : 2.2.6.0/24
Outbound Rule ID : 1031 Inbound Rule ID : 2147484679
Action : RA_ENCRYPT
Stats
Rx Pkts : 0 Tx Pkts : 0
Rx Bytes : 0 Tx Bytes : 0
Rx MSS Adjusted : 0 Tx MSS Adjusted : 0
Rx MSS Ignored : 0 Tx MSS Ignored : 0
Rx Drops : 0 Tx Drops : 0
Rx Drop Crypto Failure : 0 Tx Drop Crypto Failure : 0
Rx Drop Enqueue Failure : 0 Tx Drop Enqueue Failure : 0
Rx Drop State Mismatch : 0 Tx Drop State Mismatch : 0
Rx Drop Malformed : 0 Tx Drop Malformed : 0
Rx Drop Proto Not Supported : 0 Tx Drop Proto Not Supported : 0
Rx Drop Replay : 0 Tx Drop Seq Rollover : 0
Rx Drop Inner Malformed : 0 Tx Drop Fragmentation Needed : 0
Rx Drop Policy Nomatch : 0 Rekey Request Failure : 0
Rx Drop Auth Failure : 0
Rx Drop Zero Sequence Number : 0
----------------------------------------------------------------------------------------------------
Interface UID : 296
Interface UUID : a14f56f9-1e1e-4842-ba2a-543f1d1cbf68
VTI UUID : a14f56f9-1e1e-4842-ba2a-543f1d1cbf68
Stats
Rx Pkts : 0 Tx Pkts : 0
Rx Bytes : 0 Tx Bytes : 0
Rx MSS Adjusted : 0 Tx MSS Adjusted : 0
Rx MSS Ignored : 0 Tx MSS Ignored : 0
Rx Drops : 0 Tx Drops : 0
Rx Drop Crypto Failure : 0 Tx Drop Crypto Failure : 0
Rx Drop Enqueue Failure : 0 Tx Drop Enqueue Failure : 0
Rx Drop State Mismatch : 0 Tx Drop State Mismatch : 0
Rx Drop Malformed : 0 Tx Drop Malformed : 0
Rx Drop Proto Not Supported : 0 Tx Drop Proto Not Supported : 0
Rx Drop Replay : 0 Tx Drop Seq Rollover : 0
Rx Drop Inner Malformed : 0 Tx Drop Fragmentation Needed : 0
Rx Drop Policy Nomatch : 0 Rekey Request Failure : 0
Rx Drop Auth Failure : 0
Rx Drop Zero Sequence Number : 0
v6 Stats
Rx Pkts : 268 Tx Pkts : 265
Rx Bytes : 20168 Tx Bytes : 50240
Rx MSS Adjusted : 0 Tx MSS Adjusted : 18684
Rx MSS Ignored : 0 Tx MSS Ignored : 0
Rx Drops : 0 Tx Drops : 0
Rx Drop Crypto Failure : 0 Tx Drop Crypto Failure : 0
Rx Drop Enqueue Failure : 0 Tx Drop Enqueue Failure : 0
Rx Drop State Mismatch : 0 Tx Drop State Mismatch : 0
Rx Drop Malformed : 0 Tx Drop Malformed : 0
Rx Drop Proto Not Supported : 0 Tx Drop Proto Not Supported : 0
Rx Drop Replay : 0 Tx Drop Seq Rollover : 0
Rx Drop Inner Malformed : 0 Tx Drop Fragmentation Needed : 0
Rx Drop Policy Nomatch : 0 Rekey Request Failure : 0
Rx Drop Auth Failure : 0
Rx Drop Zero Sequence Number : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPSec SA tunnel statistics.
| Option | Description |
|---|---|
| <keypolicy-id> | Keypolicy ID for the rule Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn tunnel stats 00003400-0000-0402-0000-040300000000
Interface UID : 294
Interface UUID : 00003400-0000-0402-0000-040300000000
Policy UUID : 00003400-0000-0402-0000-040300000000
Policy Rule Information
Local Subnet : 192.168.100.0/24 Peer Subnet : 2.2.5.0/24
Outbound Rule ID : 1027 Inbound Rule ID : 2147484675
Action : RA_ENCRYPT
Stats
Rx Pkts : 5 Tx Pkts : 5
Rx Bytes : 420 Tx Bytes : 420
Rx MSS Adjusted : 0 Tx MSS Adjusted : 0
Rx MSS Ignored : 0 Tx MSS Ignored : 0
Rx Drops : 0 Tx Drops : 0
Rx Drop Crypto Failure : 0 Tx Drop Crypto Failure : 0
Rx Drop Enqueue Failure : 0 Tx Drop Enqueue Failure : 0
Rx Drop State Mismatch : 0 Tx Drop State Mismatch : 0
Rx Drop Malformed : 0 Tx Drop Malformed : 0
Rx Drop Proto Not Supported : 0 Tx Drop Proto Not Supported : 0
Rx Drop Replay : 0 Tx Drop Seq Rollover : 0
Rx Drop Inner Malformed : 0 Tx Drop Fragmentation Needed : 0
Rx Drop Policy Nomatch : 0 Rekey Request Failure : 0
Rx Drop Auth Failure : 0
Rx Drop Zero Sequence Number : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Displays all IPSec VPN VTI Rules.
Example
nsx-edge-1> get ipsecvpn vti rules 00000000-0000-0000-0000-00000000000c
UUID : 00000000-0000-0000-0000-00000000000c
KEY Policyid : 00000000-0000-0000-0000-00000000000b
Mode
Basic
Availability
Autonomous Edge, Edge
Display an IPSec VPN VTI rule.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get ipsecvpn vti rules 00000000-0000-0000-0000-00000000000c
KEY Policyid : 00000000-0000-0000-0000-00000000000b
Mode
Basic
Availability
Autonomous Edge, Edge
Display L2VPN sessions configuration for a given L2VPN service.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsxedge-ob-7490391-1-new> get l2vpn service 1d5bb34a-0480-45e4-1d5b-b34a048046b6 sessions config
DISPLAY_NAME: l2vpn_session1
ENABLED: True
ID: 1d5bb34a-0480-45e2-a261-bd5f98c24d36
L2VPN_SERVICE_ID: 1d5bb34a-0480-45e4-1d5b-b34a048046b6
MTU: 1500
TUNNEL_ENCAPSULATION:
LOCAL_ENDPOINT_IP:
IPV4: 1.1.1.2
PEER_ENDPOINT_IP:
IPV4: 1.1.1.3
PROTOCOL: GRE
VTI:
1d5bb34a-0480-45e3-a261-bd5f98c24d37
Mode
Basic
Availability
Autonomous Edge, Edge
Display all L2VPN services configuration.
Example
nsxedge-ob-7490391-1-new> get l2vpn services config
ENABLE_FULL_MESH: True
ID: 1d5bb34a-0480-46aa-a261-bd5f98c24b9c
SR_CLUSTER_ID: a261bd5f-98c2-4d37-1d5b-b34a048045e3
Mode
Basic
Availability
Autonomous Edge, Edge
Display stretched logical switch behind L2VPN session.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get l2vpn session 2ds29c11-8920-29q1-1029-2lk20129d910 logical-switch ea8c4460-6d15-49c5-a82e-6812a26b4200
Tunnel-Port : fe34062b-7ad3-5bca-beb8-1adde6c0d46e
Logical-Switch : ea8c4460-6d15-49c5-a82e-6812a26b4200
Switch-Port : 6289cca5-4ee7-40ad-8064-70c74c86122c
Bridge-Port : e249e1b6-9248-5975-b8aa-bbc4b33e2630
VNI : 1
Tunnel ID : 10
Local Egress GW: 192.168.100.14, 192.168.100.13
Mode
Basic
Availability
Autonomous Edge, Edge
Display remote macs learnt on L2VPN stretched logical-switch.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get l2vpn session 2ds29c11-8920-29q1-1029-2lk20129d910 logical-switch ea8c4460-6d15-49c5-a82e-6812a26b4200 remote-macs
MACs:
04:00:c0:a8:fa:a2
02:50:56:56:44:52
00:50:56:8e:1b:21
00:50:56:8e:9a:a5
Mode
Basic
Availability
Autonomous Edge, Edge
Display stats for stretched logical-switch behind L2VPN session.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get l2vpn session 2ds29c11-8920-29q1-1029-2lk20129d910 logical-switch ea8c4460-6d15-49c5-a82e-6812a26b4200 stats
RX-Packets : 4474
RX-Bytes : 302966
RX-Drops : 0
Malformed : 0
No-Match : 0
L2-Loop : 0
TX-Packets : 5527
TX-Bytes : 371568
TX-Drops : 0
TX-Drops : 0
No-Memory : 0
No-Linked-Port : 0
Arp-Request-Filter(Local-Egress): 3
Mode
Basic
Availability
Autonomous Edge, Edge
Display stretched logical switches behind given L2VPN session.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get l2vpn session 2ds29c11-8920-29q1-1029-2lk20129d910 logical-switches
Tunnel-Port : fe34062b-7ad3-5bca-beb8-1adde6c0d46e
Logical-Switch : 6aeaf0a7-110d-4d9d-bd76-b17032b36746
Switch-Port : c9fdf6aa-520a-4b08-8d0a-fa9e8e683ccf
Bridge-Port : f606ca0f-873d-55b9-b303-350aa2a3a5c1
VNI : 60297
Tunnel ID : 1000
Local Egress GW: 192.168.100.14, 192.168.100.13
Logical-Switch : 9cac13e9-eb71-4ce4-870e-ccc1dc8d6c3f
Switch-Port : 6289cca5-4ee7-40ad-8064-70c74c86122c
Bridge-Port : e249e1b6-9248-5975-b8aa-bbc4b33e2630
VNI : 60296
Tunnel ID : 2000
Mode
Basic
Availability
Autonomous Edge, Edge
Display stats for L2VPN session
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get l2vpn session abf1479d-bda6-443e-a890-5af0904368e4 stats
Thu May 28 17:17:13 2020
Session : abf1479d-bda6-443e-a890-5af0904368e4
Tunnel : 9d2c5c22-7485-5430-a04a-48853eedc37d
Local IP : 169.254.64.1
Remote IP : 169.254.64.2
Status : UP
RX-Packets : 39179
RX-Bytes : 3978859
RX-MSS-Adjusted : 6
RX-MSS-Ignored : 0
RX-Drops : 0
Malformed : 0
No-Match : 0
L2-Loop : 0
TX-Packets : 297574
TX-Bytes : 380742363
TX-MSS-Adjusted : 4
TX-MSS-Ignored : 1
TX-Drops : 1
No-Memory : 0
No-Route : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display status of specific L2VPN session.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get l2vpn session 2ds29c11-8920-29q1-1029-2lk20129d910 status
Session : 2ds29c11-8920-29q1-1029-2lk20129d910
Tunnel : 6598ab27-95c6-50ef-85b3-89b7811ab672
TCP MSS : 0
IPSec Session : d20c3216-3f25-4791-aecf-c26a01d0e8f9
Status : UP
Mode
Basic
Availability
Autonomous Edge, Edge
Display all L2VPN sessions information.
Example
nsx-edge-1> get l2vpn sessions
Session : 1d5bb34a-0480-45e2-a261-bd5f98c24d36
Tunnel : d87cd7e0-eb91-5dd5-bae4-ceb0a2760bfa
TCP MSS : 1310
IPSec Session : d20c3216-3f25-4791-aecf-c26a01d0e8f9
Status : UP
Session : 2ds29c11-8920-29q1-1029-2lk20129d910
Tunnel : 6598ab27-95c6-50ef-85b3-89b7811ab672
TCP MSS : 0
IPSec Session : c7d6a5a9-804a-42c6-b91a-2a887798d98d
Status : UP
Mode
Basic
Availability
Autonomous Edge, Edge
Display all L2VPN sessions configuration.
Example
nsxedge-ob-7490391-1-new> get l2vpn sessions config
DISPLAY_NAME: l2vpn_session1
ENABLED: True
ID: 1d5bb34a-0480-45e2-a261-bd5f98c24d36
L2VPN_SERVICE_ID: 1d5bb34a-0480-45e4-1d5b-b34a048046b6
MTU: 1500
TUNNEL_ENCAPSULATION:
LOCAL_ENDPOINT_IP:
IPV4: 1.1.1.2
PEER_ENDPOINT_IP:
IPV4: 1.1.1.3
PROTOCOL: GRE
VTI:
1d5bb34a-0480-45e3-a261-bd5f98c24d37
Mode
Basic
Availability
Autonomous Edge, Edge
Display all L2VPN sessions information on a logical-router.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get l2vpn sessions logical-router 1c4c0277-3c0f-4d6c-ab42-727c0072dd7d
Session : 1d5bb34a-0480-45e2-a261-bd5f98c24d36
Tunnel : d87cd7e0-eb91-5dd5-bae4-ceb0a2760bfa
TCP MSS : 1310
IPSec Session : d20c3216-3f25-4791-aecf-c26a01d0e8f9
Status : UP
Mode
Basic
Availability
Autonomous Edge, Edge
Display L2VPN sessions stats
Example
nsx-edge-1> get l2vpn sessions stats
Thu May 28 17:15:45 2020
Session : abf1479d-bda6-443e-a890-5af0904368e4
Tunnel : 9d2c5c22-7485-5430-a04a-48853eedc37d
Local IP : 169.254.64.1
Remote IP : 169.254.64.2
Status : UP
RX-Packets : 39179
RX-Bytes : 3978859
RX-MSS-Adjusted : 6
RX-MSS-Ignored : 0
RX-Drops : 0
Malformed : 0
No-Match : 0
L2-Loop : 0
TX-Packets : 297574
TX-Bytes : 380742363
TX-MSS-Adjusted : 4
TX-MSS-Ignored : 1
TX-Drops : 1
No-Memory : 0
No-Route : 0
Session : 26bb08a7-73d6-450a-81be-b4591284caab
Tunnel : 1478ef61-e7b4-5640-bbc9-a75dc55a4c17
Local IP : 169.254.64.1
Remote IP : 169.254.64.3
Status : UP
RX-Packets : 0
RX-Bytes : 0
RX-MSS-Adjusted : 0
RX-MSS-Ignored : 0
RX-Drops : 0
Malformed : 0
No-Match : 0
L2-Loop : 0
TX-Packets : 406
TX-Bytes : 47350
TX-MSS-Adjusted : 0
TX-MSS-Ignored : 0
TX-Drops : 0
No-Memory : 0
No-Route : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Get the last barrier processed by NestDb Pigeon for the specified transport node.
| Option | Description |
|---|---|
| <last-desc-arg> | Last barrier processed by NestDb Pigeon Allowed values: last |
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get last processed barrier 7c72c4ae-8fe8-4449-a4e2-c5e53ab0bb4f
1191
Mode
Basic
Availability
Manager
Display specified counter's detailed description.
| Option | Description |
|---|---|
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
| <counter-name> | Observability counters for specified kernel module Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get livetrace datapath-stats module nsxt-vdl2 counter arpProxyRespFiltered description verbose
Fri Jul 29 2022 UTC 17:53:57.223
Datapath Observability Counter Description
--------------------------------------------------
COUNTER NAME: arpProxyRespFiltered
VERBOSE DESCRIPTION:
Count of ARP responses corresponding to IP-MAC
binding response from CCP that are not sent to
switchport that requested ARP request. Possible
due to ARP was requested due to traceflow or port
that requested the ARP request was no more present
in the TN.
Mode
Basic
Availability
ESXi
List all the counters with brief description for the specified module.
| Option | Description |
|---|---|
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get livetrace datapath-stats module nsxt-vdl2 counters list
Fri Jul 29 2022 UTC 17:53:25.560
Datapath Observability Counters List
--------------------------------------------------------------------------------------------------------------
COUNTER_NAME BRIEF DESCRIPTION
leafRx Count of packets received at VDL2LeafInput IOChain of a switchport
leafTx Count of packets processed at VDL2LeafOutput IOChain of a switchport
uplinkRx Count of packets received at uplink port from underlay network
uplinkTx Count of packets transmitted through uplink port towards underlay network
uplinkRxSkipMACLearn Count of packets for which MAC learn was skipped at uplink input IOChain.
uplinkRxMcastInvalidDRUplinkDrops Count of IP multicast packets dropped at unexpected DR uplink
Mode
Basic
Availability
ESXi
Display specified kernel module's detailed description.
| Option | Description |
|---|---|
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> com> get livetrace datapath-stats module nsxt-vdl2 description verbose
Fri Jul 29 2022 UTC 17:53:39.445
Datapath Observability Counter Description
--------------------------------------------------
MODULE NAME: nsxt-vdl2
VERBOSE DESCRIPTION:
Overlay Layer-2 module responsible for workload
connectivity
Mode
Basic
Availability
ESXi
List all the observability enabled kernel modules with.
Example
esx-1> get livetrace datapath-stats modules list
Fri Jul 29 2022 UTC 17:53:13.316
Kernel Modules List
--------------------------------------------------------------------------------------------------
MODULE NAME BRIEF DESCRIPTION
nsxt-vdl2 Overlay Layer-2 module
nsxt-vdrb virtual distributed routing module
Mode
Basic
Availability
ESXi
Display all the counters for the specified livetrace session.
| Option | Description |
|---|---|
| <session-id> | Session ID argument. Allowed pattern: ^[0-9]+$ |
Example
esx-1> get livetrace datapath-stats session 69632 all
Fri Jul 29 2022 UTC 18:38:43.743
Datapath Observability All Counters
----------------------------------------------------------------------
FORWARD DIRECTION:
--------------------
Module : nsxt-vdl2
=================================================================
COUNTER NAME COUNTERS
leafRx 7515
leafTx 7522
.......
noRouteIPv6Drops 0
noNbrIPv6Drops 0
----------------------------------------------------------------------
REVERSE DIRECTION:
--------------------
Module : nsxt-vdl2
=================================================================
COUNTER NAME COUNTERS
leafRx 7517
leafTx 7524
......
mcastProxyRxDrops 0
mcastProxyTxDrops 0
Module : nsxt-vdrb
=================================================================
COUNTER NAME COUNTERS
rxIPv4 3777
txIPv4 3736
consumedICMPv4 3726
.....
noNbrIPv6Drops 0
---------------------------------------------------------------------
Mode
Basic
Availability
ESXi
Display all counters for the specified livetrace session.
| Option | Description |
|---|---|
| <session-id> | Session ID argument. Allowed pattern: ^[0-9]+$ |
Example
esx-1> get livetrace datapath-stats session 69632 all new
Fri Jul 29 2022 UTC 18:06:51.473
Datapath Observability New All Counters
-------------------------------------------------------------------------------------------------------------------
FORWARD DIRECTION:
--------------------
Module : nsxt-vdl2
==============================================================================================================
COUNTER NAME COUNTERS RATE(pkts/sec) DURATION(HH:MM:SS)
leafRx 5788 2.99 00:32:14.586388
leafTx 5795 3.0 00:32:14.586388
....
mcastProxyRxDrops 0 0.0 00:32:14.586388
mcastProxyTxDrops 0 0.0 00:32:14.586388
Module : nsxt-vdrb
==============================================================================================================
COUNTER NAME COUNTERS RATE(pkts/sec) DURATION(HH:MM:SS)
rxIPv4 1265 9.64 00:02:11.287151
txIPv4 1252 9.54 00:02:11.287151
consumedICMPv4 1249 9.51 00:02:11.287151
.....
noNbrIPv6Drops 0 0.0 00:02:11.287151
-------------------------------------------------------------------------------------------------------------------
REVERSE DIRECTION:
--------------------
Module : nsxt-vdl2
==============================================================================================================
COUNTER NAME COUNTERS RATE(pkts/sec) DURATION(HH:MM:SS)
leafRx 5794 2.99 00:32:14.885594
leafTx 5801 3.0 00:32:14.885594
....
mcastProxyRxDrops 0 0.0 00:32:14.885593
mcastProxyTxDrops 0 0.0 00:32:14.885593
Module : nsxt-vdrb
==============================================================================================================
COUNTER NAME COUNTERS RATE(pkts/sec) DURATION(HH:MM:SS)
rxIPv4 1266 9.63 00:02:11.412511
txIPv4 1253 9.53 00:02:11.412511
.....
noNbrIPv6Drops 0 0.0 00:02:11.412512
-------------------------------------------------------------------------------------------------------------------
Mode
Basic
Availability
ESXi
Display all drop counters of all modules for the specified livetrace session.
| Option | Description |
|---|---|
| <session-id> | Session ID argument. Allowed pattern: ^[0-9]+$ |
Example
esx-1> get livetrace datapath-stats session 69632 drops
Fri Jul 29 2022 UTC 17:59:29.015
Datapath Observability Drop Counters
----------------------------------------------------------------------
FORWARD DIRECTION:
--------------------
Module : nsxt-vdl2
============================================================
COUNTER NAME COUNTERS
leafTxDrops 0
leafRxSystemErrDrops 0
.....
mcastProxyTxDrops 0
Module : nsxt-vdrb
============================================================
COUNTER NAME COUNTERS
txDispatchQueueTooLongDrops 0
......
noNbrIPv6Drops 0
----------------------------------------------------------------------
REVERSE DIRECTION:
--------------------
Module : nsxt-vdl2
============================================================
COUNTER NAME COUNTERS
leafTxDrops 0
.....
mcastProxyTxDrops 0
Module : nsxt-vdrb
============================================================
COUNTER NAME COUNTERS
txDispatchQueueTooLongDrops 0
.....
noNbrIPv6Drops 0
----------------------------------------------------------------------
Mode
Basic
Availability
ESXi
Display new drop counters of all modules for the specified livetrace session.
| Option | Description |
|---|---|
| <session-id> | Session ID argument. Allowed pattern: ^[0-9]+$ |
Example
esx-1> get livetrace datapath-stats session 69632 drops new
Fri Jul 29 2022 UTC 18:00:58.031
Datapath Observability New Drop Counters
-------------------------------------------------------------------------------------------------------------------
FORWARD DIRECTION:
--------------------
Module : nsxt-vdl2
===================================================================================================================
COUNTER NAME COUNTERS RATE(pkts/sec) DURATION(HH:MM:SS)
leafTxDrops 0 0.0 00:01:28.826767
leafRxSystemErrDrops 0 0.0 00:01:28.826767
leafRxRefPortNotFoundDrops 0 0.0 00:01:28.826767
.....
mcastProxyTxDrops 0 0.0 00:01:28.826766
Module : nsxt-vdrb
===================================================================================================================
COUNTER NAME COUNTERS RATE(pkts/sec) DURATION(HH:MM:SS)
txDispatchQueueTooLongDrops 0 0.0 00:01:28.933968
....
noNbrIPv6Drops 0 0.0 00:01:28.933967
-------------------------------------------------------------------------------------------------------------------
REVERSE DIRECTION:
--------------------
Module : nsxt-vdl2
===================================================================================================================
COUNTER NAME COUNTERS RATE(pkts/sec) DURATION(HH:MM:SS)
leafTxDrops 0 0.0 00:01:29.028756
leafRxSystemErrDrops 0 0.0 00:01:29.028756
leafRxRefPortNotFoundDrops 0 0.0 00:01:29.028756
....
mcastProxyTxDrops 0 0.0 00:01:29.028756
Module : nsxt-vdrb
===================================================================================================================
COUNTER NAME COUNTERS RATE(pkts/sec) DURATION(HH:MM:SS)
txDispatchQueueTooLongDrops 0 0.0 00:01:29.028344
....
noRouteIPv6Drops 0 0.0 00:01:29.028343
noNbrIPv6Drops 0 0.0 00:01:29.028343
-------------------------------------------------------------------------------------------------------------------
Mode
Basic
Availability
ESXi
Display all the counters for the specified livetrace session and module.
| Option | Description |
|---|---|
| <session-id> | Session ID argument. Allowed pattern: ^[0-9]+$ |
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get livetrace datapath-stats session 69632 module nsxt-vdrb all
Fri Jul 29 2022 UTC 18:16:15.060
Datapath Observability All Counters
----------------------------------------------------------------------
FORWARD DIRECTION:
----------------------------------------------------------------------
COUNTER NAME COUNTERS
rxIPv4 1640
txIPv4 1623
....
noRouteIPv6Drops 0
noNbrIPv6Drops 0
----------------------------------------------------------------------
REVERSE DIRECTION:
----------------------------------------------------------------------
COUNTER NAME COUNTERS
rxIPv4 1641
txIPv4 1624
consumedICMPv4 1620
......
noNbrIPv6Drops 0
----------------------------------------------------------------------
Mode
Basic
Availability
ESXi
Display all new counters for the specified livetrace session and module.
| Option | Description |
|---|---|
| <session-id> | Session ID argument. Allowed pattern: ^[0-9]+$ |
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get livetrace datapath-stats session 69632 module nsxt-vdrb all new
Fri Jul 29 2022 UTC 18:16:58.101
Datapath Observability New All Counters
-------------------------------------------------------------------------------------------------------------------
FORWARD DIRECTION:
-------------------------------------------------------------------------------------------------------------------
COUNTER NAME COUNTERS RATE(pkts/sec) DURATION(HH:MM:SS)
rxIPv4 35 9.58 00:00:03.653778
txIPv4 35 9.58 00:00:03.653778
....
rpfIPv6Drops 0 0.0 00:00:03.653779
noRouteIPv6Drops 0 0.0 00:00:03.653779
noNbrIPv6Drops 0 0.0 00:00:03.653779
-------------------------------------------------------------------------------------------------------------------
REVERSE DIRECTION:
-------------------------------------------------------------------------------------------------------------------
COUNTER NAME COUNTERS RATE(pkts/sec) DURATION(HH:MM:SS)
rxIPv4 36 9.59 00:00:03.752978
txIPv4 36 9.59 00:00:03.752978
consumedICMPv4 36 9.59 00:00:03.752978
....
noNbrIPv6Drops 0 0.0 00:00:03.752978
------------------------------------------------------------------------------------------------------------------
Mode
Basic
Availability
ESXi
Display drop counters for the specified livetrace session and module.
| Option | Description |
|---|---|
| <session-id> | Session ID argument. Allowed pattern: ^[0-9]+$ |
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get livetrace datapath-stats session 69632 module nsxt-vdrb drops
Fri Jul 29 2022 UTC 18:02:22.017
Datapath Observability Drop Counters
----------------------------------------------------------------------
FORWARD DIRECTION:
-----------------------------------------------------------------
COUNTER NAME COUNTERS
txDispatchQueueTooLongDrops 0
.....
rpfIPv6Drops 0
noRouteIPv6Drops 0
noNbrIPv6Drops 0
----------------------------------------------------------------------
REVERSE DIRECTION:
-----------------------------------------------------------------
COUNTER NAME COUNTERS
txDispatchQueueTooLongDrops 0
....
nsHoldPktDrops 0
rpfIPv6Drops 0
noRouteIPv6Drops 0
noNbrIPv6Drops 0
----------------------------------------------------------------------
Mode
Basic
Availability
ESXi
Display new drop counters for the specified livetrace session and module.
| Option | Description |
|---|---|
| <session-id> | Session ID argument. Allowed pattern: ^[0-9]+$ |
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get livetrace datapath-stats session 69632 module nsxt-vdrb drops new
Fri Jul 29 2022 UTC 18:02:14.905
Datapath Observability New Drop Counters
-------------------------------------------------------------------------------------------------------------------
FORWARD DIRECTION:
-------------------------------------------------------------------------------------------------------------------
COUNTER NAME COUNTERS RATE(pkts/sec) DURATION(HH:MM:SS)
txDispatchQueueTooLongDrops 0 0.0 00:02:45.673562
rxPktParsingErrorDrops 0 0.0 00:02:45.673562
.....
noRouteIPv6Drops 0 0.0 00:02:45.673561
noNbrIPv6Drops 0 0.0 00:02:45.673561
-------------------------------------------------------------------------------------------------------------------
REVERSE DIRECTION:
-------------------------------------------------------------------------------------------------------------------
COUNTER NAME COUNTERS RATE(pkts/sec) DURATION(HH:MM:SS)
txDispatchQueueTooLongDrops 0 0.0 00:02:45.743122
rxPktParsingErrorDrops 0 0.0 00:02:45.743122
.....
noRouteIPv6Drops 0 0.0 00:02:45.743121
noNbrIPv6Drops 0 0.0 00:02:45.743121
-------------------------------------------------------------------------------------------------------------------
Mode
Basic
Availability
ESXi
List all the datapath-stats enabled livetrace sessions.
Example
esx-1> get livetrace datapath-stats sessions list
Livetrace Datapath Sessions Summary
--------------------------------------------------------------------------------
FORWARD DIRECTION:
--------------------------------------------------------------------------------
SESSION ID SESSION ACTIONS SESSION NAME
66 ['Datapath Stats'] livetrace-vm1-to-vm2
REVERSE DIRECTION:
--------------------------------------------------------------------------------
SESSION ID SESSION ACTIONS SESSION NAME
66 ['Datapath Stats'] livetrace-vm1-to-vm2
Mode
Basic
Availability
ESXi
Display LLDP configuration on all devices.
Example
KVM-TN-02> get lldp config
Device
Name : eth0
Tx : disabled
Rx : enabled
Tx Interval : NA
Device
Name : eth1
Tx : disabled
Rx : enabled
Tx Interval : NA
Device
Name : eth2
Tx : disabled
Rx : enabled
Tx Interval : NA
Device
Name : hyperbus
Tx : disabled
Rx : enabled
Tx Interval : NA
or
nsx-esx> get lldp config
Device
Name : vmnic1
Tx : disabled
Rx : enabled
Tx Interval : NA
or
nsx-edge-1> get lldp config
Device
Name : eth0
Tx : enabled
Rx : enabled
Tx Interval : 30
Device
Name : eth1
Tx : disabled
Rx : enabled
Tx Interval : 30
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Display LLDP configuration on given device.
| Option | Description |
|---|---|
| <interface-name> | LLDP interface argument |
Example
prme-vmkqa-net3002-dhcp133.eng.vmware.com> get lldp config vmnic1
Device
Name : vmnic1
Tx : disabled
Rx : enabled
Tx Interval : NA
Mode
Basic
Availability
ESXi
Display LLDP configuration on given device.
| Option | Description |
|---|---|
| <interface-name> | LLDP interface argument |
Example
KVM-TN-02> get lldp config eth0
Device
Name : eth0
Tx : enabled
Rx : enabled
Tx Interval : 30
Mode
Basic
Availability
KVM
Displays LLDP configuration given device.
| Option | Description |
|---|---|
| <interface-name> | LLDP interface argument |
Example
nsx-edge-1> get lldp config eth0
Device
Name : eth0
Tx : enabled
Rx : enabled
Tx Interval : 30
Mode
Basic
Availability
Autonomous Edge, Edge
Display LLDP Neighbor information on all devices.
Example
KVM-TN-02> get lldp neighbors
============================================================
Device : eth0
Neighbor Count : 0
============================================================
Device : eth1
Neighbor Count : 1
Neighbors
Chassis Id : eth1
Port Id : 00:50:56:ab:6c:6e
Port Description : driver_name: e1000e, driver_version: 3.2.6-k, firmware_version: 1.8-0
System Description : x86_64 #1 SMP Sun Jan 14 10:36:03 EST 2018
Enabled Capabilities : Bridge
Management Address:
Management Address : ::80fe:0:2a7:9ad6:300:0
ifIndex : 3
Organizationally Specific TLVs:
Maximum Frame Size : 161
============================================================
Device : eth2
Neighbor Count : 1
Neighbors
Chassis Id : eth2
Port Id : 00:50:56:ab:f6:3c
Port Description : driver_name: e1000e, driver_version: 3.2.6-k, firmware_version: 1.8-0
System Description : x86_64 #1 SMP Sun Jan 14 10:36:03 EST 2018
Enabled Capabilities : Bridge
Management Address:
Management Address : ::80fe:0:2a7:9ad6:400:0
ifIndex : 4
Organizationally Specific TLVs:
Maximum Frame Size : 151
============================================================
Device : hyperbus
Neighbor Count : 0
or
prme-vmkqa-net3002-dhcp133.eng.vmware.com> get lldp neighbors
============================================================
Device : vmnic1
Neighbor Count : 1
Neighbors
Chassis Id : 00:1a:a1:84:fb:ff
Port Id : Gi1/3
TTL : 93
Port Description : GigabitEthernet1/3
System Name : prme-vmkqa-4948c.eng.vmware.com
System Description : unknown
Enabled Capabilities : Router, TransparentBridge
Management Address : 10.115.160.146
Organizationally Specific TLVs:
Vlan ID : 16
or
nsx-edge-1> get lldp neighbors
Device : eth0
Neighbor Count : 1
Neighbors
Neighbor : eth0/0:50:56:b7:7f:47
Life Time : 111
System Name : NSX ESG
System Desc : NSX Edge Services Gateway
System Cap : ['Router']
Enabled Cap : ['Router']
Chassis Id : eth0
Port Id : 0:50:56:b7:7f:47
Port Desc : management iface
Mgmt Address
Address : 10.172.139.51
Addr Family : IPv4
Iface Number : 2
Iface Type : 2
MAC PHY Status
AutoNeg : supported
AutoNeg Status: enabled
PMDAutoNeg : supported
PMDAutoNeg Status: not-enabled
MAU Type : 16
Power via MDI
Port Class : PSE
Power Source : supported
PSE MDI State : enabled
PSE Pair Ctrl : yes
PSE Pair : 1
PSE Class : 2
Link Aggregation
Aggr Capability: yes
Aggr Status : enabled
Aggr Port Id : 1
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Display LLDP Neighbor information on given device.
| Option | Description |
|---|---|
| <interface-name> | LLDP interface argument |
Example
prme-vmkqa-net3002-dhcp133.eng.vmware.com> get lldp neighbors vmnic1
============================================================
Device : vmnic1
Neighbor Count : 1
Neighbors
Chassis Id : 00:1a:a1:84:fb:ff
Port Id : Gi1/3
TTL : 103
Port Description : GigabitEthernet1/3
System Name : prme-vmkqa-4948c.eng.vmware.com
System Description : unknown
Enabled Capabilities : Router, TransparentBridge
Management Address : 10.115.160.146
Organizationally Specific TLVs:
Vlan ID : 16
Mode
Basic
Availability
ESXi
Display LLDP Neighbor information on given device.
| Option | Description |
|---|---|
| <interface-name> | LLDP interface argument |
Example
KVM-TN-02> get lldp neighbors eth1
============================================================
Device : eth1
Neighbor Count : 1
Neighbors
Chassis Id : eth1
Port Id : 00:50:56:ab:6c:6e
Port Description : driver_name: e1000e, driver_version: 3.2.6-k, firmware_version: 1.8-0
System Description : x86_64 #1 SMP Sun Jan 14 10:36:03 EST 2018
Enabled Capabilities : Bridge
Management Address:
Management Address : ::80fe:0:2a7:9ad6:300:0
ifIndex : 3
Organizationally Specific TLVs:
Maximum Frame Size : 161
Mode
Basic
Availability
KVM
Displays LLDP Neighbor information on given device.
| Option | Description |
|---|---|
| <interface-name> | LLDP interface argument |
Example
nsx-edge-1> get lldp neighbors eth0
Device : eth0
Neighbor Count : 1
Neighbors
Neighbor : eth0/0:50:56:b7:7f:47
Life Time : 111
System Name : NSX ESG
System Desc : NSX Edge Services Gateway
System Cap : ['Router']
Enabled Cap : ['Router']
Chassis Id : eth0
Port Id : 0:50:56:b7:7f:47
Port Desc : management iface
Mgmt Address
Address : 10.172.139.51
Addr Family : IPv4
Iface Number : 2
Iface Type : 2
MAC PHY Status
AutoNeg : supported
AutoNeg Status: enabled
PMDAutoNeg : supported
PMDAutoNeg Status: not-enabled
MAU Type : 16
Power via MDI
Port Class : PSE
Power Source : supported
PSE MDI State : enabled
PSE Pair Ctrl : yes
PSE Pair : 1
PSE Class : 2
Link Aggregation
Aggr Capability: yes
Aggr Status : enabled
Aggr Port Id : 1
Mode
Basic
Availability
Autonomous Edge, Edge
Displays LLDP Statistics on all devices.
Example
nsx-edge-1> get lldp stats
TX Total : 36
TX Errors : 0
RX Total : 36
RX Errors : 0
RX Discards : 0
RX Deletes : 0
Device : eth0
Tx Total : 36
Tx Errors : 0
Device : eth0
Rx Total : 36
Rx Valid : 36
Rx Errors : 0
Rx Discards : 0
Rx Deletes : 0
Neighbor : eth0/0:50:56:b7:7f:47
Rx Total : 36
Rx Valid : 36
Rx Discards : 0
Rx TLV Errors : 0
Rx TLV Unrecognized: 0
Mode
Basic
Availability
Autonomous Edge, Edge
Displays LLDP Statistics on given device.
| Option | Description |
|---|---|
| <interface-name> | LLDP interface argument |
Example
nsx-edge-1> get lldp stats eth0
TX Total : 36
TX Errors : 0
RX Total : 36
RX Errors : 0
RX Discards : 0
RX Deletes : 0
Device : eth0
Tx Total : 36
Tx Errors : 0
Device : eth0
Rx Total : 36
Rx Valid : 36
Rx Errors : 0
Rx Discards : 0
Rx Deletes : 0
Neighbor : eth0/0:50:56:b7:7f:47
Rx Total : 36
Rx Valid : 36
Rx Discards : 0
Rx TLV Errors : 0
Rx TLV Unrecognized: 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-1> get load-balancer eba5f460-c660-4f82-8488-62231fb9aea3
Load Balancer
Access Log Enabled : False
Display Name : mydlb
Enabled : True
UUID : 3d62a405-c24c-442d-ba98-e0c1200b7fce
Log Level : LB_LOG_LEVEL_INFO
Relax Scale Validation : False
Size : DLB
Virtual Server Id : f1e1eadd-0928-4643-8ff8-77dbaa350ae1
Mode
Basic
Availability
ESXi
Display the error log file for a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-1> get load-balancer 4d3eafaa-5a16-422a-80d9-f799cb4bd40a error-log
2019-11-04T20:27:43.266Z cpu6:1000152537)[INFO] lb: received lb config update, full config sync 0, 1 lb messages.
2019-11-04T20:27:45.199Z cpu7:1000152537)[INFO] lb: received lb config update, full config sync 0, 1 lb messages.
Mode
Basic
Availability
ESXi
Display the persistence tables of a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-1> get load-balancer eba5f460-c660-4f82-8488-62231fb9aea3 persistence-tables
Persistence-Tables
FILTER_NAME PROTO VADDR VPORT DADDR DPORT LIFE_TIME(s) NUM_SESSIONS
nic-1000050137-eth1-vmware-sfw.2 TCP 123.123.123.123 80 192.168.100.162 80 30 1
Mode
Basic
Availability
ESXi
Display the statistics for a specific load balancer and pool.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <pool-uuid> | Pool UUID argument |
Example
nsx-1> get load-balancer ed785df6-2143-4944-b918-66470886be83 pool 953e4da8-a571-4695-b54c-90505d8e59c2 stats
Pool
UUID : 65002572-e03a-4d57-8f41-77a725385624
Type : L4
Total L4 Session : 0
Current L4 Session : 0
Current L4 Session Rate : 0
L4 Session Max : 0
Bytes :
(In, Out) : (0, 0)
Packets :
(In, Out) : (0, 0)
Bytes Rate :
(In, Out) : (0, 0)
Packets rate :
(In, Out) : (0, 0)
Pool Member
IP : 192.168.100.160
Ports : 80
Total L4 Session : 0
Current L4 Session : 0
Current L4 Session Rate : 0
L4 Session Max : 0
Bytes :
(In, Out) : (0, 0)
Packets :
(In, Out) : (0, 0)
Bytes Rate :
(In, Out) : (0, 0)
Packets rate :
(In, Out) : (0, 0)
Pool Member
IP : 192.168.100.161
Ports : 80
Total L4 Session : 0
Current L4 Session : 0
Current L4 Session Rate : 0
L4 Session Max : 0
Bytes :
(In, Out) : (0, 0)
Packets :
(In, Out) : (0, 0)
Bytes Rate :
(In, Out) : (0, 0)
Packets rate :
(In, Out) : (0, 0)
Mode
Basic
Availability
ESXi
Display the pools of a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-1> get load-balancer eba5f460-c660-4f82-8488-62231fb9aea3 pools
Load Balancer
UUID : eba5f460-c660-4f82-8488-62231fb9aea3
Pool
UUID : e85dcbea-aa64-486b-965e-c6f4250b237a
Mode
Basic
Availability
ESXi
Display the statistics for all the pools of a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-1> get load-balancer ed785df6-2143-4944-b918-66470886be83 pools stats
Pool
UUID : 65002572-e03a-4d57-8f41-77a725385624
Type : L4
Total L4 Session : 0
Current L4 Session : 0
Current L4 Session Rate : 0
L4 Session Max : 0
Bytes :
(In, Out) : (0, 0)
Packets :
(In, Out) : (0, 0)
Bytes Rate :
(In, Out) : (0, 0)
Packets rate :
(In, Out) : (0, 0)
Pool
UUID : fdcf967b-4fa3-497d-a450-e401f50aa9a6
Type : L4
Total L4 Session : 0
Current L4 Session : 0
Current L4 Session Rate : 0
L4 Session Max : 0
Bytes :
(In, Out) : (0, 0)
Packets :
(In, Out) : (0, 0)
Bytes Rate :
(In, Out) : (0, 0)
Packets rate :
(In, Out) : (0, 0)
Mode
Basic
Availability
ESXi
Display sessions of load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-1> get load-balancer 60f50e2c-9fb8-4fe5-b444-a9ebfa160e11 sessions
L4 Session-Tables
PROTO CADDR CPORT VADDR VPORT DADDR DPORT
TCP 1.1.5.10 55646 123.123.123.124 80 192.168.100.161 80
TCP 1.1.5.10 55647 123.123.123.124 80 192.168.100.162 80
TCP 1.1.5.10 55648 123.123.123.124 80 192.168.100.160 80
TCP 1.1.6.10 38263 123.123.123.124 80 192.168.100.160 80
Mode
Basic
Availability
ESXi
Display stats for load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-1> get load-balancer 60f50e2c-9fb8-4fe5-b444-a9ebfa160e11 stats verbose
Load Balancer
UUID : 60f50e2c-9fb8-4fe5-b444-a9ebfa160e11
Total L4 Sessions : 8783
Current L4 Sessions : 8783
Current L4 Sessions Rate : 2024
L4 Sessions Max : 8783
Mode
Basic
Availability
ESXi
Display verbose stats for load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-1> get load-balancer 60f50e2c-9fb8-4fe5-b444-a9ebfa160e11 stats verbose
Load Balancer
UUID : 60f50e2c-9fb8-4fe5-b444-a9ebfa160e11
Total L4 Sessions : 8783
Current L4 Sessions : 8783
Current L4 Sessions Rate : 2024
L4 Sessions Max : 8783
New Flow - VS Matched : 0
New Flow - Server Selected : 0
New Flow Accepted : 0
Flow Validate LBS Replaced After Full Sync : 0
Src IP Persistence Entry Added : 0
Src IP Persistence Entry Deleted : 0
PM List Resize Count : 1
Config Update:
LBS Update Error - No Memory : 0
LBS Update Error - Unexpected LSPs to Unlink : 0
Filter Not Found : 0
VS Update Error - Reached Maximum Limit : 0
VS Update Error - No Memory : 0
Pool Update Error - No Memory : 0
Pool Update Error (New Pool) - PM Exists : 0
Pool Update Error - Invalid PM Count : 0
Pool Update Error - PM Not Found At Detaching : 0
Pool Update Error - Dup PM Found At Attaching : 0
VS Delete Error - VS Not Found : 0
Pool Delete Error - Pool Not Found : 0
L4 Flow Rejected : 0
LBS Invalid : 0
Session Limit Reached : 0
Flow Validate Bypassed:
Flow/Kif LBS Diff : 0
LBS Invalid : 0
Kif LBS Is Null : 0
Src IP Persistence:
Purge Error - Failed to Add to RB Tree : 0
Entry Deleted - Failed to Create State : 0
Export/Import:
State Import - LBS State Inserted : 0
State Import - VS Not Found : 0
State Import - PM Not Found : 0
State Import - SIP Not Found : 0
State Import - LBS State Insert Failed : 0
SIP Import - Entry Has No Flow : 0
SIP Import - Entry Has Flow but was in purge : 0
SIP Import - Entry Deleted : 0
Mode
Basic
Availability
ESXi
Display the status of a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-1> get load-balancer ed785df6-2143-4944-b918-66470886be83 status
Load Balancer
UUID : ed785df6-2143-4944-b918-66470886be83
Display-Name : lbs-dgo
Status : ready
Ready LSP Count : 2
Not Ready LSP Count: 0
Conflict LSP Count : 0
Ready LSP : 08e711a2-f8dd-4092-9dd9-231c9d1fc7d0
4ef68b6a-67a6-4e46-9b1d-9121d5822e6a
Not Ready LSP :
Conflict LSP :
Mode
Basic
Availability
ESXi
Display the backend server IP address for the specified source IP traffic..
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
| <ip-address> | Network IP address argument |
Example
nsx-1> get load-balancer a8fecedc-5c54-4019-8d99-634a1740dcd4 virtual-server 91dd7950-7245-4d98-98b8-3a9553388b5b hash 1.1.5.10
Sun Jan 03 2021 UTC 16:51:19.219
Traffic Source IP Backend Server IP
1.1.5.10 192.168.100.160
Mode
Basic
Availability
ESXi
Display the statistics for a specific load balancer and virtual server.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
Example
nsx-1> get load-balancer ed785df6-2143-4944-b918-66470886be83 virtual-server 953e4da8-a571-4695-b54c-90505d8e59c2 stats
Virtual Server
UUID : 0f8175bc-6c2f-4c65-85bf-724af5f3c401
Type : L4
VIP : TCP 123.123.123.123:80
Total L4 Session : 0
Current L4 Session : 0
Current L4 Session Rate : 0
L4 Session Max : 0
Bytes :
(In, Out) : (0, 0)
Packets :
(In, Out) : (0, 0)
Bytes Rate :
(In, Out) : (0, 0)
Packets rate :
(In, Out) : (0, 0)
Mode
Basic
Availability
ESXi
Display verbose statistics for a specific load balancer and virtual server.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
Example
nsx-1> get load-balancer ed785df6-2143-4944-b918-66470886be83 virtual-server 953e4da8-a571-4695-b54c-90505d8e59c2 stats verbose
Virtual Server
UUID : 953e4da8-a571-4695-b54c-90505d8e59c2
Current L4 session : 0
Total L4 session : 0
New flow - VS matched : 0
New flow - server selected : 0
New flow accepted : 0
L4 flow rejected - lbs invalid : 0
L4 flow rejected - vs has no pool : 0
L4 flow rejected - vs has empty pool : 0
L4 flow rejected - pm select error : 0
L4 flow rejected - syn expected : 0
L4 flow rejected - no session alloc : 0
Src IP persistence entry added : 0
Src IP persistence - removed (no pm found) : 0
Src IP persistence - add error (no memory) : 0
Src IP persistence - purge error (failed to add to RB tree): 0
Mode
Basic
Availability
ESXi
Display the virtual servers of a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-1> get load-balancer eba5f460-c660-4f82-8488-62231fb9aea3 virtual-servers
Load Balancer
UUID : 1ec99bec-cd8d-4231-ad52-517a2c0833b7
Virtual Server
UUID : 1117b0d3-5e9f-41dd-b294-85fb8a9c0d6c
IP : 123.123.123.124:80
Mode
Basic
Availability
ESXi
Display the statistics for all virtual servers of a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-1> get load-balancer ed785df6-2143-4944-b918-66470886be83 virtual-servers stats
Virtual Server
UUID : 0f8175bc-6c2f-4c65-85bf-724af5f3c401
Type : L4
VIP : TCP 123.123.123.123:80
Total L4 Session : 0
Current L4 Session : 0
Current L4 Session Rate : 0
L4 Session Max : 0
Bytes :
(In, Out) : (0, 0)
Packets :
(In, Out) : (0, 0)
Bytes Rate :
(In, Out) : (0, 0)
Packets rate :
(In, Out) : (0, 0)
Virtual Server
UUID : 3d13bd90-26e7-4753-9d18-04b83d97e705
Type : L4
VIP : TCP 123.123.123.124:80
Total L4 Session : 0
Current L4 Session : 0
Current L4 Session Rate : 0
L4 Session Max : 0
Bytes :
(In, Out) : (0, 0)
Packets :
(In, Out) : (0, 0)
Bytes Rate :
(In, Out) : (0, 0)
Packets rate :
(In, Out) : (0, 0)
Mode
Basic
Availability
ESXi
Display a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> get load-balancer eba5f460-c660-4f82-8488-62231fb9aea3
Load Balancer
Access Log Enabled : False
Applied To :
Logical Router Id : c46b1482-0638-4ed0-959b-06ca203cf50b
Service Router Id : 95327762-ddfc-4196-b92b-671fd1b99e25
Display Name : lbs-on-lr1
Enabled : True
UUID : eba5f460-c660-4f82-8488-62231fb9aea3
Log Level : LB_LOG_LEVEL_INFO
Size : SMALL
Virtual Server Id : 37f1a8c9-ab8b-4ee9-9b41-5da317ac05d3
26168a79-48d6-44a7-86fe-0d5ee7c91e47
7e012072-0594-4063-97f0-82452e9a2813
11bb214f-bd06-4bff-b2a5-6f82e5ec62b6
110ac92c-1647-48a5-8d66-4cac06817716
Mode
Basic
Availability
Autonomous Edge, Edge
Show load balancer diagnosis information
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> get load-balancer 2433423e-4c52-489b-b987-8477b015b255 diagnosis
Checking
Action : checking system
Result : passed
Action : checking crash
Result : passed
Action : checking deamon status
Result : lb processes are not running.
Mode
Basic
Availability
Autonomous Edge, Edge
Display the error log file for a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> get load-balancer 4d3eafaa-5a16-422a-80d9-f799cb4bd40a error-log
2017/11/16 11:41:43 [info] 8290#0: Initialized l4lb zone (size: 3674112)
2017/11/16 11:41:43 [info] 8290#0: Initialized lb zone (size: 5550080)
2017/11/16 11:41:43 [debug] 8290#0: bind() 127.0.0.1:80 #16
2017/11/16 11:41:43 [info] 8290#0: lb stats module is disabled, configure lbstats_size to enable it.
2017/11/16 11:41:43 [notice] 8290#0: using the "epoll" event method
2017/11/16 11:41:43 [debug] 8290#0: counter: 00007B5D15B1A080, 1
2017/11/16 11:41:43 [info] 8290#0: lb allocated connection ctx (size: 56)
.
.
.
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> get load-balancer 4d3eafaa-5a16-422a-80d9-f799cb4bd40a error-log follow
2017/11/16 22:32:13 [debug] 8326#0: worker cycle
2017/11/16 22:32:13 [debug] 8326#0: epoll timer: 346
2017/11/16 22:32:14 [debug] 8326#0: timer delta: 346
2017/11/16 22:32:14 [debug] 8326#0: event timer del: 0: 1510871534258
2017/11/16 22:32:14 [debug] 8326#0: event timer add: 0: 2500:1510871536758
2017/11/16 22:32:14 [debug] 8326#0: http check begin handler index: 1, owner: -1, ngx_pid: 8326, interval: 2479, check_interval: 5000
2017/11/16 22:32:14 [debug] 8326#0: shmtx lock
.
.
.
Mode
Basic
Availability
Autonomous Edge, Edge
Display error log messages containing strings that match the given regular expression pattern for a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <regex> | Regular expression |
Example
nsx-edge-1> get load-balancer 4d3eafaa-5a16-422a-80d9-f799cb4bd40a error-log reg-filter req.*
2017/11/16 11:41:48 [debug] 8326#0: ha: sent bulk pull request
2017/11/16 11:41:48 [notice] 8326#0: ha: sent full sync request, enter request state
2017/11/16 11:41:55 [debug] 8326#0: *3 http wait request handler
2017/11/16 11:41:55 [debug] 8326#0: *3 http process request line
2017/11/16 11:41:55 [debug] 8326#0: *3 http request line: "GET /show_status/all HTTP/1.1"
2017/11/16 11:41:55 [debug] 8326#0: *3 http process request header line
.
.
.
Mode
Basic
Availability
Autonomous Edge, Edge
Display the health check table of a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> get load-balancer 0f6510bb-ff15-4385-9c45-a1ce626fc276 health-check-table
Health-Check-Table
MONITOR POOLS TYPE NAME STATUS RISE FALL PORT CHECK_TIME CHANGE_TIME FAIL_REASON ERRNO STATUS_CODE
0c03 d6e23c- tcp 127.0.0.1:3971 down 0 193 0 Aug 25 01:13:48 Aug 25 01:23:51 Connect Fail Connection refused n/a
0c03 d6e23c- tcp 127.0.0.1:3972 down 0 190 0 Aug 25 01:13:48 Aug 25 01:23:50 Connect Fail Connection refused n/a
0c03 d6e23c- tcp 127.0.0.1:3970 up 192 0 0 Aug 25 01:13:52 Aug 25 01:23:52 n/a n/a n/a
0c03 26905e- tcp 127.0.0.1:3976 down 0 195 0 Aug 25 01:13:48 Aug 25 01:23:51 Connect Fail Connection refused n/a
62b7 408b54- http 127.0.0.1:1971 down 0 196 0 Aug 25 01:13:48 Aug 25 01:23:51 Connect Fail Connection refused n/a
62b7 408b54- http 127.0.0.1:1970 down 0 175 0 Aug 25 01:13:48 Aug 25 01:23:51 Rx HTTP Code 4XX n/a 403
62b7 d25f10- http 127.0.0.1:1972 down 0 195 0 Aug 25 01:13:48 Aug 25 01:23:52 Connect Fail Connection refused n/a
88bd d25f10- http 127.0.0.1:1973 down 0 195 0 Aug 25 01:13:48 Aug 25 01:23:51 Connect Fail Connection refused n/a
88fa d25f10- http 127.0.0.1:1974 down 0 192 0 Aug 25 01:13:48 Aug 25 01:23:51 Connect Fail Connection refused n/a
a528 d25f10- http 127.0.0.1:1975 down 0 193 0 Aug 25 01:13:48 Aug 25 01:23:52 Connect Fail Connection refused n/a
eb46 d25f10- http 127.0.0.1:1976 down 0 192 0 Aug 25 01:13:48 Aug 25 01:23:52 Connect Fail Connection refused n/a
Mode
Basic
Availability
Autonomous Edge, Edge
Display the HA state of a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> get load-balancer 0f6510bb-ff15-4385-9c45-a1ce626fc276 HA-State
LB HA is disable
Mode
Basic
Availability
Autonomous Edge, Edge
Display a specific load balancer monitor.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <monitor-uuid> | Monitor UUID argument |
Example
nsx-edge-1> get load-balancer eba5f460-c660-4f82-8488-62231fb9aea3 monitor 72945dda-f4f1-532f-9bd0-a3f52c099d4b
Monitor
Display Name : nsx-default-https-monitor
Fall Count : 3
Https Monitor :
Authenticate Depth : 3
Cipher : TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
Protocol :
TLS_V1_1
TLS_V1_2
Request Method : HTTP_METHOD_GET
Request Version : HTTP_VERSION_1_1
Response Status : HTTP_STATUS_2XX
Server Auth : SERVER_AUTH_IGNORE
UUID : 72945dda-f4f1-532f-9bd0-a3f52c099d4b
Interval : 5
Monitor Port : 443
Rise Count : 3
Timeout : 1970-01-01 00:00:00.015000 (timestamp: 15)
Type : HTTPS
Mode
Basic
Availability
Autonomous Edge, Edge
Show the health check table of a load balancer monitor.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <monitor-uuid> | Monitor UUID argument |
Example
nsx-edge> get load-balancer ed785df6-2143-4944-b918-66470886be83 monitor 72945dda-f4f1-532f-9bd0-a3f52c099d4b status
Health-Check-Table
MONITOR POOLS TYPE NAME STATUS RISE FALL PORT CHECK_TIME CHANGE_TIME FAIL_REASON ERRNO STATUS_CODE
0c03 d6e23c- icmp 192.168.100.160:0 up 10755 0 0 Jun 1 11:28:43 May 28 08:30:00 n/a n/a n/a
62b7 d6e23c- icmp 192.168.100.161:0 up 20820 0 0 Jun 1 11:28:46 May 28 08:30:02 n/a n/a n/a
Mode
Basic
Availability
Autonomous Edge, Edge
Display the monitors for a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> get load-balancer eba5f460-c660-4f82-8488-62231fb9aea3 monitors
Monitor
Display Name : nsx-default-http-monitor
Fall Count : 3
Http Monitor :
Request Method : HTTP_METHOD_GET
Request Version : HTTP_VERSION_1_1
Response Status : HTTP_STATUS_2XX
UUID : c2cb7f9e-72d7-55ed-914e-5209b67d02b2
Interval : 5
Monitor Port : 80
Rise Count : 3
Timeout : 1970-01-01 00:00:00.015000 (timestamp: 15)
Type : HTTP
Monitor
Display Name : nsx-default-https-monitor
Fall Count : 3
Https Monitor :
Authenticate Depth : 3
Cipher : TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
Protocol :
TLS_V1_1
TLS_V1_2
Request Method : HTTP_METHOD_GET
Request Version : HTTP_VERSION_1_1
Response Status : HTTP_STATUS_2XX
Server Auth : SERVER_AUTH_IGNORE
UUID : 72945dda-f4f1-532f-9bd0-a3f52c099d4b
Interval : 5
Monitor Port : 443
Rise Count : 3
Timeout : 1970-01-01 00:00:00.015000 (timestamp: 15)
Type : HTTPS
Mode
Basic
Availability
Autonomous Edge, Edge
Display the persistence tables of a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> get load-balancer 0f6510bb-ff15-4385-9c45-a1ce626fc276 persistence-tables
Persistence-Tables
TABLE :ag32445y-bec7-4ee5-b03c-fc037b3cbfe2
VIP :bg32445y-bec7-4ee5-bb3j-fc037b3cgfe5
KEY DADDR DPORT LIFE_TIME(s) NUM_SESSIONS
b3aa5...fwefd_b3aa5745-bec7-4ee5-b03c-fc037b3cbfeb3aa5745-bec7-4ee5-b03c-fwefd 192.168.100.30 80 109 0
mbbb5745-bec7-4ee5-b03c-fc037b3cbfe_192.168.100.10 192.168.100.0 80 108 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display a specific load balancer pool.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <pool-uuid> | Pool UUID argument |
Example
nsx-edge-1> get load-balancer eba5f460-c660-4f82-8488-62231fb9aea3 pool 29e66f11-d589-4208-a78d-f72e18aa8286
Pool
Algorithm : ROUND_ROBIN
Display Name : tcppool1
UUID : 29e66f11-d589-4208-a78d-f72e18aa8286
Member Group :
Admin State : ENABLED
Container Id : aded6b65-54ce-47b7-8da6-92fa0d96ccf4
Ip Revision Filter : IPV4
Max Ip List Size : 100
Min Active Members : 1
Snat Translation :
Auto Map : True
Port Overload : 1
Tcp Multiplexing Enabled : False
Tcp Multiplexing Number : 6
Member Group
UUID : aded6b65-54ce-47b7-8da6-92fa0d96ccf4
Ip Address :
Ipv4 : 192.168.1.2
Prefix Length : 31
Ipv4 : 192.168.1.4
Prefix Length : 31
Ipv4 : 192.168.1.6
Prefix Length : 32
Ipv4 : 192.168.4.8
Prefix Length : 24
Ipv4 : 192.168.1.8
Prefix Length : 32
Ipv4 : 192.168.1.1
Prefix Length : 32
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about an LB pool.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <pool-uuid> | Pool UUID argument |
Example
nsx-edge-1> get load-balancer 17b8637a-c816-41dd-b793-6d0acfa53569 pool 5b501a56-e56f-4a76-bba4-70f0de2dbc26 snat-pools
SNAT : nat_336860180_4
Min Port : 4096
Max Port : 65535
Port Overload Factor : 32
Random Port : False
Snat IP : 20.20.20.20 Allocated Port: 0
Snat IP : 20.20.20.21 Allocated Port: 1
Snat IP : 20.20.20.22 Allocated Port: 0
Snat IP : 20.20.20.23 Allocated Port: 1
Mode
Basic
Availability
Autonomous Edge, Edge
Display the statistics for a specific load balancer and pool.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <pool-uuid> | Pool UUID argument |
Example
nsx-edge-1> get load-balancer ed785df6-2143-4944-b918-66470886be83 pool 953e4da8-a571-4695-b54c-90505d8e59c2 stats
Pool
UUID : 953e4da8-a571-4695-b54c-90505d8e59c2
Display-Name : tcp pool
Type : L4
Sessions :
(Cur, Max, Total, Rate) : (0, 0, 0, 0)
Bytes :
(In, Out) : (0, 0)
Packets :
(In, Out) : (0, 0)
Pool Member
Display-Name : m1
IP : 192.168.1.1
Port : 80
Sessions :
(Cur, Max, Total, Rate) : (0, 0, 0, 0)
Bytes :
(In, Out) : (0, 0)
Packets :
(In, Out) : (0, 0)
Mode
Basic
Availability
Autonomous Edge, Edge
Display the status of a specific load balancer and pool.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <pool-uuid> | Pool UUID argument |
Example
nsx-edge-1> get load-balancer ed785df6-2143-4944-b918-66470886be83 pool 2197df80-77d3-44e6-89b3-1db930be374d status
Pool
UUID : 2197df80-77d3-44e6-89b3-1db930be374d
Display-Name : tcppool1
Status : up
Total-Members : 2
Primary Up : 0
Primary Down : 0
Primary Disabled : 0
Primary Graceful Disabled : 0
Backup Up : 0
Backup Down : 0
Backup Graceful Disabled : 0
Backup Disabled : 0
Member
Display-Name : m1
IP : 192.168.2.201
Port : 8888
Status : up
Last-State-Change-Time : 2019-10-08 02:32:56
L4-Passive-State : down
L4-Passive-Last-Change-Time : 2019-07-31 04:38:13
Monitor
Display-Name : TEST_MONITOR_HTTP
Type : HTTP
Status : up
Url : /test.html
Last-Check-Time : 2019-10-08 02:34:16
Last-State-Change-Time : 2019-10-08 02:32:56
Monitor
Display-Name : LB_Http_Monitor
Type : HTTP
Status : up
Url : /
Last-Check-Time : 2019-10-08 02:34:16
Last-State-Change-Time : 2019-10-08 02:32:56
Member
Display-Name : m2
IP : 192.168.2.202
Port : 8888
Status : up
Last-State-Change-Time : 2019-10-08 02:32:56
L4-Passive-State : down
L4-Passive-Last-Change-Time : 2019-07-31 04:38:13
Monitor
Display-Name : TEST_MONITOR_HTTP
Type : HTTP
Status : up
Url : /test.html
Last-Check-Time : 2019-10-08 02:34:16
Last-State-Change-Time : 2019-10-08 02:32:56
Monitor
Display-Name : LB_Http_Monitor
Type : HTTP
Status : up
Url : /
Last-Check-Time : 2019-10-08 02:34:16
Last-State-Change-Time : 2019-10-08 02:32:56
Mode
Basic
Availability
Autonomous Edge, Edge
Display the pools of a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> get load-balancer eba5f460-c660-4f82-8488-62231fb9aea3 pools
Pool
Active Monitor Id :
c2cb7f9e-72d7-55ed-914e-5209b67d02b2
Algorithm : ROUND_ROBIN
Display Name : httppool1
UUID : d39f9ed7-444c-493d-8c99-327a30befe8e
Member :
Admin State : ENABLED
Backup Member : False
Display Name : m1
Ip Address :
Ipv4 : 192.168.1.1
Port : 80
Weight : 1
Admin State : ENABLED
Backup Member : False
Display Name : m2
Ip Address :
Ipv4 : 192.168.1.2
Port : 80
Weight : 1
Min Active Members : 1
Snat Translation :
Auto Map : True
Port Overload : 1
Tcp Multiplexing Enabled : False
Tcp Multiplexing Number : 6
Pool
Algorithm : ROUND_ROBIN
Display Name : tcppool1
UUID : 29e66f11-d589-4208-a78d-f72e18aa8286
Member Group :
Admin State : ENABLED
Container Id : aded6b65-54ce-47b7-8da6-92fa0d96ccf4
Ip Revision Filter : IPV4
Max Ip List Size : 100
Min Active Members : 1
Snat Translation :
Auto Map : True
Port Overload : 1
Tcp Multiplexing Enabled : False
Tcp Multiplexing Number : 6
Mode
Basic
Availability
Autonomous Edge, Edge
Display the statistics for all the pools of a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> get load-balancer ed785df6-2143-4944-b918-66470886be83 pools stats
Pool
UUID : 953e4da8-a571-4695-b54c-90505d8e59c2
Display-Name : tcp pool
Type : L4
Sessions :
(Cur, Max, Total, Rate) : (0, 0, 0, 0)
Bytes :
(In, Out) : (0, 0)
Packets :
(In, Out) : (0, 0)
Pool
UUID : 0ba2817e-9ddb-411e-a397-ef2f3b099a46
Display-Name : http pool
Type : L7
Sessions :
(Cur, Max, Total, Rate) : (0, 0, 0, 0)
Bytes :
(In, In-Rate) : (0, 0)
(Out, Out-Rate) : (0, 0)
HTTP Requests :
(Total, Rate) : (0, 0)
Pool
UUID : 0ba2817e-9ddb-411e-a397-ef2f3b099a83
Display-Name : shared pool
Type : L4 and L7
Sessions :
(Cur, Max, Total, Rate) : (0, 0, 0, 0)
Bytes :
(In, Out) : (0, 0)
Mode
Basic
Availability
Autonomous Edge, Edge
Display the status of all the pools of a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> get load-balancer ed785df6-2143-4944-b918-66470886be83 pools status
Pool
UUID : 2197df80-77d3-44e6-89b3-1db930be374d
Display-Name : tcppool1
Members : 2
Status : up
Primary-UP-No : 0
Backup-UP-No : 0
Pool
UUID : 5cca6ba3-5732-4ea9-8197-c582e211a0aa
Display-Name : httppool1
Members : 2
Status : up
Primary-UP-No : 0
Backup-UP-No : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display the sessions of a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> get load-balancer eba5f460-c660-4f82-8488-62231fb9aea3 session-tables
Session-Tables
TABLE ID PROTO CADDR CPORT VADDR VPORT SADDR SPORT DADDR DPORT
l4lb-0 0000000000000000 udp 10.10.10.10 2000 20.20.20.20 80 30.30.30.30 4096 40.40.40.40 8000
l4lb-0 0000000000000001 tcp 10.10.10.11 2000 20.20.20.21 80 30.30.30.31 4097 40.40.40.41 8000
l4lb-0 0000000000000002 tcp 10.10.10.12 2000 20.20.20.22 80 30.30.30.32 5000 40.40.40.42 8000
l4lb-0 0000000000000004 tcp 10.10.10.14 2000 20.20.20.24 80 30.30.30.34 6000 40.40.40.44 8000
Mode
Basic
Availability
Autonomous Edge, Edge
Get the load balancer L4 session table with the expiration time.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> get load-balancer 4f518a4e-9a40-43d3-98ef-db654e8be7c5 session-tables l4
Session-Tables
TABLE ID PROTO CADDR CPORT VADDR VPORT SADDR SPORT DADDR DPORT STATE EXP
l4lb-0 00000001000159f2 tcp 10.114.218.199 35011 10.114.213.75 80 10.114.218.199 35011 10.37.1.11 80 TW 45
Mode
Basic
Availability
Autonomous Edge, Edge
Get the load balancer L7 session table with the expiration time.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> get load-balancer 4f518a4e-9a40-43d3-98ef-db654e8be7c5 session-tables l7
Session-Tables
TABLE ID PROTO CADDR CPORT VADDR VPORT SADDR SPORT DADDR DPORT STATE EXP
l7lb-0 00000001000159f8 http 10.114.218.199 35012 10.114.213.75 80 10.114.218.199 35012 10.37.1.12 80 EST 3600
Mode
Basic
Availability
Autonomous Edge, Edge
Get load-balancer snat pools' information.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> get load-balancer ed785df6-2143-4944-b918-66470886be83 snat-pools
SNAT : nat_3232235998_1
Min Port : 4096
Max Port : 65535
Port Overload Factor : 1
Random Port : False
Snat IP : 192.168.1.222 Allocated Port: 0
SNAT : nat_3232235998_3
Min Port : 4096
Max Port : 65535
Port Overload Factor : 1
Random Port : False
Snat IP : 192.168.1.222 Allocated Port: 0
Snat IP : 192.168.1.223 Allocated Port: 0
Snat IP : 192.168.1.224 Allocated Port: 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display the statistics for a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> get load-balancer ed785df6-2143-4944-b918-66470886be83 stats
Load Balancer
UUID : ed785df6-2143-4944-b918-66470886be83
Display-Name : lbs-dgo
Enabled : True
Type CUR_SESS MAX_SESS TOTAL_SESS SESS_RATE
L4 1000 2000 34325 30
L7 100 100 54321 10
Mode
Basic
Availability
Autonomous Edge, Edge
Display the status of a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> get load-balancer ed785df6-2143-4944-b918-66470886be83 status
Load Balancer
UUID : ed785df6-2143-4944-b918-66470886be83
Display-Name : lbs-dgo
Enabled : True
LB-State : not_ready
LR-HA-State : active
Virtual Servers : 2
Up Virtual Servers: 0
Pools : 2
Up Pools : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display a specific load balancer virtual server.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
Example
nsx-edge-1> get load-balancer eba5f460-c660-4f82-8488-62231fb9aea3 virtual-server 11bb214f-bd06-4bff-b2a5-6f82e5ec62b6
Virtual Server
Application Profile Id : 4b6d4d28-208e-4a0d-a9aa-a712934d5bef
Display Name : udpvip1
Enabled : True
UUID : 11bb214f-bd06-4bff-b2a5-6f82e5ec62b6
Ip Address :
Ipv4 : 124.124.124.124
Ip Protocol : UDP
Pool Id : 56722b45-c276-43fb-81d0-4b15760fdbce
Port : 9999
Application Profile
Application Type : FAST_UDP
Display Name : fastUdpProfile1
Fast Udp Profile :
Flow Mirroring Enabled : False
Idle Timeout : 1970-01-01 00:00:00.300000 (timestamp: 300)
UUID : 4b6d4d28-208e-4a0d-a9aa-a712934d5bef
Mode
Basic
Availability
Autonomous Edge, Edge
Display the access log file for a specific load balancer and virtual server.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
Example
nsx-edge-1> get load-balancer 4d3eafaa-5a16-422a-80d9-f799cb4bd40a virtual-server 953e4da8-a571-4695-b54c-90505d8e59c2 access-log
1.1.5.10 - - [16/Nov/2017:11:47:49 +0000] "GET / HTTP/1.1" 200 22 "-" "-"
1.1.5.10 - - [16/Nov/2017:11:47:49 +0000] "GET / HTTP/1.1" 200 22 "-" "-"
1.1.5.10 - - [16/Nov/2017:11:48:15 +0000] "GET / HTTP/1.1" 200 22 "-" "-"
1.1.5.10 - - [16/Nov/2017:11:48:16 +0000] "GET / HTTP/1.1" 200 22 "-" "-"
1.1.5.10 - - [16/Nov/2017:11:48:17 +0000] "GET / HTTP/1.1" 200 22 "-" "-"
1.1.5.10 - - [16/Nov/2017:11:54:50 +0000] "GET / HTTP/1.1" 200 22 "-" "-"
1.1.5.10 - - [16/Nov/2017:16:42:15 +0000] "GET / HTTP/1.1" 200 22 "-" "-"
.
.
.
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
Example
nsx-edge-1> get load-balancer 4d3eafaa-5a16-422a-80d9-f799cb4bd40a virtual-server 953e4da8-a571-4695-b54c-90505d8e59c2 access-log follow
1.1.5.10 - - [16/Nov/2017:11:47:49 +0000] "GET / HTTP/1.1" 200 22 "-" "-"
1.1.5.10 - - [16/Nov/2017:11:47:49 +0000] "GET / HTTP/1.1" 200 22 "-" "-"
1.1.5.10 - - [16/Nov/2017:11:48:15 +0000] "GET / HTTP/1.1" 200 22 "-" "-"
1.1.5.10 - - [16/Nov/2017:11:48:16 +0000] "GET / HTTP/1.1" 200 22 "-" "-"
1.1.5.10 - - [16/Nov/2017:11:48:17 +0000] "GET / HTTP/1.1" 200 22 "-" "-"
1.1.5.10 - - [16/Nov/2017:11:54:50 +0000] "GET / HTTP/1.1" 200 22 "-" "-"
1.1.5.10 - - [16/Nov/2017:16:42:15 +0000] "GET / HTTP/1.1" 200 22 "-" "-"
.
.
.
Mode
Basic
Availability
Autonomous Edge, Edge
Display access log messages containing strings that match the given regular expression pattern for a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
| <regex> | Regular expression |
Example
nsx-edge-1> get load-balancer 4d3eafaa-5a16-422a-80d9-f799cb4bd40a virtual-server 953e4da8-a571-4695-b54c-90505d8e59c2 access-log reg-filter 16/Nov.*11:48
1.1.5.10 - - [16/Nov/2017:11:48:15 +0000] "GET / HTTP/1.1" 200 22 "-" "-"
1.1.5.10 - - [16/Nov/2017:11:48:16 +0000] "GET / HTTP/1.1" 200 22 "-" "-"
1.1.5.10 - - [16/Nov/2017:11:48:17 +0000] "GET / HTTP/1.1" 200 22 "-" "-"
Mode
Basic
Availability
Autonomous Edge, Edge
Display the load balancer rules for a specific load balancer and virtual server.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
Example
nsx-edge-1> get load-balancer eba5f460-c660-4f82-8488-62231fb9aea3 virtual-server 110ac92c-1647-48a5-8d66-4cac06817716 lbrules
LbRule
Action :
Action Type : HTTP_REQUEST_URI_REWRITE
Http Request Uri Rewrite :
Uri : /product_detail.html
Display Name : RewriteRequestUrl
UUID : 4202cb56-c8b3-4d7a-9f61-686d55ed7d80
Match Condition :
Http Request Url Config :
Request Url : /product.html
Match Type : HTTP_REQUEST_URL
Match Strategy : MATCH_STRATEGY_ANY
Phase : HTTP_REQUEST_REWRITE
LbRule
Action :
Action Type : SELECT_POOL
Select Pool Config :
Pool Id : e7a438a1-69e9-4347-9f21-0f28d7aa44d9
Display Name : LoginRouteRule
UUID : 58ba5a69-6a5a-4b6b-8899-d0fa8159fbcd
Match Condition :
Http Request Url Config :
Request Url : /login.html
Match Type : HTTP_REQUEST_URL
Match Strategy : MATCH_STRATEGY_ALL
Phase : HTTP_FORWARDING
Mode
Basic
Availability
Autonomous Edge, Edge
Display the statistics for a specific load balancer and virtual server.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
Example
nsx-edge-1> get load-balancer ed785df6-2143-4944-b918-66470886be83 virtual-server 953e4da8-a571-4695-b54c-90505d8e59c2 stats
Virtual Server
UUID : 953e4da8-a571-4695-b54c-90505d8e59c2
Display-Name : tcpvip1
VIP : TCP 123.123.123.123:80
Type : L4
Sessions :
(Cur, Max, Total, Rate) : (0, 0, 0, 0)
(Drop_By_ACL) : (0)
Bytes :
(In, Out) : (0, 0)
Packets :
(In, Out) : (0, 0)
Mode
Basic
Availability
Autonomous Edge, Edge
Display the status of a specific load balancer virtual server.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
Example
nsx-edge-1> get load-balancer ed785df6-2143-4944-b918-66470886be83 virtual-server 0ba2817e-9ddb-411e-a397-ef2f3b099a46 status
Virtual Server
UUID : 0ba2817e-9ddb-411e-a397-ef2f3b099a46
Display-Name: http-vip-1
IP : 123.123.123.123
Port : 80
Status : up
Mode
Basic
Availability
Autonomous Edge, Edge
Display the virtual servers of a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> get load-balancer eba5f460-c660-4f82-8488-62231fb9aea3 virtual-servers
Virtual Server
Application Profile Id : 9c4d7f35-13f9-46fc-8d57-d60f0a12544d
Display Name : http-vip-1
Enabled : True
UUID : 37f1a8c9-ab8b-4ee9-9b41-5da317ac05d3
Ip Address :
Ipv4 : 123.123.123.123
Ip Protocol : TCP
Persistence Profile Id : e57ef9b9-fe06-4269-9c2c-9fc2609e3941
Pool Id : d39f9ed7-444c-493d-8c99-327a30befe8e
Port : 80
Virtual Server
Application Profile Id : f5586889-a812-4e64-b735-610851a6fad6
Display Name : tcpvip1
Enabled : True
UUID : 26168a79-48d6-44a7-86fe-0d5ee7c91e47
Ip Address :
Ipv4 : 123.123.123.123
Ip Protocol : TCP
Persistence Profile Id : 17d24b73-c090-495a-b60f-ed772b613bdf
Pool Id : 29e66f11-d589-4208-a78d-f72e18aa8286
Port : 8888
Mode
Basic
Availability
Autonomous Edge, Edge
Display the statistics for all virtual servers of a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> get load-balancer ed785df6-2143-4944-b918-66470886be83 virtual-servers stats
Virtual Server
UUID : 953e4da8-a571-4695-b54c-90505d8e59c2
Display-Name : tcpvip1
VIP : TCP 123.123.123.123:80
Type : L4
Sessions :
(Cur, Max, Total, Rate) : (0, 0, 0, 0)
(Drop_By_ACL) : (0)
Bytes :
(In, Out) : (0, 0)
Packets :
(In, Out) : (0, 0)
Virtual Server
UUID : 0ba2817e-9ddb-411e-a397-ef2f3b099a46
Display-Name : http-vip-1
VIP : TCP 123.123.123.123:8080
Type : L7
Sessions :
(Cur, Max, Total, Rate) : (0, 0, 0, 0)
(Drop_By_LBRule) : (0)
Bytes :
(In, In-Rate) : (0, 0)
(Out, Out-Rate) : (0, 0)
HTTP Requests :
(Total, Rate) : (0, 0)
Mode
Basic
Availability
Autonomous Edge, Edge
Display the status of all virtual servers of a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
Example
nsx-edge-1> get load-balancer ed785df6-2143-4944-b918-66470886be83 virtual-servers status
Virtual Server
UUID : 953e4da8-a571-4695-b54c-90505d8e59c2
Display-Name: tcpvip1
IP : 123.123.123.123
Port : 8888
Status : up
Virtual Server
UUID : 0ba2817e-9ddb-411e-a397-ef2f3b099a46
Display-Name: http-vip-1
IP : 123.123.123.123
Port : 80
Status : up
Mode
Basic
Availability
Autonomous Edge, Edge
Display global verbose stats for load balancer.
Example
nsx-1> get load-balancer global stats
Global Info
Config Update:
Config Update Rcvd : 4
Full Sync Rcvd : 1
LBS Update Rcvd : 4
VS Update Rcvd : 1
Pool Update Rcvd : 1
LBS Delete Rcvd : 0
VS Delete Rcvd : 0
Pool Delete Rcvd : 0
RCU Queue:
RCU Queue Add - LBS : 0
RCU Queue Add - VS : 0
RCU Queue Add - Pool : 0
RCU Queue Add - Pool UUID : 0
RCU Queue Del - LBS : 0
RCU Queue Del - VS : 0
RCU Queue Del - Pool : 0
RCU Queue Del - Pool UUID : 0
Data Path:
LB Flow Purged - LBS Invalid : 0
LB Flow Purged - Flow/Kif LBS Diff : 0
LB Flow Purged -
Kif Not Linked With LBS After Full Sync : 0
LB Flow Purged -
Flow/Kif LBS Diff After Full Sync : 0
LB Flow Purged - Session Validate Fail : 0
Export/Import:
Global Config Save Received : 0
Global Config Restore - Unknown Type : 0
Global Config Restore - Unknown TLV Tag : 0
Global Error:
Config Update:
Full Sync Error - No Msg : 0
Full Sync Error - No Memory : 0
LBS Update Error - No Memory : 0
VS Update Error - LBS Not Found : 0
Pool Update Error - LBS Not Found : 0
LBS Delete Error - LBS Not Found : 0
VS Delete Error - LBS Not Found : 0
VS Delete Error - VS Not Found : 0
Pool Delete Error - LBS Not Found : 0
Pool Delete Error - Pool Not Found : 0
RCU Queue:
RCU Lock Init Error : 0
RCU Queue Add - Invalid Type : 0
RCU Queue Add - No Memory : 0
RCU Queue Del - Invalid Type : 0
RCU Queue Del -
PM Hmap Not Empty After Pool Purge : 0
Export/Import:
Global Config Save Failed - Global LBS : 0
Global Config Save Failed - LBS Entry : 0
Global Config Save Failed - LSP Listn : 0
Global Config Save Failed - Pool : 0
Global Config Save Failed - PM List : 0
Global Config Save Failed - VS : 0
Global Config Save Failed - Buffer Error : 0
Global Config Save Failed - TLV Error : 0
Global Config Restore Failed - Buffer Error : 0
Global Config Restore Failed - TLV Error : 0
LBS Not Found at State Import : 0
Mode
Basic
Availability
ESXi
Get edge parameters configured by load balancer for performance.
Example
nsx-edge-1> get load-balancer perf-profile config
Load Balancer Performance Config
Profile :large vm http profile
Dataplane
Kni Busy Loop :enabled
Kni Fifo Size :8192
Tx Ring Size :512
Rx Ring Size :512
Cores :0
Intr Mode :disabled
Kni Mbuf Burst Num :2048
Dispatcher
Cores :4,5,6,7
Kni
Cores :1
Rps Cpus :2,3
Engine
Cores :4,5,6,7
Mode
Basic
Availability
Autonomous Edge, Edge
Display the information for pool.
| Option | Description |
|---|---|
| <pool-uuid> | Pool UUID argument |
Example
nsx-1> get load-balancer pool 6be8651e-dac3-44cd-a175-72965fe4dc92
Pool
UUID : 6be8651e-dac3-44cd-a175-72965fe4dc92
Display Aame : mylbpool
Algorithm : ROUND_ROBIN
Min Active Members : 1
Tcp Multiplexing Enabled : False
Tcp Multiplexing Number : 6
Members
Admin State : ENABLED
Backup Member : False
Display Name : Member_VM30
Ip Address : 192.168.100.160
Port : 8888
Weight : 1
Admin State : ENABLED
Backup Member : False
Display Name : Member_VM31
Ip Address : 192.168.100.161
Port : 8888
Weight : 1
Admin State : ENABLED
Backup Member : False
Display Name : Member_VM32
Ip Address : 192.168.100.162
Port : 8888
Weight : 1
Mode
Basic
Availability
ESXi
Display a specific load balancer virtual server.
| Option | Description |
|---|---|
| <vs-uuid> | Virtual server UUID argument |
Example
nsx-1> get load-balancer eba5f460-c660-4f82-8488-62231fb9aea3 virtual-server 34683d78-7e13-48c9-8064-f0ccbca6ecb1
Virtual Server
Access Log Enabled : True
Log Significant Event Only : False
Display Name : mytcpvip
Enabled : True
IP Protocol : TCP
IP : 123.123.123.125
Port : 8888
UUID : 34683d78-7e13-48c9-8064-f0ccbca6ecb1
Pool Id : 6be8651e-dac3-44cd-a175-72965fe4dc92
Application Profile Id : a15907b6-df80-43ac-bbd3-68487544170f
Mode
Basic
Availability
ESXi
Display the access log for the virtual server.
| Option | Description |
|---|---|
| <vs-uuid> | Virtual server UUID argument |
Example
nsx-1> get load-balancer 229f3a19-f045-418a-9f5c-750d321e674a access-log
Operation.Category: 'LbAccessLog': Operation.Type: 'N/A', Lb.UUID: '1ee776f7-7b30-4a64-a091-48f50dcb8eb0' Vs.UUID: '229f3a19-f045-418a-9f5c-750d321e674a' Vs.IP: '123.123.123.125' Vs.Port: '47138' Pool.UUID: 'e38717cc-20e2-4c79-a760-53e835bf09b5' PoolMember.IP: '192.168.100.160' PoolMemeber.Port: '47138' Client.Ip: '' Client.Port: '0' Session.state: 'Create' Error.Reason: '-'
Mode
Basic
Availability
ESXi
Display all load balancers.
Example
nsx-1> get load-balancers
Load Balancer
Access Log Enabled : False
Display Name : mydlb
Enabled : True
UUID : 3d62a405-c24c-442d-ba98-e0c1200b7fce
Log Level : LB_LOG_LEVEL_INFO
Relax Scale Validation : False
Size : DLB
Virtual Server Id : f1e1eadd-0928-4643-8ff8-77dbaa350ae1
Load Balancer
Access Log Enabled : False
Display Name : mydlb2
Enabled : True
UUID : 4dcd2946-5ab9-40d2-9aaa-8d9cf93f5810
Log Level : LB_LOG_LEVEL_INFO
Relax Scale Validation : False
Size : DLB
Virtual Server Id : 8d4f29c0-c194-46ba-aa16-1a0fe9f70fd1
or
nsx-edge-1> get load-balancers
Load Balancer
Access Log Enabled : False
Applied To :
Logical Router Id : c46b1482-0638-4ed0-959b-06ca203cf50b
Service Router Id : 95327762-ddfc-4196-b92b-671fd1b99e25
Display Name : lbs-on-lr1
Enabled : True
UUID : eba5f460-c660-4f82-8488-62231fb9aea3
Log Level : LB_LOG_LEVEL_INFO
Size : SMALL
Virtual Server Id : 37f1a8c9-ab8b-4ee9-9b41-5da317ac05d3
26168a79-48d6-44a7-86fe-0d5ee7c91e47
7e012072-0594-4063-97f0-82452e9a2813
11bb214f-bd06-4bff-b2a5-6f82e5ec62b6
110ac92c-1647-48a5-8d66-4cac06817716
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi
Display the status of all load balancers.
Example
nsx-1> get load-balancers status
Load Balancer
UUID : ed785df6-2143-4944-b918-66470886be83
Display-Name : lbs-dgo
Status : ready
Ready LSP Count : 2
Not Ready LSP Count: 0
Conflict LSP Count : 0
or
nsx-edge-1> get load-balancers status
Load Balancer
UUID : ed785df6-2143-4944-b918-66470886be83
Display-Name : lbs-dgo
Enabled : True
LB-State : not_ready
LR-HA-State : active
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi
Display the contents of the specified log file.
| Option | Description |
|---|---|
| <filename> | Log file name |
Example
nsx-esx-1> get log-file manager.log
2016-10-24 05:11:50.292 UTC INFO MaintenanceSyncTimer RestRequestImpl - - [nsx comp="nsx-manager" subcomp="manager"] URL : https://localhost:15671/api/connections?columns=name,user
Entity Body : <{Accept=[application/json]}> method: GET
2016-10-24 05:11:50.312 UTC INFO MaintenanceSyncTimer RestRequestImpl - - [nsx comp="nsx-manager" subcomp="manager"] URL : https://localhost:15671/api/connections?columns=name,user
Response Body : [Lcom.vmware.nsx.management.messaging.rabbitmq.Connection;@59e806a2 method : GET
2016-10-24 05:11:50.312 UTC INFO MaintenanceSyncTimer RestRequestImpl - - [nsx comp="nsx-manager" subcomp="manager"] URL : https://localhost:15671/api/users
Entity Body : <{Accept=[application/json]}> method: GET
2016-10-24 05:11:50.354 UTC INFO MaintenanceSyncTimer RestRequestImpl - - [nsx comp="nsx-manager" subcomp="manager"] URL : https://localhost:15671/api/users
Response Body : [Lcom.vmware.nsx.management.messaging.rabbitmq.Account;@5307ed29 method : GET
2016-10-24 05:11:55.298 UTC INFO increment-barrier-timer RealizationStateBarrierServiceImpl - SYSTEM [nsx comp="nsx-manager" subcomp="manager"] Incremented realization state barrier number to 122598
2016-10-24 05:11:55.674 UTC INFO Event Processor for GatewaySender_AsyncEventQueue_txLogEventQueue TxLogAsyncEventListener - - [nsx comp="nsx-manager" subcomp="manager"] Gets 1 events to process.
.
.
.
or
nsx-manager-1> get log-file manager.log
2016-10-24 05:11:50.292 UTC INFO MaintenanceSyncTimer RestRequestImpl - - [nsx comp="nsx-manager" subcomp="manager"] URL : https://localhost:15671/api/connections?columns=name,user
Entity Body : <{Accept=[application/json]}> method: GET
2016-10-24 05:11:50.312 UTC INFO MaintenanceSyncTimer RestRequestImpl - - [nsx comp="nsx-manager" subcomp="manager"] URL : https://localhost:15671/api/connections?columns=name,user
Response Body : [Lcom.vmware.nsx.management.messaging.rabbitmq.Connection;@59e806a2 method : GET
2016-10-24 05:11:50.312 UTC INFO MaintenanceSyncTimer RestRequestImpl - - [nsx comp="nsx-manager" subcomp="manager"] URL : https://localhost:15671/api/users
Entity Body : <{Accept=[application/json]}> method: GET
2016-10-24 05:11:50.354 UTC INFO MaintenanceSyncTimer RestRequestImpl - - [nsx comp="nsx-manager" subcomp="manager"] URL : https://localhost:15671/api/users
Response Body : [Lcom.vmware.nsx.management.messaging.rabbitmq.Account;@5307ed29 method : GET
2016-10-24 05:11:55.298 UTC INFO increment-barrier-timer RealizationStateBarrierServiceImpl - SYSTEM [nsx comp="nsx-manager" subcomp="manager"] Incremented realization state barrier number to 122598
2016-10-24 05:11:55.674 UTC INFO Event Processor for GatewaySender_AsyncEventQueue_txLogEventQueue TxLogAsyncEventListener - - [nsx comp="nsx-manager" subcomp="manager"] Gets 1 events to process.
.
.
.
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, ESXi, Manager, NSX on VMC
Display the last 10 lines of the specified log file and all new messages that are written to the log file.
| Option | Description |
|---|---|
| <filename> | Log file name |
Example
nsx-manager-1> get log-file manager.log follow
2016-10-24 05:11:50.292 UTC INFO MaintenanceSyncTimer RestRequestImpl - - [nsx comp="nsx-manager" subcomp="manager"] URL : https://localhost:15671/api/connections?columns=name,user
Entity Body : <{Accept=[application/json]}> method: GET
2016-10-24 05:11:50.312 UTC INFO MaintenanceSyncTimer RestRequestImpl - - [nsx comp="nsx-manager" subcomp="manager"] URL : https://localhost:15671/api/connections?columns=name,user
Response Body : [Lcom.vmware.nsx.management.messaging.rabbitmq.Connection;@59e806a2 method : GET
2016-10-24 05:11:50.312 UTC INFO MaintenanceSyncTimer RestRequestImpl - - [nsx comp="nsx-manager" subcomp="manager"] URL : https://localhost:15671/api/users
Entity Body : <{Accept=[application/json]}> method: GET
2016-10-24 05:11:50.354 UTC INFO MaintenanceSyncTimer RestRequestImpl - - [nsx comp="nsx-manager" subcomp="manager"] URL : https://localhost:15671/api/users
Response Body : [Lcom.vmware.nsx.management.messaging.rabbitmq.Account;@5307ed29 method : GET
2016-10-24 05:11:55.298 UTC INFO increment-barrier-timer RealizationStateBarrierServiceImpl - SYSTEM [nsx comp="nsx-manager" subcomp="manager"] Incremented realization state barrier number to 122598
2016-10-24 05:11:55.674 UTC INFO Event Processor for GatewaySender_AsyncEventQueue_txLogEventQueue TxLogAsyncEventListener - - [nsx comp="nsx-manager" subcomp="manager"] Gets 1 events to process.
.
.
.
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, ESXi, Manager, NSX on VMC
Display the list of logs files
| Option | Description |
|---|---|
| <list-desc-arg> | List of log files Allowed values: list |
Example
nsx-manager-1> get log-file list
File Name File Timestamp
faillog Tue Aug 20 2024 UTC 00:56:39.260
copy_jars.log Tue Aug 20 2024 UTC 00:51:34.261
cloud-init.log Tue Aug 20 2024 UTC 00:56:39.260
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, ESXi, Manager, NSX on VMC
Display logging server configuration.
Example
nsx> get logging-servers
192.168.110.60 proto udp level info facility syslog messageid SYSTEM,FABRIC
192.168.110.60 proto udp level info facility auth,user
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display information about the specified logical router.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 736a80e3-23f6-5a2d-81d6-bbefb2786666
Logical Router
UUID VRF LR-ID Name Type Ports Neighbors
736a80e3-23f6-5a2d-81d6-bbefb2786666 0 0 R1 TUNNEL 3 4/50000
Mode
Basic
Availability
Autonomous Edge, Edge
Display parameters defined in global logical router BFD
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge> get logical-router 463c9dd1-986b-4947-895b-1126bd53abc8 bfd-config
Logical Router
UUID : d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8
vrf : 6
lr-id : 6
name : R1
type : SERVICE_ROUTER_TIER0
BFD global configuration
Enabled : True
Min RX Interval: 1000
Min TX Interval: 1000
Min RX TTL : 255
Multiplier : 3
Port : 4451c48f-8cff-4444-8e10-bff403783dca
BFD session configuration
Source : 192.168.50.1
Peer : 192.168.50.10
Enabled : True
Min RX Interval: 1000
Min TX Interval: 1000
RX TTL : 255
Multiplier : 3
Source : 192.168.50.1
Peer : 192.168.50.20
Enabled : True
Min RX Interval: 3000
Min TX Interval: 3000
RX TTL : 255
Multiplier : 5
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPv4 & IPv6 BGP routes.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be bgp
BGP table version is 1, local router ID is 50.50.50.1
Status flags: > - best, I - internal
Origin flags: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
> 111.111.0.0/16 100.64.0.1 0 100 32768 2000 ?
> 2003::/24 :: 0 100 32768 2000 ?
> 2002::/64 fca9:1c1c:96b2:e000::2 0 100 32768 2000 ?
> 2001::/64 fca9:1c1c:96b2:e000::2 0 100 32768 2000 ?
Mode
Basic
Availability
Autonomous Edge, Edge
Display all BGP NLRI matching the community.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <bgp-community> | BGP community argument, either NO_EXPORT, NO_ADVERTISE, NO_EXPORT_SUBCONFED or community in AA:NN format |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be bgp community 1:1
BGP table version is 1, local router ID is 50.50.50.1
Status flags: > - best, I - internal
Origin flags: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
> 111.111.0.0/16 100.64.0.1 0 100 32768 2000 ?
> 2003::/24 :: 0 100 32768 2000 ?
Mode
Basic
Availability
Autonomous Edge, Edge
Display BGP EVPN Ethernet Segment information.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router cde323b5-e8e0-44d7-bd11-da76822ffd30 bgp evpn es
ES Flags: L local, R remote, I inconsistent
VTEP Flags: E ESR/Type-4, A active nexthop
ESI Flags RD #VNIs VTEPs
03:11:22:33:44:55:02:00:00:01 R - 1 192.168.1.2(A)
03:11:22:33:44:55:03:00:00:02 R - 1 192.168.1.2(A),192.168.1.3(A)
Mode
Basic
Availability
Edge
Display BGP EVPN Ethernet Segment(ES) per EVPN instance(EVI) information.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router cde323b5-e8e0-44d7-bd11-da76822ffd30 bgp evpn es-evi
Flags: L local, R remote, I inconsistent
VTEP-Flags: E EAD-per-ES, V EAD-per-EVI
VNI ESI Flags VTEPs
101 03:11:22:33:44:55:02:00:00:01 R 192.168.1.2(EV),192.168.1.3(V)
201 03:11:22:33:44:55:03:00:00:02 R 192.168.1.2(EV),192.168.1.3(EV)
Mode
Basic
Availability
Edge
Display all BGP NLRI matching the large-community.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <bgp-large-community> | BGP large-community argument in AA:BB:CC format |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be bgp large-community 1:1:1
BGP table version is 1, local router ID is 50.50.50.1
Status flags: > - best, I - internal
Origin flags: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
> 111.111.0.0/16 100.64.0.1 0 100 32768 2000 ?
> 2003::/24 :: 0 100 32768 2000 ?
Mode
Basic
Availability
Autonomous Edge, Edge
Display all BGP neighbor information.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be bgp neighbor
BGP neighbor is 50.50.50.10, remote AS 1000, local AS 2000, external link
Hostname: prome-mdt-dhcp412
BGP version 4, remote router ID 50.50.50.10, local router ID 50.50.50.1
BGP state = Established, up for 2d13h28m
Last read 00:00:17, Last write 00:00:19
Hold time is 180, keepalive interval is 60 seconds
Configured hold time is 180, keepalive interval is 60 seconds
Neighbor capabilities:
4 Byte AS: advertised and received
AddPath:
IPv4 Unicast: RX advertised IPv4 Unicast and received
Route refresh: advertised and received(old & new)
Address Family IPv4 Unicast: advertised and received
Hostname Capability: advertised (name: nsx-edge-1,domain name: n/a) received (name: prome-mdt-dhcp412,domain name: n/a)
Graceful Restart Capabilty: advertised and received
Remote Restart timer is 120 seconds
Address families by peer:
none
Graceful restart informations:
End-of-RIB send: IPv4 Unicast
End-of-RIB received: IPv4 Unicast
Message statistics:
Inq depth is 0
Outq depth is 0
Sent Rcvd
Opens: 14 13
Notifications: 2 16
Updates: 10 10
Keepalives: 3832 3827
Route Refresh: 0 0
Capability: 0 0
Total: 3858 3866
Minimum time between advertisement runs is 0 seconds
Update source is 50.50.50.1
For address family: IPv4 Unicast
Update group 49, subgroup 49
Packet Queue length 0
Community attribute sent to this neighbor(all)
0 accepted prefixes
Connections established 6; dropped 5
Last reset 2d13h28m, due to Interface down
Local host: 50.50.50.1, Local port: 179
Foreign host: 50.50.50.10, Foreign port: 39948
Nexthop: 50.50.50.1
Nexthop global: 2005::2828:2801
Nexthop local: fe80::53ff:feb2:c1ad
BGP connection: shared network
BGP Connect Retry Timer in Seconds: 120
Estimated round trip time: 1 ms
Read thread: on Write thread: on
BFD Status: peer 50.50.50.10 status down
Mode
Basic
Availability
Autonomous Edge, Edge
Display EVPN VNI ARP information.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
EVPN-M0-EDGE-ONE> get logical-router cde323b5-e8e0-44d7-bd11-da76822ffd30 evpn arp
VNI 3000 #MACs (local and remote) 1
MAC Type Intf/Remote VTEP VLAN
ea:4d:80:ae:3d:32 local Br_l2_3000 1 0/0
Mode
Basic
Availability
Edge
Display EVPN Mode information.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
EVPN-M0-EDGE-ONE> get logical-router cde323b5-e8e0-44d7-bd11-da76822ffd30 evpn deployment-mode
EVPN Deploy Mode: inline
L2 VNIs: 1
L3 VNIs: 1
Advertise gateway mac-ip: No
Advertise svi mac-ip: No
Duplicate address detection: Enable
Detection max-moves 5, time 180
Mode
Basic
Availability
Edge
Display EVPN Ethernet Segment information.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1>get logical-router cde323b5-e8e0-44d7-bd11-da76822ffd30 evpn es
Type: L local, R remote
ESI Type ES-IF VTEPs
03:11:22:33:44:55:02:00:00:01 R - 192.168.1.2,192.168.1.3
Mode
Basic
Availability
Edge
Display particular EVPN Ethernet Segment information.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <esi> | Ethernet Segment Identifier (ESI) |
Example
nsx-edge-1>get logical-router cde323b5-e8e0-44d7-bd11-da76822ffd30 evpn es 03:11:22:33:44:55:02:00:00:01
ESI: 03:11:22:33:44:55:02:00:00:01
Type: Remote
Interface: -
State: down
Ready for BGP: no
VNI Count: 0
MAC Count: 1
Nexthop group: 0x2000001
VTEPs:
192.168.1.2 nh: 0x1000004
Mode
Basic
Availability
Edge
Display EVPN VNI MAC information.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
EVPN-M0-EDGE-ONE> get logical-router cde323b5-e8e0-44d7-bd11-da76822ffd30 evpn mac
VNI 3000 #ARP (IPv4 and IPv6, local and remote) 1
IP Type State MAC Remote VTEP
fe80::e84d:80ff:feae:3d32 local active ea:4d:80:ae:3d:32
Mode
Basic
Availability
Edge
Display information about IGMP reports snooped in the LR
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
pnq4-hs1-a0212> get logical-router 8d96679c-bf01-4656-ac0a-7964c9d4ca05 igmp-snooping-table
Thu Jul 09 2020 UTC 23:15:48.323
Receiving Interface
UUID VRF Group Origin / VTEP IP Timeout Uptime
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 239.49.49.49 EDGE 138.1.1.4 119 0:05:49
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 224.0.0.22 EDGE 138.1.1.4 18 0:11:18
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 224.0.0.22 EDGE 138.1.1.5 122 2:39:49
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 224.0.0.2 EDGE 138.1.1.5 127 2:39:44
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 235.1.1.15 EDGE 138.1.1.4 119 2:39:44
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 224.0.0.13 EDGE 138.1.1.5 120 2:39:46
49acf593-91c7-4607-b91a-f7f8d40152d7 3 239.13.13.13 Local 135 0:00:08
49acf593-91c7-4607-b91a-f7f8d40152d7 3 239.13.13.15 Local 129 0:00:14
49acf593-91c7-4607-b91a-f7f8d40152d7 3 239.13.13.14 Local 122 0:10:25
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 239.49.49.49 EDGE 138.1.1.5 124 2:39:53
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 224.0.0.2 EDGE 138.1.1.4 122 0:08:20
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about IGMP reports snooped in the LR filtered by multicast group
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <multicast-ip-address> | Multicast IP address argument |
Example
pnq4-hs1-a0212> get logical-router 8d96679c-bf01-4656-ac0a-7964c9d4ca05 igmp-snooping-table 239.49.49.49
Thu Jul 09 2020 UTC 23:18:07.006
Receiving Interface
UUID VRF Group Origin / VTEP IP Timeout Uptime
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 239.49.49.49 EDGE 138.1.1.4 59 0:08:08
c0a98e00-5d07-41c7-b54b-6137adfd2adc 3 239.49.49.49 EDGE 138.1.1.5 136 2:42:12
Mode
Basic
Availability
Autonomous Edge, Edge
Display interface information for the specified logical router.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 interfaces
Logical Router
UUID VRF LR-ID Name Type
736a80e3-23f6-5a2d-81d6-bbefb2786666 0 0 R1 TUNNEL
interfaces
interface : 9fd3c667-32db-5921-aaad-7a88c80b5e9f
ifuid : 258
mode : blackhole
interface : 34ca595f-fa62-5ed4-afcc-a6ef0195d4ed
ifuid : 261
mode : lif
IP/Mask : 142.134.61.36/24
MAC : 00:0c:29:5a:96:2b
VLAN id : untagged
LS port : 238d7422-e488-5cee-9639-1894b8ab56e2
urpf-mode : NONE
admin : up
op_state : up
MTU : 1600
arp_proxy : 40.40.10.60, 40.40.10.50, 40.40.10.55
: 40.40.10.100, 40.40.10.110
interface : f322c6ca-4298-568b-81c7-a006ba6e6c88
ifuid : 257
mode : cpu
Mode
Basic
Availability
Autonomous Edge, Edge
Display the interface statistics for the specified logical router.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router e9d3379d-aba7-4459-9262-18bc95eaeec1 interfaces stats
Logical Router
UUID : e9d3379d-aba7-4459-9262-18bc95eaeec1
VRF : 1
LR-ID : 1
name : R2
type : SERVICE_ROUTER_TIER0
Statistics
Interface Type RX PKTS TX PKTS RX BYTES TX BYTES RX Drops TX Drops
b83cb77f-ca34-595c-a3e1-76278f0dcb00 blackhole 0 0 0 0 0 0
4b115e5f-1395-54c3-aaf0-0de5736f99df cpu 8 0 648 0 8 0
6c427841-e151-4479-9184-4196cfcef3b6 lif 5563 11 1902546 462 5563 0
081e2e50-2f0e-42e1-8764-80a127dd3918 lif 0 0 0 0 0 0
00003300-0000-0000-0000-000000000002 loopback 8 0 648 0 8 0
Total 5579 11 1903842 462 5579 0
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge> get logical-router 3b5a8fa4-30f0-41cd-90d0-a68f9cac54dd mfib
Logical Router
UUID VRF LR-ID Name Type
3b5a8fa4-30f0-41cd-90d0-a68f9cac54dd 1 2 SR-Tier0-LR-1 SERVICE_ROUTER_TIER0
IPv4 Multicast Forwarding Table
Source IP Group IP Incoming UUID Outgoing UUID/VTEP/MTEP/UMG
40.40.40.1 237.0.0.1 cc8bd3c5-6558-49b4-90f5-dd180e3fdf0f 77f6b2fe-0c3d-4c56-91d6-a008ab3bfdcb
100.1.2.1
239.100.100.100
40.40.40.10 237.0.0.1 77f6b2fe-0c3d-4c56-91d6-a008ab3bfdcb cc8bd3c5-6558-49b4-90f5-dd180e3fdf0f
0.0.0.0 0.0.0.0 none 0000000a-0000-0000-0000-000000000000
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <multicast-ip-address> | Multicast IP address argument |
Example
nsx-edge> get logical-router 3b5a8fa4-30f0-41cd-90d0-a68f9cac54dd mfib
Logical Router
UUID VRF LR-ID Name Type
3b5a8fa4-30f0-41cd-90d0-a68f9cac54dd 1 2 SR-Tier0-LR-1 SERVICE_ROUTER_TIER0
IPv4 Multicast Forwarding Table
Source IP Group IP Incoming UUID Outgoing UUID/VTEP/MTEP/UMG
40.40.40.1 237.0.0.1 cc8bd3c5-6558-49b4-90f5-dd180e3fdf0f 77f6b2fe-0c3d-4c56-91d6-a008ab3bfdcb
100.1.2.1
239.100.100.100
40.40.40.10 237.0.0.1 77f6b2fe-0c3d-4c56-91d6-a008ab3bfdcb cc8bd3c5-6558-49b4-90f5-dd180e3fdf0f
nsx-edge> get logical-router 6263fe96-0ecf-4b3b-ad2d-3c0447de038b mfib
Logical Router
UUID VRF LR-ID Name Type
6263fe96-0ecf-4b3b-ad2d-3c0447de038b 2 2 SR-tier0 SERVICE_ROUTER_TIER0
IPv4 Multicast Forwarding Table
Source IP Group IP Incoming UUID Outgoing UUID/VTEP/MTEP/UMG
2.1.4.11 237.0.0.16 b9267b0d-5d4b-48c5-8ae4-38ab95de40bf 0ef83a9d-5014-4b3e-bcef-32109a34237b
1.1.8.10 237.0.0.12 0ef83a9d-5014-4b3e-bcef-32109a34237b b9267b0d-5d4b-48c5-8ae4-38ab95de40bf
nsx-edge> get logical-router 6263fe96-0ecf-4b3b-ad2d-3c0447de038b mfib 237.0.0.12
Logical Router
UUID VRF LR-ID Name Type
6263fe96-0ecf-4b3b-ad2d-3c0447de038b 2 2 SR-tier0 SERVICE_ROUTER_TIER0
IPv4 Multicast Forwarding Table
Source IP Group IP Incoming UUID Outgoing UUID/VTEP/MTEP/UMG
1.1.8.10 237.0.0.12 0ef83a9d-5014-4b3e-bcef-32109a34237b b9267b0d-5d4b-48c5-8ae4-38ab95de40bf
Mode
Basic
Availability
Autonomous Edge, Edge
Display the multicast load-balancing selection for the specified logical router.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <multicast-ip-address> | Multicast IP address argument |
Example
Edge-1> get logical-router 8e562305-16c0-4053-b846-61a8fd68182d multicast load-balancing 237.1.1.12
Logical Router
UUID : 8e562305-16c0-4053-b846-61a8fd68182d
vrf : 1
type : SERVICE_ROUTER_TIER0
selected-backplane: local
Edge-1> get logical-router 8e562305-16c0-4053-b846-61a8fd68182d multicast load-balancing 237.1.1.1
Logical Router
UUID : 8e562305-16c0-4053-b846-61a8fd68182d
vrf : 1
type : SERVICE_ROUTER_TIER0
selected-backplane: non-local
Edge-1> get logical-router ddba36a0-c758-4076-bb16-fd3344b284d6 multicast load-balancing 237.1.1.1
Logical Router
UUID : ddba36a0-c758-4076-bb16-fd3344b284d6
vrf : 3
type : DISTRIBUTED_ROUTER_TIER0
selected-backplane: 169.254.0.5
Mode
Basic
Availability
Autonomous Edge, Edge
Display the neighbor table for the specified logical router.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 neighbor
Logical Router
UUID : d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8
VRF : 6
LR-ID : 6
name : R3
type : DISTRIBUTED_ROUTER
neighbor
interface : c66fc321-df74-4aaa-835e-95dc815fe7ae
IP : 172.16.130.13
MAC : 00:50:56:8e:3e:0b
state : perm
interface : f6ef3b50-64a0-4948-ab9e-9135963d4b8b
IP : 169.0.0.2
MAC : 02:50:56:00:00:05
state : reach
timeout : 7
interface : be290c92-74ed-437c-bbf1-dd78673b6a5a
IP : 172.16.120.11
MAC : 00:50:56:8e:15:e5
state : reach
timeout : 24
interface : 3c139373-f8f7-441e-aac4-146d9b5ff3a6
IP : 172.16.110.11
MAC : 00:50:56:8e:91:12
state : perm
Mode
Basic
Availability
Autonomous Edge, Edge
Display the neighbor table and statistics for the specified logical router.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 neighbor stats
Logical Router
UUID : d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8
VRF : 6
LR-ID : 6
name : R3
type : DISTRIBUTED_ROUTER
neighbor
interface : c66fc321-df74-4aaa-835e-95dc815fe7ae
IP : 172.16.130.13
MAC : 00:50:56:8e:3e:0b
state : perm
statistics
TX-Packets : 0
TX-Fails : 0
TX-Solicits : 0
TX-Solicit-Fails : 0
RX-Solicits : 0
RX-Unsolicits : 0
interface : f6ef3b50-64a0-4948-ab9e-9135963d4b8b
IP : 169.0.0.2
MAC : 02:50:56:00:00:05
state : reach
timeout : 325
statistics
TX-Packets : 1
TX-Fails : 0
TX-Solicits : 239
TX-Solicit-Fails : 0
RX-Solicits : 241
RX-Unsolicits : 0
interface : be290c92-74ed-437c-bbf1-dd78673b6a5a
IP : 172.16.120.11
MAC : 00:50:56:8e:15:e5
state : reach
timeout : 378
statistics
TX-Packets : 6
TX-Fails : 0
TX-Solicits : 261
TX-Solicit-Fails : 0
RX-Solicits : 233
RX-Unsolicits : 0
interface : 3c139373-f8f7-441e-aac4-146d9b5ff3a6
IP : 172.16.110.11
MAC : 00:50:56:8e:91:12
state : perm
statistics
TX-Packets : 0
TX-Fails : 0
TX-Solicits : 0
TX-Solicit-Fails : 0
RX-Solicits : 0
RX-Unsolicits : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display OSPF information.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be ospf
OSPF Routing Process, Router ID: 40.40.40.1
Supports only single TOS (TOS0) routes
This implementation conforms to RFC2328
RFC1583Compatibility flag is disabled
OpaqueCapability flag is disabled
Initial SPF scheduling delay 0 millisec(s)
Minimum hold time between consecutive SPFs 50 millisec(s)
Maximum hold time between consecutive SPFs 5000 millisec(s)
Hold time multiplier is currently 1
SPF algorithm last executed 7.813s ago
Last SPF duration 19 usecs
SPF timer is inactive
LSA minimum interval 5000 msecs
LSA minimum arrival 1000 msecs
Write Multiplier set to 20
Refresh timer 10 secs
Maximum multiple paths(ECMP) supported 256
Number of external LSA 1. Checksum Sum 0x00007561
Number of opaque AS LSA 0. Checksum Sum 0x00000000
Number of areas attached to this router: 1
Area ID: 0.0.0.0 (Backbone)
Number of interfaces in this area: Total: 1, Active: 1
Number of fully adjacent neighbors in this area: 1
Area has no authentication
SPF algorithm executed 4 times
Number of LSA 3
Number of router LSA 2. Checksum Sum 0x00010d70
Number of network LSA 1. Checksum Sum 0x000071c7
Number of summary LSA 0. Checksum Sum 0x00000000
Number of ASBR summary LSA 0. Checksum Sum 0x00000000
Number of NSSA LSA 0. Checksum Sum 0x00000000
Number of opaque link LSA 0. Checksum Sum 0x00000000
Number of opaque area LSA 0. Checksum Sum 0x00000000
Mode
Basic
Availability
Autonomous Edge, Edge
Display OSPF database summary.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be ospf database
OSPF Router with ID (40.40.40.1)
Router Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum Link count
40.40.40.1 40.40.40.1 556 0x80000003 0xce8a 1
40.40.40.10 40.40.40.10 553 0x80000005 0x3ae8 1
Net Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum
40.40.40.10 40.40.40.10 557 0x80000001 0x71c7
AS External Link States
Link ID ADV Router Age Seq# CkSum Route
10.92.0.0 40.40.40.10 860 0x80000002 0x7362 E2 10.92.0.0/19 [0x0]
Mode
Basic
Availability
Autonomous Edge, Edge
Display ASBR-Summary LSAs.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be ospf database asbr-summary
OSPF Router with ID (40.40.40.1)
Router Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum Link count
40.40.40.1 40.40.40.1 556 0x80000003 0xce8a 1
40.40.40.10 40.40.40.10 553 0x80000005 0x3ae8 1
Net Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum
40.40.40.10 40.40.40.10 557 0x80000001 0x71c7
AS External Link States
Link ID ADV Router Age Seq# CkSum Route
10.92.0.0 40.40.40.10 860 0x80000002 0x7362 E2 10.92.0.0/19 [0x0]
Mode
Basic
Availability
Autonomous Edge, Edge
Display ASBR-Summary LSAs.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be ospf database asbr-summary 1.1.1.1
OSPF Router with ID (40.40.40.1)
Router Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum Link count
40.40.40.1 40.40.40.1 556 0x80000003 0xce8a 1
40.40.40.10 40.40.40.10 553 0x80000005 0x3ae8 1
Net Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum
40.40.40.10 40.40.40.10 557 0x80000001 0x71c7
AS External Link States
Link ID ADV Router Age Seq# CkSum Route
10.92.0.0 40.40.40.10 860 0x80000002 0x7362 E2 10.92.0.0/19 [0x0]
Mode
Basic
Availability
Autonomous Edge, Edge
Display external LSAs.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be ospf database external
OSPF Router with ID (192.168.10.1)
AS External Link States
LS age: 656
Options: 0x2 : *|-|-|-|-|-|E|-
LS Flags: 0x6
LS Type: AS-external-LSA
Link State ID: 51.1.1.1 (External Network Number)
Advertising Router: 192.168.10.2
LS Seq Number: 80000027
Checksum: 0xc580
Length: 36
Network Mask: /32
Metric Type: 2 (Larger than any link state path)
TOS: 0
Metric: 20
Forward Address: 192.168.10.51
External Route Tag: 0
LS age: 616
Options: 0x2 : *|-|-|-|-|-|E|-
LS Flags: 0x6
LS Type: AS-external-LSA
Link State ID: 60.1.1.1 (External Network Number)
Advertising Router: 192.168.10.2
LS Seq Number: 80000027
Checksum: 0xce65
Length: 36
Network Mask: /32
Metric Type: 2 (Larger than any link state path)
TOS: 0
Metric: 20
Forward Address: 192.168.10.60
External Route Tag: 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display external LSAs.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be ospf database external 55.1.1.1
OSPF Router with ID (192.168.10.1)
AS External Link States
LS age: 685
Options: 0x2 : *|-|-|-|-|-|E|-
LS Flags: 0x6
LS Type: AS-external-LSA
Link State ID: 55.1.1.1 (External Network Number)
Advertising Router: 192.168.10.2
LS Seq Number: 80000026
Checksum: 0xcb73
Length: 36
Network Mask: /32
Metric Type: 2 (Larger than any link state path)
TOS: 0
Metric: 20
Forward Address: 192.168.10.55
External Route Tag: 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display Network LSAs.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be ospf database network
OSPF Router with ID (192.168.10.1)
Net Link States (Area 0.0.0.0)
LS age: 896
Options: 0x2 : *|-|-|-|-|-|E|-
LS Flags: 0x6
LS Type: network-LSA
Link State ID: 192.168.10.2 (address of Designated Router)
Advertising Router: 192.168.10.2
LS Seq Number: 80000024
Checksum: 0x66fb
Length: 32
Network Mask: /24
Attached Router: 192.168.10.1
Attached Router: 192.168.10.2
Mode
Basic
Availability
Autonomous Edge, Edge
Display Network LSAs.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be ospf database network 192.168.10.2
OSPF Router with ID (192.168.10.1)
Net Link States (Area 0.0.0.0)
LS age: 954
Options: 0x2 : *|-|-|-|-|-|E|-
LS Flags: 0x6
LS Type: network-LSA
Link State ID: 192.168.10.2 (address of Designated Router)
Advertising Router: 192.168.10.2
LS Seq Number: 80000024
Checksum: 0x66fb
Length: 32
Network Mask: /24
Attached Router: 192.168.10.1
Attached Router: 192.168.10.2
Mode
Basic
Availability
Autonomous Edge, Edge
Display NSSA external LSAs.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be ospf database nssa-external
OSPF Router with ID (40.40.40.1)
Router Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum Link count
40.40.40.1 40.40.40.1 556 0x80000003 0xce8a 1
40.40.40.10 40.40.40.10 553 0x80000005 0x3ae8 1
Net Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum
40.40.40.10 40.40.40.10 557 0x80000001 0x71c7
AS External Link States
Link ID ADV Router Age Seq# CkSum Route
10.92.0.0 40.40.40.10 860 0x80000002 0x7362 E2 10.92.0.0/19 [0x0]
Mode
Basic
Availability
Autonomous Edge, Edge
Display NSSA external LSAs.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be ospf database nssa-external 1.1.1.1
OSPF Router with ID (40.40.40.1)
Router Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum Link count
40.40.40.1 40.40.40.1 556 0x80000003 0xce8a 1
40.40.40.10 40.40.40.10 553 0x80000005 0x3ae8 1
Net Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum
40.40.40.10 40.40.40.10 557 0x80000001 0x71c7
AS External Link States
Link ID ADV Router Age Seq# CkSum Route
10.92.0.0 40.40.40.10 860 0x80000002 0x7362 E2 10.92.0.0/19 [0x0]
Mode
Basic
Availability
Autonomous Edge, Edge
Display router LSAs.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be ospf database router
OSPF Router with ID (192.168.10.1)
Router Link States (Area 0.0.0.0)
LS age: 140
Options: 0x2 : *|-|-|-|-|-|E|-
LS Flags: 0x3
Flags: 0x0
LS Type: router-LSA
Link State ID: 192.168.10.1
Advertising Router: 192.168.10.1
LS Seq Number: 80000003
Checksum: 0xa3d1
Length: 36
Number of Links: 1
Link connected to: a Transit Network
(Link ID) Designated Router address: 192.168.10.2
(Link Data) Router Interface address: 192.168.10.1
Number of TOS metrics: 0
TOS 0 Metric: 10
LS age: 141
Options: 0x2 : *|-|-|-|-|-|E|-
LS Flags: 0x6
Flags: 0x2 : ASBR
LS Type: router-LSA
Link State ID: 192.168.10.2
Advertising Router: 192.168.10.2
LS Seq Number: 80000004
Checksum: 0xa5c9
Length: 36
Number of Links: 1
Link connected to: a Transit Network
(Link ID) Designated Router address: 192.168.10.2
(Link Data) Router Interface address: 192.168.10.2
Number of TOS metrics: 0
TOS 0 Metric: 10
Mode
Basic
Availability
Autonomous Edge, Edge
Display router LSAs.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be ospf database router 192.168.10.2
OSPF Router with ID (192.168.10.1)
Router Link States (Area 0.0.0.0)
LS age: 700
Options: 0x2 : *|-|-|-|-|-|E|-
LS Flags: 0x6
Flags: 0x2 : ASBR
LS Type: router-LSA
Link State ID: 192.168.10.2
Advertising Router: 192.168.10.2
LS Seq Number: 80000004
Checksum: 0xa5c9
Length: 36
Number of Links: 1
Link connected to: a Transit Network
(Link ID) Designated Router address: 192.168.10.2
(Link Data) Router Interface address: 192.168.10.2
Number of TOS metrics: 0
TOS 0 Metric: 10
Mode
Basic
Availability
Autonomous Edge, Edge
Display summary LSAs.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be ospf database summary
OSPF Router with ID (40.40.40.1)
Router Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum Link count
40.40.40.1 40.40.40.1 556 0x80000003 0xce8a 1
40.40.40.10 40.40.40.10 553 0x80000005 0x3ae8 1
Net Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum
40.40.40.10 40.40.40.10 557 0x80000001 0x71c7
AS External Link States
Link ID ADV Router Age Seq# CkSum Route
10.92.0.0 40.40.40.10 860 0x80000002 0x7362 E2 10.92.0.0/19 [0x0]
Mode
Basic
Availability
Autonomous Edge, Edge
Display summary LSAs.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be ospf database summary 1.1.1.1
OSPF Router with ID (40.40.40.1)
Router Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum Link count
40.40.40.1 40.40.40.1 556 0x80000003 0xce8a 1
40.40.40.10 40.40.40.10 553 0x80000005 0x3ae8 1
Net Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum
40.40.40.10 40.40.40.10 557 0x80000001 0x71c7
AS External Link States
Link ID ADV Router Age Seq# CkSum Route
10.92.0.0 40.40.40.10 860 0x80000002 0x7362 E2 10.92.0.0/19 [0x0]
Mode
Basic
Availability
Autonomous Edge, Edge
Display OSPF Graceful Restart information.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be ospf graceful-restart
OSPF Router with ID (40.40.40.1)
Graceful restart helper support disabled.
Strict LSA check is enabled.
Helper supported for Planned and Unplanned Restarts.
Supported Graceful restart interval: 1800(in seconds).
Mode
Basic
Availability
Autonomous Edge, Edge
Display OSPF interface information.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be ospf interface
uplink-275 is up
ifindex 32, MTU 1500 bytes, BW 0 Mbit
Internet Address 40.40.40.1/24, Broadcast 40.40.40.255, Area 0.0.0.0
MTU mismatch detection: enabled
Router ID 40.40.40.1, Network Type BROADCAST, Cost: 10
Transmit Delay is 1 sec, State Backup, Priority 1
Designated Router (ID) 40.40.40.10, Interface Address 40.40.40.10
Backup Designated Router (ID) 40.40.40.1, Interface Address 40.40.40.1
Multicast group memberships: OSPFAllRouters OSPFDesignatedRouters
Timer intervals configured, Hello 10s, Dead 40s, Wait 40s, Retransmit 5
Hello due in 0.745s
Neighbor Count is 1, Adjacent neighbor count is 1
Mode
Basic
Availability
Autonomous Edge, Edge
Display OSPF neighbor list.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be ospf neighbor
Neighbor ID Pri State Dead Time Address Interface RXmtL RqstL DBsmL
40.40.40.10 1 Full/DR 30.173s 40.40.40.10 uplink-275:40.40.40.1 0 0 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display OSPF routes.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be ospf route
============ OSPF network routing table ============
N 40.40.40.0/24 [10] area: 0.0.0.0
directly attached to uplink-297
============ OSPF router routing table =============
R 40.40.40.2 [10] area: 0.0.0.0, ASBR
via 40.40.40.2, uplink-297
============ OSPF external routing table ===========
N E2 1.1.1.0/25 [10/20] tag: 4016
via 40.40.40.2, uplink-297
N E2 1.1.2.0/24 [10/20] tag: 4016
via 40.40.40.2, uplink-297
N E2 1.1.3.0/24 [10/20] tag: 0
via 40.40.40.2, uplink-297
N E2 100.64.176.0/31 [10/20] tag: 0
via 40.40.40.2, uplink-297
Mode
Basic
Availability
Autonomous Edge, Edge
Show external summary addresses.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
mnaragund-svc> get logical-router b85dbb25-0c04-46e1-9c14-7bbb879f08b3 ospf summary-address
Summary-address Metric-type Metric Tag External_Rt_count
aggregation delay interval :5(in seconds)
172.16.0.0/24 E2 20 0 0
172.16.1.0/24 E2 20 0 0
Fri Dec 17 2021 UTC 11:20:26.010
Mode
Basic
Availability
Autonomous Edge, Edge
Display QoS config for the specified logical router.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 736a80e3-23f6-5a2d-81d6-bbefb2786666 qos-config
Logical Router
UUID : 736a80e3-23f6-5a2d-81d6-bbefb2786666
Direction : Egress
Rate (Mbps) : 10
Burst (bytes) : 1000
Direction : Ingress
Rate (Mbps) : 100
Burst (bytes) : 5000
Mode
Basic
Availability
Autonomous Edge, Edge
Display all OSPF routes in RIB.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be route ospf
Flags: t0c - Tier0-Connected, t0s - Tier0-Static, o - OSPF,
t0n - Tier0-NAT, t1s - Tier1-Static, t1c - Tier1-Connected,
t1n: Tier1-NAT, t1l: Tier1-LB VIP, t1ls: Tier1-LB SNAT,
t1d: Tier1-DNS FORWARDER, > - selected route, * - FIB route
Total number of routes: 2
o > * 10.92.0.0/19 [110/20] via 40.40.40.10, uplink-275, 00:00:20
o 40.40.40.0/24 is directly connected, uplink-275, 00:00:22
Mode
Basic
Availability
Autonomous Edge, Edge
Display statistics for the specified logical router.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 736a80e3-23f6-5a2d-81d6-bbefb2786666 stats
Logical Router
UUID : 736a80e3-23f6-5a2d-81d6-bbefb2786666
VRF : 0
LR-ID : 0
name : R1
type : TUNNEL
Statistics
Dropped No Memory : 0
Dropped No Route : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display tenant context information for the specified logical router.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
Edge3> get logical-router 4e416838-219b-4a91-88cf-b73448e319a8 tenant-context
Sat Jul 15 2023 UTC 00:05:34.788
org : default
proj : maroon
vpc :
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about the specified logical router.
| Option | Description |
|---|---|
| <uuid> | Logical Router identifier |
Example
nsx-controller-1> get logical-router db6760b3-d9e2-44ef-b1c4-f56138665d71
LR-Id LR-Name Hosts[] Service-Controller Router-Type ClusterId UUID
0x5 SR-46740ffe-9bf1-406e-816d-e200a45f0707 192.168.110.111 192.168.110.108 SERVICE_ROUTER_TIER1 00002000-0000-0000-0000-000000000001 db6760b3-d9e2-44ef-b1c4-f56138665d71
192.168.110.112
Mode
Basic
Availability
Manager
Display the routing table for the specified logical router.
| Option | Description |
|---|---|
| <uuid> | Logical Router identifier |
| <route> | Logical Router route description Allowed values: route |
Example
nsx-controller-1> get logical-router db6760b3-d9e2-44ef-b1c4-f56138665d71 route
LR-Id Destination Next-Hop LR-Port-Id Blackhole Route-Type Admin-Distance Admin-State-Up Route-UUID
0x5 172.16.110.0/24 169.0.0.1 8b06827f-6325-4afd-b56d-6260ebf0a1a0 false NSX_CONNECTED 0 true 00000018-ac10-6e00-0000-000000000005
0x5 100.64.1.0/31 0.0.0.0 97458be5-bf5e-44f8-a6b0-9fc32be347fc false CONNECTED 0 true 0000001f-6440-0100-0000-000000000005
0x5 0.0.0.0/0 100.64.1.0 97458be5-bf5e-44f8-a6b0-9fc32be347fc false NSX_STATIC 3 true 00000000-0000-0000-0000-000000000005
0x5 172.16.120.0/24 169.0.0.1 8b06827f-6325-4afd-b56d-6260ebf0a1a0 false NSX_CONNECTED 0 true 00000018-ac10-7800-0000-000000000005
0x5 172.16.130.0/24 169.0.0.1 8b06827f-6325-4afd-b56d-6260ebf0a1a0 false NSX_CONNECTED 0 true 00000018-ac10-8200-0000-000000000005
0x5 169.0.0.0/28 0.0.0.0 8b06827f-6325-4afd-b56d-6260ebf0a1a0 false CONNECTED 0 true 0000001c-a900-0000-0000-000000000005
Mode
Basic
Availability
Manager
Display a specific IPv4 route on the specified logical router.
| Option | Description |
|---|---|
| <uuid> | Logical Router identifier |
| <route> | Logical Router route description Allowed values: route |
| <prefix> | Network Address argument |
Example
nsx-controller-1> get logical-router db6760b3-d9e2-44ef-b1c4-f56138665d71 route 172.16.120.0/24
LR-Id Destination Next-Hop LR-Port-Id Blackhole Route-Type Admin-Distance Admin-State-Up Route-UUID
0x5 172.16.120.0/24 169.0.0.1 8b06827f-6325-4afd-b56d-6260ebf0a1a0 false NSX_CONNECTED 0 true 00000018-ac10-7800-0000-000000000005
Mode
Basic
Availability
Manager
Display information about a specific interface on the specified logical router.
| Option | Description |
|---|---|
| <uuid> | Logical Router identifier |
| <interface-id> | Logical Router interface id Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-router db6760b3-d9e2-44ef-b1c4-f56138665d71 interface 8b06827f-6325-4afd-b56d-6260ebf0a1a0
UUID: 8b06827f-6325-4afd-b56d-6260ebf0a1a0
Interface-Name: bp-sr0-port
Logical-Router-Id: 0x5
Id: 15240
Type: VXSTT
AdminStateUp: true
UrpfMode: PORT_CHECK
Subnets:
169.0.0.2/28
Mac: 02:50:56:00:00:06
Mtu: 0
Multicast-IP: 0.0.0.1
Flags: 0x204
DHCP-Server-IP:
Mode
Basic
Availability
Manager
Display all interfaces on the specified logical router.
| Option | Description |
|---|---|
| <uuid> | Logical Router identifier |
Example
nsx-controller-1> get logical-router db6760b3-d9e2-44ef-b1c4-f56138665d71 interfaces
Interface Type Id IP[] Urpf-Mode Admin-State-Up UUID
sr-0-loopback-port UNSET 0 127.0.0.1/8 NONE true 00003300-0000-0000-0000-000000000005
bp-sr0-port VXSTT 15240 169.0.0.2/28 PORT_CHECK true 8b06827f-6325-4afd-b56d-6260ebf0a1a0
97458be5-bf5e-44f8-a6b0-9fc32be347fc VXSTT 41864 100.64.1.1/31 PORT_CHECK true 97458be5-bf5e-44f8-a6b0-9fc32be347fc
Mode
Basic
Availability
Manager
Get all routing Config entities on the specified Service Router.
| Option | Description |
|---|---|
| <uuid> | Logical Router identifier |
Mode
Basic
Availability
Manager
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.| Option | Description |
|---|---|
| <uuid> | UUID argument |
Example
nsx-edge-1> get logical-router 4e425c9e-09c6-4021-bbc7-fab2895a2c09 high-availability history state
State : Down
Event : Init
Resources :
Time : 2016-02-02 18:41:22.80
State : Active
Event : Node Up
Resources : 0
Time : 2016-02-02 18:41:26.91
Mode
Basic
Availability
Autonomous Edge, Edge
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.| Option | Description |
|---|---|
| <uuid> | UUID argument |
Example
nsx-edge-1> get logical-router 4e425c9e-09c6-4021-bbc7-fab2895a2c09 high-availability history state details
State : Down
Event : Init
Reason : Initialize
Resources :
Time : 2016-02-02 18:41:22.80
State : Active
Event : Node Up
Reason : Initialize
Resources : 0
Time : 2016-02-02 18:41:26.91
Mode
Basic
Availability
Autonomous Edge, Edge
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.| Option | Description |
|---|---|
| <uuid> | UUID argument |
Example
nsx-edge-1> get logical-router 4e425c9e-09c6-4021-bbc7-fab2895a2c09 high-availability status
Service Router
UUID : 4e425c9e-09c6-4021-bbc7-fab2895a2c09
state : Active
type : TIER0
mode : Stateful A/A
rank : 0
service count : 1
service score : 1
HA ports state
UUID : 733d7ed3-1daa-4c28-bc0a-77e3736fea14
op_state : Up
addresses : 169.0.0.2/28
Sub-cluster Information
UUID : 6c3089d1-dac5-43ce-b8bb-91e6bb36345d
Peer SR UUID : 44e3ee5f-36ea-4703-80ad-0e6b50af552a
Peer Node UUID : 3b34da96-ed06-11e8-9814-020063efb6dc
Peer Routers
SR UUID : 4ba2a916-9080-4a2e-9bd7-24d7f3271ab1
Node UUID : 3b34da96-ed06-11e8-9814-020063efb6dc
HA state : Active
SR UUID : 7f7987cf-cef8-4ea9-aa67-eac84f8275d1
Node UUID : 2e7dcee8-ed06-11e8-b593-020063334468
HA state : Active
Mode
Basic
Availability
Autonomous Edge, Edge
Display the high availability status of interface-groups for the logical router
| Option | Description |
|---|---|
| <uuid> | UUID argument |
Example
nsx-edge-1> get logical-router 4e425c9e-09c6-4021-bbc7-fab2895a2c09 interface-groups high-availability
Group UUID : 4e425c9e-09c6-4021-bbc7-fab2895a2c09
Port UUID : e13dbba8-542e-11e9-a177-020021d58d1d
Members
SR UUID : e0e7c638-aa8c-4354-b8a9-0aa0fbbfdb05
Port UUID : e13dbba8-542e-11e9-a177-020021d58d1d
Port MAC : 02:50:56:56:00:02
State : Active
SR UUID : 44e3ee5f-36ea-4703-80ad-0e6b50af552a
Port UUID : c23bc228-f5ec-4ad4-b596-fc0dcccd6922
Port MAC : 02:50:56:56:00:03
State : Active
SR UUID : 79ac0bb6-6ddb-45be-82bd-baf83fdfc788
Port UUID : 628f3976-472a-4543-906c-b6b07c4ffb74
Port MAC : 02:50:56:56:00:04
State : Down
Mode
Basic
Availability
Autonomous Edge, Edge
Display the service groups state for the service router
| Option | Description |
|---|---|
| <uuid> | UUID argument |
Example
nsx-edge-1> get logical-router 4e425c9e-09c6-4021-bbc7-fab2895a2c09 service-groups
Service-Group : a97dea09-a9a9-446d-bd8f-4d6d4f2bc070
Id : 1
Local State : Active
Peer State : Standby
State History
State : Down
Event : Init
Resources :
Time : 2022-01-21 09:31:15.22
State : Standby
Event : Service Router Up
Resources :
Time : 2022-01-21 09:31:15.22
State : Active
Event : Service Router Up
Resources : 0
Time : 2022-01-21 09:31:15.68
Mode
Basic
Availability
Autonomous Edge, Edge
Display the service groups state for the service router
| Option | Description |
|---|---|
| <uuid> | UUID argument |
Example
nsx-edge-1> get logical-router 4e425c9e-09c6-4021-bbc7-fab2895a2c09 service-groups details
Service-Group : a97dea09-a9a9-446d-bd8f-4d6d4f2bc070
Id : 1
Local State : Active
Peer State : Standby
State History
State : Down
Event : Init
Reason : Initialize
Resources :
Time : 2022-01-21 09:31:15.22
State : Standby
Event : Service Router Up
Reason : Service Router Up
Resources :
Time : 2022-01-21 09:31:15.22
State : Active
Event : Service Router Up
Reason : Service Router Up
Resources : 0
Time : 2022-01-21 09:31:15.68
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about the specified logical router.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
kvm-1> get logical-router 091a05dc-8080-41a2-a56f-baf6d32fb512
Logical Router
==================================================
UUID : 091a05dc-8080-41a2-a56f-baf6d32fb512
ID : 32769
Max Neighbors : 50000
Current Neighbors : 1
Interfaces :
100.64.1.1/31 (02:50:56:00:00:03)
172.16.30.1/24 (02:50:56:56:44:52)
172.16.10.1/24 (02:50:56:56:44:52)
172.16.20.1/24 (02:50:56:56:44:52)
or
esx-1> get logical-router d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8
Logical Router
-------------------------------------------------------------------------------------
VDR UUID : d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8
LIF number : 4
IPv4 Route number : 7
IPv6 Route number : 5
State : ['Enabled']
Role : VPC DR
Policy Path : /orgs/default/projects/default/vpcs/vpc1
Controller IP : 192.168.110.108
Control plane IP : 192.168.210.51
Control plane active : True
Next hop number : 1
Generation number : 0
Edge active : False
Current Neighbors : 20
Max Neighbors : 50000
Neighbor Limit Overridden : False
Multicast Routing Enable : False
ECMP Mode : L3
Mode
Basic
Availability
ESXi, KVM, NSX Cloud VM
Display forwarding for the specified logical router.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
kvm-1> get logical-router 3f37a518-0b5a-4833-be11-0f6df5e96421 forwarding
Logical Router Forwarding Table
==============================================================================================================
Prefix Gateway Interface
100.64.1.0/31 0.0.0.0 7f475e70-6919-42f4-a9ab-7c8381ef93c2
192.168.10.0/24 0.0.0.0 4891b955-a8cf-4e2f-b87f-ea1fc6c3b7a8
192.168.20.0/24 0.0.0.0 a12f6616-31bd-4d75-8972-bc75f3fe4392
0.0.0.0/0 100.64.1.0 7f475e70-6919-42f4-a9ab-7c8381ef93c2
2000:20::/64 :: a12f6616-31bd-4d75-8972-bc75f3fe4392
2000:10::/64 :: 4891b955-a8cf-4e2f-b87f-ea1fc6c3b7a8
fc88:474c:60c:2800::/64 :: 7f475e70-6919-42f4-a9ab-7c8381ef93c2
::/0 fc88:474c:60c:2800::1 7f475e70-6919-42f4-a9ab-7c8381ef93c2
or
esx-1> get logical-router d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 forwarding
Logical Routers Forwarding Table
-----------------------------------------------------------------------------------------------------
Flags Legend: [U: Up], [G: Gateway], [C: Connected], [I: Interface]
[H: Host], [R: Reject], [B: Blackhole], [F: Soft Flush], [E: ECMP]
[S1|S2|S3: TGW Private|Public|External Route Scope]
Network Gateway Type Interface UUID
=====================================================================================================
172.16.10.0/26 100.64.0.1 UGS1 47b3683e-3d26-5d7b-8c68-d5c28980bc70
172.16.10.64/26 100.64.0.3 UGS1 3b2115c7-23ef-5aaf-9ad2-085684c2fb92
192.168.1.0/24 0.0.0.0 UCI 1c1a47f7-d314-4e74-a198-5568540e4284
192.168.2.0/24 0.0.0.0 UCI 53a15328-e7cb-4c97-b147-e7ee833754db
2000::1/64 :: UCI 1c1a47f7-d314-4e74-a198-5568540e4284
3000::1/64 :: UCI 53a15328-e7cb-4c97-b147-e7ee833754db
Mode
Basic
Availability
ESXi, KVM, NSX Cloud VM
Display forwarding for the specified logical router filtered on prefix.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <prefix> | Network Address argument |
Example
esx-1> get logical-router d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 forwarding 192.168.1.0/24
Logical Routers Forwarding Table
-----------------------------------------------------------------------------------------------------
Flags Legend: [U: Up], [G: Gateway], [C: Connected], [I: Interface]
[H: Host], [R: Reject], [B: Blackhole], [F: Soft Flush], [E: ECMP]
[S1|S2|S3: TGW Private|Public|External Route Scope]
Network Gateway Type Interface UUID
=====================================================================================================
192.168.1.0/24 0.0.0.0 UCI 1c1a47f7-d314-4e74-a198-5568540e4284
Mode
Basic
Availability
ESXi
Display forwarding for the specified logical router, filtered by prefix.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <prefix> | Network Address argument |
Example
kvm-1> get logical-router 091a05dc-8080-41a2-a56f-baf6d32fb512 forwarding fc88:474c:60c:2800::/64
Logical Router Forwarding Table
==============================================================================================================
Prefix Gateway Interface
fc88:474c:60c:2800::/64 :: 7f475e70-6919-42f4-a9ab-7c8381ef93c2
Mode
Basic
Availability
KVM, NSX Cloud VM
Display IPv4 forwarding for the specified logical router.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
kvm-1> get logical-router 3f37a518-0b5a-4833-be11-0f6df5e96421 forwarding ipv4
Logical Router Forwarding Table
==============================================================================================================
Prefix Gateway Interface
100.64.1.0/31 0.0.0.0 7f475e70-6919-42f4-a9ab-7c8381ef93c2
192.168.10.0/24 0.0.0.0 4891b955-a8cf-4e2f-b87f-ea1fc6c3b7a8
192.168.20.0/24 0.0.0.0 a12f6616-31bd-4d75-8972-bc75f3fe4392
or
esx-1> get logical-router d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 forwarding
Logical Routers Forwarding Table - IPv4
------------------------------------------------------------------------------------------------------
Flags Legend: [U: Up], [G: Gateway], [C: Connected], [I: Interface]
[H: Host], [R: Reject], [B: Blackhole], [F: Soft Flush], [E: ECMP]
[S1|S2|S3: TGW Private|Public|External Route Scope]
Network Gateway Type Interface UUID
=====================================================================================================
172.16.10.0/26 100.64.0.1 UGS1 47b3683e-3d26-5d7b-8c68-d5c28980bc70
172.16.10.64/26 100.64.0.3 UGS1 3b2115c7-23ef-5aaf-9ad2-085684c2fb92
192.168.1.0/24 0.0.0.0 UCI 1c1a47f7-d314-4e74-a198-5568540e4284
192.168.2.0/24 0.0.0.0 UCI 53a15328-e7cb-4c97-b147-e7ee833754db
Mode
Basic
Availability
ESXi, KVM, NSX Cloud VM
Display IPv6 forwarding for the specified logical router.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
kvm-1> get logical-router 091a05dc-8080-41a2-a56f-baf6d32fb512 forwarding ipv6
Logical Router Forwarding Table
==============================================================================================================
Prefix Gateway Interface
2000:20::/64 :: a12f6616-31bd-4d75-8972-bc75f3fe4392
2000:10::/64 :: 4891b955-a8cf-4e2f-b87f-ea1fc6c3b7a8
fc88:474c:60c:2800::/64 :: 7f475e70-6919-42f4-a9ab-7c8381ef93c2
::/0 fc88:474c:60c:2800::1 7f475e70-6919-42f4-a9ab-7c8381ef93c2
or
esx-1> get logical-router d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 forwarding
Logical Routers Forwarding Table - IPv6
-------------------------------------------------------------------------------------------------------
Flags Legend: [U: Up], [G: Gateway], [C: Connected], [I: Interface]
[H: Host], [R: Reject], [B: Blackhole], [F: Soft Flush], [E: ECMP]
Network Gateway Type Interface UUID
=====================================================================================================
2000::1/64 :: UCI 1c1a47f7-d314-4e74-a198-5568540e4284
3000::1/64 :: UCI 53a15328-e7cb-4c97-b147-e7ee833754db
Mode
Basic
Availability
ESXi, KVM, NSX Cloud VM
Display Mcast Groups for the specified logical router.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
esx-1> get logical-router 95a67044-9353-4e69-aa45-a1d29480eef5 igmp membership
Mcast groups with Local or Remote Receivers
==============================================================
Number of Local Receiver Entries : 1
Number of Remote Receiver Entries : 1
Number of Multicast Groups : 1
==============================================================
Multicast group IP Replication IP
---------------------------------------
237.0.0.10 230.0.0.220
Local Receivers :
1)
Lif Name : b151ed17-c023-4b1c-a487-f2418198fe02
VNI Type : 2
VNI : 69643
Expire Time(sec) : 183
Up Time(sec) : 1643380
---------------------------------------
Remote Receivers :
VTEP count: 1
1)
Label: 12342
Subnet IP: 200.200.200.10
VTEP IP: 200.200.200.21
VTEP Mac: 30:30:3a:31:31:3a
Is MTEP: True
MTEP Favourable: True
Up Time(sec): 8
Expire Time(sec): 252
==============================================================
Mode
Basic
Availability
ESXi
Display Mcast Groups for the specified logical router.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <ip-address> | Network IP address argument |
Example
esx-1> get logical-router 95a67044-9353-4e69-aa45-a1d29480eef5 igmp membership 237.0.0.10
Mcast groups with Local or Remote Receivers
==============================================================
Number of Local Receiver Entries : 1
Number of Remote Receiver Entries : 1
Number of Multicast Groups : 1
==============================================================
Multicast group IP Replication IP
---------------------------------------
237.0.0.10 230.0.0.220
Local Receivers :
1)
Lif Name : b151ed17-c023-4b1c-a487-f2418198fe02
VNI Type : 2
VNI : 69643
Expire Time(sec) : 183
Up Time(sec) : 1643380
---------------------------------------
Remote Receivers :
VTEP count: 1
1)
Label: 12342
Subnet IP: 200.200.200.10
VTEP IP: 200.200.200.21
VTEP Mac: 30:30:3a:31:31:3a
Is MTEP: True
MTEP Favourable: True
Up Time(sec): 8
Expire Time(sec): 252
==============================================================
Mode
Basic
Availability
ESXi
Display information for the specified logical router instance.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
esx-1> get logical-router d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 interface c66fc321-df74-4aaa-835e-95dc815fe7ae
Logical Router Interface
---------------------------------------------------------------------------
LIF UUID : c66fc321-df74-4aaa-835e-95dc815fe7ae
Name : vpc1-private-subnet1-gateway-interface
Subnet Access Mode : PRIVATE
Mode : ['Routing']
Overlay VNI : 27530
IP : 172.16.130.1
IP mask : 255.255.255.0
Mac : 02:50:56:56:44:52
Connected DVS : nsxvswitch
Control plane enable : True
Replication Mode : 0.0.0.1
Multicast Routing : ['Enabled', 'Oper Up', 'Local VM Present']
State : ['Enabled']
Flags : 0x2388
DHCP relay : Not enable
Mode
Basic
Availability
ESXi
Display interface information for the specified logical router and port.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
kvm-1> get logical-router 091a05dc-8080-41a2-a56f-baf6d32fb512 interface e1ce6498-b3ca-4000-a0f4-0734415044cf
Logical Router Interfaces
============================================================
Interface UUID : e1ce6498-b3ca-4000-a0f4-0734415044cf
IP/Mask : 100.64.1.1/31
MAC Address : 02:50:56:00:00:03
VNI : 58248
Flag : 1
DHCP relay : 192.168.33.1, 2001::192:168:33:1
RA-mode : SLAAC_DNS_THROUGH_RA(M=0, O=0)
DAD-mode : Loose
============================================================
Mode
Basic
Availability
KVM, NSX Cloud VM
Display policy table reference information for the specified logical router instance.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
esx-1> get logical-router 22cf7bdd-dd1e-41d6-b3bd-67c566b86fb5 interface 8d0979da-5d73-4717-b711-f44a19007b44 policy-table-ref
Logical Router Interface Policy Table Reference
--------------------------------------------------------------------------------
Policy Table ID Next Hop Type
================================================================================
2 00:50:56:6c:f1:31 proximity routing
Mode
Basic
Availability
ESXi
Display interface instance stats for a logical router.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
esx1> get logical-router a485769d-dc65-4197-b3c9-9a200033e3ea interface e2f2ee21-871a-4c39-8640-2501b9bb871d stats
Logical Router Interface Stats
---------------------------------------------------------------------------
RX Unicast Packets : 0
RX Unicast Bytes : 0
TX Unicast Packets : 0
TX Unicast Bytes : 0
RX Broadcast Packets : 0
RX Broadcast Bytes : 0
TX Broadcast Packets : 4
TX Broadcast Bytes : 240
RX Multicast Packets : 0
RX Multicast Bytes : 0
RX Packets System Error : 0
TX Ref Errors : 0
Packets Deferred Free : 0
RX Packets Dropped : 0
LIF IPv4 Net Statistics
IP & ARP packets RX : 0
IP & ARP packets TX : 4
...
IPv6 Route not found to Dest : 0
Neighbor not found : 0
Mode
Basic
Availability
ESXi
Display interface statistics for the specified logical router and port.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
kvm> get logical-router 96252d7f-1d01-40e7-8f1e-6e3305f22af5 interface 7edd998a-0dfd-4c36-92eb-1bd1d48976ec stats
Logical Router Interface Stats
---------------------------------------------------------------------------
IPv4 Packets RX : 4791
IPv4 Packets TX : 0
IPv4 RX Packets Drops : 0
IPv4 TX Packets Drops : 0
IPv4 TTL Zero Drops : 0
IPv4 uRPF Drops : 0
IPv6 Packets RX : 56520
IPv6 Packets TX : 56432
IPv6 RX Packets Drops : 56459
IPv6 TX Packets Drops : 0
IPv6 TTL Zero Drops : 0
IPV6 uRPF Drops : 0
RS RX Packets : 4
RA TX Packets : 4170
Redirect TX Packets : 2
Mode
Basic
Availability
KVM, NSX Cloud VM
Display interface statistics for the specified logical router and port.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <ip-version> | Internet Protocol Version (IPV4 or IPV6) Allowed values: ipv4, ipv6 |
Example
kvm> get logical-router 96252d7f-1d01-40e7-8f1e-6e3305f22af5 interface 7edd998a-0dfd-4c36-92eb-1bd1d48976ec stats ipv4
Logical Router Interface Stats
---------------------------------------------------------------------------
IPv4 Packets RX : 4791
IPv4 Packets TX : 0
IPv4 RX Packets Drops : 0
IPv4 TX Packets Drops : 0
IPv4 TTL Zero Drops : 0
IPv4 uRPF Drops : 0
kvm> get logical-router 96252d7f-1d01-40e7-8f1e-6e3305f22af5 interface 7edd998a-0dfd-4c36-92eb-1bd1d48976ec stats ipv6
Logical Router Interface Stats
---------------------------------------------------------------------------
IPv6 Packets RX : 56520
IPv6 Packets TX : 56432
IPv6 RX Packets Drops : 56459
IPv6 TX Packets Drops : 0
IPv6 TTL Zero Drops : 0
IPV6 uRPF Drops : 0
RS RX Packets : 4
RA TX Packets : 4170
Redirect TX Packets : 2
Mode
Basic
Availability
KVM, NSX Cloud VM
Display interface instance stats for a logical router (ipv4).
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
esx1> get logical-router a485769d-dc65-4197-b3c9-9a200033e3ea interface e2f2ee21-871a-4c39-8640-2501b9bb871d stats ipv4
Logical Router Interface Stats
---------------------------------------------------------------------------
RX Unicast Packets : 0
RX Unicast Bytes : 0
TX Unicast Packets : 0
TX Unicast Bytes : 0
RX Broadcast Packets : 0
RX Broadcast Bytes : 0
TX Broadcast Packets : 4
TX Broadcast Bytes : 240
RX Multicast Packets : 0
RX Multicast Bytes : 0
RX Packets System Error : 0
TX Ref Errors : 0
Packets Deferred Free : 0
RX Packets Dropped : 0
LIF IPv4 Net Statistics
IP & ARP packets RX : 0
IP & ARP packets TX : 4
...
Route not found to Dest : 0
Neighbor not found : 0
Mode
Basic
Availability
ESXi
Display interface instance stats for a logical router (ipv6).
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
esx1> get logical-router a485769d-dc65-4197-b3c9-9a200033e3ea interface e2f2ee21-871a-4c39-8640-2501b9bb871d stats ipv6
Logical Router Interface Stats
---------------------------------------------------------------------------
RX Unicast Packets : 0
RX Unicast Bytes : 0
TX Unicast Packets : 0
TX Unicast Bytes : 0
RX Broadcast Packets : 0
RX Broadcast Bytes : 0
TX Broadcast Packets : 4
TX Broadcast Bytes : 240
RX Multicast Packets : 0
RX Multicast Bytes : 0
RX Packets System Error : 0
TX Ref Errors : 0
Packets Deferred Free : 0
RX Packets Dropped : 0
LIF IPv6 Net Statistics
IPv6 packets RX : 0
IPv6 packets TX : 0
...
IPv6 Route not found to Dest : 0
Neighbor not found : 0
Mode
Basic
Availability
ESXi
Display interface information for the specified logical router.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
kvm-1> get logical-router 091a05dc-8080-41a2-a56f-baf6d32fb512 interfaces
Logical Router Interfaces
============================================================
Interface UUID : e1ce6498-b3ca-4000-a0f4-0734415044cf
IP/Mask : 100.64.1.1/31
MAC Address : 02:50:56:00:00:03
VNI : 58248
Flag : 1
DHCP relay : Not enabled
RA-mode : RA_DISABLED
DAD-mode : Loose
============================================================
Interface UUID : d7c184c8-bf63-47c8-bf48-01836d0380e5
IP/Mask : 172.16.30.1/24
MAC Address : 02:50:56:56:44:52
VNI : 31624
Flag : 0
DHCP relay : 192.168.33.1, 2001::192:168:33:1
RA-mode : RA_DISABLED
DAD-mode : Loose
============================================================
Interface UUID : 07607708-9bc7-46fc-8d14-fc016b9297da
IP/Mask : 172.16.10.1/24
MAC Address : 02:50:56:56:44:52
VNI : 54152
Flag : 0
DHCP relay : Not enabled
RA-mode : RA_DISABLED
DAD-mode : Loose
============================================================
Interface UUID : b2d3d312-962e-4a79-864c-09304195b88a
IP/Mask : 172.16.20.1/24
MAC Address : 02:50:56:56:44:52
VNI : 52104
Flag : 0
DHCP relay : 192.168.33.1, 2001::192:168:33:1
RA-mode : RA_DISABLED
DAD-mode : Loose
============================================================
or
esx-1> get logical-router d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 interfaces
Logical Router Interfaces
---------------------------------------------------------------------------
LIF UUID : c66fc321-df74-4aaa-835e-95dc815fe7ae
Name : vpc1-private-subnet1-gateway-interface
Subnet Access Mode : PRIVATE
Mode : ['Routing']
Overlay VNI : 27530
IP : 172.16.130.1
IP mask : 255.255.255.0
Mac : 02:50:56:56:44:52
Connected DVS : nsxvswitch
Control plane enable : True
Replication Mode : 0.0.0.1
Multicast Routing : ['Enabled', 'Oper Up', 'Local VM Present']
State : ['Enabled']
Flags : 0x2288
DHCP relay : Not enable
LIF UUID : be290c92-74ed-437c-bbf1-dd78673b6a5a
Name : vpc1-project-subnet1-gateway-interface
Subnet Access Mode : TGW-PRIVATE
Mode : ['Routing']
Overlay VNI : 25480
IP : 172.16.120.1
IP mask : 255.255.255.0
Mac : 02:50:56:56:44:52
Connected DVS : nsxvswitch
Control plane enable : True
Replication Mode : 0.0.0.1
Multicast Routing : ['Enabled', 'Oper Up']
State : ['Enabled']
Flags : 0x2288
DHCP relay : Not enable
LIF UUID : f6ef3b50-64a0-4948-ab9e-9135963d4b8b
Name :
Subnet Access Mode : NONE
Mode : ['Routing-Backplane']
Overlay VNI : 37768
IP : 169.0.0.1
IP mask : 255.255.255.240
Mac : 02:50:56:56:44:52
Connected DVS : nsxvswitch
Control plane enable : True
Replication Mode : 0.0.0.1
Multicast Routing : ['Enabled', 'Oper Up']
State : ['Enabled']
Flags : 0x12308
DHCP relay : Not enable
LIF UUID : 3c139373-f8f7-441e-aac4-146d9b5ff3a6
Name : vpc1-public-subnet1-gateway-interface
Subnet Access Mode : PUBLIC
Mode : ['Routing']
Overlay VNI : 11145
IP : 172.16.110.1
IP mask : 255.255.255.0
Mac : 02:50:56:56:44:52
Connected DVS : nsxvswitch
Control plane enable : True
Replication Mode : 0.0.0.1
Multicast Routing : ['Enabled', 'Oper Up']
State : ['Enabled']
Flags : 0x2388
DHCP relay : Not enable
Mode
Basic
Availability
ESXi, KVM, NSX Cloud VM
Display Mcast router backplane IP for load-balancing a multicast group
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <ip-address> | Network IP address argument |
Example
esx-1> get logical-router 95a67044-9353-4e69-aa45-a1d29480eef5 multicast load-balancing 239.1.1.1
selected-backplane: 169.254.0.2
Mode
Basic
Availability
ESXi
Display neighbor information (ARP/ND cache) for the specified logical router, using IP or MAC.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <ip-or-mac-address> | IP or MAC address |
Example
kvm-1> get logical-router 1904e13f-757a-4f44-9f85-cb84678a1a16 neighbor 192.168.1.1
Logical Router Forwarding Table
============================================================
Prefix MAC State Timeout
192.168.1.1/24 02:50:56:56:44:52 Up 10
or
esx-1> get logical-router d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 neighbor 172.16.130.1
Logical Routers Neighbors
--------------------------------------------------------------------------------------------------------------
Flags Legend: [S: Static], [V: Valid], [P: Proxy], [I: Interface]
[N: Nascent], [L: Local], [D: Deleted], [K: linKlif], [A: AutoRefresh]
Network Mac Flags State Uptime SrcPort Refcnt Lif UUID
=======================================================================================================================================
172.16.130.1 00:0c:29:74:3c:0e VL 503 97 50331655 11 176a992c-5977-4011-9ad2-c0d1e807e1a6
Mode
Basic
Availability
ESXi, KVM, NSX Cloud VM
Display neighbor information (ARP cache) for the specified logical router.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
kvm-1> get logical-router 1904e13f-757a-4f44-9f85-cb84678a1a16 neighbors
Logical Router Forwarding Table
============================================================
Prefix MAC State Timeout
192.168.1.1/24 02:50:56:56:44:52 Up 10
or
esx-1> get logical-router d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 neighbors
Logical Routers Neighbors
--------------------------------------------------------------------------------------------------------------
Flags Legend: [S: Static], [V: Valid], [P: Proxy], [I: Interface]
[N: Nascent], [L: Local], [D: Deleted], [K: linKlif]
Network Mac Flags State Uptime SrcPort Refcnt Lif UUID
========================================================================================================================================
172.16.130.1 02:50:56:56:44:52 VI permanent 453 0 1 c66fc321-df74-4aaa-835e-95dc815fe7ae
172.16.130.12 00:00:00:00:00:00 NP 0 2 0 2 c66fc321-df74-4aaa-835e-95dc815fe7ae
172.16.120.1 02:50:56:56:44:52 VI permanent 453 0 1 be290c92-74ed-437c-bbf1-dd78673b6a5a
169.0.0.1 02:50:56:56:44:52 VI permanent 453 0 1 f6ef3b50-64a0-4948-ab9e-9135963d4b8b
169.0.0.2 02:50:56:00:00:05 V 498 255 83886128 2 f6ef3b50-64a0-4948-ab9e-9135963d4b8b
172.16.110.1 02:50:56:56:44:52 VI permanent 453 0 1 3c139373-f8f7-441e-aac4-146d9b5ff3a6
172.16.110.11 00:50:56:8e:91:12 VL 488 265 83886132 18 3c139373-f8f7-441e-aac4-146d9b5ff3a6
2000:1::1 02:50:56:56:44:52 VI permanent 453 0 1 c66fc321-df74-4aaa-835e-95dc815fe7ae
2000:130::12 00:00:00:00:00:00 N 0 2 0 2 c66fc321-df74-4aaa-835e-95dc815fe7ae
fe8089db:00000000:005056ff:fe564452 02:50:56:56:44:52 VI permanent 453 0 1 1c1a47f7-d314-4e74-a198-5568540e4284
Mode
Basic
Availability
ESXi, KVM, NSX Cloud VM
Display BFD sessions in a logical router
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge> get logical-router 463c9dd1-986b-4947-895b-1126bd53abc8 bfd-session
BFD Session
Dest_port : 3784
Diag : No Diagnostic
Encap : vlan
Forwarding : last false (current false)
Interface : 4451c48f-8cff-4444-8e10-bff403783dca
Last_cp_diag : No Diagnostic
Last_cp_rmt_diag : No Diagnostic
Last_cp_rmt_state : admin_down
Last_cp_state : admin_down
Last_fwd_state : NONE
Local_address : 192.168.50.1
Local_discr : 2830404107
Min_rx_ttl : 255
Multiplier : 5
Prev_failure_diag : No Diagnostic
Received_remote_diag : No Diagnostic
Received_remote_state : down
Remote_address : 192.168.50.20
Remote_admin_down : false
Remote_diag : No Diagnostic
Remote_discr : 0
Remote_min_rx_interval : 0
Remote_min_tx_interval : 0
Remote_multiplier : 0
Remote_state : down
Rx_cfg_min : 3000
Rx_interval : 3000
Session_type : LR_PORT
State : down
Tx_cfg_min : 3000
Tx_interval : 3000
Mode
Basic
Availability
Autonomous Edge, Edge
Display BGP EVPN routes.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
EVPN-M0-EDGE-ONE> get logical-router cde323b5-e8e0-44d7-bd11-da76822ffd30 bgp evpn
BGP table version is 4, local router ID is 20.20.20.10
Status codes: s suppressed, d damped, h history, * valid, > best, i - internal
Origin codes: i - IGP, e - EGP, ? - incomplete
EVPN type-2 prefix: [2]:[EthTag]:[MAClen]:[MAC]:[IPlen]:[IP]
EVPN type-3 prefix: [3]:[EthTag]:[IPlen]:[OrigIP]
EVPN type-4 prefix: [4]:[ESI]:[IPlen]:[OrigIP]
EVPN type-5 prefix: [5]:[EthTag]:[IPlen]:[IP]
Network Next Hop Metric LocPrf Weight Path
Route Distinguisher: 12.1.1.2:2
*> [5]:[0]:[32]:[12.1.1.2]
70.1.1.2 0 0 200 ?
*> [5]:[0]:[32]:[80.1.1.1]
70.1.1.2 0 0 200 i
*> [5]:[0]:[32]:[81.1.1.1]
70.1.1.2 0 0 200 i
*> [5]:[0]:[32]:[87.1.1.1]
70.1.1.2 0 0 200 i
Displayed 4 prefixes (4 paths)
Mode
Basic
Availability
Edge
Display BGP EVPN overlay information for all RDs.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
EVPN-M0-EDGE-ONE> get logical-router cde323b5-e8e0-44d7-bd11-da76822ffd30 bgp evpn overlay
Route Distinguisher: as2 0:0
*> [5]:[0]:[24]:[101.1.1.0]
0.0.0.0 00:00:00:00:00:00:00:00:00:00/0.0.0.0
*> [5]:[0]:[32]:[12.12.12.12]
0.0.0.0 00:00:00:00:00:00:00:00:00:00/0.0.0.0
Route Distinguisher: ip 100.1.1.2:2
*> [5]:[0]:[24]:[100.1.1.0]
5.1.1.2 00:00:00:00:00:00:00:00:00:00/0.0.0.0/92:fc:ee:ac:51:61
*> [5]:[0]:[32]:[11.11.11.11]
5.1.1.2 00:00:00:00:00:00:00:00:00:00/0.0.0.0/92:fc:ee:ac:51:61
Route Distinguisher: ip 101.1.1.3:2
*> [5]:[0]:[24]:[101.1.1.0]
6.1.1.2 00:00:00:00:00:00:00:00:00:00/0.0.0.0/1a:de:dd:e7:46:b7
*> [5]:[0]:[32]:[12.12.12.12]
6.1.1.2 00:00:00:00:00:00:00:00:00:00/0.0.0.0/1a:de:dd:e7:46:b7
Route Distinguisher: ip 150.1.1.2:4
Displayed 7 out of 7 total prefixes
Mode
Basic
Availability
Edge
Display BGP EVPN VNI information.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
EVPN-M0-EDGE-ONE> get logical-router cde323b5-e8e0-44d7-bd11-da76822ffd30 bgp evpn vni
Advertise Gateway Macip: Disabled
Advertise All VNI flag: Enabled
BUM flooding: Head-end replication
Number of L2 VNIs: 0
Number of L3 VNIs: 1
Flags: * - Kernel
VNI Type RD Import RT Export RT Tenant VRF
* 10001 L3 101.1.1.3:2 1:500 1:500 vrf-blue
Mode
Basic
Availability
Edge
Display information about a specific BGP neighbor.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be bgp neighbor 2005::2828:280a
BGP neighbor is 2005::2828:280a, remote AS 1000, local AS 2000, external link
Administratively shut down
BGP version 4, remote router ID 0.0.0.0, local router ID 50.50.50.1
BGP state = Idle
Last read 2d16h06m, Last write never
Hold time is 180, keepalive interval is 60 seconds
Configured hold time is 4, keepalive interval is 1 seconds
Message statistics:
Inq depth is 0
Outq depth is 0
Sent Rcvd
Opens: 0 0
Notifications: 0 0
Updates: 0 0
Keepalives: 0 0
Route Refresh: 0 0
Capability: 0 0
Total: 0 0
Minimum time between advertisement runs is 0 seconds
For address family: IPv6 Unicast
Not part of any update group
Community attribute sent to this neighbor(all)
0 accepted prefixes
Connections established 0; dropped 0
Last reset never
BGP Connect Retry Timer in Seconds: 120
Read thread: off Write thread: off
BFD Status: Not configured
Mode
Basic
Availability
Autonomous Edge, Edge
Display routes advertised to a BGP neighbor.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be bgp neighbor 50.50.50.10 advertised-routes
BGP table version is 1, local router ID is 50.50.50.1
Status flags: > - best, I - internal
Origin flags: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
> 111.111.0.0/16 100.64.0.1 0 100 32768 2000 ?
Mode
Basic
Availability
Autonomous Edge, Edge
Display routes learnt from a BGP neighbor.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be bgp neighbor 50.50.50.10 routes
BGP table version is 1, local router ID is 50.50.50.1
Status flags: > - best, I - internal
Origin flags: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Weight Path
> 11.11.0.0/16 100.64.0.2 0 100 32768 2000 ?
Mode
Basic
Availability
Autonomous Edge, Edge
Display a specific BGP neighbor diagnostic information.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1(tier0_sr)> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be bgp neighbor 10.1.1.20 session-diagnostics
BGP neighbor is 10.1.1.20
Current State: Connect
Number of session flaps : 2
Session last reset due to : BGP Notification send
Session Statistics:
Recent keeep-alives sent (most recent first, upto maximum 5):
2023-09-01-10:02.55
2023-09-01-10:02.52
2023-09-01-10:02.49
2023-09-01-10:02.46
2023-09-01-10:02.43
Recent keeep-alives received(most recent first, upto maximum 5):
2023-09-01-10:02.49
2023-09-01-10:02.46
2023-09-01-10:02.43
2023-09-01-10:02.40
2023-09-01-10:02.37
Recent Events (most recent first, upto maximum 8):
2023-09-01-10:02.59: BGP_Start [Idle -> Connect]
2023-09-01-10:02.58: Clearing_Completed [Clearing -> Idle]
Recent Flaps (most recent first, upto maximum 4):
Down at: 2023-09-01-10:02.58
Down events:
2023-09-01-10:02.58: Hold_Timer_expired [Established -> Clearing]
2023-09-01-10:02.34: TCP_connection_open_failed [OpenConfirm -> Established]
2023-09-01-10:02.34: Receive_OPEN_message [OpenSent -> OpenConfirm]
2023-09-01-10:02.34: TCP_connection_open [Active -> OpenSent]
2023-09-01-10:02.34: Null [Idle -> Active]
Keepalives sent before flap:
2023-09-01-10:02.55
2023-09-01-10:02.52
2023-09-01-10:02.49
2023-09-01-10:02.46
2023-09-01-10:02.43
Keepalives received before flap:
2023-09-01-10:02.49
2023-09-01-10:02.46
2023-09-01-10:02.43
2023-09-01-10:02.40
2023-09-01-10:02.37
Up events:
Down at: 2023-09-01-09:59.42
Down events:
2023-09-01-09:59.42: Hold_Timer_expired [Established -> Clearing]
2023-09-01-09:39.09: BGP_Stop [OpenConfirm -> Established]
2023-09-01-09:39.09: Receive_OPEN_message [OpenSent -> OpenConfirm]
2023-09-01-09:39.09: TCP_connection_open [Active -> OpenSent]
2023-09-01-09:39.09: Null [Idle -> Active]
Keepalives sent before flap:
2023-09-01-09:59.42
2023-09-01-09:59.39
2023-09-01-09:59.36
2023-09-01-09:59.33
2023-09-01-09:59.30
Keepalives received before flap:
2023-09-01-09:59.33
2023-09-01-09:59.30
2023-09-01-09:59.27
2023-09-01-09:59.24
2023-09-01-09:59.21
Up events:
2023-09-01-10:02.34: TCP_connection_open_failed [OpenConfirm -> Established]
2023-09-01-10:02.34: Receive_OPEN_message [OpenSent -> OpenConfirm]
2023-09-01-10:02.34: TCP_connection_open [Active -> OpenSent]
2023-09-01-10:02.34: Null [Idle -> Active]
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display BGP neighbor diagnostic information.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be bgp neighbor session-diagnostics
BGP neighbor is 10.1.1.20
Current State: Connect
Number of session flaps : 2
Session last reset due to : BGP Notification send
Session Statistics:
Recent keeep-alives sent (most recent first, upto maximum 5):
2023-09-01-10:02.55
2023-09-01-10:02.52
2023-09-01-10:02.49
2023-09-01-10:02.46
2023-09-01-10:02.43
Recent keeep-alives received(most recent first, upto maximum 5):
2023-09-01-10:02.49
2023-09-01-10:02.46
2023-09-01-10:02.43
2023-09-01-10:02.40
2023-09-01-10:02.37
Recent Events (most recent first, upto maximum 8):
2023-09-01-10:02.59: BGP_Start [Idle -> Connect]
2023-09-01-10:02.58: Clearing_Completed [Clearing -> Idle]
Recent Flaps (most recent first, upto maximum 4):
Down at: 2023-09-01-10:02.58
Down events:
2023-09-01-10:02.58: Hold_Timer_expired [Established -> Clearing]
2023-09-01-10:02.34: TCP_connection_open_failed [OpenConfirm -> Established]
2023-09-01-10:02.34: Receive_OPEN_message [OpenSent -> OpenConfirm]
2023-09-01-10:02.34: TCP_connection_open [Active -> OpenSent]
2023-09-01-10:02.34: Null [Idle -> Active]
Keepalives sent before flap:
2023-09-01-10:02.55
2023-09-01-10:02.52
2023-09-01-10:02.49
2023-09-01-10:02.46
2023-09-01-10:02.43
Keepalives received before flap:
2023-09-01-10:02.49
2023-09-01-10:02.46
2023-09-01-10:02.43
2023-09-01-10:02.40
2023-09-01-10:02.37
Up events:
Down at: 2023-09-01-09:59.42
Down events:
2023-09-01-09:59.42: Hold_Timer_expired [Established -> Clearing]
2023-09-01-09:39.09: BGP_Stop [OpenConfirm -> Established]
2023-09-01-09:39.09: Receive_OPEN_message [OpenSent -> OpenConfirm]
2023-09-01-09:39.09: TCP_connection_open [Active -> OpenSent]
2023-09-01-09:39.09: Null [Idle -> Active]
Keepalives sent before flap:
2023-09-01-09:59.42
2023-09-01-09:59.39
2023-09-01-09:59.36
2023-09-01-09:59.33
2023-09-01-09:59.30
Keepalives received before flap:
2023-09-01-09:59.33
2023-09-01-09:59.30
2023-09-01-09:59.27
2023-09-01-09:59.24
2023-09-01-09:59.21
Up events:
2023-09-01-10:02.34: TCP_connection_open_failed [OpenConfirm -> Established]
2023-09-01-10:02.34: Receive_OPEN_message [OpenSent -> OpenConfirm]
2023-09-01-10:02.34: TCP_connection_open [Active -> OpenSent]
2023-09-01-10:02.34: Null [Idle -> Active]
Mode
Basic
Availability
Autonomous Edge, Edge
Display summarized BGP neighbor information.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be bgp neighbor summary
BFD States: NC - Not configured, DC - Disconnected
AD - Admin down, DW - Down, IN - Init, UP - Up
BGP summary information for VRF default for address-family: ipv4Unicast
Router ID: 50.50.50.1 Local AS: 2000
Neighbor AS State Up/DownTime BFD InMsgs OutMsgs InPfx OutPfx
50.50.50.10 1000 Estab 2d13h55m DW 3893 3885 0 1
BFD States: NC - Not configured, DC - Disconnected
AD - Admin down, DW - Down, IN - Init, UP - Up
BGP summary information for VRF default for address-family: ipv6Unicast
Router ID: 50.50.50.1 Local AS: 2000
Neighbor AS State Up/DownTime BFD InMsgs OutMsgs InPfx OutPfx
2005::2828:280a 1000 Idle never NC 0 0 0 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display summarized BGP neighbor information for a given address-family.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <address-family> | BGP address family argument Allowed values: ipv4, ipv6, evpn |
Example
nsx-edge-1> get logical-router cde323b5-e8e0-44d7-bd11-da76822ffd30 bgp neighbor summary evpn
BFD States: NC - Not configured, DC - Disconnected
AD - Admin down, DW - Down, IN - Init, UP - Up
BGP summary information for VRF default for address-family: l2VpnEvpn
Router ID: 150.1.1.3 Local AS: 200
Neighbor AS State Up/DownTime BFD InMsgs OutMsgs InPfx OutPfx
150.1.1.2 100 Estab 10:32:15 NC 762 765 3 7
Mode
Basic
Availability
Autonomous Edge, Edge
Generate BGP/BFD diagnostic report.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1>get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be bgp-bfd diagnostics report
2024-07-19 17:59:12,205 - INFO - CSV write operation is completed. Time taken = 0:00:01.494980
Fri Jul 19 2024 UTC 17:59:08.784
nsx-edge-1>
Mode
Basic
Availability
Autonomous Edge, Edge
Display EVPN VNI ARP information.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <vni> | vni Allowed pattern: ^[0-9]+$ |
Example
nsx-edge-1>get logical-router cde323b5-e8e0-44d7-bd11-da76822ffd30 evpn arp 3000
VNI 3000 #MACs (local and remote) 1
MAC Type Intf/Remote VTEP VLAN
ea:4d:80:ae:3d:32 local Br_l2_3000 1 0/0
Mode
Basic
Availability
Edge
Display EVPN VNI MAC information.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <vni> | vni Allowed pattern: ^[0-9]+$ |
Example
nsx-edge-1> get logical-router cde323b5-e8e0-44d7-bd11-da76822ffd30 evpn mac 3000
VNI 3000 #ARP (IPv4 and IPv6, local and remote) 1
IP Type State MAC Remote VTEP
fe80::e84d:80ff:feae:3d32 local active ea:4d:80:ae:3d:32
Mode
Basic
Availability
Edge
Display router MACs for all VNIs.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
EVPN-M0-EDGE-ONE> get logical-router cde323b5-e8e0-44d7-bd11-da76822ffd30 evpn rmac
VNI 10001 #RMACs 1
RMAC Remote VTEP
92:fc:ee:ac:51:61 5.1.1.2
Mode
Basic
Availability
Edge
Display all EVPN VNI information.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
EVPN-M0-EDGE-ONE> get logical-router cde323b5-e8e0-44d7-bd11-da76822ffd30 evpn vni
VNI: 100000
Type: L3
Tenant VRF: vrf-2
Local Vtep Ip: 70.1.1.1
Vxlan-Intf: vxlan-100000
SVI-If: kni-275
State: Up
VNI Filter: none
Router MAC: 02:50:56:56:54:00
L2 VNIs:
Mode
Basic
Availability
Edge
Display the forwarding table for the specified logical router. Optionally specify a prefix to display only the entry that matches that network.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <prefix> | Network Address argument |
Example
nsx-edge-1> get logical-router 736a80e3-23f6-5a2d-81d6-bbefb2786666 forwarding
Logical Router
UUID VRF LR-ID Name Type
736a80e3-23f6-5a2d-81d6-bbefb2786666 0 0 R1 TUNNEL
IPv4 Forwarding Table
IP Prefix Gateway IP Type UUID Gateway MAC
142.134.61.0/24 route 34ca595f-fa62-5ed4-afcc-a6ef0195d4ed
142.134.61.36/32 route f322c6ca-4298-568b-81c7-a006ba6e6c88
or
nsx-edge-1> get logical-router 736a80e3-23f6-5a2d-81d6-bbefb2786666 forwarding 142.134.61.0/24
Logical Router
UUID VRF LR-ID Name Type
736a80e3-23f6-5a2d-81d6-bbefb2786666 0 0 R1 TUNNEL
IPv4 Forwarding Table
IP Prefix Gateway IP Type UUID Gateway MAC
142.134.61.0/24 route 34ca595f-fa62-5ed4-afcc-a6ef0195d4ed
Mode
Basic
Availability
Autonomous Edge, Edge
Display all the multicast learnt routes.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
Example
nsxedge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be mroute 235.1.2.3
IP Multicast Routing Table
Flags: S- Sparse, C - Connected, P - Pruned
R - RP-bit set, F - Register flag, T - SPT-bit set
Source Group Flags Proto Input Output TTL Uptime
* 235.1.2.3 SC IGMP uplink-280 pimreg 1 00:11:24
IGMP downlink-272 1 00:11:24
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <prefix> | Prefix or IP address with optional prefix length |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be route 22.3.3.0/24
Flags: t0c - Tier0-Connected, t0s - Tier0-Static, b - BGP,
t0n - Tier0-NAT, t1s - Tier1-Static, t1c - Tier1-Connected,
t1n: Tier1-NAT, t1l: Tier1-LB VIP, t1ls: Tier1-LB SNAT,
t1d: Tier1-DNS FORWARDER, > - selected route, * - FIB route
Total number of routes: 1
t0s> * 22.3.3.0/24 [103/0] via 50.50.50.10, uplink-273, 00:52:33
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <prefix> | IPv6 Prefix or IPv6 address with optional prefix length |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be route 2002::/64
Flags: t0c - Tier0-Connected, t0s - Tier0-Static, b - BGP,
t0n - Tier0-NAT, t1s - Tier1-Static, t1c - Tier1-Connected,
t1n: Tier1-NAT, t1l: Tier1-LB VIP, t1ls: Tier1-LB SNAT,
t1d: Tier1-DNS FORWARDER, > - selected route, * - FIB route
Total number of routes: 1
t1c> * 2002::/64 [3/0] via fca9:1c1c:96b2:e000::2, downlink-282, 00:56:03
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPv4 BGP routes for a specified prefix in RIB.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <prefix> | Network Address argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be route bgp 2.1.0.0/16
Flags: t0c - Tier0-Connected, t0s - Tier0-Static, b - BGP,
t0n - Tier0-NAT, t1s - Tier1-Static, t1c - Tier1-Connected,
t1n: Tier1-NAT, t1l: Tier1-LB VIP, t1ls: Tier1-LB SNAT,
t1d: Tier1-DNS FORWARDER, > - selected route, * - FIB route
Total number of routes: 2
b > * 2.1.4.0/24 [20/0] via 40.40.40.10, uplink-276, 21:12:29
b > * 2.1.5.0/24 [20/0] via 90.90.90.10, uplink-282, 21:12:10
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPv4 Connected routes for a specified prefix in RIB.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <prefix> | Network Address argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be route connected 1.0.0.0/8
Flags: t0c - Tier0-Connected, t0s - Tier0-Static, b - BGP,
t0n - Tier0-NAT, t1s - Tier1-Static, t1c - Tier1-Connected,
t1n: Tier1-NAT, t1l: Tier1-LB VIP, t1ls: Tier1-LB SNAT,
t1d: Tier1-DNS FORWARDER, > - selected route, * - FIB route
Total number of routes: 2
t0c> * 1.1.3.0/24 is directly connected, downlink-294, 21:17:14
t0c> * 1.2.3.0/24 is directly connected, downlink-297, 21:17:04
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPv4 OSPF routes for a specified prefix in RIB.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <prefix> | Network Address argument |
Example
Edge-1> get logical-router 43d96cff-989e-4ff9-98d6-107e816146cd route ospf 30.30.30.0/24
Flags: t0c - Tier0-Connected, t0s - Tier0-Static, b - BGP, o - OSPF
t0n - Tier0-NAT, t1s - Tier1-Static, t1c - Tier1-Connected,
t1n: Tier1-NAT, t1l: Tier1-LB VIP, t1ls: Tier1-LB SNAT,
t1d: Tier1-DNS FORWARDER, t1ipsec: Tier1-IPSec, isr: Inter-SR,
> - selected route, * - FIB route
Total number of routes: 1
o > * 30.30.30.0/24 [110/20] via 40.40.40.10, uplink-292, 00:03:20
Mode
Basic
Availability
Autonomous Edge, Edge
Display IPv4 Static routes for a specified prefix in RIB.
get logical-router command
also displays Tier 0 NAT, Tier 1 NAT, Tier 1 connected,
Load balancer routes along with Tier 0 & Tier 1 static routes
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <prefix> | Network Address argument |
Example
nsx-edge-1> get logical-router 3a57c438-7ee9-4ba2-92ef-6f758931e1be route static 1.1.0.0/16
Flags: t0c - Tier0-Connected, t0s - Tier0-Static, b - BGP,
t0n - Tier0-NAT, t1s - Tier1-Static, t1c - Tier1-Connected,
t1n: Tier1-NAT, t1l: Tier1-LB VIP, t1ls: Tier1-LB SNAT,
t1d: Tier1-DNS FORWARDER, > - selected route, * - FIB route
Total number of routes: 2
t1c> * 1.1.2.0/24 [3/0] via 100.64.1.1, downlink-298, 21:10:43
t1c> * 1.1.1.0/25 [3/0] via 100.64.1.1, downlink-298, 21:10:43
Mode
Basic
Availability
Autonomous Edge, Edge
Display the multicast HA role. Active - Multicast is running in Active mode. Standby - Multicast is running in Standby mode. None - Multicast is not running.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router 3a59c438-7ea9-4fa2-82ef-6f778911e1be mcast high-availability role
Codes : Active - This node is active w.r.t multicast
Standby - This node is standby w.r.t multicast
Standby node participates in multicast forwarding when LR is Active-Active
Standby node does not participate in multicast forwarding when LR is Active-Standby
Other - This node participates in multicast forwarding only
N/A - This node is not participating in multicast
Multicast High Availability : Standby
Mode
Basic
Availability
Autonomous Edge, Edge
Display all VRF VNI information.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
EVPN-M0-EDGE-ONE> get logical-router cde323b5-e8e0-44d7-bd11-da76822ffd30 vrf vni
VRF VNI VxLAN IF L3-SVI State Rmac
vrf-2 100000 vxlan-100000 kni-275 Up 02:50:56:56:54:00
Mode
Basic
Availability
Edge
Display interface information for the specified logical router.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router interface 34ca595f-fa62-5ed4-afcc-a6ef0195d4ed
interface : 34ca595f-fa62-5ed4-afcc-a6ef0195d4ed
ifuid : 261
VRF : 736a80e3-23f6-5a2d-81d6-bbefb2786666
mode : lif
IP/Mask : 142.134.61.36/24
MAC : 00:0c:29:5a:96:2b
VLAN id : untagged
LS port : 238d7422-e488-5cee-9639-1894b8ab56e2
urpf-mode : NONE
admin : up
op_state : up
MTU : 1600
arp_proxy : 40.40.10.60, 40.40.10.50, 40.40.10.55
: 40.40.10.100, 40.40.10.110
Mode
Basic
Availability
Autonomous Edge, Edge
Display ARP proxy for a logical router port.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router interface 1faf61ce-9da1-4aad-a8c6-80abd02c7e33 arp-proxy
interface : 1faf61ce-9da1-4aad-a8c6-80abd02c7e33
ifuid : 274
VRF : be3543f5-7b8c-4888-b9ef-5a5ffbf09686
name : UPLINK_PLR_SR1
mode : lif
MAC : 02:00:29:10:43:07
admin : up
op_state : up
arp_proxy : 40.40.10.60, 40.40.10.50, 40.40.10.55
: 40.40.10.100, 40.40.10.110
Mode
Basic
Availability
Autonomous Edge, Edge
Display interface-group info for logical router port
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router interface e13dbba8-542e-11e9-a177-020021d58d1d interface-groups high-availability
Group UUID : 4e425c9e-09c6-4021-bbc7-fab2895a2c09
Port UUID : e13dbba8-542e-11e9-a177-020021d58d1d
Members
SR UUID : e0e7c638-aa8c-4354-b8a9-0aa0fbbfdb05
Port UUID : e13dbba8-542e-11e9-a177-020021d58d1d
Port MAC : 02:50:56:56:00:02
State : Active
SR UUID : 44e3ee5f-36ea-4703-80ad-0e6b50af552a
Port UUID : c23bc228-f5ec-4ad4-b596-fc0dcccd6922
Port MAC : 02:50:56:56:00:03
State : Active
SR UUID : 79ac0bb6-6ddb-45be-82bd-baf83fdfc788
Port UUID : 628f3976-472a-4543-906c-b6b07c4ffb74
Port MAC : 02:50:56:56:00:04
State : Down
Mode
Basic
Availability
Autonomous Edge, Edge
Display the neighbor table for the specified logical router interface.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router interface 3c139373-f8f7-441e-aac4-146d9b5ff3a6 neighbor
interface : 3c139373-f8f7-441e-aac4-146d9b5ff3a6
IP : 172.16.110.12
MAC : 00:0c:29:4d:09:19
state : perm
interface : 3c139373-f8f7-441e-aac4-146d9b5ff3a6
IP : 172.16.110.11
MAC : 00:50:56:8e:91:12
state : perm
Mode
Basic
Availability
Autonomous Edge, Edge
Display shadow port mac list for lrouter port
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router interface 5b5aa5f4-9408-4963-a913-705254359134 shadow-macs
Logical Router Interface
UUID : 5b5aa5f4-9408-4963-a913-705254359134
Shadow MACs:
02:50:56:56:00:01
02:50:56:56:00:03
02:50:56:56:00:06
02:50:56:56:00:08
Mode
Basic
Availability
Autonomous Edge, Edge
Get the shadow port MAC address selected for specific IP address
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get logical-router interface 5b5aa5f4-9408-4963-a913-705254359134 shadow-macs ip 40.40.40.10
Logical Router Interface
UUID : 5b5aa5f4-9408-4963-a913-705254359134
Shadow MACs:
02:50:56:56:00:01
02:50:56:56:00:03
02:50:56:56:00:06
02:50:56:56:00:08
Selected MAC: 02:50:56:56:00:03
Mode
Basic
Availability
Autonomous Edge, Edge
Get the shadow port MAC address selected for specific source and destination IP addresses
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get logical-router interface 5b5aa5f4-9408-4963-a913-705254359134 shadow-macs source-ip 40.40.40.10 dest-ip 30.30.30.10
Logical Router Interface
UUID : 5b5aa5f4-9408-4963-a913-705254359134
Shadow MACs:
02:50:56:56:00:01
02:50:56:56:00:03
02:50:56:56:00:06
02:50:56:56:00:08
Selected MAC: 02:50:56:56:00:03
Mode
Basic
Availability
Autonomous Edge, Edge
Display statistics for the specified logical router interface.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-router interface 6c427841-e151-4479-9184-4196cfcef3b6 stats
interface : 6c427841-e151-4479-9184-4196cfcef3b6
ifuid : 266
VRF : e9d3379d-aba7-4459-9262-18bc95eaeec1
IP/Mask : 172.20.1.60/24
MAC : 00:0c:29:5a:96:2b
VLAN id : 101
LS port : 986ab7c0-acda-465f-8cda-1b9b84cd2518
urpf-mode : STRICT_MODE
admin : up
op_state : up
MTU : 1600
statistics
RX-Packets : 1331
RX-Bytes : 455202
RX-Drops : 1331
Blocked : 0
DST-Unsupported: 1331
Firewall : 0
Malformed : 0
No-Receiver : 0
No-Route : 0
RPF-Check : 0
Protocol-Unsupported: 0
IPv6 : 0
Port-Unsupported: 0
TTL-Exceeded: 0
Kni : 0
Rate-Limit : 0
IPsec : 0
IPsec-NoSA : 0
IPsec-NoVTI : 0
TX-Packets : 11
TX-Bytes : 462
TX-Drops : 0
Blocked : 0
Firewall : 0
Frag-Needed : 0
No-ARP : 0
No-Memory : 0
No-Linked-Port: 0
Rate-Limit : 0
IPsec : 0
IPsec-NoSA : 0
IPsec-NoVTI : 0
IPsec-Policy-Error: 0
IPsec-Policy-Block: 0
IP Ressemble
Fragments-OK: 0
Fragemnts-Error: 0
Fragments-Timeout: 0
IP Fragment
Fragments-OK: 0
Fragments-Error: 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display information for all logical router interfaces.
Example
nsx-edge-1> get logical-router interfaces
interface : 9fd3c667-32db-5921-aaad-7a88c80b5e9f
ifuid : 258
VRF : 736a80e3-23f6-5a2d-81d6-bbefb2786666
mode : blackhole
interface : 34ca595f-fa62-5ed4-afcc-a6ef0195d4ed
ifuid : 261
VRF : 736a80e3-23f6-5a2d-81d6-bbefb2786666
mode : lif
IP/Mask : 142.134.61.36/24
MAC : 00:0c:29:5a:96:2b
VLAN id : untagged
LS port : 238d7422-e488-5cee-9639-1894b8ab56e2
urpf-mode : NONE
admin : up
op_state : up
MTU : 1600
arp_proxy : 40.40.10.60, 40.40.10.50, 40.40.10.55
: 40.40.10.100, 40.40.10.110
interface : f322c6ca-4298-568b-81c7-a006ba6e6c88
ifuid : 257
VRF : 736a80e3-23f6-5a2d-81d6-bbefb2786666
mode : cpu
interface : b83cb77f-ca34-595c-a3e1-76278f0dcb00
ifuid : 265
VRF : e9d3379d-aba7-4459-9262-18bc95eaeec1
mode : blackhole
interface : 4b115e5f-1395-54c3-aaf0-0de5736f99df
ifuid : 264
VRF : e9d3379d-aba7-4459-9262-18bc95eaeec1
mode : cpu
interface : 6c427841-e151-4479-9184-4196cfcef3b6
ifuid : 266
VRF : e9d3379d-aba7-4459-9262-18bc95eaeec1
mode : lif
IP/Mask : 172.20.1.60/24
MAC : 00:0c:29:5a:96:2b
VLAN id : 101
LS port : 986ab7c0-acda-465f-8cda-1b9b84cd2518
urpf-mode : STRICT_MODE
admin : up
op_state : up
MTU : 1600
arp_proxy : 40.40.10.60, 40.40.10.50, 40.40.10.55
: 40.40.10.100, 40.40.10.110
Mode
Basic
Availability
Autonomous Edge, Edge
Display statistics for all logical router interfaces.
Example
nsx-edge-1> get logical-router interfaces stats
interface : 34ca595f-fa62-5ed4-afcc-a6ef0195d4ed
ifuid : 261
VRF : 736a80e3-23f6-5a2d-81d6-bbefb2786666
IP/Mask : 142.134.61.36/24
MAC : 00:0c:29:5a:96:2b
VLAN id : untagged
LS port : 238d7422-e488-5cee-9639-1894b8ab56e2
urpf-mode : NONE
admin : up
op_state : up
MTU : 1600
statistics
RX-Packets : 768
RX-Bytes : 53788
RX-Drops : 210
Blocked : 0
DST-Unsupported: 21
Firewall : 0
Malformed : 0
No-Receiver : 0
No-Route : 0
RPF-Check : 0
Protocol-Unsupported: 101
IPv6 : 87
Port-Unsupported: 0
TTL-Exceeded: 0
Kni : 0
Rate-Limit : 0
IPsec : 0
IPsec-NoSA : 0
IPsec-NoVTI : 0
TX-Packets : 11
TX-Bytes : 462
TX-Drops : 0
Blocked : 0
Firewall : 0
Frag-Needed : 0
No-ARP : 0
No-Memory : 0
No-Linked-Port: 0
Rate-Limit : 0
IPsec : 0
IPsec-NoSA : 0
IPsec-NoVTI : 0
IPsec-Policy-Error: 0
IPsec-Policy-Block: 0
IP Ressemble
Fragments-OK: 0
Fragemnts-Error: 0
Fragments-Timeout: 0
IP Fragment
Fragments-OK: 0
Fragments-Error: 0
interface : 6c427841-e151-4479-9184-4196cfcef3b6
ifuid : 266
VRF : e9d3379d-aba7-4459-9262-18bc95eaeec1
IP/Mask : 172.20.1.60/24
MAC : 00:0c:29:5a:96:2b
VLAN id : 101
LS port : 986ab7c0-acda-465f-8cda-1b9b84cd2518
urpf-mode : STRICT_MODE
admin : up
op_state : up
MTU : 1600
statistics
RX-Packets : 1313
RX-Bytes : 449046
RX-Drops : 1313
Blocked : 0
DST-Unsupported: 1313
Firewall : 0
Malformed : 0
No-Receiver : 0
No-Route : 0
RPF-Check : 0
Protocol-Unsupported: 0
IPv6 : 0
Port-Unsupported: 0
TTL-Exceeded: 0
Kni : 0
IPsec : 0
IPsec-NoSA : 0
IPsec-NoVTI : 0
TX-Packets : 11
TX-Bytes : 462
TX-Drops : 0
Blocked : 0
Firewall : 0
Frag-Needed : 0
No-ARP : 0
No-Memory : 0
No-Linked-Port: 0
IPsec : 0
IPsec-NoSA : 0
IPsec-NoVTI : 0
IPsec-Policy-Error: 0
IPsec-Policy-Block: 0
IP Ressemble
Fragments-OK: 0
Fragemnts-Error: 0
Fragments-Timeout: 0
IP Fragment
Fragments-OK: 0
Fragments-Error: 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display the neighbor table for all logical router interfaces.
Example
nsx-edge-1> get logical-router neighbor
interface : 8d655fb8-fc5e-5c08-90f5-15de973a9c77
IP : 192.168.250.61
MAC : 00:50:56:62:58:be
state : reach
timeout : 287
interface : 4b3be9e1-1363-4a85-ac13-8f7ad5b1e842
IP : 192.168.130.1
MAC : 68:ef:bd:4e:98:7f
state : reach
timeout : 309
interface : ef76622f-52ea-425f-b7c9-6264bf11b667
IP : 169.0.0.2
MAC : 02:50:56:00:00:02
state : reach
timeout : 425
interface : c66fc321-df74-4aaa-835e-95dc815fe7ae
IP : 172.16.130.13
MAC : 00:50:56:8e:3e:0b
state : perm
interface : f6ef3b50-64a0-4948-ab9e-9135963d4b8b
IP : 169.0.0.2
MAC : 02:50:56:00:00:05
state : reach
timeout : 397
.
.
.
Mode
Basic
Availability
Autonomous Edge, Edge
Display specific IPv4 routes from all the logical routers.
| Option | Description |
|---|---|
| <prefix> | Network Address argument |
Example
nsx-controller-1> get logical-router routes 172.16.120.0/24
LR-Id Destination Next-Hop LR-Port-Id Blackhole Route-Type Admin-Distance Admin-State-Up Route-UUID
0x5 172.16.120.0/24 169.0.0.1 8b06827f-6325-4afd-b56d-6260ebf0a1a0 false NSX_CONNECTED 0 true 00000018-ac10-7800-0000-000000000005
Mode
Basic
Availability
Manager
Display information about the specified proximity routing policy table.
| Option | Description |
|---|---|
| <policy-table-id> | Proximity routing policy table identifier UUID or ID |
Example
esx-1> get logical-router-policy-table 2
Proximity Routing Policy Table
------------------------------------------------------------------------------------------
Flags Legend: [F: Soft Flush]
Network Action Type Hit Count
==========================================================================================
192.168.150.0/24 allow 0
192.168.151.0/24 deny 0
Mode
Basic
Availability
ESXi
Display information about proximity routing policy tables on this hypervisor host.
Example
esx-1> get logical-router-policy-tables
Proximity Routing Policy Tables Summary
---------------------------------------------------------------------------
Table UUID Table ID Reference Count
ea652563-8c90-4354-99b8-38ccf96d3622 4 0
2dd5ea46-6e19-4d38-8be8-e4ec63fa62af 2 0
Mode
Basic
Availability
ESXi
Display information about the specified logical router port.
| Option | Description |
|---|---|
| <interface-id> | Logical Router interface id Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-router-port e81817b4-d7d3-41c4-96fb-47081d6ee20c
Interface IP Urpf-Mode Admin-State-Up UUID Router/Cluster-UUID Mac Mtu DHCP-Server-IP
infra-InfraSegment101-dlrp 192.168.1.1/24 URPF_MODE_STRICT_MODE true e81817b4-d7d3-41c4-96fb-47081d6ee20c f3e83620-ce38-4570-bedf-171ff65f1d90 02:50:56:56:44:52
Mode
Basic
Availability
Manager
Display information about all logical routers.
Example
nsx-edge-1> get logical-routers
Logical Router
UUID VRF LR-ID Name Type Ports Neighbors
736a80e3-23f6-5a2d-81d6-bbefb2786666 0 0 R1 TUNNEL 3 4/50000
e9d3379d-aba7-4459-9262-18bc95eaeec1 1 1 R2 SERVICE_ROUTER_TIER0 5 5/50000
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about all logical routers.
Example
nsx-controller-1> get logical-routers
LR-Id LR-Name Hosts[] Service-Controller Router-Type ClusterId UUID
0x5 SR-46740ffe-9bf1-406e-816d-e200a45f0707 192.168.110.111 192.168.110.108 SERVICE_ROUTER_TIER1 00002000-0000-0000-0000-000000000001 db6760b3-d9e2-44ef-b1c4-f56138665d71
192.168.110.112
0x2 DR-ef64d966-56f0-4f3f-bb02-16d07de74b5c 192.168.110.111 192.168.110.108 DISTRIBUTED_ROUTER N/A ef64d966-56f0-4f3f-bb02-16d07de74b5c
192.168.110.112
0x1 DR-46740ffe-9bf1-406e-816d-e200a45f0707 192.168.110.111 192.168.110.108 DISTRIBUTED_ROUTER N/A 46740ffe-9bf1-406e-816d-e200a45f0707
192.168.210.52
192.168.110.112
192.168.210.51
0x3 SR-ef64d966-56f0-4f3f-bb02-16d07de74b5c 192.168.110.111 192.168.110.108 SERVICE_ROUTER_TIER0 00002000-0000-0000-0000-000000000002 19772688-b220-4a34-94a3-8a094dcdd979
0x4 SR-ef64d966-56f0-4f3f-bb02-16d07de74b5c 192.168.110.112 192.168.110.108 SERVICE_ROUTER_TIER0 00002000-0000-0000-0000-000000000002 2d1667ba-ed4a-49d0-8a1d-cd8a77c324bc
Mode
Basic
Availability
Manager
Display information about logical routers on this hypervisor host.
Example
kvm-1> get logical-routers
Logical Routers Summary
==============================================================================================================
Router UUID ID Port Count Max Neighbors Current Neighbors
b8aba183-8776-42d8-8ec5-4eccf1ebbbd2 1 2 50000 1
or
esx-1> get logical-routers
Logical Routers Summary
-----------------------------------------------------------------------------------------------------------------
VDR UUID LIF num IPv4 Route num IPv6 Route num Max Neighbors Current Neighbors
d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 4 7 5 25000 15
Mode
Basic
Availability
ESXi, KVM
Display information about logical routers asscociated with the VIF on this public cloud host.
Example
host-1> get logical-routers
Host Logical Routers Summary
======================================================================
Router UUID ID Port Count
091a05dc-8080-41a2-a56f-baf6d32fb512 32769 1
Mode
Basic
Availability
NSX Cloud VM
Display statistics for all logical routers.
Example
nsx-edge-1> get logical-router stats
Logical Router
UUID : 736a80e3-23f6-5a2d-81d6-bbefb2786666
VRF : 0
LR-ID : 0
name : R1
type : TUNNEL
Statistics
Dropped No Memory : 0
Dropped No Route : 0
Logical Router
UUID : e9d3379d-aba7-4459-9262-18bc95eaeec1
VRF : 1
LR-ID : 1
name : R2
type : SERVICE_ROUTER_TIER0
Statistics
Dropped No Memory : 0
Dropped No Route : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display a specific logical service binding.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get logical-service binding 8bc04d52-b1f9-4258-8d13-b8fdbf031a0d
DHCP_ID: 8bc04d52-b1f9-4258-8d13-b8fdbf031a0d
ID: 8bc04d52-b1f9-4258-8d13-b8fdbf031a0d
LOG_SWITCH_PORT_ID: 60905155-4378-4902-8528-7231a2f6d736
SERVICE_TYPE: DHCP
Mode
Basic
Availability
Autonomous Edge, Edge
Display all logical service bindings.
Example
nsx-edge-1> get logical-service bindings
DHCP_ID: 8bc04d52-b1f9-4258-8d13-b8fdbf031a0d
ID: 8bc04d52-b1f9-4258-8d13-b8fdbf031a0d
LOG_SWITCH_PORT_ID: 60905155-4378-4902-8528-7231a2f6d736
SERVICE_TYPE: DHCP
Mode
Basic
Availability
Autonomous Edge, Edge
Display information for the specified logical service port. Optionally specify an argument to display the statistics.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-service port b836eacf-3d1c-5fc9-ab18-19dc0015a57e
lservice-port: b836eacf-3d1c-5fc9-ab18-19dc0015a57e
ifuid : 262
service-type: dhcp
IP : 192.168.110.50
MAC : 00:50:56:98:7d:d7
attach-port : 60905155-4378-4902-8528-7231a2f6d736
nsx-edge-1> get logical-service port b836eacf-3d1c-5fc9-ab18-19dc0015a57e stats
lservice-port: b836eacf-3d1c-5fc9-ab18-19dc0015a57e
ifuid : 262
service-type: dhcp
Statistics
RX-Packets : 16
RX-Bytes : 1080
RX-Drops : 0
Slowpath : 0
Kni : 0
Malformed : 0
No-DHCP-Server: 0
No-Match : 0
TX-Packets : 10
TX-Bytes : 420
TX-Drops : 0
No-Memory : 0
No-Linked-Port: 0
nsx-edge-1> get logical-service port 80e93dd3-0eab-5f8a-96c5-80846c3711b5 stats
lservice-port: 80e93dd3-0eab-5f8a-96c5-80846c3711b5
ifuid : 276
service-type: mdproxy
status : UP
listen_status: UP
monitor_status: UP
err_msg :
Statistics
requests_from_clients : 5
requests_to_nova_server : 5
responses_to_clients : 5
succeeded_responses_from_nova_server: 4
error_responses_from_nova_server: 1
RX-Packets : 0
RX-Bytes : 0
RX-Drops : 0
Slowpath : 0
Kni : 0
Malformed : 0
No-DHCP-Server: 0
No-Match : 0
TX-Packets : 10
TX-Bytes : 420
TX-Drops : 0
No-Memory : 0
No-Linked-Port: 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display information for all logical service ports. Optionally specify an argument to display the statistics.
Example
nsx-edge-1> get logical-service ports
lservice-port: b836eacf-3d1c-5fc9-ab18-19dc0015a57e
ifuid : 262
service-type: dhcp
IP : 192.168.110.50
MAC : 00:50:56:98:7d:d7
attach-port : 60905155-4378-4902-8528-7231a2f6d736
nsx-edge-1> get logical-service ports stats
lservice-port: b836eacf-3d1c-5fc9-ab18-19dc0015a57e
ifuid : 262
service-type: dhcp
Statistics
RX-Packets : 16
RX-Bytes : 1080
RX-Drops : 0
Slowpath : 0
Kni : 0
Malformed : 0
No-DHCP-Server: 0
No-Match : 0
TX-Packets : 10
TX-Bytes : 420
TX-Drops : 0
No-Memory : 0
No-Linked-Port: 0
lservice-port: 80e93dd3-0eab-5f8a-96c5-80846c3711b5
ifuid : 276
service-type: mdproxy
status : ERROR
listen_status: UP
monitor_status: ERROR
err_msg : backend nova server connection is broken with reason: Connect to Peer Failure;
Statistics
requests_from_clients : 5
requests_to_nova_server : 5
responses_to_clients : 5
succeeded_responses_from_nova_server: 4
error_responses_from_nova_server: 1
RX-Packets : 0
RX-Bytes : 0
RX-Drops : 0
Slowpath : 0
Kni : 0
Malformed : 0
No-DHCP-Server: 0
No-Match : 0
TX-Packets : 10
TX-Bytes : 420
TX-Drops : 0
No-Memory : 0
No-Linked-Port: 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display the state of a specific logical service.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get logical-service state 8bc04d52-b1f9-4258-8d13-b8fdbf031a0d
ID: 8bc04d52-b1f9-4258-8d13-b8fdbf031a0d
NODE_ID: 3284f707-98f9-4e7c-b573-f7898dfa12ba
NODE_RANK: 0
PEER_MGMT_IP:
IPV4: 192.168.110.101
STATE: ACTIVE
Mode
Basic
Availability
Autonomous Edge, Edge
Display the state of all logical services.
Example
nsx-edge-1> get logical-service states
ID: 8bc04d52-b1f9-4258-8d13-b8fdbf031a0d
NODE_ID: 3284f707-98f9-4e7c-b573-f7898dfa12ba
NODE_RANK: 0
PEER_MGMT_IP:
IPV4: 192.168.110.101
STATE: ACTIVE
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about the specified logical switch.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-switch 857212c6-3d87-4a4a-9700-0c9d23f74f1c
Logical Switch
UUID : 857212c6-3d87-4a4a-9700-0c9d23f74f1c
Name : LS1-0681-LS
VNI : 5000
ENCAP : GENEVE
Replication : mtep
routing-domain: 00000007-0000-0000-0000-000000000000
Mode
Basic
Availability
Autonomous Edge, Edge
Display the l2forwarder for the specified logical switch.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-switch 78e32f70-074d-41e7-973e-612e919a7c00 l2forwarders
Logical Switch
UUID : 78e32f70-074d-41e7-973e-612e919a7c00
VNI : 69634
Global VNI : 1930436
L2Forwarder State : up
TCN notification : non-active
Mode
Basic
Availability
Autonomous Edge, Edge
Display the mac address table for the specified logical switch.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-switch 857212c6-3d87-4a4a-9700-0c9d23f74f1c mac-address-table
Logical Switch
UUID : 857212c6-3d87-4a4a-9700-0c9d23f74f1c
VNI : 5000
ENCAP : GENEVE
Replication : mtep
routing-domain: 00000007-0000-0000-0000-000000000000
MAC-Table:
MAC : 00:50:56:8e:9a:a5
Tunnel : d87cd7e0-eb91-5dd5-bae4-ceb0a2760bfa
IFUID : 295
LOCAL : 192.168.250.162
REMOTE : 192.168.250.160
ENCAP : GENEVE
SOURCE : Static
MAC : 02:50:56:56:44:52
Port : bbe56ae2-0bc1-46c0-b334-a241e2a56193
IFUID : 280
SOURCE : Static
MAC : 00:50:56:8e:1b:21
Tunnel : 6598ab27-95c6-50ef-85b3-89b7811ab672
IFUID : 296
LOCAL : 192.168.250.162
REMOTE : 192.168.250.161
ENCAP : GENEVE
SOURCE : Static
MAC : 04:00:c0:a8:fa:a2
Port : bbe56ae2-0bc1-46c0-b334-a241e2a56193
IFUID : 280
SOURCE : Dynamic
Mode
Basic
Availability
Autonomous Edge, Edge
Display mcast offload tunnel.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
| <multicast-ip-address> | Multicast IP address argument |
Example
nsx-edge-1> get logical-switch cef3cc88-2f54-4042-9265-5a74f28347e7 mcast-offload-tunnel source 10.10.10.10 group 237.1.1.1
Tunnel : 33e477c1-404c-507f-a99e-ceba46271972
IFUID : 399
LOCAL : 111.10.10.27
REMOTE : 110.10.10.20
ENCAP : GENEVE
Mode
Basic
Availability
Autonomous Edge, Edge
Display the ARP/NDP table for the specified logical switch.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-switch 857212c6-3d87-4a4a-9700-0c9d23f74f1c neighbor
Logical Switch
UUID : 00000004-0000-0000-0000-000000000000
VNI : 1
ENCAP : GENEVE
Replication : source
Enable Hub : True
Neighbor
IP : 11.1.1.1
MAC : c2:81:09:00:00:11
IP : 11:1:1::1
MAC : c2:81:09:00:00:11
IP : fe80::c081:9ff:fe00:11
MAC : c2:81:09:00:00:11
Mode
Basic
Availability
Autonomous Edge, Edge
Display port information for the specified logical switch.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-switch 857212c6-3d87-4a4a-9700-0c9d23f74f1c ports
Logical Switch
UUID : 857212c6-3d87-4a4a-9700-0c9d23f74f1c
VNI : 5000
ENCAP : GENEVE
Replication : mtep
routing-domain: 00000007-0000-0000-0000-000000000000
Ports
Port : bbe56ae2-0bc1-46c0-b334-a241e2a56193
IFUID : 280
Peer : 70b21c84-cf3b-4fc3-a442-a941ba86ef48
Mode
Basic
Availability
Autonomous Edge, Edge
Display port statistics for the specified logical switch.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-switch 973b00a2-3be8-4e01-9824-3c6b7e2bf690 ports stats
Logical Switch
UUID : 973b00a2-3be8-4e01-9824-3c6b7e2bf690
VLAN : 100
Device : fp-eth0
IFUID : 0
Ports
Port : 783a05cd-033d-4891-ad11-7c082641e069
RX-Packets : 8690
RX-Bytes : 587073
RX-Drops : 0
Malformed : 0
No-Match : 0
L2-Loop : 0
TX-Packets : 10188
TX-Bytes : 687181
TX-Drops : 0
No-Memory : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display remote rtep-group mac addresses for a logical switch.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-switch 8a036869-fd67-41f8-89de-85f2675d68c3 rtep-group-mac-address-table
Remote MAC-Table
MAC : 00:0c:29:ba:4c:f5
RTEP Group ID : 5281216
Mode
Basic
Availability
Autonomous Edge, Edge
Display remote rtep-group mac addresses.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <rtep-group-id> | RTEP Group ID |
Example
nsx-edge-1> get logical-switch 8a036869-fd67-41f8-89de-85f2675d68c3 rtep-group-mac-address-table 5281216
Remote MAC-Table
MAC : 00:0c:29:ba:4c:f5
RTEP Group ID : 5281216
Mode
Basic
Availability
Autonomous Edge, Edge
Display remote rtep-groups for a logical switch
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-switch 8a036869-fd67-41f8-89de-85f2675d68c3 rtep-groups
Logical Switch
UUID : 8a036869-fd67-41f8-89de-85f2675d68c3
Local RTEP Group
RTEP Group ID : 3643676
Members
Member IP : 172.20.10.11
Remote RTEP Groups
RTEP Group ID : 5740828
Members
Member IP : 172.20.10.20
Member State : active
Member IP : 172.20.10.21
Member State : down
Mode
Basic
Availability
Autonomous Edge, Edge
Display the tunnel information for the specified logical switch.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-switch 857212c6-3d87-4a4a-9700-0c9d23f74f1c tunnel-ports
Logical Switch
UUID : 857212c6-3d87-4a4a-9700-0c9d23f74f1c
VNI : 5000
ENCAP : GENEVE
Replication : mtep
routing-domain: 00000007-0000-0000-0000-000000000000
Tunnels
Tunnel : d87cd7e0-eb91-5dd5-bae4-ceb0a2760bfa
IFUID : 295
LOCAL : 192.168.250.162
REMOTE : 192.168.250.160
ENCAP : GENEVE
Tunnel : 6598ab27-95c6-50ef-85b3-89b7811ab672
IFUID : 296
LOCAL : 192.168.250.162
REMOTE : 192.168.250.161
ENCAP : GENEVE
Mode
Basic
Availability
Autonomous Edge, Edge
Display the tunnel endpoint table for the specified logical switch.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-switch 857212c6-3d87-4a4a-9700-0c9d23f74f1c vtep-table
Logical Switch
UUID : 857212c6-3d87-4a4a-9700-0c9d23f74f1c
VNI : 5000
ENCAP : GENEVE
Replication : mtep
routing-domain: 00000007-0000-0000-0000-000000000000
Replication Tunnels
Tunnel : d87cd7e0-eb91-5dd5-bae4-ceb0a2760bfa
IFUID : 295
LOCAL : 192.168.250.162
REMOTE : 192.168.250.160
ENCAP : GENEVE
TYPE : VTEP
MTEP : False
Tunnel : 6598ab27-95c6-50ef-85b3-89b7811ab672
IFUID : 296
LOCAL : 172.20.10.10
REMOTE : 172.20.10.20
ENCAP : GENEVE
TYPE : RTEP
MTEP : False
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about the specified logical switch.
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
Example
kvm-1> get logical-switch 0a8cb2ab-d15b-4b46-a6ee-0a1cd29be34d
Logical Switch
=======================================================
UUID : 0a8cb2ab-d15b-4b46-a6ee-0a1cd29be34d
VNI/VLAN : 31624
Is VLAN backed : True
Replication mode: mtep
Controller IP : 192.168.110.51
Link status : Up
VIF count : 1
MAC entry count : 0
TEP entry count : 4
ARP entry count : 0
Mode
Basic
Availability
KVM, NSX Cloud VM
Display the ARP table for the specified logical switch.
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
Example
kvm-1> get logical-switch 29576 arp-table
Logical Switch ARP Table
==================================================
IP MAC
10.144.13.29 00:01:02:03:42:11
Mode
Basic
Availability
KVM, NSX Cloud VM
Display the MAC table for the specified logical switch.
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
Example
kvm-1> get logical-switch 29576 mac-table
Logical Switch MAC Table
============================================================
MAC VTEP Label
00:01:02:00:00:03 124928
00:01:02:00:00:04 124928
Mode
Basic
Availability
KVM, NSX Cloud VM
Display ports on the specified logical switch.
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
Example
kvm-1> get logical-switch 0a8cb2ab-d15b-4b46-a6ee-0a1cd29be34d ports
Logical Switch Ports
============================================================
Port UUID : 59d3da36-d5f8-43d0-bca0-ae98c593861c
Status : up
VIF UUID : 57601300-2e82-48c4-8c27-1e961ac70e81
Snoop Mode : dhcp
============================================================
Mode
Basic
Availability
KVM, NSX Cloud VM
Display the VTEP table for the specified logical switch.
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
Example
kvm-1> get logical-switch 0a8cb2ab-d15b-4b46-a6ee-0a1cd29be34d vtep
Logical Switch VTEP Table
==============================
Label VTEP IP
114689 192.168.140.154
2049 192.168.140.153
102401 192.168.150.151
79873 192.168.150.152
Mode
Basic
Availability
KVM, NSX Cloud VM
Display information about the specified logical switch.
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get logical-switch bf543c67-3ffe-44dd-a1d3-57e7cd2e0aff
Logical Switch
-----------------------------------------------------------------
Host Kernel Entry
==================================================
DVS name : nsxvswitch
VNI : 11145
Multicast IP : 0.0.0.1
Multicast proxy enable : True
ARP proxy enable : True
VPC Subnet access mode : Public
CP connection up : True
Controller IP : 192.168.110.108
MAC entry count : 2
ARP entry count : 0
VIF entry count : 2
MTEP entry count : 0
Routing Domain : af2dddc6-80e5-449a-b582-f2f64b717080
Multicast Routing Domain : af2dddc6-80e5-449a-b582-f2f64b717080
LCP Entry
=================================================================
Logical switch UUID : bf543c67-3ffe-44dd-a1d3-57e7cd2e0aff
VNI : 11145
Replication mode : unicast mtep
Transport binding : None
Vlan ID : None
Admin state up : True
VPC Subnet access mode : Public
esx-1> get segment 7f386f4b-cbd5-42cc-81c9-95de3d34b29a
Logical Switch
-----------------------------------------------------------------
Segment UUID : 7f386f4b-cbd5-42cc-81c9-95de3d34b29a
VLAN ID : 4087
esx-1> get logical-switch e5e5ff09-99a9-4cc6-9a6f-349776472cb9
Logical Switch
-----------------------------------------------------------------
Logical switch UUID : e5e5ff09-99a9-4cc6-9a6f-349776472cb9
VLAN RANGES : 1050-1500, 1550-2000, 2050-2500, 2550-3000
Mode
Basic
Availability
ESXi
Display the ARP table for the specified logical switch.
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get logical-switch bf543c67-3ffe-44dd-a1d3-57e7cd2e0aff arp-table
Logical Switch ARP Table
--------------------------------------------------
Host Kernel Entry
==================================================
IP MAC Flags
LCP Entry
==================================================
IP MAC
172.16.110.11 00:50:56:8e:91:12
172.16.110.12 00:0c:29:4d:09:19
Mode
Basic
Availability
ESXi
Display all the counters for the specified logical switch.
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get logical-switch 66560 datapath-stats all
Datapath Observability All Counters
--------------------------------------------------
Module VDRB
==================================================
COUNTER NAME COUNTERS
vdr-leafIn1 300
vdr-leafIn2 400
vdr-leafInDrop1 500
vdr-leafInDrop2 600
Module VDL2
==================================================
COUNTER NAME COUNTERS
vdl2-leafIn1 300
vdl2-leafIn2 400
vdl2-leafInDrop1 500
vdl2-leafInDrop2 600
Mode
Basic
Availability
ESXi
Display all counters for the specified logical switch.
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get logical-switch 74752 datapath-stats all new
Datapath Observability New All Counters
--------------------------------------------------------------------------------------------------------------
Module : nsxt-vdl2
==============================================================================================================
COUNTER NAME COUNTERS RATE(pkts or bytes /sec) DURATION(HH:MM:SS)
leafRx 40 19.16 00:00:02.087919
leafTx 40 19.16 00:00:02.087919
uplinkRx 0 0.0 00:00:02.087920
uplinkRxSkipMACLearn 0 0.0 00:00:02.087920
uplinkRxMcastInvalidDRUplinkDrops 0 0.0 00:00:02.087920
uplinkTx 0 0.0 00:00:02.087920
uplinkTxIgnore 0 0.0 00:00:02.087920
.......
Mode
Basic
Availability
ESXi
Display all drop counters of all modules for the specified logical switch.
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get logical-switch 66560 datapath-stats drops
Datapath Observability Drop Counters
----------------------------------------------------------
Module VDRB
==========================================================
COUNTER NAME COUNTERS
vdr-leafInDrop1 300
vdr-leafInDrop2 400
Module VDL2
==========================================================
COUNTER NAME COUNTERS
vdl2-leafInDrop1 300
vdl2-leafInDrop2 400
Mode
Basic
Availability
ESXi
Display new drop counters of all modules for the specified logical switch.
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get logical-switch 74752 datapath-stats drops new
Datapath Observability New Drop Counters
--------------------------------------------------------------------------------------------------------------
Module : nsxt-vdl2
==============================================================================================================
COUNTER NAME COUNTERS RATE(pkts or bytes /sec) DURATION(HH:MM:SS)
leafTxDrops 0 0.0 00:00:35.966333
leafRxSystemErrDrops 0 0.0 00:00:35.966334
leafRxRefPortNotFoundDrops 0 0.0 00:00:35.966334
leafRxDrops 0 0.0 00:00:35.966334
uplinkRxWrongDestDrops 0 0.0 00:00:35.966334
uplinkRxGuestVlanDrops 0 0.0 00:00:35.966334
......
Mode
Basic
Availability
ESXi
Display all the counters for the specified logical switch and module.
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get logical-switch 66560 datapath-stats module nsx-vdl2 all
Datapath Observability All Counters
--------------------------------------------------
COUNTER NAME COUNTERS
vdl2-leafIn1 300
vdl2-leafIn2 400
vdl2-leafInDrop1 500
vdl2-leafInDrop2 600
Mode
Basic
Availability
ESXi
Display all new counters for the specified logical switch and module.
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get logical-switch 74752 datapath-stats module nsxt-vdl2 all new
Datapath Observability New All Counters
--------------------------------------------------------------------------------------------------------------
COUNTER NAME COUNTERS RATE(pkts or bytes /sec) DURATION(HH:MM:SS)
leafRx 2043 19.3 00:01:45.843856
leafTx 2044 19.31 00:01:45.843856
uplinkRx 0 0.0 00:01:45.843856
uplinkRxSkipMACLearn 0 0.0 00:01:45.843856
uplinkRxMcastInvalidDRUplinkDrops 0 0.0 00:01:45.843857
uplinkTx 0 0.0 00:01:45.843856
uplinkTxIgnore 0 0.0 00:01:45.843857
.......
Mode
Basic
Availability
ESXi
Display drop counters for the specified logical switch and module.
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get logical-switch 66560 datapath-stats module nsxt-vdrb drops
Datapath Observability Drop Counters
---------------------------------------------------------------------------
COUNTER NAME COUNTERS
leafInDrop1 250
leafInDrop2 134
Mode
Basic
Availability
ESXi
Display new drop counters for the specified logical switch and module.
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get logical-switch 74752 datapath-stats module nsxt-vdl2 drop new
Datapath Observability New Drop Counters
--------------------------------------------------------------------------------------------------------------
COUNTER NAME COUNTERS RATE(pkts or bytes /sec) DURATION(HH:MM:SS)
leafTxDrops 0 0.0 00:01:30.291375
leafRxSystemErrDrops 0 0.0 00:01:30.291375
leafRxRefPortNotFoundDrops 0 0.0 00:01:30.291375
leafRxDrops 0 0.0 00:01:30.291375
uplinkRxWrongDestDrops 0 0.0 00:01:30.291375
.......
Mode
Basic
Availability
ESXi
Display the HW VTEP table for the specified logical switch.
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get logical-switch bf543c67-3ffe-44dd-a1d3-57e7cd2e0aff hw-vtep-table
Logical Switch HW VTEP Table
-----------------------------------------------------------------------------------------------
Host Kernel Entry
===============================================================================================
Label VTEP IP Subnet IP VTEP MAC
114689 192.168.250.60 192.168.250.0 02:50:56:00:00:00
40961 192.168.250.61 192.168.250.0 00:50:56:62:58:be
LCP Remote Entry
===============================================================================================
Label VTEP IP Subnet IP VTEP MAC DEVICE NAME
114689 192.168.250.60 192.168.250.0 02:50:56:00:00:00 None
40961 192.168.250.61 192.168.250.0 00:50:56:62:58:be None
LCP Local Entry
===============================================================================================
Label VTEP IP Subnet IP VTEP MAC DEVICE NAME
36865 192.168.250.62 192.168.250.0 00:50:56:69:ba:80 None
Mode
Basic
Availability
ESXi
Display the MAC table for the specified logical switch.
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get logical-switch bf543c67-3ffe-44dd-a1d3-57e7cd2e0aff mac-table
Logical Switch MAC Table
---------------------------------------------------------------------------
Host Kernel Entry
===========================================================================
Inner MAC Outer MAC Outer IP Flags
02:50:56:56:44:52 02:50:56:00:00:00 192.168.250.60 0xd
00:50:56:8e:3e:0b 00:50:56:62:58:be 192.168.250.61 0xf
LCP Remote Entry
===========================================================================
Inner MAC Outer MAC Outer IP
LCP Local Entry
===========================================================================
Inner MAC Outer MAC Outer IP
00:50:56:8e:91:12 00:50:56:69:ba:80 192.168.250.62
00:0c:29:4d:09:19 00:50:56:69:ba:80 192.168.250.62
Mode
Basic
Availability
ESXi
Display the ND table for the specified logical switch.
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get logical-switch bf543c67-3ffe-44dd-a1d3-57e7cd2e0aff nd-table
Logical Switch ND Table
---------------------------------------------------------------------------
Host Kernel Entry
===========================================================================
IP MAC Flags
2001:bd6::c:2957:201:51 00:0c:29:dc:80:b5 0x3
LCP Entry
===========================================================================
IP MAC
2001:bd6::c:2957:201:51 00:0c:29:dc:80:b5
2001:bd6::c:2957:192:212 00:0c:29:f8:cb:9f
fe80::20c:29ff:fedc:80b5 00:0c:29:dc:80:b5
fe80::20c:29ff:fef8:cb9f 00:0c:29:f8:cb:9f
Mode
Basic
Availability
ESXi
Display VTEP groups for the specified logical switch
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get logical-switch bf543c67-3ffe-44dd-a1d3-57e7cd2e0aff vtep-group
VTEP Group Label: 1001
Type: Gateway
HA Type: Active/Standby
HA State Sync (ms): 18983125
Active Mbr: 0
Label: 1
VTEP IP: None
VTEP MAC: 00:50:56:62:17:2a
State: 1
BFD Count: 2
Mode
Basic
Availability
ESXi
Display the VTEP table for the specified logical switch.
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get logical-switch bf543c67-3ffe-44dd-a1d3-57e7cd2e0aff vtep-table
Logical Switch VTEP Table
-----------------------------------------------------------------------------------------------
Host Kernel Entry
===============================================================================================
Label VTEP IP Subnet IP Is MTEP VTEP MAC BFD count
114689 192.168.250.60 192.168.250.0 False 02:50:56:00:00:00 1
40961 192.168.250.61 192.168.250.0 False 00:50:56:62:58:be 1
LCP Remote Entry
===============================================================================================
Label VTEP IP Subnet IP VTEP MAC DEVICE NAME
114689 192.168.250.60 192.168.250.0 02:50:56:00:00:00 None
40961 192.168.250.61 192.168.250.0 00:50:56:62:58:be None
LCP Local Entry
===============================================================================================
Label VTEP IP Subnet IP VTEP MAC DEVICE NAME
36865 192.168.250.62 192.168.250.0 00:50:56:69:ba:80 None
Mode
Basic
Availability
ESXi
Display L2Forwarder high-availability history of a switch
| Option | Description |
|---|---|
| <uuid> | UUID argument |
Example
nsx-edge-1> get logical-switch 6e21f326-b6ef-4e7b-bbf9-d986807bab2b l2forwarder high-availability history state
State : Init
Event : Init
Time : 2019-04-15T18:33:09.954336
State : Down
Event : Init
Time : 2019-04-15T18:33:09.954378
State : Standby
Event : Device Up
Time : 2019-04-15T18:33:09.954534
State : Active
Event : Remote State Updated
Time : 2019-04-15T18:34:57.472649
Mode
Basic
Availability
Autonomous Edge, Edge
Display l2forwarder configuration and HA information of switch
| Option | Description |
|---|---|
| <uuid> | UUID argument |
Example
nsx-edge-1> get logical-switch 60c8ee36-20f2-52c4-a844-964250480339 l2forwarders high-availability state
Switch UUID : 6a085ef9-f954-4af6-9f05-0182e12bcfa0
Switch Port UUID : e228bce3-ed8c-4a35-9b80-2b798175013c
Rank : 0
High Availability State : Down
Failover Mode : Non-preemptive
High Availability Mode : Active-Standby
VTEP Group ID : 71689
RTEP Group ID : 1120265
Service Router Cluster ID : 76c85110-b041-4e9f-a3e3-b54179a88ceb
Peer L2Forwarders
Node UUID : 3b34da96-ed06-11e8-9814-020063efb6dc
High Availability state : Active
Mode
Basic
Availability
Autonomous Edge, Edge
Display port information for the specified logical switch.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch 857212c6-3d87-4a4a-9700-0c9d23f74f1c ports
LogSwitchPort-ID LogSwitch-ID Child-UUID Child-EntityType TransportNode-ID
335bbfdc-d6d6-4d87-8fb1-b98614fff1d8 857212c6-3d87-4a4a-9700-0c9d23f74f1c c78a1655-228c-493b-88cf-6b77dafe908d VIF 857212c6-3d87-4a4a-9700-0c9d23f74f1c
593d2540-bb7b-4abe-ad78-8727ebd5c1d2 857212c6-3d87-4a4a-9700-0c9d23f74f1c null LOG_SWITCH 857212c6-3d87-4a4a-9700-0c9d23f74f1c
Mode
Basic
Availability
Manager
Display the routing domain ID of a logical switch.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch 857212c6-3d87-4a4a-9700-0c9d23f74f1c routing-domain-from-app
758212c6-87ff-4a4a-9700-23f74f1c0c9d
Mode
Basic
Availability
Manager
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.| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch 857212c6-3d87-4a4a-9700-0c9d23f74f1c
VNI UUID Name Type
5000 857212c6-3d87-4a4a-9700-0c9d23f74f1c ls-mtep DEFAULT
or
nsx-controller-1> get logical-switch 5000
VNI UUID Name Type
5000 857212c6-3d87-4a4a-9700-0c9d23f74f1c ls-mtep DEFAULT
Mode
Basic
Availability
Manager
Display local ARP table for the specified logical switch.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch 857212c6-3d87-4a4a-9700-0c9d23f74f1c arp-table
VNI IP MAC TransportNode-ID
5000 172.16.130.12 00:50:56:8e:1b:21 857212c6-3d87-5d5d-9700-0c9d23f74f1d
Mode
Basic
Availability
Manager
Display the ARP table for the specified logical switch for both local and remote records.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch de73518d-26a0-4e9c-8356-ce97c49dc13e arp-table all
Local Records:
VNI IP MAC TransportNode-Id
5000 172.16.130.12 00:50:56:8e:1b:21 857212c6-3d87-5d5d-9700-0c9d23f74f1d
Remote Records:
VNI IP MAC Site-Id
5000 172.16.131.10 00:51:3c:8e:2a:18 957212c6-8a83-53cd-3701-0c8d23f74c1e
Mode
Basic
Availability
Manager
Display the ARP table for the specified logical switch for both local and remote records
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch de73518d-26a0-4e9c-8356-ce97c49dc13e arp-table all verbose
Local Records:
VNI IP MAC TransportNode-Id Timestamp TN-Connection
5000 172.16.130.12 00:50:56:8e:1b:21 857212c6-3d87-5d5d-9700-0c9d23f74f1d 2020-03-30 22:36:09 +0000 true
Remote Records:
VNI IP MAC Site-Id Timestamp
5000 172.16.131.10 00:51:3c:8e:2a:18 957212c6-8a83-53cd-3701-0c8d23f74c1e 2020-03-30 21:31:09 +0000
Mode
Basic
Availability
Manager
Display the ARP table for the specified logical switch for only remote records.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch 857212c6-3d87-4a4a-9700-0c9d23f74f1c arp-table remote
VNI IP MAC Site-Id
5000 172.16.130.12 00:50:56:8e:1b:21 857212c6-3d87-5d5d-9700-0c9d23f74f1d
Mode
Basic
Availability
Manager
Display the ARP table for the specified logical switch for only remote records.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch 857212c6-3d87-4a4a-9700-0c9d23f74f1c arp-table remote verbose
VNI IP MAC Site-Id Timestamp
5000 172.16.130.12 00:50:56:8e:1b:21 857212c6-3d87-5d5d-9700-0c9d23f74f1d 2020-03-30 22:36:09 +0000
Mode
Basic
Availability
Manager
Display local ARP table for the specified logical switch.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch 857212c6-3d87-4a4a-9700-0c9d23f74f1c arp-table verbose
VNI IP MAC TransportNode-Id Timestamp TN-Connection
5000 172.16.130.12 00:50:56:8e:1b:21 857212c6-3d87-5d5d-9700-0c9d23f74f1d 2020-03-30 22:36:09 +0000 true
Mode
Basic
Availability
Manager
Display local MAC address table for the specified logical switch.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch 857212c6-3d87-4a4a-9700-0c9d23f74f1c mac-table
VNI MAC VTEP-IP VTEP-IPv6 TransportNodeId
5000 00:50:56:8e:1b:21 192.168.250.161 2002::1234 957612c6-4321-4a4a-9700-0c9d23f74f1c
5000 00:50:56:8e:9a:a5 192.168.250.160 857212c6-3d87-5d5d-9700-0c9d23f74f1d
Mode
Basic
Availability
Manager
Display the MAC address table for the specified logical switch for both local and remote mac records.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch 71680 mac-table all
Local Records:
VNI MAC VTEP-IP VTEP-IPv6 TransportNode-Id
71680 00:0c:29:8a:1d:c8 192.168.20.70 2002:abcd::1234 e27f2436-72d3-11ea-babf-b1f46b3dc4af
71680 00:0c:29:c6:84:b3 192.168.24.111 b9aea2c0-72d3-11ea-bbff-49b0b7f6d0fa
Remote Records:
VNI MAC VTEP-GROUP-ID RTEP-GROUP-ID SITE-ID
71680 00:0c:22:2b:c4:d1 35173 82351 7bde6dac-3c95-11ea-b7bc-25a8a2ecc338
Mode
Basic
Availability
Manager
Display the MAC address table for the specified logical switch for both local and remote records.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch 71680 mac-table all verbose
Local Records:
VNI MAC VTEP-IP VTEP-IPv6 TransportNode-Id Timestamp TN-Connection
71680 00:0c:29:8a:1d:c8 192.168.20.70 2002:abcd::1234 e27f2436-72d3-11ea-babf-b1f46b3dc4af 2020-03-30 22:36:09 +0000 true
71680 00:0c:29:c6:84:b3 192.168.24.111 b9aea2c0-72d3-11ea-bbff-49b0b7f6d0fa 2020-03-30 22:19:48 +0000 true
Remote Records:
VNI MAC VTEP-GROUP-ID RTEP-GROUP-ID SITE-ID Timestamp
67584 00:0c:29:3a:96:81 27834 56912 4edbef90-4d15-11ea-bc9e-579dbd0b1786 2020-02-11 21:39:57 +0000
Mode
Basic
Availability
Manager
Display the MAC address table for the specified logical switch for only remote mac records.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch 857212c6-3d87-4a4a-9700-0c9d23f74f1c mac-table remote
VNI MAC VTEP-GROUP-ID RTEP-GROUP-ID SITE-ID
71680 00:0c:22:2b:c4:d1 235123 123232 7bde6dac-3c95-11ea-b7bc-25a8a2ecc338
71680 00:0c:29:8b:d4:a1 531231 231523 2b316da4-3d25-11ca-b4ba-15a8a2ecc338
Mode
Basic
Availability
Manager
Display the MAC address table for the specified logical switch for only remote records.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
get logical-switch 67584 mac-table remote verbose
VNI MAC VTEP-GROUP-ID RTEP-GROUP-ID SITE-ID Timestamp
67584 00:0c:29:04:d3:eb -1 -1 79430382-4d15-11ea-a7f0-31115f864439 2020-02-11 21:53:41 +0000
67584 00:0c:29:3a:96:81 -1 -1 4edbef90-4d15-11ea-bc9e-579dbd0b1786 2020-02-11 21:39:57 +0000
Mode
Basic
Availability
Manager
Display local MAC address table for the specified logical switch.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch 71680 mac-table verbose
VNI MAC VTEP-IP VTEP-IPv6 TransportNode-ID Timestamp
71680 00:0c:29:8b:d4:d1 192.168.12.36 2002:1234 7b3e6dac-3c95-11ea-b7bd-15a8a2ecc338 2020-01-21 21:55:21 +0000
71680 00:0c:29:14:48:ec 192.168.20.99 486a38e6-3c95-11ea-b7fd-a90b61f7fe1e 2020-01-21 21:53:53 +0000
Mode
Basic
Availability
Manager
Display the routing domain ID of a logical switch.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch 857212c6-3d87-4a4a-9700-0c9d23f74f1c routing-domain
758212c6-87ff-4a4a-9700-23f74f1c0c9d
Mode
Basic
Availability
Manager
Display RTEP Group synced from remote site
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch 4315367d-ee17-4b86-b3d8-29deda88ec59 rtep-group
SITE-ID RTEP-GROUP-ID
1330fc51-370b-4d95-bafa-4885f69b16ae 28473
71b1460b-33ac-4e78-bcf9-cfc00953af29 15324
9bce4707-f951-45a7-a8fc-e3dd2174989e 73619
Mode
Basic
Availability
Manager
Display statistics information about the specified logical switch.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch 857212c6-3d87-4a4a-9700-0c9d23f74f1c stats
LogSwitchFibMsg.vtep.update 4
LogSwitchFibMsg.vtep.remove 4
LogSwitchFibMsg.vtep.size 4
LogSwitchFibMsg.mac.update 4
LogSwitchFibMsg.mac.remove 4
LogSwitchFibMsg.mac.size 4
LogSwitchFibMsg.ip.update 4
LogSwitchFibMsg.ip.remove 4
LogSwitchFibMsg.ip.size 4
Mode
Basic
Availability
Manager
Display transport nodes which joined a given logical switch.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch 857212c6-3d87-4a4a-9700-0c9d23f74f1c transport-node-table
TransportNodeId
857212c6-3d87-4a4a-9700-0c9d23f74f1c
857212c6-3d87-3d3d-9700-0c9d23f74f1d
857212c6-3d87-5c5c-9700-0c9d23f74f1f
Mode
Basic
Availability
Manager
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.| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch 857212c6-3d87-4a4a-9700-0c9d23f74f1c verbose
VNI UUID LogicalSwitchPorts
5000 857212c6-3d87-4a4a-9700-0c9d23f74f1c 29c7254f-f148-46a2-be3d-bbf2707f7e66
837a565a-f88c-4979-a7f0-9955a365bb9
or
nsx-controller-1> get logical-switch 5000 verbose
VNI UUID LogicalSwitchPorts
5000 857212c6-3d87-4a4a-9700-0c9d23f74f1c 29c7254f-f148-46a2-be3d-bbf2707f7e66
837a565a-f88c-4979-a7f0-9955a365bb9
Mode
Basic
Availability
Manager
Display all virtual tunnel end points related to the specified logical switch.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch 857212c6-3d87-4a4a-9700-0c9d23f74f1c vtep
VNI IP LABEL Segment MAC TransportNodeId
5000 192.168.250.163 0x18801 192.168.250.0 04:00:c0:a8:fa:a3 857212c6-3d87-4a4a-9700-0c9d23f74f1c
5000 192.168.250.162 0xC801 192.168.250.0 04:00:c0:a8:fa:a2 857212c6-3d87-4a4a-9700-0c9d23f74f1d
5000 192.168.250.161 0x3001 192.168.250.0 00:50:56:62:af:a4 857212c6-3d87-4a4a-9700-0c9d23f74f1e
5000 192.168.250.160 0xF001 192.168.250.0 00:50:56:67:4b:95 857212c6-3d87-4a4a-9700-0c9d23f74f1f
Mode
Basic
Availability
Manager
Display all virtual tunnel end points related to the specified logical switch.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Mode
Basic
Availability
Manager
Display port information for the specified logical switch.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-switch port bbe56ae2-0bc1-46c0-b334-a241e2a56193
Port : bbe56ae2-0bc1-46c0-b334-a241e2a56193
IFUID : 280
Logical Switch: 857212c6-3d87-4a4a-9700-0c9d23f74f1c
Peer : 70b21c84-cf3b-4fc3-a442-a941ba86ef48
Mode
Basic
Availability
Autonomous Edge, Edge
Display statistics for the specified logical switch port.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get logical-switch port 783a05cd-033d-4891-ad11-7c082641e069 stats
Port : 783a05cd-033d-4891-ad11-7c082641e069
RX-Packets : 4474
RX-Bytes : 302966
RX-Drops : 0
Malformed : 0
No-Match : 0
L2-Loop : 0
TX-Packets : 5527
TX-Bytes : 371568
TX-Drops : 0
No-Memory : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display ports for all logical switches.
Example
nsx-edge-1> get logical-switch ports
Port : 18c26214-ab90-45ab-a2e0-78de070f9eb6
IFUID : 279
Peer : 8c4f10d5-9c4e-40a2-b239-e2eae7d39a33
Port : 271d49b0-f052-4c0c-a79f-44636229e471
IFUID : 264
Peer : a62432b5-68e7-4f95-a3f8-1b63ee4b102a
Port : 7bd1dd3d-97eb-5312-9d0d-b26c148a4fac
IFUID : 261
Peer : c2a03cab-3bad-56f3-b5ae-442ad6599bcf
Port : bbe56ae2-0bc1-46c0-b334-a241e2a56193
IFUID : 280
Peer : 70b21c84-cf3b-4fc3-a442-a941ba86ef48
Port : 58845bb9-19fc-4ec2-826f-bcbe871f99b5
IFUID : 282
Peer : e4be0c73-57bc-4b4f-b10c-f3f858ff8ccc
Port : 783a05cd-033d-4891-ad11-7c082641e069
IFUID : 276
Peer : aaec58d9-5dca-49c7-b39e-cdd8cd75901d
Port : 4ca7839f-2308-43f0-a799-f82d3911c134
IFUID : 287
Peer : 3fe772aa-8594-47cf-8a3e-20a26081ba15
Port : fe9c5ba9-3641-497f-ab95-046ffbc9356f
IFUID : 275
Peer : c7bbfc17-fbb9-4a39-a04b-0df93d788b57
Port : 1ff51f67-9ffb-446a-ae08-0a4a74adbf29
IFUID : 274
Peer : d37160fc-6e17-4c5c-8af1-54064c480798
Port : 286d2aad-ad4e-4ad6-b6c6-5256f38e9265
IFUID : 286
Peer : 6da71663-ce1a-4c2a-8557-ecfd85f031f5
Port : 93e656e1-0625-4ec2-b34c-98f2774bc8d3
IFUID : 281
Peer : 6c03a210-75b7-4a0d-8d66-cedf3c3f0750
Mode
Basic
Availability
Autonomous Edge, Edge
Display port statistics for all logical switches.
Example
nsx-edge-1> get logical-switch ports stats
Port : 18c26214-ab90-45ab-a2e0-78de070f9eb6
RX-Packets : 11123
RX-Bytes : 1088318
RX-Drops : 0
Malformed : 0
No-Match : 0
L2-Loop : 0
TX-Packets : 11141
TX-Bytes : 1089386
TX-Drops : 0
No-Memory : 0
Port : 271d49b0-f052-4c0c-a79f-44636229e471
RX-Packets : 11141
RX-Bytes : 1089386
RX-Drops : 0
Malformed : 0
No-Match : 0
L2-Loop : 0
TX-Packets : 11123
TX-Bytes : 1088318
TX-Drops : 0
No-Memory : 0
Port : 7bd1dd3d-97eb-5312-9d0d-b26c148a4fac
RX-Packets : 285577
RX-Bytes : 11994234
RX-Drops : 0
Malformed : 0
No-Match : 0
L2-Loop : 0
TX-Packets : 0
TX-Bytes : 0
TX-Drops : 0
No-Memory : 0
.
.
.
Mode
Basic
Availability
Autonomous Edge, Edge
Display a specific logical switch's local or remote MAC, ARP, or VTEP information.
| Option | Description |
|---|---|
| <vni> | vni Allowed pattern: ^[0-9]+$ |
Example
ESXi-1> get logical-switch local mac-cache 48008
VM MAC VTEP IP VTEP MAC
00:0c:29:67:4e:5c 192.168.90.55 00:50:56:6d:74:bf
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Display information about the specified logical switch port.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get logical-switch-port 593d2540-bb7b-4abe-ad78-8727ebd5c1d2
LogSwitchPort-ID LogSwitch-ID Child-UUID Child-EntityType TransportNode-ID
593d2540-bb7b-4abe-ad78-8727ebd5c1d2 857212c6-3d87-4a4a-9700-0c9d23f74f1c null LOG_SWITCH 857212c6-3d87-4a4a-9700-0c9d23f74f1c
Mode
Basic
Availability
Manager
Display the status for logical switch ports on this hypervisor host.
Example
esx-host-1> get logical-switch-port status
Logical Port UUID Status DVSwitch ID Logical Switch DVPort ID
fa1d9fcb-94cc-4a00-b499-8413f4dcef1e up 4adaf34e-6ee4-4153-844b-485a5e30627c 4adaf34e-6ee4-4153-844b-485a5e30627c
9c6a1a36-b468-404c-8084-bebfb91d5a31 up 65 bf 59 08 cd 4e 42 04-bf b5 93 de 83 ee ba 56 4adaf34e-6ee4-4153-844b-485a5e30627c 12345
Mode
Basic
Availability
ESXi
Display information about all logical switches.
Example
nsx-controller-1> get logical-switches
VNI UUID
15240 c31126b8-be8d-49a5-a7ab-d7c13f6013eb
5000 857212c6-3d87-4a4a-9700-0c9d23f74f1c
7048 7943ca31-9c8a-402e-adeb-a83f5cf2455d
19336 041d0ce3-4a26-415c-af4b-8324fb0a54fd
11144 718f154a-c1d4-47b6-b692-11c615f91229
41864 9985fd0a-c361-4a82-94cb-de004ce82834
or
When TN TEP GROUP is not enabled on Edge
nsx-edge-1> get logical-switches
Logical Switch
UUID VLAN DEVICE NAME
22ff0f12-fdfe-4443-a741-68a97020bcb9 11 fp-eth1 ULS_PLR_SR1
e21d35f1-31bf-5c90-9aee-ca57f1cbb73d 10 fp-eth0
UUID VNI ENCAP DEVICE NAME GLOBAL_VNI(FED)
33b1040d-5550-4a12-8c6b-7738178da15d 73730 GENEVE fp-eth0 SERVER_TLR_DOWNLINK_SWITCH_500
01222040-d799-4cd6-9da3-c70b080b9ad2 73729 GENEVE fp-eth0 transit-bp-269fd0be-3e78-4531-a158-109221520922
d636774f-0965-471c-acb4-9dd2ae1fca23 73728 GENEVE fp-eth0 transit-rl-9206a4d9-21e0-454c-a4ff-f5a68785d1f8
0d6f3c26-4980-4d3e-b8b3-00f022a06054 73732 GENEVE fp-eth0 SERVER_TLR_DOWNLINK_SWITCH_501
c501a184-8155-442a-97e8-bce4e6004f04 73731 GENEVE fp-eth0 transit-bp-9206a4d9-21e0-454c-a4ff-f5a68785d1f8
When TN TEP GROUP is enabled on Edge
nsxedge-3> get logical-switches
Logical Switch
UUID VLAN DEVICE NAME
c2b187bf-fd6e-465f-93bb-9955667abc74 10 fp-eth2
8496e976-7a5e-d155-4a88-b13260f47cec 10 fp-eth0
418ffc27-f72d-4ca8-98b9-fc25a2776cc8 13 fp-eth1 ULS_PLR_SR3
UUID VNI ENCAP TEP_GROUP NAME GLOBAL_VNI(FED)
897e8040-ef3f-430e-ae2f-7aef68bb6d52 69632 GENEVE 387072 multicast-transit-bp-da1dee4c-a9c7-429b-8d66-0f9dc0e4d48d
fb09df42-dac6-4987-b9b6-fc778f336b12 71680 GENEVE 387072 TIER0_DOWN_LINK_SWITCH
0a93dad5-fe43-4d04-b10a-7d2e91e75d87 65537 GENEVE 387072 transit-bp-PLR_LR_ACTIVEACTIVE_MODE
da09ab8f-ab48-4776-88d9-6724f16ef3be 65536 GENEVE 387072 transit-rl-ce082055-b8e2-4826-981b-6c02f911157c
Mode
Basic
Availability
Autonomous Edge, Edge, Manager
Display all logical switches on this host.
Example
kvm-1> get logical-switches
Logical Switches Summary
====================================================================
Switch UUID VNI/VLAN Port Count Name
16fa7892-df1b-4ffe-af87-3923efc8bdbe vni:64392 0 LS1
aacc41f2-7b32-4e0e-8679-6baff5bcbb64 vni:58248 0 LS2
da091cea-505c-4528-9b09-3f63efb8000d vni:54152 0 LS3
0a8cb2ab-d15b-4b46-a6ee-0a1cd29be34d vni:31624 1 LS4
d114f967-73aa-4dfc-8d59-a16de584b380 vni:52104 0 LS5
8b652ea8-86fe-4b03-9245-997fd2d7dfee vni:48008 0 LS6
or
esx-1> get logical-switches
Logical Switches Summary
------------------------------------------------------------
Overlay Kernel Entry
============================================================
VNI DVS name VIF num
69634 nsxvswitch 2
69636 nsxvswitch 2
69638 nsxvswitch 2
69640 nsxvswitch 1
69641 nsxvswitch 1
69642 nsxvswitch 1
Overlay LCP Entry
============================================================
VNI Logical Switch UUID Name
69636 c7018373-71aa-4c34-916b-aa73db274fe8 22-switch-1112
69638 eb0a435e-fd24-4347-83df-4194fa011c55 21-switch-56
69641 4c969550-4a32-4747-8653-5162aab607ea transit-rl-d39a1cde-552b-4118-8e68-bd80ecebd6cc
69640 327ec38a-6f1a-4077-8bc1-30e356a1b5cf transit-bp-b2a097ea-c9eb-4a89-a043-72438f633e28
69634 f6b2b4fa-1cb5-40f9-9852-ae6184024bac 3-switch-1090
69642 3c73d8d2-16c5-4cff-a206-6b2c33d0ad39 transit-bp-d39a1cde-552b-4118-8e68-bd80ecebd6cc
VLAN Backed Entry
============================================================
Segments UUID VLAN ID
e5e5ff09-99a9-4cc6-9a6f-349776472cb9 1050-1500
1550-2000
2050-2500
2550-3000
7f386f4b-cbd5-42cc-81c9-95de3d34b29a 4087
Mode
Basic
Availability
ESXi, KVM
Display all logical switches associated with the VIF on this host.
Example
host-1> get logical-switches
Host Logical Switches Summary
============================================================
Switch UUID VNI/VLAN Port Count
4e0f3312-d8c5-42b7-95a5-def111d14671 vni:41864 1
Mode
Basic
Availability
NSX Cloud VM
Display specified counter's detailed description.
| Option | Description |
|---|---|
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
| <counter-name> | Observability counters for specified kernel module Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get logical-switches datapath-stats module nsxt-vdl2 counter leafInDrop1 description verbose
Datapath Observability Counter Description
--------------------------------------------------
COUNTER NAME: leafInDrop2
VERBOSE DESCRIPTION:
Drop counters at leaf for reason2 verbose. This is
expected to be very big as like paragraphs.Thus,
let's test it by printing as much log msg as
possible. So this message is for a counter xxx.
This counter is incremented when the packets are
dropped since they are received with an incorrect
value for x.
Mode
Basic
Availability
ESXi
List all the counters with brief description for the specified module.
| Option | Description |
|---|---|
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get logical-switches datapath-stats module nsxt-vdl2 counters list
Datapath Observability Counters List
------------------------------------------------------------
COUNTER_NAME BRIEF DESCRIPTION
leafInDrop1 drop counters at leaf for reason1
leafInDrop2 drop counters at leaf for reason2
leafIn1 counters at leaf for reason1
leafIn2 counters at leaf for reason2
Mode
Basic
Availability
ESXi
Display specified kernel module's detailed description.
| Option | Description |
|---|---|
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get logical-switches datapath-stats module nsxt-vdl2 description verbose
Datapath Observability Module Description
--------------------------------------------------
MODULE NAME: nsxt-vdr
VERBOSE DESCRIPTION:
Kernel module nsxt-vdr is responsible for any
layer-3 routing decisions.
Mode
Basic
Availability
ESXi
List all the observability enabled kernel modules with.
Example
esx-1> get logical-switches datapath-stats modules list
Kernel Modules List
------------------------------------------------------------
MODULE NAME BRIEF DESCRIPTION
nsxt-vdrb nsxt-vdrb-brief-desc
nsxt-vdl2 nsxt-vdl2-brief-desc
Mode
Basic
Availability
ESXi
Display a summary of all logical switch statistics.
Example
nsx-controller-1> get logical-switches stats
LogSwitchFibMsg.vtep.update 40
LogSwitchFibMsg.vtep.remove 40
LogSwitchFibMsg.vtep.size 40
LogSwitchFibMsg.mac.update 40
LogSwitchFibMsg.mac.remove 40
LogSwitchFibMsg.mac.size 40
LogSwitchFibMsg.ip.update 40
LogSwitchFibMsg.ip.remove 40
LogSwitchFibMsg.ip.size 40
Mode
Basic
Availability
Manager
Display external IP and internal IP of LSP.
| Option | Description |
|---|---|
| <uuid> | LS identifier |
Example
wmoran-svc-nsxmanager-ob-24141745-1-magn1> get lsp-eip-binding-under-ls 20335582-acb7-40f8-8f1c-18e5a7ab3e5b
LSP-ID External-Ip Internal-Ip
c1ebd60c-a6fa-4144-864d-d6b2f0d98d69 192.168.100.11 192.168.100.20
16b81b25-ebe0-425d-b582-c112b320714a 192.168.100.10 192.168.100.10
Mode
Basic
Availability
Manager
Get maintenance mode status.
Example
nsx-esx> get maintenance-mode
Maintenance Mode: enabled
or
nsx-edge-1> get maintenance-mode
Maintenance Mode: disabled
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Show the current list of configured managers.
Example
nsx-controller1> get managers
- 10.1.1.101 Connected
- 10.1.1.102 Connected
- 10.1.1.103 Connected
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM, Manager
Display a specific metadata proxy server.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get mdproxy server d5845582-8cb5-4f6a-9d9d-d2641cd2fe55
EDGE_CLUSTER_ID: 5db40b38-05e2-4e00-ac90-74c6ff191911
EDGE_NODE_ID:
3284f707-98f9-4e7c-b573-f7898dfa12ba
ID: d5845582-8cb5-4f6a-9d9d-d2641cd2fe55
SECRET: ****
SERVER_URL: https://nova-server.example.com
Mode
Basic
Availability
Autonomous Edge, Edge
Display all metadata proxy servers.
Example
nsx-edge-1> get mdproxy servers
EDGE_CLUSTER_ID: 5db40b38-05e2-4e00-ac90-74c6ff191911
EDGE_NODE_ID:
3284f707-98f9-4e7c-b573-f7898dfa12ba
ID: d5845582-8cb5-4f6a-9d9d-d2641cd2fe55
SECRET: ****
SERVER_URL: https://nova-server.example.com
MONITOR_INTERVAL: 300
MONITOR_TIMEOUT: 15
MONITOR_RETRY: 3
SERVER_STATUS: CONNECTED
MONITOR_TOTAL_COUNT: 100
MONITOR_FAIL_COUNT: 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display the system memory information.
Example
nsx-manager-1> get memory-stats
MemTotal: 16430284 kB
MemFree: 10472728 kB
MemAvailable: 12800580 kB
Buffers: 363356 kB
Cached: 1820988 kB
SwapCached: 0 kB
Active: 4880696 kB
Inactive: 513728 kB
Active(anon): 3212444 kB
Inactive(anon): 368 kB
Active(file): 1668252 kB
Inactive(file): 513360 kB
Unevictable: 2348 kB
Mlocked: 2348 kB
SwapTotal: 3997692 kB
SwapFree: 3997692 kB
Dirty: 244 kB
Writeback: 0 kB
AnonPages: 3212392 kB
Mapped: 52056 kB
Shmem: 780 kB
Slab: 420328 kB
SReclaimable: 399656 kB
SUnreclaim: 20672 kB
KernelStack: 10512 kB
PageTables: 11940 kB
NFS_Unstable: 0 kB
Bounce: 0 kB
WritebackTmp: 0 kB
CommitLimit: 12212832 kB
Committed_AS: 10288852 kB
VmallocTotal: 34359738367 kB
VmallocUsed: 185388 kB
VmallocChunk: 34359440748 kB
HardwareCorrupted: 0 kB
AnonHugePages: 2764800 kB
HugePages_Total: 0
HugePages_Free: 0
HugePages_Rsvd: 0
HugePages_Surp: 0
Hugepagesize: 2048 kB
DirectMap4k: 16320 kB
DirectMap2M: 16760832 kB
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
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.
Example
nsx-edge(tier0_sr)> get mfib
Logical Router
UUID VRF LR-ID Name Type
3b5a8fa4-30f0-41cd-90d0-a68f9cac54dd 1 2 SR-Tier0-LR-1 SERVICE_ROUTER_TIER0
IPv4 Multicast Forwarding Table
Source IP Group IP Incoming UUID Outgoing UUID/VTEP/MTEP/UMG
40.40.40.1 237.0.0.1 cc8bd3c5-6558-49b4-90f5-dd180e3fdf0f 77f6b2fe-0c3d-4c56-91d6-a008ab3bfdcb
100.1.2.1
239.100.100.100
40.40.40.10 237.0.0.1 77f6b2fe-0c3d-4c56-91d6-a008ab3bfdcb cc8bd3c5-6558-49b4-90f5-dd180e3fdf0f
0.0.0.0 0.0.0.0 none 0000000a-0000-0000-0000-000000000000
Mode
Tier0_sr, VRF, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <multicast-ip-address> | Multicast IP address argument |
Example
nsx-edge(tier0_sr)> get mfib
Logical Router
UUID VRF LR-ID Name Type
6263fe96-0ecf-4b3b-ad2d-3c0447de038b 2 2 SR-tier0 SERVICE_ROUTER_TIER0
IPv4 Multicast Forwarding Table
Source IP Group IP Incoming UUID Outgoing UUID/VTEP/MTEP/UMG
2.1.4.11 237.0.0.16 b9267b0d-5d4b-48c5-8ae4-38ab95de40bf 0ef83a9d-5014-4b3e-bcef-32109a34237b
1.1.8.10 237.0.0.12 0ef83a9d-5014-4b3e-bcef-32109a34237b b9267b0d-5d4b-48c5-8ae4-38ab95de40bf
nsx-edge(tier0_sr)> get mfib 237.0.0.12
Logical Router
UUID VRF LR-ID Name Type
6263fe96-0ecf-4b3b-ad2d-3c0447de038b 2 2 SR-tier0 SERVICE_ROUTER_TIER0
IPv4 Multicast Forwarding Table
Source IP Group IP Incoming UUID Outgoing UUID/VTEP/MTEP/UMG
1.1.8.10 237.0.0.12 0ef83a9d-5014-4b3e-bcef-32109a34237b b9267b0d-5d4b-48c5-8ae4-38ab95de40bf
Mode
Tier0_sr, VRF, Tier1_sr
Availability
Autonomous Edge, Edge
Display information about the specified mirror session.
| Option | Description |
|---|---|
| <mirror-session-id> | Mirror session identifier UUID |
Example
kvm-1> get mirror-session 5a55a0e1-ec3e-40bd-9a49-1117119efe9a
Mirror Session
==========================================================
UUID : 5a55a0e1-ec3e-40bd-9a49-1117119efe9a
Direction : Both
Snap Length : 0
Source : 81286c82-67f4-40ab-84ab-1e705241134b
Destination : 10.10.10.1
EncapVlan :
OrigialVlan :
EncapType : GRE
GreKey : 0
ERspanID :
Filter :
Source IPs : 10.1.1.1
: 2000:1/64
Destination IPs : 20.1.1.1
: 2000:2/64
IP Protocol : TCP
Source Ports : 234
Destination Ports : 2999-4000
Action : Mirror
Mode
Basic
Availability
KVM
Display all mirror sessions on this host.
Example
kvm-1> get mirror-sessions
Mirror Session Summary
============================================================
Mirror UUID Direction Snap Length
5a55a0e1-ec3e-40bd-9a49-1117119efe9a Both 0
Mode
Basic
Availability
KVM
Display all the multicast learnt routes.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsxedge-1(tier0_sr)> get mroute 235.1.2.3
IP Multicast Routing Table
Flags: S- Sparse, C - Connected, P - Pruned
R - RP-bit set, F - Register flag, T - SPT-bit set
Source Group Flags Proto Input Output TTL Uptime
* 235.1.2.3 SC IGMP uplink-280 pimreg 1 00:11:24
IGMP downlink-272 1 00:11:24
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display the load-balancing selection for a multicast group for the specified logical router in the VRF context.
| Option | Description |
|---|---|
| <multicast-ip-address> | Multicast IP address argument |
Example
Edge-1(tier0_sr[1])> get multicast load-balancing 237.1.1.12
Logical Router
UUID : 8e562305-16c0-4053-b846-61a8fd68182d
vrf : 1
type : SERVICE_ROUTER_TIER0
selected-backplane: local
Edge-1(tier0_sr[1])> get multicast load-balancing 237.1.1.1
Logical Router
UUID : 8e562305-16c0-4053-b846-61a8fd68182d
vrf : 1
type : SERVICE_ROUTER_TIER0
selected-backplane: non-local
Edge-1(vrf[3])> get multicast load-balancing 237.1.1.1
Logical Router
UUID : ddba36a0-c758-4076-bb16-fd3344b284d6
vrf : 3
type : DISTRIBUTED_ROUTER_TIER0
selected-backplane: 169.254.0.5
Mode
Tier0_sr, VRF, Tier1_sr
Availability
Autonomous Edge, Edge
Get all name servers in the DNS configuration.
Example
nsx> get name-servers
192.168.110.10
192.168.110.11
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display a specific namespace config
| Option | Description |
|---|---|
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
Example
nsx-edge-1> get namespace status root
INTERFACE:
ADMIN_STATUS: True
IF_ID: 1
MTU: 65536
NAME: lo
VLAN_ID: 0
NAME: root
ROUTE:
DEVICE: eth0
NEXTHOP: 169957373
PREFIX:
IPV4: 0.0.0.0
PREFIX_LENGTH: 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display all namespace configs.
Example
nsx-edge-1> get namespaces status
INTERFACE:
ADMIN_STATUS: True
IF_ID: 1
MTU: 65536
NAME: lo
VLAN_ID: 0
NAME: root
ROUTE:
DEVICE: eth0
NEXTHOP: 169957373
PREFIX:
IPV4: 0.0.0.0
PREFIX_LENGTH: 0
INTERFACE:
ADMIN_STATUS: True
IF_ID: 1
MTU: 65536
NAME: lo
VLAN_ID: 0
NAME: plr_sr
ROUTE:
DEVICE: lo
NEXTHOP: 0
PREFIX:
IPV4: 127.0.0.0
PREFIX_LENGTH: 32
Mode
Basic
Availability
Autonomous Edge, Edge
Display all EIP binding config table entries.
Example
nsx-edge-1> get nat eip-binding
Total Number of EIP Bindings in fastpath: 2
EIP Table ID Match IP Translate IP
----------------------------------------------------------------------
d2843556-ac67-443a-90ac-06f113ecb33b 192.168.1.2 172.168.1.2
d2843556-ac67-443a-90ac-06f113ecb33b [Incomplete] 172.168.1.1
Mode
Basic
Availability
Edge
Display all EIP binding config entries with matching eip table id.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get nat eip-binding eip-table-id d2843556-ac67-443a-90ac-06f113ecb33b
Total Number of EIP Bindings: 2
EIP Table ID Match IP Translate IP
----------------------------------------------------------------------
d2843556-ac67-443a-90ac-06f113ecb33b 192.168.1.2 172.168.1.2
d2843556-ac67-443a-90ac-06f113ecb33b 192.168.1.1 172.168.1.1
Mode
Basic
Availability
Edge
Display all EIP binding config table entries with ip and uuid.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> > get nat eip-binding d2843556-ac67-443a-90ac-06f113ecb33b ip 192.168.1.2
Total Number of EIP Bindings: 1
EIP Table ID Match IP Translate IP
----------------------------------------------------------------------
d2843556-ac67-443a-90ac-06f113ecb33b 192.168.1.2 172.168.1.2
Mode
Basic
Availability
Edge
Display all EIP binding fastpath table entries.
Example
nsx-edge-1> get nat eip-binding fastpath
Total Number of EIP Bindings in fastpath: 4
EIP Table ID Match IP Translate IP
----------------------------------------------------------------------
d2843556-ac67-443a-90ac-06f113ecb33b 192.168.1.2 172.168.1.2
d2843556-ac67-443a-90ac-06f113ecb33b 172.168.1.1 192.168.1.1
d2843556-ac67-443a-90ac-06f113ecb33b 192.168.1.1 172.168.1.1
d2843556-ac67-443a-90ac-06f113ecb33b 172.168.1.2 192.168.1.2
Mode
Basic
Availability
Edge
Display all EIP binding fastpath table entries with matching eip table id.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> > get nat eip-binding fastpath eip-table-id d2843556-ac67-443a-90ac-06f113ecb33b
Total Number of EIP Bindings in fastpath: 4
EIP Table ID Match IP Translate IP
----------------------------------------------------------------------
d2843556-ac67-443a-90ac-06f113ecb33b 192.168.1.2 172.168.1.2
d2843556-ac67-443a-90ac-06f113ecb33b 172.168.1.1 192.168.1.1
d2843556-ac67-443a-90ac-06f113ecb33b 192.168.1.1 172.168.1.1
d2843556-ac67-443a-90ac-06f113ecb33b 172.168.1.2 192.168.1.2
Mode
Basic
Availability
Edge
Display all EIP binding fastpath table entries with specific ip and uuid
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> > get nat eip-binding fastpath eip-table-id d2843556-ac67-443a-90ac-06f113ecb33b ip 192.168.1.1
Total Number of EIP Bindings in fastpath: 2
EIP Table ID Match IP Translate IP
----------------------------------------------------------------------
d2843556-ac67-443a-90ac-06f113ecb33b 192.168.1.1 172.168.1.1
d2843556-ac67-443a-90ac-06f113ecb33b 172.168.1.1 192.168.1.1
Mode
Basic
Availability
Edge
Display all EIP binding fastpath table entries with ip.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> > get nat eip-binding fastpath ip 192.168.1.2
Total Number of EIP Bindings in fastpath: 2
EIP Table ID Match IP Translate IP
----------------------------------------------------------------------
d2843556-ac67-443a-90ac-06f113ecb33b 192.168.1.2 172.168.1.2
d2843556-ac67-443a-90ac-06f113ecb33b 172.168.1.2 192.168.1.2
Mode
Basic
Availability
Edge
Display all EIP binding config table entries with ip.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> get nat eip-binding ip 192.168.1.2
Total Number of EIP Bindings: 1
EIP Table ID Match IP Translate IP
----------------------------------------------------------------------
d2843556-ac67-443a-90ac-06f113ecb33b 192.168.1.2 172.168.1.2
Mode
Basic
Availability
Edge
Display the neighbor table for the logical router in the VRF context.
Example
nsx-edge-1(vrf)> get context neighbor
Logical Router
UUID : d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8
VRF : 6
LR-ID : 6
name : R3
type : DISTRIBUTED_ROUTER
neighbor
interface : c66fc321-df74-4aaa-835e-95dc815fe7ae
IP : 172.16.130.13
MAC : 00:50:56:8e:3e:0b
state : perm
interface : f6ef3b50-64a0-4948-ab9e-9135963d4b8b
IP : 169.0.0.2
MAC : 02:50:56:00:00:05
state : reach
timeout : 429
interface : be290c92-74ed-437c-bbf1-dd78673b6a5a
IP : 172.16.120.11
MAC : 00:50:56:8e:15:e5
state : reach
timeout : 482
interface : 3c139373-f8f7-441e-aac4-146d9b5ff3a6
IP : 172.16.110.11
MAC : 00:50:56:8e:91:12
state : perm
Mode
VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display the system network statistics.
Example
nsx-manager-1> get network-stats
Ip:
Total packets received: 165414209
Forwarded: 0
Incoming packets discarded: 0
Incoming packets delivered: 165187515
Requests sent out: 165175926
Icmp:
ICMP messages received: 157
ICMP messages failed: 5
ICMP input historgram:
Destination unreachable: 152
ICMP messages sent: 151
ICMP messages failed: 0
ICMP output historgram:
Destination unreachable: 151
IcmpMsg:
InType3: 152
InType8: 5
OutType3: 151
Tcp:
Active connections openings: 277703
Passive connection openings: 274411
Failed connection attempts: 3339
Connection resets attempts: 4921
Connections established: 160
Segments received: 164687995
Segments sent out: 164695227
Segments retransmitted: 28845
Bad segments received: 0
Resets sent: 22503
Udp:
Packets received: 499183
Packets to unknown port received: 151
Packet receive errors: 1
Packets sent: 454814
RcvbufErrors: 0
SndbufErrors: 0
UdpLite:
InDatagrams: 0
NoPorts: 0
InErrors: 0
OutDatagrams: 0
RcvbufErrors: 0
SndbufErrors: 0
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Get central-config properties.
Example
nsx> get node central-config
Enabled: True
Mode
Availability
Edge, Global Manager, KVM, Manager
Display upgrade status of the node.
Example
nsx-edge-1> get node upgrade status
Running "run_migration_tool" (step 7 of 10)
Running "start_manager" (step 8 of 10)
Running "update_upgrade_status" (step 9 of 10)
Running "finish_upgrade" (step 10 of 10)
Playbook finished successfully
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Display the status of the rollback tasks executed on the node and details of the last rollback task.
Example
nsx-manager> get node-rollback progress-status
Rollback info:
From-version: 3.2.1.0.0.51746298
To-version: 3.2.1.0.0.51739175
Rollback tasks:
backup_version_check [2021-11-24 03:22:50 - 2021-11-24 03:22:55] SUCCESS
cleanup_bundle [2021-11-24 03:22:55 - 2021-11-24 03:23:00] SUCCESS
reboot_into_rollback_version [2021-11-24 03:23:00 - 2021-11-24 03:24:54] SUCCESS
restore_config_files [2021-11-24 03:25:04 - 2021-11-24 03:25:09] SUCCESS
start_corfu [2021-11-24 03:25:09 - 2021-11-24 03:25:19] SUCCESS
node_version_check [2021-11-24 03:28:00 - 2021-11-24 03:28:06] SUCCESS
restore_ready_check [2021-11-24 03:28:06 - 2021-11-24 03:28:11] SUCCESS
run_db_restore [2021-11-24 03:28:11 - 2021-11-24 03:28:31] SUCCESS
Mode
Basic
Availability
Global Manager, Manager
Show the UUID for the node.
Example
nsx> get node-uuid
uuid: 692eef9a-026e-4e24-8494-251990b2b4e3
Mode
Basic
Availability
Edge
Display the UUID for the host.
Example
host-1> get node-uuid
uuid: f776222e-c95c-11e5-8e3e-23020aa2163f
Mode
Basic
Availability
ESXi, KVM
Display the list of registered nodes.
Example
nsx-manager-1> get nodes
UUID Type IP Address IPv6 Address Hostname/FQDN Display Name
4254fdce-281d-11ec-83d8-02011898bb21 edg 10.191.234.215 2002::30:30:0:86ce wdc-10-191-234-215.nimbus.eng.vmware.com nsxedge-1
831c0df2-281d-11ec-8743-020118f9b65f edg 10.191.231.212 2002::30:30:0:ab1b wdc-10-191-231-212.nimbus.eng.vmware.com nsxedge-2
dfcb2c8e-004f-4274-8d51-cb5d88f1b05e esx 10.191.239.130 2002::30:30:0:e180 wdc-10-191-239-130.nimbus.eng.vmware.com esx-1
862e6ce4-1d3f-494c-93af-17a3be722ff4 esx 10.191.234.125 2002::30:30:0:d4f3 wdc-10-191-234-125.nimbus.eng.vmware.com esx-2
36ea0142-44ad-04bd-dc64-064996ff44cd mgr 10.191.236.157 2002::30:30:0:84fd wdc-10-191-236-157.nimbus.eng.vmware.com nsxmanager
23a40142-bc54-bf19-0c9b-78dad477a268 mgr 10.191.233.49 2002::30:30:0:de54 wdc-10-191-233-49.nimbus.eng.vmware.com nsxmanager
df480142-7ec1-5b52-0967-43397a9ffc7c mgr 10.191.228.94 2002::30:30:0:ccb9 wdc-10-191-228-94.nimbus.eng.vmware.com nsxmanager
Mode
Basic
Availability
Global Manager, Manager
Display the list of registered nodes information in detail.
Example
nsx-manager-1> get nodes verbose
UUID : 8bf24232-802a-11ed-8a4c-0200a2d7c1a5
Label : Edge
IPv4 Addresses : ['10.187.107.146']
IPv6 Addresses : ['2002:0:0:0:30:30:0:1d']
Hostname/FQDN : sc2-10-187-107-146.nimbus.eng.vmware.com
Display Name : nsx-egde
UUID : 82eed5e5-b6b0-4bee-a4b1-1a7dabdb51c6
Label : ESX
IPv4 Addresses : ['10.187.105.164', '10.187.106.167']
IPv6 Addresses : ['2620:124:6020:c206:0:a2ff:fe57:b59c', '2620:124:6020:1045:ec72:4b40:34c0:1bf6']
Hostname/FQDN : sc2-10-187-105-164.nimbus.eng.vmware.com
Display Name : nsx-esx
UUID : b3480142-31dd-2be3-dfd9-5ff221d98404
Label : Manager
IPv4 Addresses : ['10.43.203.155']
IPv6 Addresses : ['2620:124:6020:c706:0:a:0:9b1']
Hostname/FQDN : sc2-10-43-203-155.nimbus.eng.vmware.com
Display Name : nsx-manager
Mode
Basic
Availability
Global Manager, Manager
Display the status of the NTP system. The delay, offset and dispersion values are in seconds.
Example
nsx-manager-1> get ntp-server associations
remote refid st t when poll reach delay offset jitter
==============================================================================
0.ubuntu.pool.n .POOL. 16 p - 64 0 0.000 0.000 0.000
1.ubuntu.pool.n .POOL. 16 p - 64 0 0.000 0.000 0.000
2.ubuntu.pool.n .POOL. 16 p - 64 0 0.000 0.000 0.000
3.ubuntu.pool.n .POOL. 16 p - 64 0 0.000 0.000 0.000
ntp.ubuntu.com .POOL. 16 p - 64 0 0.000 0.000 0.000
*ns1-time1.corp. 10.0.0.1 4 u 23 64 3 1.902 0.223 0.221
+ns2-time2.corp. 10.0.0.2 5 u 22 64 3 3.340 -1.312 0.026
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display all NTP servers.
Example
nsx-manager-1> get ntp-servers
0.ubuntu.pool.ntp.org
1.ubuntu.pool.ntp.org
2.ubuntu.pool.ntp.org
3.ubuntu.pool.ntp.org
ntp.ubuntu.com
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display OSPF information.
Example
nsx-edge-1(tier0_sr)> get ospf
OSPF Routing Process, Router ID: 40.40.40.1
Supports only single TOS (TOS0) routes
This implementation conforms to RFC2328
RFC1583Compatibility flag is disabled
OpaqueCapability flag is disabled
Initial SPF scheduling delay 0 millisec(s)
Minimum hold time between consecutive SPFs 50 millisec(s)
Maximum hold time between consecutive SPFs 5000 millisec(s)
Hold time multiplier is currently 1
SPF algorithm last executed 7.813s ago
Last SPF duration 19 usecs
SPF timer is inactive
LSA minimum interval 5000 msecs
LSA minimum arrival 1000 msecs
Write Multiplier set to 20
Refresh timer 10 secs
Maximum multiple paths(ECMP) supported 256
Number of external LSA 1. Checksum Sum 0x00007561
Number of opaque AS LSA 0. Checksum Sum 0x00000000
Number of areas attached to this router: 1
Area ID: 0.0.0.0 (Backbone)
Number of interfaces in this area: Total: 1, Active: 1
Number of fully adjacent neighbors in this area: 1
Area has no authentication
SPF algorithm executed 4 times
Number of LSA 3
Number of router LSA 2. Checksum Sum 0x00010d70
Number of network LSA 1. Checksum Sum 0x000071c7
Number of summary LSA 0. Checksum Sum 0x00000000
Number of ASBR summary LSA 0. Checksum Sum 0x00000000
Number of NSSA LSA 0. Checksum Sum 0x00000000
Number of opaque link LSA 0. Checksum Sum 0x00000000
Number of opaque area LSA 0. Checksum Sum 0x00000000
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display OSPF database summary.
Example
nsx-edge-1(tier0_sr)> get ospf database
OSPF Router with ID (40.40.40.1)
Router Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum Link count
40.40.40.1 40.40.40.1 556 0x80000003 0xce8a 1
40.40.40.10 40.40.40.10 553 0x80000005 0x3ae8 1
Net Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum
40.40.40.10 40.40.40.10 557 0x80000001 0x71c7
AS External Link States
Link ID ADV Router Age Seq# CkSum Route
10.92.0.0 40.40.40.10 860 0x80000002 0x7362 E2 10.92.0.0/19 [0x0]
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display ASBR-Summary LSAs.
Example
nsx-edge-1(tier0_sr)> get ospf database asbr-summary
OSPF Router with ID (40.40.40.1)
Router Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum Link count
40.40.40.1 40.40.40.1 556 0x80000003 0xce8a 1
40.40.40.10 40.40.40.10 553 0x80000005 0x3ae8 1
Net Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum
40.40.40.10 40.40.40.10 557 0x80000001 0x71c7
AS External Link States
Link ID ADV Router Age Seq# CkSum Route
10.92.0.0 40.40.40.10 860 0x80000002 0x7362 E2 10.92.0.0/19 [0x0]
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display ASBR-Summary LSAs.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1(tier0_sr)> get ospf database asbr-summary 1.1.1.1
OSPF Router with ID (40.40.40.1)
Router Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum Link count
40.40.40.1 40.40.40.1 556 0x80000003 0xce8a 1
40.40.40.10 40.40.40.10 553 0x80000005 0x3ae8 1
Net Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum
40.40.40.10 40.40.40.10 557 0x80000001 0x71c7
AS External Link States
Link ID ADV Router Age Seq# CkSum Route
10.92.0.0 40.40.40.10 860 0x80000002 0x7362 E2 10.92.0.0/19 [0x0]
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display external LSAs.
Example
nsx-edge-1(tier0_sr)> get ospf database external
OSPF Router with ID (192.168.10.1)
AS External Link States
LS age: 656
Options: 0x2 : *|-|-|-|-|-|E|-
LS Flags: 0x6
LS Type: AS-external-LSA
Link State ID: 51.1.1.1 (External Network Number)
Advertising Router: 192.168.10.2
LS Seq Number: 80000027
Checksum: 0xc580
Length: 36
Network Mask: /32
Metric Type: 2 (Larger than any link state path)
TOS: 0
Metric: 20
Forward Address: 192.168.10.51
External Route Tag: 0
LS age: 616
Options: 0x2 : *|-|-|-|-|-|E|-
LS Flags: 0x6
LS Type: AS-external-LSA
Link State ID: 60.1.1.1 (External Network Number)
Advertising Router: 192.168.10.2
LS Seq Number: 80000027
Checksum: 0xce65
Length: 36
Network Mask: /32
Metric Type: 2 (Larger than any link state path)
TOS: 0
Metric: 20
Forward Address: 192.168.10.60
External Route Tag: 0
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display external LSAs.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1(tier0_sr)> get ospf database external 55.1.1.1
OSPF Router with ID (192.168.10.1)
AS External Link States
LS age: 685
Options: 0x2 : *|-|-|-|-|-|E|-
LS Flags: 0x6
LS Type: AS-external-LSA
Link State ID: 55.1.1.1 (External Network Number)
Advertising Router: 192.168.10.2
LS Seq Number: 80000026
Checksum: 0xcb73
Length: 36
Network Mask: /32
Metric Type: 2 (Larger than any link state path)
TOS: 0
Metric: 20
Forward Address: 192.168.10.55
External Route Tag: 0
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display Network LSAs.
Example
nsx-edge-1(tier0_sr)> get ospf database network
OSPF Router with ID (192.168.10.1)
Net Link States (Area 0.0.0.0)
LS age: 896
Options: 0x2 : *|-|-|-|-|-|E|-
LS Flags: 0x6
LS Type: network-LSA
Link State ID: 192.168.10.2 (address of Designated Router)
Advertising Router: 192.168.10.2
LS Seq Number: 80000024
Checksum: 0x66fb
Length: 32
Network Mask: /24
Attached Router: 192.168.10.1
Attached Router: 192.168.10.2
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display Network LSAs.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1(tier0_sr)> get ospf database network 192.168.10.2
OSPF Router with ID (192.168.10.1)
Net Link States (Area 0.0.0.0)
LS age: 954
Options: 0x2 : *|-|-|-|-|-|E|-
LS Flags: 0x6
LS Type: network-LSA
Link State ID: 192.168.10.2 (address of Designated Router)
Advertising Router: 192.168.10.2
LS Seq Number: 80000024
Checksum: 0x66fb
Length: 32
Network Mask: /24
Attached Router: 192.168.10.1
Attached Router: 192.168.10.2
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display NSSA external LSAs.
Example
nsx-edge-1(tier0_sr)> get ospf database nssa-external
OSPF Router with ID (40.40.40.1)
Router Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum Link count
40.40.40.1 40.40.40.1 556 0x80000003 0xce8a 1
40.40.40.10 40.40.40.10 553 0x80000005 0x3ae8 1
Net Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum
40.40.40.10 40.40.40.10 557 0x80000001 0x71c7
AS External Link States
Link ID ADV Router Age Seq# CkSum Route
10.92.0.0 40.40.40.10 860 0x80000002 0x7362 E2 10.92.0.0/19 [0x0]
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display NSSA external LSAs.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1(tier0_sr)> get ospf database nssa-external 1.1.1.1
OSPF Router with ID (40.40.40.1)
Router Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum Link count
40.40.40.1 40.40.40.1 556 0x80000003 0xce8a 1
40.40.40.10 40.40.40.10 553 0x80000005 0x3ae8 1
Net Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum
40.40.40.10 40.40.40.10 557 0x80000001 0x71c7
AS External Link States
Link ID ADV Router Age Seq# CkSum Route
10.92.0.0 40.40.40.10 860 0x80000002 0x7362 E2 10.92.0.0/19 [0x0]
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display router LSAs.
Example
nsx-edge-1(tier0_sr)> get ospf database router
OSPF Router with ID (192.168.10.1)
Router Link States (Area 0.0.0.0)
LS age: 140
Options: 0x2 : *|-|-|-|-|-|E|-
LS Flags: 0x3
Flags: 0x0
LS Type: router-LSA
Link State ID: 192.168.10.1
Advertising Router: 192.168.10.1
LS Seq Number: 80000003
Checksum: 0xa3d1
Length: 36
Number of Links: 1
Link connected to: a Transit Network
(Link ID) Designated Router address: 192.168.10.2
(Link Data) Router Interface address: 192.168.10.1
Number of TOS metrics: 0
TOS 0 Metric: 10
LS age: 141
Options: 0x2 : *|-|-|-|-|-|E|-
LS Flags: 0x6
Flags: 0x2 : ASBR
LS Type: router-LSA
Link State ID: 192.168.10.2
Advertising Router: 192.168.10.2
LS Seq Number: 80000004
Checksum: 0xa5c9
Length: 36
Number of Links: 1
Link connected to: a Transit Network
(Link ID) Designated Router address: 192.168.10.2
(Link Data) Router Interface address: 192.168.10.2
Number of TOS metrics: 0
TOS 0 Metric: 10
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display router LSAs.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1(tier0_sr)> get ospf database router 192.168.10.2
OSPF Router with ID (192.168.10.1)
Router Link States (Area 0.0.0.0)
LS age: 700
Options: 0x2 : *|-|-|-|-|-|E|-
LS Flags: 0x6
Flags: 0x2 : ASBR
LS Type: router-LSA
Link State ID: 192.168.10.2
Advertising Router: 192.168.10.2
LS Seq Number: 80000004
Checksum: 0xa5c9
Length: 36
Number of Links: 1
Link connected to: a Transit Network
(Link ID) Designated Router address: 192.168.10.2
(Link Data) Router Interface address: 192.168.10.2
Number of TOS metrics: 0
TOS 0 Metric: 10
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display summary LSAs.
Example
nsx-edge-1(tier0_sr)> get ospf database summary
OSPF Router with ID (40.40.40.1)
Router Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum Link count
40.40.40.1 40.40.40.1 556 0x80000003 0xce8a 1
40.40.40.10 40.40.40.10 553 0x80000005 0x3ae8 1
Net Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum
40.40.40.10 40.40.40.10 557 0x80000001 0x71c7
AS External Link States
Link ID ADV Router Age Seq# CkSum Route
10.92.0.0 40.40.40.10 860 0x80000002 0x7362 E2 10.92.0.0/19 [0x0]
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display summary LSAs.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge-1(tier0_sr)> get ospf database summary 1.1.1.1
OSPF Router with ID (40.40.40.1)
Router Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum Link count
40.40.40.1 40.40.40.1 556 0x80000003 0xce8a 1
40.40.40.10 40.40.40.10 553 0x80000005 0x3ae8 1
Net Link States (Area 0.0.0.0)
Link ID ADV Router Age Seq# CkSum
40.40.40.10 40.40.40.10 557 0x80000001 0x71c7
AS External Link States
Link ID ADV Router Age Seq# CkSum Route
10.92.0.0 40.40.40.10 860 0x80000002 0x7362 E2 10.92.0.0/19 [0x0]
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display OSPF Graceful Restart information.
Example
nsx-edge-1(tier0_sr)> get ospf graceful-restart
OSPF Router with ID (40.40.40.1)
Graceful restart helper support disabled.
Strict LSA check is enabled.
Helper supported for Planned and Unplanned Restarts.
Supported Graceful restart interval: 1800(in seconds).
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display OSPF interface information.
Example
nsx-edge-1(tier0_sr)> get ospf interface
uplink-275 is up
ifindex 32, MTU 1500 bytes, BW 0 Mbit
Internet Address 40.40.40.1/24, Broadcast 40.40.40.255, Area 0.0.0.0
MTU mismatch detection: enabled
Router ID 40.40.40.1, Network Type BROADCAST, Cost: 10
Transmit Delay is 1 sec, State Backup, Priority 1
Designated Router (ID) 40.40.40.10, Interface Address 40.40.40.10
Backup Designated Router (ID) 40.40.40.1, Interface Address 40.40.40.1
Multicast group memberships: OSPFAllRouters OSPFDesignatedRouters
Timer intervals configured, Hello 10s, Dead 40s, Wait 40s, Retransmit 5
Hello due in 0.745s
Neighbor Count is 1, Adjacent neighbor count is 1
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display OSPF neighbor list.
Example
nsx-edge-1(tier0_sr)> get ospf neighbor
Neighbor ID Pri State Dead Time Address Interface RXmtL RqstL DBsmL
40.40.40.10 1 Full/DR 30.173s 40.40.40.10 uplink-275:40.40.40.1 0 0 0
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display OSPF routes.
Example
nsx-edge-1(tier0_sr)> get ospf route
============ OSPF network routing table ============
N 40.40.40.0/24 [10] area: 0.0.0.0
directly attached to uplink-297
============ OSPF router routing table =============
R 40.40.40.2 [10] area: 0.0.0.0, ASBR
via 40.40.40.2, uplink-297
============ OSPF external routing table ===========
N E2 1.1.1.0/25 [10/20] tag: 4016
via 40.40.40.2, uplink-297
N E2 1.1.2.0/24 [10/20] tag: 4016
via 40.40.40.2, uplink-297
N E2 1.1.3.0/24 [10/20] tag: 0
via 40.40.40.2, uplink-297
N E2 100.64.176.0/31 [10/20] tag: 0
via 40.40.40.2, uplink-297
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Show external summary addresses.
Example
mnaragund-svc(tier0_sr[2])> get ospf summary-address
Summary-address Metric-type Metric Tag External_Rt_count
aggregation delay interval :5(in seconds)
172.16.0.0/24 E2 20 0 0
172.16.1.0/24 E2 20 0 0
Fri Dec 17 2021 UTC 11:19:25.152
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display the parent of the current interface.
Example
nsx-edge-1(path)> get parent
{
"arp_refresh_timeout": 600,
"number_arp_entries": 0,
"type": "SERVICE_ROUTER_TIER0",
"uuid": "f2a25dd6-4ceb-4bf5-8ad5-3e80d2970d60",
"vrf": 6
}
or
nsx-edge-1(path)> get parent
{
"encap": "STT",
"repl": "mtep",
"uuid": "d5af58f5-0616-46fd-af83-242d82983c65",
"vni": 39816
}
Mode
Path
Availability
Autonomous Edge, Edge
Get configured password complexity requirements.
Example
nsx> get password-complexity
- minimum 12 characters in length
- minimum 128 characters in length
- minimum 1 uppercase character
- minimum 1 lowercase character
- minimum 1 numeric character
- minimum 1 special character
- minimum 5 unique characters
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display the path. The arrow indicates which interface is selected. Other commands, such as
get current, will display information about the selected interface.Example
nsx-edge-1(path)> get path
port : fdc429ef-d778-421b-bf84-e1063a7bf5ab
->interface : b414acab-8d88-5ead-b2ce-e170eb045327 : cpu + SR-t1-domain-c9:aa317e48-b458-4
interface : 5461772f-f32a-4674-832c-341928509dd1 : uplink + ContainerT0-t1_30ae76a2-d2b5-4825-8bd2-672bad85e939_rtr-t1_lrp
port : a4d7ce05-8649-41b8-94e8-0da1af5bb5e9 : vni:65543 + ContainerT0-t1_30ae76a2-d2b5-4825-8bd2-672bad85e939_rtr-t1_lrp
port : ed7771c2-9652-497c-a6c1-44dadebe11a1 : vni:65543 + ContainerT0-t1_30ae76a2-d2b5-4825-8bd2-672bad85e939_rtr-t0_lrp
interface : cb482b2a-1684-43c7-9beb-2096a9f1ee4d : downlink + ContainerT0-t1_30ae76a2-d2b5-4825-8bd2-672bad85e939_rtr-t0_lrp
interface : 64b419b5-4f55-4e75-9b1e-d00f3a56b5e2 : uplink + tier0-interface200
port : 6858f1bc-7965-45e8-bc47-60f9a0101d57 : vlan:untagged + tier0-interface200
Mode
Path
Availability
Autonomous Edge, Edge
Display the specified physical port.
| Option | Description |
|---|---|
| <physical-port-name> | Datapath String argument |
Example
nsx-edge-1> get physical-port fp-eth1
Physical Port
DRIVER : rte_vmxnet3_pmd
DUPLEX : full
ID : 1
LINK : up
MAC : 00:50:56:a9:a2:e6
MTU : 1600
NAME : fp-eth1
OFFLOAD_CAPABILITIES : TX_VLAN_INSERT TX_UDP_CKSUM TX_TCP_CKSUM TX_TCP_TSO RX_VLAN_STRIP RX_UDP_CKSUM RX_TCP_CKSUM
PCI : 0000:13:00:00
POLLING_STATUS : active
RX_QUEUE : 1
SOCKET : -1
SPEED : 10000
TX_QUEUE : 1
Mode
Basic
Availability
Autonomous Edge, Edge
Display statistics for the specified physical port.
| Option | Description |
|---|---|
| <physical-port-name> | Datapath String argument |
Example
nsx-edge-1> get physical-port fp-eth1 stats
Physical Port Stats
NAME : fp-eth1
RX_BYTES : 744689
RX_DROP_NO_MATCH : 0
RX_ERRORS : 0
RX_MISSES : 0
RX_NOMBUFS : 0
RX_PACKETS : 8984
TX_BYTES : 7140
TX_DROPS : 0
TX_ERRORS : 0
TX_PACKETS : 170
Mode
Basic
Availability
Autonomous Edge, Edge
Display verbose statistics for the specified physical port.
| Option | Description |
|---|---|
| <physical-port-name> | Datapath String argument |
Example
nsx-edge-1> get physical-port fp-eth1 stats verbose
Physical Port Stats
NAME : fp-eth1
RX_BYTES : 749793
RX_DROP_NO_MATCH : 0
RX_ERRORS : 0
RX_MISSES : 0
RX_NOMBUFS : 0
RX_PACKETS : 9037
TX_BYTES : 7140
TX_DROPS : 0
TX_ERRORS : 0
TX_PACKETS : 170
QUEUES :
id rx_bytes rx_errors rx_packets tx_bytes tx_drops tx_packets
0 749793 0 9037 7140 0 170
1 0 0 0 0 0 0
2 0 0 0 0 0 0
3 0 0 0 0 0 0
4 0 0 0 0 0 0
5 0 0 0 0 0 0
6 0 0 0 0 0 0
7 0 0 0 0 0 0
8 0 0 0 0 0 0
9 0 0 0 0 0 0
10 0 0 0 0 0 0
11 0 0 0 0 0 0
12 0 0 0 0 0 0
13 0 0 0 0 0 0
14 0 0 0 0 0 0
15 0 0 0 0 0 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display x statistics for the specified physical port.
| Option | Description |
|---|---|
| <physical-port-name> | Datapath String argument |
Example
nsx-edge-1> get physical-port fp-eth1 xstats
Physical Port Xstats
RX_ERRORS : 0
RX_GOOD_BYTES : 396004
RX_GOOD_PACKETS : 2457
RX_MBUF_ALLOCATION_ERRORS: 0
RX_MISSED_ERRORS : 0
RX_Q0_DROP_ERR : 0
RX_Q0_DROP_FCS : 0
RX_Q0_DROP_TOTAL : 0
RX_Q0_RX_BUF_ALLOC_FAILURE: 0
RX_Q0BYTES : 14460
RX_Q0ERRORS : 0
RX_Q0PACKETS : 241
RX_Q1_DROP_ERR : 0
RX_Q1_DROP_FCS : 0
RX_Q1_DROP_TOTAL : 0
RX_Q1_RX_BUF_ALLOC_FAILURE: 0
RX_Q1BYTES : 240
RX_Q1ERRORS : 0
RX_Q1PACKETS : 4
RX_Q2_DROP_ERR : 0
RX_Q2_DROP_FCS : 0
RX_Q2_DROP_TOTAL : 0
RX_Q2_RX_BUF_ALLOC_FAILURE: 0
RX_Q2BYTES : 364980
RX_Q2ERRORS : 0
RX_Q2PACKETS : 1970
RX_Q3_DROP_ERR : 0
RX_Q3_DROP_FCS : 0
RX_Q3_DROP_TOTAL : 0
RX_Q3_RX_BUF_ALLOC_FAILURE: 0
RX_Q3BYTES : 16324
RX_Q3ERRORS : 0
RX_Q3PACKETS : 242
TX_ERRORS : 0
TX_GOOD_BYTES : 309710
TX_GOOD_PACKETS : 2386
TX_Q0_DROP_TOO_MANY_SEGS: 0
TX_Q0_DROP_TOTAL : 0
TX_Q0_DROP_TSO : 0
TX_Q0_TX_RING_FULL: 0
TX_Q0BYTES : 79099
Mode
Basic
Availability
Autonomous Edge, Edge
Display all physical ports.
Example
nsx-edge-1> get physical-ports
Physical Port
DRIVER : rte_vmxnet3_pmd
DUPLEX : full
ID : 0
LINK : up
MAC : 00:50:56:a9:51:09
MTU : 1500
NAME : fp-eth0
OFFLOAD_CAPABILITIES : TX_VLAN_INSERT TX_UDP_CKSUM TX_TCP_CKSUM TX_TCP_TSO RX_VLAN_STRIP RX_UDP_CKSUM RX_TCP_CKSUM
PCI : 0000:0b:00:00
POLLING_STATUS : inactive
RX_QUEUE : 1
SOCKET : -1
SPEED : 10000
TX_QUEUE : 1
Physical Port
DRIVER : rte_vmxnet3_pmd
DUPLEX : full
ID : 1
LINK : up
MAC : 00:50:56:a9:a2:e6
MTU : 1600
NAME : fp-eth1
OFFLOAD_CAPABILITIES : TX_VLAN_INSERT TX_UDP_CKSUM TX_TCP_CKSUM TX_TCP_TSO RX_VLAN_STRIP RX_UDP_CKSUM RX_TCP_CKSUM
PCI : 0000:13:00:00
POLLING_STATUS : active
RX_QUEUE : 1
SOCKET : -1
SPEED : 10000
TX_QUEUE : 1
Physical Port
DRIVER : rte_vmxnet3_pmd
DUPLEX : full
ID : 2
LINK : up
MAC : 00:50:56:a9:5b:33
MTU : 1500
NAME : fp-eth2
OFFLOAD_CAPABILITIES : TX_VLAN_INSERT TX_UDP_CKSUM TX_TCP_CKSUM TX_TCP_TSO RX_VLAN_STRIP RX_UDP_CKSUM RX_TCP_CKSUM
PCI : 0000:1b:00:00
POLLING_STATUS : inactive
RX_QUEUE : 1
SOCKET : -1
SPEED : 10000
TX_QUEUE : 1
Mode
Basic
Availability
Autonomous Edge, Edge
Display the state of BSM message processing. Enabled - BSM messages are processed. Disabled - BSM messages are ignored.
Example
nsx-edge-1> get pim bsm state
Codes : Enabled - BSM messages are processed on all LR ports
Disabled - BSM messages are ignored on all LR ports
PIM BSM State : Disabled
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display logical objects related to the specified logical port.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get port 22103ac6-917c-4de0-b6cb-ebe1a47f53b7
Logical Switch: 0e8ea505-14bc-4961-b5b8-8f410d1e4b6b
Logical Router Port: 22103ac6-917c-4de0-b6cb-ebe1a47f53b7
Logical Switch Port: ce1979d6-fbdd-44b5-ad2a-7711220eaffb
Mode
Basic
Availability
Autonomous Edge
Display information about all ports.
Example
nsx-edge-1> get ports
ID : d676e7d3-1953-4825-8778-97e1fef3fcb1
Name : lrport_testABC
Resource Type : LogicalRouterPort
IP/Mask : 192.12.33.2/20
MAC : 00:0c:29:a6:4a:66
VLAN id : 30
Urpf-mode : STRICT_MODE
MTU : 1500
ID : 21cbe556-f8d9-4b78-997e-c2db06e1cdff
Name : lrport_test
Resource Type : LogicalRouterPort
MAC : 00:0c:29:a6:4a:66
VLAN id : 40
Urpf-mode : STRICT_MODE
MTU : 1500
L2 Extension
Tunnel Id : 100 l2VPN Session Id: 415bf182-832a-42b8-8ff5-56f8c0aea79b
Mode
Basic
Availability
Autonomous Edge
Display port information on the current host.
Example
esx-1> get ports
PortNum Switch Client DVSPort MAC Uplink
==================================================================================================================================
50331649 DvsPortset-0 Management 00:00:00:00:00:00 n/a
50331650 DvsPortset-0 vmnic1 uplink1 00:00:00:00:00:00
50331651 DvsPortset-0 Shadow of vmnic1 00:50:56:58:d0:45 n/a
50331652 DvsPortset-0 vmk10 10 00:50:56:67:49:73 vmnic1
50331653 DvsPortset-0 vmk50 624ce7e0-b7ea-41de-ada6-a9b1a1 00:50:56:67:e8:1c void
f9ee67
50331654 DvsPortset-0 vdr-vdrPort vdrPort 02:50:56:56:44:52 vmnic1
50331655 DvsPortset-0 1-vm_ubuntu_1404_srv_64-local- 51f92d21-95dd-4b47-8569-db3ce6 00:0c:29:d9:7f:f5 vmnic1
935-d6f49164-29ef-4e24-aa24-20 61f2a5
2dac5e635c.eth1
Mode
Basic
Availability
ESXi
Display a snapshot of the system processes.
Example
nsx> get processes
top - 01:12:28 up 3 days, 1:51, 1 user, load average: 0.06, 0.05, 0.07
Tasks: 133 total, 1 running, 132 sleeping, 0 stopped, 0 zombie
%Cpu(s): 4.2 us, 0.9 sy, 0.0 ni, 94.7 id, 0.2 wa, 0.0 hi, 0.0 si, 0.0 st
KiB Mem: 16430712 total, 2604180 used, 13826532 free, 324432 buffers
KiB Swap: 3997692 total, 0 used, 3997692 free. 460404 cached Mem
PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND
1 root 20 0 33216 2564 1460 S 0.0 0.0 2:51.13 init
2 root 20 0 0 0 0 S 0.0 0.0 0:00.00 kthreadd
3 root 20 0 0 0 0 S 0.0 0.0 0:02.21 ksoftirqd/0
4 root 20 0 0 0 0 S 0.0 0.0 0:00.00 kworker/0:0
5 root 0 -20 0 0 0 S 0.0 0.0 0:00.00 kworker/0:0H
7 root 20 0 0 0 0 S 0.0 0.0 1:23.74 rcu_preempt
8 root 20 0 0 0 0 S 0.0 0.0 0:39.39 rcuop/0
.
.
.
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display information about processes that are running. The display is updated every few seconds.
Example
nsx-manager-1> get processes monitor
top - 00:24:51 up 15 days, 6 min, 1 user, load average: 0.18, 0.16, 0.15
Tasks: 142 total, 2 running, 140 sleeping, 0 stopped, 0 zombie
%Cpu(s): 6.2 us, 1.3 sy, 0.0 ni, 92.3 id, 0.2 wa, 0.0 hi, 0.0 si, 0.0 st
KiB Mem: 16430284 total, 5863860 used, 10566424 free, 363284 buffers
KiB Swap: 3997692 total, 0 used, 3997692 free. 1732000 cached Mem
PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND
1530 uproton 20 0 8867728 1.862g 23868 S 18.6 11.9 3041:54 java
1009 elastic+ 20 0 4611496 403996 15712 S 1.0 2.5 178:33.40 java
.
.
.
or
nsx-edge> get processes monitor
top - 00:24:51 up 15 days, 6 min, 1 user, load average: 0.18, 0.16, 0.15
Tasks: 142 total, 2 running, 140 sleeping, 0 stopped, 0 zombie
%Cpu(s): 6.2 us, 1.3 sy, 0.0 ni, 92.3 id, 0.2 wa, 0.0 hi, 0.0 si, 0.0 st
KiB Mem: 16430284 total, 5863860 used, 10566424 free, 363284 buffers
KiB Swap: 3997692 total, 0 used, 3997692 free. 1732000 cached Mem
PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND
1530 uproton 20 0 8867728 1.862g 23868 S 18.6 11.9 3041:54 java
2245 rabbitmq 20 0 1200504 110528 4568 S 4.6 0.7 484:17.48 beam.smp
1009 elastic+ 20 0 4611496 403996 15712 S 1.0 2.5 178:33.40 java
.
.
.
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Get the realization status for the specified transport node.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get realization status 7c72c4ae-8fe8-4449-a4e2-c5e53ab0bb4f
{u'VERTICAL_ID_DFW': 1191}
Mode
Basic
Availability
Manager
Display all connected receivers.
Example
nsx-controller-1> get receivers
['e97edc33-0b56-11e7-8af3-85d3287ccc85', '6a93350e-0b57-11e7-a82e-02002a4b8864', 'f763ddf5-0b56-11e7-84aa-81f3962a9a84']
Mode
Basic
Availability
Manager
Display information about Redirection Policy
Example
nsxedge(tier0_sr)> get redirection-policy
Redirection Policy:
Policy UUID : ffeeddcc-bbaa-bbaa-2332-23fe33221100
Transport type : L2_BRIDGE
BFD status : BFD_DOWN
Redirected packet count north-to-south : 0
Redirected packet count south-to-north : 0
Service link1 IP : 10.10.10.1
Service link2 IP : 20.20.20.1
Service link1 nexthop IP : 10.10.10.2
Service link2 nexthop IP : 20.20.20.2
Failure policy : ON_FAILURE_DROP
Redirection Policy:
Policy UUID : 7fbe102d-268c-4b33-bdf5-8f1e608e9864
Transport type : L3_ROUTED
Redirected packet count : 1600
Nexthop IP : 40.40.40.10
Redirection Policy:
Policy UUID : dd947221-c3c1-45cd-b231-ee2d17fdfc61
Transport type : EW_NSH
Is EW policy : 1
EW Policy lookup count : 1
Failure Policy : FAIL_DROP
Number of Service Paths : 2
Path Index : 0
Forward Service Path ID : 1
Forward Service Chain ID : 1
Forward Service Index : 2
Forward Service Mac Address : 00:50:56:8b:73:96
Reverse Service Path ID : 2
Reverse Policy Service Chain ID : 1
Reverse Service Index : 2
Reverse Service Mac Address : 00:50:56:8b:89:b2
Path Index : 1
Forward Service Path ID : 3
Forward Policy Service Chain ID : 1
Forward Service Index : 2
Forward Service Mac Address : 00:50:56:8b:4e:b5
Reverse Service Path ID : 4
Reverse Service Chain ID : 1
Reverse Service Index : 2
Reverse Service Mac Address : 00:50:56:8b:89:b2
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about Redirection Policy.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsxedge(tier0_sr)> get redirection-policy ffeeddcc-bbaa-bbaa-2332-23fe33221100
Redirection Policy:
Policy UUID : ffeeddcc-bbaa-bbaa-2332-23fe33221100
BFD status : BFD_DOWN
Redirected packet count north-to-south : 0
Redirected packet count south-to-north : 0
Service link1 IP : 10.10.10.1
Service link2 IP : 20.20.20.1
Service link1 nexthop IP : 10.10.10.2
Service link2 nexthop IP : 20.20.20.2
Failure policy : ON_FAILURE_DROP
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about Redirection Policy BFD control status.
Example
nsxedge(tier0_sr)> get redirection-policy bfd-ctrl
Redirection Policy BFD control status:
bfd_fail_gen : 1225
LR active timestamp : 933565834
Number of packets bypassing bfd check : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about Redirection Policy flow programming table.
Example
nsxedge(tier0_sr)> get redirection-policy flow-prog-table
Flow Programming Table:
Flow Programming Generation : 1
Number of Entries : 1
Flow Programming Entries
Flow ID : 118423680
Action : accept_flow
VRF : 1
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about Redirection Policy failed SPI.
Example
nsxedge(tier0_sr)> get redirection-policy spi-fail-table
Redirection Policy SPI Fail Table:
SPI Fail Generation : 2
SPI Fail entries:
SPI : 1
SPI : 2
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about EW Redirection VRF to interface mapping.
Example
nsxedge(tier0_sr)> get commands/edge/get_redirection_policy_spifail.mako
Redirection Policy VRF to Interface Table:
VRF ID : 1
Interface UID : 316
Interface UUID : 9435fb09-7615-4c40-a01e-c33373a402e9
Mode
Basic
Availability
Autonomous Edge, Edge
Display detailed information of an IPv4 route in RIB. Specify a prefix or IPv4 address to display only the route used for that network.
| Option | Description |
|---|---|
| <prefix> | Prefix or IP address with optional prefix length |
Example
nsx-edge-1(tier0_sr)> get route 22.3.3.0/24
Flags: t0c - Tier0-Connected, t0s - Tier0-Static, b - BGP,
t0n - Tier0-NAT, t1s - Tier1-Static, t1c - Tier1-Connected,
t1n: Tier1-NAT, t1l: Tier1-LB VIP, t1ls: Tier1-LB SNAT,
t1d: Tier1-DNS FORWARDER, > - selected route, * - FIB route
Total number of routes: 1
t0s> * 22.3.3.0/24 [103/0] via 50.50.50.10, uplink-273, 00:49:52
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display detailed information of an IPv6 route in RIB. Specify a prefix or IPv6 address to display only the route used for that network.
| Option | Description |
|---|---|
| <prefix> | IPv6 Prefix or IPv6 address with optional prefix length |
Example
nsx-edge-1(tier0_sr)> get route 2005::/64
Flags: t0c - Tier0-Connected, t0s - Tier0-Static, b - BGP,
t0n - Tier0-NAT, t1s - Tier1-Static, t1c - Tier1-Connected,
t1n: Tier1-NAT, t1l: Tier1-LB VIP, t1ls: Tier1-LB SNAT,
t1d: Tier1-DNS FORWARDER, > - selected route, * - FIB route
Total number of routes: 1
t0c> * 2005::/64 is directly connected, uplink-273, 00:52:46
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display IPv4 BGP routes for a specified prefix in RIB.
| Option | Description |
|---|---|
| <prefix> | Network Address argument |
Example
nsx-edge-1(tier0_sr)> get route bgp 2.1.0.0/16
Flags: t0c - Tier0-Connected, t0s - Tier0-Static, b - BGP,
t0n - Tier0-NAT, t1s - Tier1-Static, t1c - Tier1-Connected,
t1n: Tier1-NAT, t1l: Tier1-LB VIP, t1ls: Tier1-LB SNAT,
t1d: Tier1-DNS FORWARDER, > - selected route, * - FIB route
Total number of routes: 2
b > * 2.1.4.0/24 [20/0] via 40.40.40.10, uplink-276, 21:12:29
b > * 2.1.5.0/24 [20/0] via 90.90.90.10, uplink-282, 21:12:10
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display IPv4 Connected routes for a specified prefix in RIB.
| Option | Description |
|---|---|
| <prefix> | Network Address argument |
Example
nsx-edge-1(tier0_sr)> get route connected 1.0.0.0/8
Flags: t0c - Tier0-Connected, t0s - Tier0-Static, b - BGP,
t0n - Tier0-NAT, t1s - Tier1-Static, t1c - Tier1-Connected,
t1n: Tier1-NAT, t1l: Tier1-LB VIP, t1ls: Tier1-LB SNAT,
t1d: Tier1-DNS FORWARDER, > - selected route, * - FIB route
Total number of routes: 2
t0c> * 1.1.3.0/24 is directly connected, downlink-294, 21:17:14
t0c> * 1.2.3.0/24 is directly connected, downlink-297, 21:17:04
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display all OSPF routes in RIB.
Example
nsx-edge-1(tier0_sr)> get ospf route
Flags: t0c - Tier0-Connected, t0s - Tier0-Static, o - OSPF,
t0n - Tier0-NAT, t1s - Tier1-Static, t1c - Tier1-Connected,
t1n: Tier1-NAT, t1l: Tier1-LB VIP, t1ls: Tier1-LB SNAT,
t1d: Tier1-DNS FORWARDER, > - selected route, * - FIB route
Total number of routes: 2
o > * 10.92.0.0/19 [110/20] via 40.40.40.10, uplink-275, 00:00:20
o 40.40.40.0/24 is directly connected, uplink-275, 00:00:22
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display IPv4 OSPF routes for a specified prefix in RIB.
| Option | Description |
|---|---|
| <prefix> | Network Address argument |
Example
Edge-1(tier0_sr)> get route ospf 2.1.8.0/24
Flags: t0c - Tier0-Connected, t0s - Tier0-Static, b - BGP, o - OSPF
t0n - Tier0-NAT, t1s - Tier1-Static, t1c - Tier1-Connected,
t1n: Tier1-NAT, t1l: Tier1-LB VIP, t1ls: Tier1-LB SNAT,
t1d: Tier1-DNS FORWARDER, t1ipsec: Tier1-IPSec, isr: Inter-SR,
> - selected route, * - FIB route
Total number of routes: 1
o > * 2.1.8.0/24 [110/20] via 40.40.40.10, uplink-292, 00:06:45
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display the specified IPv4 route or IPv6 routes for the prefix.
| Option | Description |
|---|---|
| <prefix-ipv46> | CIDR notation argument for IPv4/IPv6 address |
Example
nsx> get route prefix 192.168.110.0/24
192.168.110.0/24 interface eth0
or
nsx> get route prefix fd01:0:106:10::/64
fd01:0:106:8::/64 interface eth0 metric 256
fd01:0:106:8::/64 gateway fe80::106:8:1 interface eth0 metric 512
Mode
Basic
Availability
Autonomous Edge, Edge
Display specific IPv4 or IPv6 routes for the prefix.
| Option | Description |
|---|---|
| <prefix-ipv46> | CIDR notation argument for IPv4/IPv6 address |
Example
nsx> get route prefix 192.168.110.0/24
192.168.110.0/24 interface eth0
or
nsx> get route prefix fd01:0:106:10::/64
fd01:0:106:8::/64 interface eth0 metric 256
fd01:0:106:8::/64 gateway fe80::106:8:1 interface eth0 metric 512
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
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
| Option | Description |
|---|---|
| <prefix> | Network Address argument |
Example
nsx-edge-1(tier0_sr)> get route static 1.1.0.0/16
Flags: t0c - Tier0-Connected, t0s - Tier0-Static, b - BGP,
t0n - Tier0-NAT, t1s - Tier1-Static, t1c - Tier1-Connected,
t1n: Tier1-NAT, t1l: Tier1-LB VIP, t1ls: Tier1-LB SNAT,
t1d: Tier1-DNS FORWARDER, > - selected route, * - FIB route
Total number of routes: 2
t1c> * 1.1.2.0/24 [3/0] via 100.64.1.1, downlink-298, 21:10:43
t1c> * 1.1.1.0/25 [3/0] via 100.64.1.1, downlink-298, 21:10:43
Mode
Tier0_sr
Availability
Autonomous Edge, Edge
Display routes across Tier0 and all its associated VRFs.
| Option | Description |
|---|---|
| <ip-version> | Internet Protocol Version (IPV4 or IPV6) Allowed values: ipv4, ipv6 |
Example
nsx-edge-1> get route vrf all ipv4
Flags: t0c - Tier0-Connected, t0s - Tier0-Static, b - BGP, o - OSPF
t0n - Tier0-NAT, t1s - Tier1-Static, t1c - Tier1-Connected,
t1n: Tier1-NAT, t1l: Tier1-LB VIP, t1ls: Tier1-LB SNAT,
t1d: Tier1-DNS FORWARDER, t1ipsec: Tier1-IPSec, isr: Inter-SR,
> - selected route, * - FIB route
Total number of routes: 12
t0s> * 10.10.10.0/24 unreachable (blackhole), VRF-3, 01w0d00h
t0c> * 169.0.0.0/24 is directly connected, downlink-299, VRF-3, 01w0d00h
t0c> * 100.64.1.0/31 is directly connected, linked-279, default, 01w0d00h
t0c> * 169.0.0.0/25 is directly connected, downlink-275, default, 01w0d00h
t1c> * 192.168.1.0/24 [3/0] via 100.64.1.1, linked-279, default, 01w0d00h
t1c> * 192.168.2.0/24 [3/0] via 100.64.1.1, linked-279, default, 01w0d00h
t0c> * 192.168.50.0/24 is directly connected, uplink-276, default, 01w0d00h
t0c> * 169.0.0.128/25 is directly connected, inter-sr-277, inter_sr_vrf, 01w0d00h
b > * 192.168.1.0/24 [200/0] via 100.64.1.1, linked-279, inter_sr_vrf, 01w0d00h
b > * 192.168.2.0/24 [200/0] via 100.64.1.1, linked-279, inter_sr_vrf, 01w0d00h
isr> * 192.168.50.0/24 is directly connected, uplink-276, inter_sr_vrf, 01w0d00h
isr> * 192.168.50.1/32 is directly connected, uplink-276, inter_sr_vrf, 01w0d00h
Mode
Basic
Availability
Autonomous Edge, Edge
Display all IPv4 and IPv6 routes of shadow_vrf Specify vrf_id to display all routes in the shadow_vrf corresponding to the vrf_id
| Option | Description |
|---|---|
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
Example
nsx-edge-1(inter_sr_vrf)> get route vrfid 7
Flags: t0c - Tier0-Connected, t0s - Tier0-Static, b - BGP, o - OSPF
t0n - Tier0-NAT, t1s - Tier1-Static, t1c - Tier1-Connected,
t1n: Tier1-NAT, t1l: Tier1-LB VIP, t1ls: Tier1-LB SNAT,
t1d: Tier1-DNS FORWARDER, t1ipsec: Tier1-IPSec, isr: Inter-SR,
ivs: Inter-VRF-Static, > - selected route, * - FIB route
Total number of routes: 14
isr> * 40.40.40.0/24 is directly connected, uplink-282, 00:33:46
isr> * 40.40.40.1/32 is directly connected, uplink-282, 00:33:46
isr> * 90.90.90.0/24 is directly connected, uplink-297, 00:33:46
isr> * 90.90.90.2/32 is directly connected, uplink-297, 00:33:46
isr> * 2009::/64 is directly connected, uplink-282, 00:33:46
isr> * 2009::1/128 is directly connected, uplink-282, 00:33:46
isr> * 2009::250:56ff:feb7:b556/128 is directly connected, uplink-282, 00:33:46
isr> * 2010::/64 is directly connected, uplink-297, 00:33:46
isr> * 2010::1/128 is directly connected, uplink-297, 00:33:46
isr> * 2010::250:56ff:feb7:a0df/128 is directly connected, uplink-297, 00:33:46
isr> * fe80::250:56ff:feb7:a0df/128 is directly connected, uplink-297, 00:33:46
isr> * fe80::250:56ff:feb7:b556/128 is directly connected, uplink-282, 00:33:46
Mode
Availability
Autonomous Edge, Edge
Display all configured IPv4 routes.
Example
nsx> get routes
0.0.0.0/0 gateway 192.168.110.1 interface eth0
192.168.110.0/24 interface eth0
Mode
Basic
Availability
Autonomous Edge, Edge
Display all configured IPv4 and IPv6 routes.
Example
nsx> get routes
0.0.0.0/0 gateway 10.78.239.254 interface eth0
10.78.224.0/20 interface eth0
fd01:0:106:8::/64 interface eth0 metric 256
fd01:0:106:8::/64 gateway fe80::106:8:1 interface eth0 metric 512
fe80::/64 interface eth0 metric 256
::/0 gateway fe80::106:8:1 interface eth0 metric 1024
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Display all configured IPv4 or IPv6 routes.
| Option | Description |
|---|---|
| <ip-address-type> | IP address type argument Allowed values: ipv4, ipv6 |
Example
nsx> get routes ipv4
0.0.0.0/0 gateway 10.78.239.254 interface eth0
10.78.224.0/20 interface eth0
or
nsx> get routes ipv6
fd01:0:106:8::/64 interface eth0 metric 256
fd01:0:106:8::/64 gateway fe80::106:8:1 interface eth0 metric 512
fe80::/64 interface eth0 metric 256
::/0 gateway fe80::106:8:1 interface eth0 metric 1024
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Display information about the specified routing domain.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge> get routing-domain b16a3ce5-e61d-43b4-b45b-66d29c8d3cf0
Routing Domain
UUID : b16a3ce5-e61d-43b4-b45b-66d29c8d3cf0
Name : SR-Tier0-LR-1
Type : SERVICE_ROUTER_TIER0
Replication Tunnels
Tunnel : 1e44a970-86e0-5a76-9e4f-ecc676b45148
IFUID : 264
Local : 200.200.200.3
Remote : 200.200.200.4
ENCAP : GENEVE
MTEP : False
Tunnel : 7305d7f1-3e84-5df6-9fdb-e29e76148542
IFUID : 273
Local : 200.200.200.3
Remote : 200.200.200.2
ENCAP : GENEVE
MTEP : False
Mode
Basic
Availability
Autonomous Edge, Edge
Display mtep information about the specified routing domain.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge> get routing-domain b16a3ce5-e61d-43b4-b45b-66d29c8d3cf0 mtep
Routing Domain
UUID : b16a3ce5-e61d-43b4-b45b-66d29c8d3cf0
Name : SR-Tier0-LR-1
Type : SERVICE_ROUTER_TIER0
MTEP Replication Tunnels
Tunnel : 1e44a970-86e0-5a76-9e4f-ecc676b45148
IFUID : 264
Local : 200.200.200.3
Remote : 200.200.200.4
ENCAP : GENEVE
MTEP : True
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about the specified routing domain.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
kvm-1> get routing-domain e168bb77-80f2-4cd5-8731-86025e095a78
Desired State:
Routing Domain
UUID : e168bb77-80f2-4cd5-8731-86025e095a78
Realized State:
Routing Domain
UUID : e168bb77-80f2-4cd5-8731-86025e095a78
Replication Tunnels
Tunnel : "geneve3232264035"
ENCAP : GENEVE
Local : 192.168.111.124
Local-subnet: /192.168.111.0
Remote : 192.168.111.99
Remote-subnet: /192.168.111.0
Tunnel : "geneve3232264080"
ENCAP : GENEVE
Local : 192.168.111.124
Local-subnet: /192.168.111.0
Remote : 192.168.111.144
Remote-subnet: /192.168.111.0
or
esx-1> get routing-domain e168bb77-80f2-4cd5-8731-86025e095a78
Realized State:
Routing Domain
UUID : e168bb77-80f2-4cd5-8731-86025e095a78
Replication Tunnels
ENCAP : GENEVE
Local : 192.168.111.124
Local-subnet: /192.168.111.0
Remote : 192.168.111.99
Remote-subnet: /192.168.111.0
ENCAP : GENEVE
Local : 192.168.111.124
Local-subnet: /192.168.111.0
Remote : 192.168.111.144
Remote-subnet: /192.168.111.0
Mode
Basic
Availability
ESXi, KVM
Display information about all logical switches in a routing domains.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get routing-domain 736d48d0-116b-4c98-9cbc-d6ca726e4c67 logical-switches-from-app
['e6256612-e93e-44e0-b605-0ca756892c41', '8a0305b6-d638-4232-82ca-05f4ebbaeea0', 'a7fe51be-6eb6-455b-9318-84f51716b199']
Mode
Basic
Availability
Manager
Display information about all logical switches in a routing domains.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get routing-domain 736d48d0-116b-4c98-9cbc-d6ca726e4c67 logical-switches
['e6256612-e93e-44e0-b605-0ca756892c41', '8a0305b6-d638-4232-82ca-05f4ebbaeea0', 'a7fe51be-6eb6-455b-9318-84f51716b199']
Mode
Basic
Availability
Manager
Display information about all logical switches in a routing domains.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get routing-domain 00000000-0000-0000-0000-000000000000 stats
RoutingDomainFibMsg.vtep.update 2
RoutingDomainFibMsg.vtep.remove 0
RoutingDomainFibMsg.vtep.message.size 0
Mode
Basic
Availability
Manager
Display information about all routing domains.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get routing-domain 857212c6-3d87-4a4a-9700-0c9d23f74f1c vtep
Routing-Domain-ID IP LABEL Segment MAC TransportNodeId
857212c6-3d87-4a4a-9700-0c9d23f74f1c 192.168.250.163 0x18801 192.168.250.0 04:00:c0:a8:fa:a3 857212c6-3d87-4a4a-9700-0c9d23f74f1c
99999999-3d87-4a4a-9700-0c9d23f74f1c 192.168.250.162 0xC801 192.168.250.0 04:00:c0:a8:fa:a2 857212c6-3d87-4a4a-9700-0c9d23f74f1d
Mode
Basic
Availability
Manager
Display information about all routing domains.
Example
kvm-1> get routing-domains
Desired State:
Routing Domain
UUID : e168bb77-80f2-4cd5-8731-86025e095a78
Realized State:
Routing Domain
UUID : e168bb77-80f2-4cd5-8731-86025e095a78
Replication Tunnels
Tunnel : "geneve3232264035"
ENCAP : GENEVE
Local : 192.168.111.124
Local-subnet: /192.168.111.0
Remote : 192.168.111.99
Remote-subnet: /192.168.111.0
Tunnel : "geneve3232264080"
ENCAP : GENEVE
Local : 192.168.111.124
Local-subnet: /192.168.111.0
Remote : 192.168.111.144
Remote-subnet: /192.168.111.0
or
esx-1> get routing-domains
Desired State:
Routing Domain
UUID : e168bb77-80f2-4cd5-8731-86025e095a78
Realized State:
Routing Domain
UUID : e168bb77-80f2-4cd5-8731-86025e095a78
Replication Tunnels
ENCAP : GENEVE
Local : 192.168.111.124
Local-subnet: /192.168.111.0
Remote : 192.168.111.99
Remote-subnet: /192.168.111.0
ENCAP : GENEVE
Local : 192.168.111.124
Local-subnet: /192.168.111.0
Remote : 192.168.111.144
Remote-subnet: /192.168.111.0
or
nsx-edge> get routing-domain
Routing Domain
UUID : b16a3ce5-e61d-43b4-b45b-66d29c8d3cf0
Name : SR-Tier0-LR-1
Type : SERVICE_ROUTER_TIER0
Replication Tunnels
Tunnel : 1e44a970-86e0-5a76-9e4f-ecc676b45148
IFUID : 264
Local : 200.200.200.3
Remote : 200.200.200.4
ENCAP : GENEVE
MTEP : False
Tunnel : 7305d7f1-3e84-5df6-9fdb-e29e76148542
IFUID : 273
Local : 200.200.200.3
Remote : 200.200.200.2
ENCAP : GENEVE
MTEP : False
Routing Domain
UUID : bca731e7-171e-4ca0-82c2-2df4974a44a7
Name : DR-Tier0-LR-AA
Type : DISTRIBUTED_ROUTER_TIER0
Replication Tunnels
Tunnel : 1e44a970-86e0-5a76-9e4f-ecc676b45148
IFUID : 264
Local : 200.200.200.3
Remote : 200.200.200.4
ENCAP : GENEVE
MTEP : False
Tunnel : 7305d7f1-3e84-5df6-9fdb-e29e76148542
IFUID : 273
Local : 200.200.200.3
Remote : 200.200.200.2
ENCAP : GENEVE
MTEP : False
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Display mtep information about all routing domains.
Example
nsx-edge> get routing-domains mtep
Routing Domain
UUID : b16a3ce5-e61d-43b4-b45b-66d29c8d3cf0
Name : SR-Tier0-LR-1
Type : SERVICE_ROUTER_TIER0
MTEP Replication Tunnels
Tunnel : 1e44a970-86e0-5a76-9e4f-ecc676b45148
IFUID : 264
Local : 200.200.200.3
Remote : 200.200.200.4
ENCAP : GENEVE
MTEP : True
Routing Domain
UUID : bca731e7-171e-4ca0-82c2-2df4974a44a7
Name : DR-Tier0-LR-AA
Type : DISTRIBUTED_ROUTER_TIER0
MTEP Replication Tunnels
Tunnel : 7305d7f1-3e84-5df6-9fdb-e29e76148542
IFUID : 273
Local : 200.200.200.3
Remote : 200.200.200.2
ENCAP : GENEVE
MTEP : True
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about all routing domains.
Example
nsx-controller-1> get routing-domains-from-app
Desired State:
Routing-Domain
c31126b8-be8d-49a5-a7ab-d7c13f6013eb
857212c6-3d87-4a4a-9700-0c9d23f74f1c
Mode
Basic
Availability
Manager
Display information about all routing domains.
Example
nsx-controller-1> get routing-domains-from-pigeon
Desired State:
Routing-Domain
c31126b8-be8d-49a5-a7ab-d7c13f6013eb
857212c6-3d87-4a4a-9700-0c9d23f74f1c
Mode
Basic
Availability
Manager
Display information about a RTEP group.
| Option | Description |
|---|---|
| <rtep-group-id> | RTEP Group ID |
Example
nsx-edge-1> get rtep-group 3184064
Remote RTEP Group : 3184064
Member IP : 20.1.1.12
Member State : Active
Member IP : 20.1.1.13
Member State : Standby
Mode
Basic
Availability
Autonomous Edge, Edge
Display stats about a RTEP group.
| Option | Description |
|---|---|
| <rtep-group-id> | RTEP Group ID |
Example
nsx-edge-1> get rtep-group 5449926 stats
Remote RTEP Group : 5449926
RX-Packets : 126518
RX-Bytes : 9577454
RX-Drops : 0
Malformed : 0
No-Match : 0
L2-Loop : 0
Blocked : 0
RA-Guard : 0
TX-Packets : 126182
TX-Bytes : 9559833
TX-Drops : 0
No-Memory : 0
No-Route : 0
No-Next-Hop : 0
Blocked : 0
Frag-Needed : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about all RTEP groups
Example
nsx-edge-1> get rtep-groups
Local RTEP Group : 1120265
Member IP : 20.1.1.10
Member State : Active
Remote RTEP Group : 1120264
Member IP : 20.1.1.12
Member State : Active
Member IP : 20.1.1.13
Member State : Standby
Mode
Basic
Availability
Autonomous Edge, Edge
Display stats about all RTEP groups.
Example
nsx-edge-1> get rtep-groups stats
Remote RTEP Group : 5951810
RX-Packets : 0
RX-Bytes : 0
RX-Drops : 0
Malformed : 0
No-Match : 0
L2-Loop : 0
Blocked : 0
RA-Guard : 0
TX-Packets : 11
TX-Bytes : 462
TX-Drops : 0
No-Memory : 0
No-Route : 0
No-Next-Hop : 0
Blocked : 0
Frag-Needed : 0
Remote RTEP Group : 5449926
RX-Packets : 126518
RX-Bytes : 9577454
RX-Drops : 0
Malformed : 0
No-Match : 0
L2-Loop : 0
Blocked : 0
RA-Guard : 0
TX-Packets : 126182
TX-Bytes : 9559833
TX-Drops : 0
No-Memory : 0
No-Route : 0
No-Next-Hop : 0
Blocked : 0
Frag-Needed : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about all rtep tunnel endpoints.
Example
nsx-edge-1> get rteps
Remote RTEP IP : 10.10.10.10
Remote RTEP Label : 69635
Local RTEP IP : 10.10.10.11
Local RTEP Label : 69632
Remote RTEP IP : 10.10.10.12
Remote RTEP Label : 69634
Mode
Basic
Availability
Autonomous Edge, Edge
Display help information on runbook usage.
| Option | Description |
|---|---|
| <runbook-id> | Runbook ID |
Example
nsx > get runbook EdgeDpBfd help
Runbook ID : EdgeDpBfd
Descrption : Runbook to gather edge datapath BFD stats
Parameters
Name : src_ip
Title : This is source IP address of BFD session
Constraint :
Optional : False
Name : dst_ip
Title : This is destination IP address of BFD session
Constraint :
Optional : False
Name : capture
Title : (Optional) Enable/Disable session packet capture (Disabled by default)
Constraint :
Default : False
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, ESXi, KVM, Manager
Display information of available runbooks on the current node.
Example
nsx > get runbooks
Runbook ID Author Version Description
====================================================================================================================================
EdgeRouting VMware, Inc. 1.0 Runbook to diagnosis routing issues on LR
EdgeDpBfd VMware, Inc. 2.0 Runbook to gather edge datapath BFD stats
BgpNeighborState VMware, Inc. 1.0 Runbook to diagnose BGP neighbor state issues.
OspfNbrState VMware, Inc. 1.0 Runbook to debug OSPF Neighbor status
PimMrouteState VMware, Inc. 1.0 Runbook to diagnose multicast traffic loss issues.
PimConfigCheck VMware, Inc. 1.0 Runbook to diagnose multicast config failure issues.
EdgeIDPS VMware, Inc. 1.0 Runbook to check and retrieve stats for IDPS Signature from Edge
EdgeHealth VMware, Inc. 1.0 Runbook to check and diagnose edge health status.
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, ESXi, KVM, Manager
Get all domain names in the DNS search list.
Example
nsx> get search-domains
eng.example.com
corp.example.com
example.com
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display information about the specified segment.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get segment 857212c6-3d87-4a4a-9700-0c9d23f74f1c
Segment
UUID : 857212c6-3d87-4a4a-9700-0c9d23f74f1c
Name : LS1-0681-LS
VNI : 5000
ENCAP : GENEVE
Replication : mtep
Routing-domain: 00000007-0000-0000-0000-000000000000
Mode
Basic
Availability
Autonomous Edge, Edge
Display the l2forwarder for the specified segment.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get segment 78e32f70-074d-41e7-973e-612e919a7c00 l2forwarders
Segment
UUID : 78e32f70-074d-41e7-973e-612e919a7c00
VNI : 69634
Global VNI : 1930436
L2Forwarder State : up
TCN notification : non-active
Mode
Basic
Availability
Autonomous Edge, Edge
Display the mac address table for the specified segment.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get segment 857212c6-3d87-4a4a-9700-0c9d23f74f1c mac-address-table
Segment
UUID : 857212c6-3d87-4a4a-9700-0c9d23f74f1c
VNI : 5000
ENCAP : GENEVE
Replication : mtep
Routing-domain: 00000007-0000-0000-0000-000000000000
MAC-Table:
MAC : 00:50:56:8e:9a:a5
Tunnel : d87cd7e0-eb91-5dd5-bae4-ceb0a2760bfa
IFUID : 295
LOCAL : 192.168.250.162
REMOTE : 192.168.250.160
ENCAP : GENEVE
SOURCE : Static
MAC : 02:50:56:56:44:52
Port : bbe56ae2-0bc1-46c0-b334-a241e2a56193
IFUID : 280
SOURCE : Static
MAC : 00:50:56:8e:1b:21
Tunnel : 6598ab27-95c6-50ef-85b3-89b7811ab672
IFUID : 296
LOCAL : 192.168.250.162
REMOTE : 192.168.250.161
ENCAP : GENEVE
SOURCE : Static
MAC : 04:00:c0:a8:fa:a2
Port : bbe56ae2-0bc1-46c0-b334-a241e2a56193
IFUID : 280
SOURCE : Dynamic
Mode
Basic
Availability
Autonomous Edge, Edge
Display the ARP/NDP table for the specified segment.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get segment 857212c6-3d87-4a4a-9700-0c9d23f74f1c neighbor
Segment
UUID : 00000004-0000-0000-0000-000000000000
VNI : 1
ENCAP : GENEVE
Replication : source
Enable Hub : True
Neighbor
IP : 11.1.1.1
MAC : c2:81:09:00:00:11
IP : 11:1:1::1
MAC : c2:81:09:00:00:11
IP : fe80::c081:9ff:fe00:11
MAC : c2:81:09:00:00:11
Mode
Basic
Availability
Autonomous Edge, Edge
Display port information for the specified segment.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get segment 857212c6-3d87-4a4a-9700-0c9d23f74f1c ports
Segment
UUID : 857212c6-3d87-4a4a-9700-0c9d23f74f1c
VNI : 5000
ENCAP : GENEVE
Replication : mtep
Routing-domain: 00000007-0000-0000-0000-000000000000
Ports
Port : bbe56ae2-0bc1-46c0-b334-a241e2a56193
IFUID : 280
Peer : 70b21c84-cf3b-4fc3-a442-a941ba86ef48
Mode
Basic
Availability
Autonomous Edge, Edge
Display port statistics for the specified segment.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get segment 973b00a2-3be8-4e01-9824-3c6b7e2bf690 ports stats
Segment
UUID : 973b00a2-3be8-4e01-9824-3c6b7e2bf690
VLAN : 100
Device : fp-eth0
IFUID : 0
Ports
Port : 783a05cd-033d-4891-ad11-7c082641e069
RX-Packets : 8690
RX-Bytes : 587073
RX-Drops : 0
Malformed : 0
No-Match : 0
L2-Loop : 0
TX-Packets : 10188
TX-Bytes : 687181
TX-Drops : 0
No-Memory : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display remote rtep-group mac addresses for a segment.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get segment 8a036869-fd67-41f8-89de-85f2675d68c3 rtep-group-mac-address-table
Remote MAC-Table
MAC : 00:0c:29:ba:4c:f5
RTEP Group ID : 5281216
Mode
Basic
Availability
Autonomous Edge, Edge
Display remote rtep-group mac addresses.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <rtep-group-id> | RTEP Group ID |
Example
nsx-edge-1> get segment 8a036869-fd67-41f8-89de-85f2675d68c3 rtep-group-mac-address-table 5281216
Remote MAC-Table
MAC : 00:0c:29:ba:4c:f5
RTEP Group ID : 5281216
Mode
Basic
Availability
Autonomous Edge, Edge
Display remote rtep-groups for a segment
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get segment 8a036869-fd67-41f8-89de-85f2675d68c3 rtep-groups
Segment
UUID : 8a036869-fd67-41f8-89de-85f2675d68c3
Local RTEP Group
RTEP Group ID : 3643676
Members
Member IP : 172.20.10.11
Remote RTEP Groups
RTEP Group ID : 5740828
Members
Member IP : 172.20.10.20
Member State : active
Member IP : 172.20.10.21
Member State : down
Mode
Basic
Availability
Autonomous Edge, Edge
Display the tunnel information for the specified segment.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get segment 857212c6-3d87-4a4a-9700-0c9d23f74f1c tunnel-ports
Segment
UUID : 857212c6-3d87-4a4a-9700-0c9d23f74f1c
VNI : 5000
ENCAP : GENEVE
Replication : mtep
Routing-domain: 00000007-0000-0000-0000-000000000000
Tunnels
Tunnel : d87cd7e0-eb91-5dd5-bae4-ceb0a2760bfa
IFUID : 295
LOCAL : 192.168.250.162
REMOTE : 192.168.250.160
ENCAP : GENEVE
Tunnel : 6598ab27-95c6-50ef-85b3-89b7811ab672
IFUID : 296
LOCAL : 192.168.250.162
REMOTE : 192.168.250.161
ENCAP : GENEVE
Mode
Basic
Availability
Autonomous Edge, Edge
Display the tunnel endpoint table for the specified segment.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get segment 857212c6-3d87-4a4a-9700-0c9d23f74f1c vtep-table
Segment
UUID : 857212c6-3d87-4a4a-9700-0c9d23f74f1c
VNI : 5000
ENCAP : GENEVE
Replication : mtep
Routing-domain: 00000007-0000-0000-0000-000000000000
Replication Tunnels
Tunnel : d87cd7e0-eb91-5dd5-bae4-ceb0a2760bfa
IFUID : 295
LOCAL : 192.168.250.162
REMOTE : 192.168.250.160
ENCAP : GENEVE
TYPE : VTEP
MTEP : False
Tunnel : 6598ab27-95c6-50ef-85b3-89b7811ab672
IFUID : 296
LOCAL : 172.20.10.10
REMOTE : 172.20.10.20
ENCAP : GENEVE
TYPE : RTEP
MTEP : False
Mode
Basic
Availability
Autonomous Edge, Edge
Display L2Forwarder high-availability history of a segment
| Option | Description |
|---|---|
| <uuid> | UUID argument |
Example
nsx-edge-1> get segment 6e21f326-b6ef-4e7b-bbf9-d986807bab2b l2forwarder high-availability history state
State : Init
Event : Init
Time : 2019-04-15T18:33:09.954336
State : Down
Event : Init
Time : 2019-04-15T18:33:09.954378
State : Standby
Event : Device Up
Time : 2019-04-15T18:33:09.954534
State : Active
Event : Remote State Updated
Time : 2019-04-15T18:34:57.472649
Mode
Basic
Availability
Autonomous Edge, Edge
Display l2forwarder configuration and HA information of segment
| Option | Description |
|---|---|
| <uuid> | UUID argument |
Example
nsx-edge-1> get segment 60c8ee36-20f2-52c4-a844-964250480339 l2forwarders high-availability state
Segment UUID : 6a085ef9-f954-4af6-9f05-0182e12bcfa0
Segment Port UUID : e228bce3-ed8c-4a35-9b80-2b798175013c
Rank : 0
High Availability State : Down
Failover Mode : Non-preemptive
High Availability Mode : Active-Standby
VTEP Group ID : 71689
RTEP Group ID : 1120265
Service Router Cluster ID : 76c85110-b041-4e9f-a3e3-b54179a88ceb
Peer L2Forwarders
Node UUID : 3b34da96-ed06-11e8-9814-020063efb6dc
High Availability state : Active
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about the specified segment.
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
Example
kvm-1> get segment 0a8cb2ab-d15b-4b46-a6ee-0a1cd29be34d
Segment
=======================================================
UUID : 0a8cb2ab-d15b-4b46-a6ee-0a1cd29be34d
VNI/VLAN : 31624
Is VLAN backed : True
Replication mode: mtep
Controller IP : 192.168.110.51
Link status : Up
VIF count : 1
MAC entry count : 0
TEP entry count : 4
ARP entry count : 0
Mode
Basic
Availability
KVM, NSX Cloud VM
Display the ARP table for the specified segment.
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
Example
kvm-1> get segment 29576 arp-table
Segment ARP Table
==================================================
IP MAC
10.144.13.29 00:01:02:03:42:11
Mode
Basic
Availability
KVM, NSX Cloud VM
Display the MAC table for the specified segment.
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
Example
kvm-1> get segment 29576 mac-table
Segment MAC Table
============================================================
MAC VTEP Label
00:01:02:00:00:03 124928
00:01:02:00:00:04 124928
Mode
Basic
Availability
KVM, NSX Cloud VM
Display ports on the specified segment.
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
Example
kvm-1> get segment 0a8cb2ab-d15b-4b46-a6ee-0a1cd29be34d ports
Segments Ports
============================================================
Port UUID : 59d3da36-d5f8-43d0-bca0-ae98c593861c
Status : up
VIF UUID : 57601300-2e82-48c4-8c27-1e961ac70e81
Snoop Mode : dhcp
============================================================
Mode
Basic
Availability
KVM, NSX Cloud VM
Display the VTEP table for the specified segment.
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
Example
kvm-1> get segment 0a8cb2ab-d15b-4b46-a6ee-0a1cd29be34d vtep
Segment VTEP Table
==============================
Label VTEP IP
114689 192.168.140.154
2049 192.168.140.153
102401 192.168.150.151
79873 192.168.150.152
Mode
Basic
Availability
KVM, NSX Cloud VM
Display information about the specified segment.
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get segment bf543c67-3ffe-44dd-a1d3-57e7cd2e0aff
Segment
-----------------------------------------------------------------
Host Kernel Entry
==================================================
DVS name : nsxvswitch
VNI : 11145
Multicast IP : 0.0.0.1
Multicast proxy enable : True
ARP proxy enable : True
VPC Subnet access mode : Public
CP connection up : True
Controller IP : 192.168.110.108
MAC entry count : 2
ARP entry count : 0
VIF entry count : 2
MTEP entry count : 0
Routing Domain : af2dddc6-80e5-449a-b582-f2f64b717080
Multicast Routing Domain : af2dddc6-80e5-449a-b582-f2f64b717080
LCP Entry
=================================================================
Segment Name : bf543c67-3ffe-44dd-a1d3-57e7cd2e0aff
VNI : 11145
Replication mode : unicast mtep
Transport binding : None
Vlan ID : None
Admin state up : True
VPC Subnet access mode : Public
esx-1> get segment 7f386f4b-cbd5-42cc-81c9-95de3d34b29a
Segment
-----------------------------------------------------------------
Segment UUID : 7f386f4b-cbd5-42cc-81c9-95de3d34b29a
VLAN ID : 4087
esx-1> get segment e5e5ff09-99a9-4cc6-9a6f-349776472cb9
Segment
-----------------------------------------------------------------
Segment UUID : e5e5ff09-99a9-4cc6-9a6f-349776472cb9
VLAN RANGES : 1050-1500, 1550-2000, 2050-2500, 2550-3000
Mode
Basic
Availability
ESXi
Display the ARP table for the specified segment.
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get segment bf543c67-3ffe-44dd-a1d3-57e7cd2e0aff arp-table
Segment ARP Table
--------------------------------------------------
Host Kernel Entry
==================================================
IP MAC Flags
LCP Entry
==================================================
IP MAC
172.16.110.11 00:50:56:8e:91:12
172.16.110.12 00:0c:29:4d:09:19
Mode
Basic
Availability
ESXi
Display all the counters for the specified segment.
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get segment 66560 datapath-stats all
Datapath Observability All Counters
--------------------------------------------------
Module : VDRB
==================================================
COUNTER NAME COUNTERS
vdr-leafIn1 300
vdr-leafIn2 400
vdr-leafInDrop1 500
vdr-leafInDrop2 600
Module : VDL2
==================================================
COUNTER NAME COUNTERS
vdl2-leafIn1 300
vdl2-leafIn2 400
vdl2-leafInDrop1 500
vdl2-leafInDrop2 600
Mode
Basic
Availability
ESXi
Display all counters for the specified segment.
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get segment 74752 datapath-stats all new
Datapath Observability New All Counters
--------------------------------------------------------------------------------------------------------------
Module : nsxt-vdl2
==============================================================================================================
COUNTER NAME COUNTERS RATE(pkts or bytes /sec) DURATION(HH:MM:SS)
leafRx 11243 19.27 00:09:43.368077
leafTx 11247 19.28 00:09:43.368077
uplinkRx 0 0.0 00:09:43.368077
uplinkRxSkipMACLearn 0 0.0 00:09:43.368077
uplinkRxMcastInvalidDRUplinkDrops 0 0.0 00:09:43.368077
uplinkTx 1 0.0 00:09:43.368077
uplinkTxIgnore 1 0.0 00:09:43.368077
..........
Mode
Basic
Availability
ESXi
Display all drop counters of all modules for the specified segment.
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get segment 66560 datapath-stats drops
Datapath Observability Drop Counters
----------------------------------------------------------
Module : VDRB
==========================================================
COUNTER NAME COUNTERS
vdr-leafInDrop1 300
vdr-leafInDrop2 400
Module : VDL2
==========================================================
COUNTER NAME COUNTERS
vdl2-leafInDrop1 300
vdl2-leafInDrop2 400
Mode
Basic
Availability
ESXi
Display new drop counters of all modules for the specified segment.
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get segment 74752 datapath-stats drops new
Datapath Observability New Drop Counters
--------------------------------------------------------------------------------------------------------------
Module : nsxt-vdl2
==============================================================================================================
COUNTER NAME COUNTERS RATE(pkts or bytes /sec) DURATION(HH:MM:SS)
leafTxDrops 0 0.0 00:05:15.791268
leafRxSystemErrDrops 0 0.0 00:05:15.791268
leafRxRefPortNotFoundDrops 0 0.0 00:05:15.791268
leafRxDrops 0 0.0 00:05:15.791268
uplinkRxWrongDestDrops 0 0.0 00:05:15.791268
uplinkRxGuestVlanDrops 0 0.0 00:05:15.791268
uplinkRxSystemErrDrops 0 0.0 00:05:15.791268
uplinkRxDrops 0 0.0 00:05:15.791268
.....
Mode
Basic
Availability
ESXi
Display all the counters for the specified segment and module.
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get segment 66560 datapath-stats module nsx-vdl2 all
Datapath Observability All Counters
--------------------------------------------------
COUNTER NAME COUNTERS
vdl2-leafIn1 300
vdl2-leafIn2 400
vdl2-leafInDrop1 500
vdl2-leafInDrop2 600
Mode
Basic
Availability
ESXi
Display all new counters for the specified segment and module.
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get segment 74752 datapath-stats module nsxt-vdl2 all new
Datapath Observability New All Counters
--------------------------------------------------------------------------------------------------------------
COUNTER NAME COUNTERS RATE(pkts or bytes /sec) DURATION(HH:MM:SS)
leafRx 4611 19.3 00:03:58.885550
leafTx 4612 19.31 00:03:58.885550
uplinkRx 0 0.0 00:03:58.885550
uplinkRxSkipMACLearn 0 0.0 00:03:58.885550
uplinkRxMcastInvalidDRUplinkDrops 0 0.0 00:03:58.885550
uplinkTx 1 0.0 00:03:58.885550
uplinkTxIgnore 1 0.0 00:03:58.885550
......
Mode
Basic
Availability
ESXi
Display drop counters for the specified segment and module.
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get segment 66560 datapath-stats module nsxt-vdrb drops
Datapath Observability Drop Counters
---------------------------------------------------------------------------
COUNTER NAME COUNTERS
leafInDrop1 250
leafInDrop2 134
Mode
Basic
Availability
ESXi
Display new drop counters for the specified segment and module.
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get segment 74752 datapath-stats module nsxt-vdl2 drop new
Datapath Observability New Drop Counters
--------------------------------------------------------------------------------------------------------------
COUNTER NAME COUNTERS RATE(pkts or bytes /sec) DURATION(HH:MM:SS)
leafTxDrops 0 0.0 00:04:22.638803
leafRxSystemErrDrops 0 0.0 00:04:22.638803
leafRxRefPortNotFoundDrops 0 0.0 00:04:22.638803
leafRxDrops 0 0.0 00:04:22.638803
uplinkRxWrongDestDrops 0 0.0 00:04:22.638804
uplinkRxGuestVlanDrops 0 0.0 00:04:22.638803
.......
Mode
Basic
Availability
ESXi
Display the HW VTEP table for the specified segment.
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get segment bf543c67-3ffe-44dd-a1d3-57e7cd2e0aff hw-vtep-table
Segment HW VTEP Table
-----------------------------------------------------------------------------------------------
Host Kernel Entry
===============================================================================================
Label VTEP IP Subnet IP VTEP MAC
114689 192.168.250.60 192.168.250.0 02:50:56:00:00:00
40961 192.168.250.61 192.168.250.0 00:50:56:62:58:be
LCP Remote Entry
===============================================================================================
Label VTEP IP Subnet IP VTEP MAC DEVICE NAME
114689 192.168.250.60 192.168.250.0 02:50:56:00:00:00 None
40961 192.168.250.61 192.168.250.0 00:50:56:62:58:be None
LCP Local Entry
===============================================================================================
Label VTEP IP Subnet IP VTEP MAC DEVICE NAME
36865 192.168.250.62 192.168.250.0 00:50:56:69:ba:80 None
Mode
Basic
Availability
ESXi
Display the MAC table for the specified segment.
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get segment bf543c67-3ffe-44dd-a1d3-57e7cd2e0aff mac-table
Segment MAC Table
---------------------------------------------------------------------------
Host Kernel Entry
===========================================================================
Inner MAC Outer MAC Outer IP Flags
02:50:56:56:44:52 02:50:56:00:00:00 192.168.250.60 0xd
00:50:56:8e:3e:0b 00:50:56:62:58:be 192.168.250.61 0xf
LCP Remote Entry
===========================================================================
Inner MAC Outer MAC Outer IP
LCP Local Entry
===========================================================================
Inner MAC Outer MAC Outer IP
00:50:56:8e:91:12 00:50:56:69:ba:80 192.168.250.62
00:0c:29:4d:09:19 00:50:56:69:ba:80 192.168.250.62
Mode
Basic
Availability
ESXi
Display the ND table for the specified segment.
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get segment bf543c67-3ffe-44dd-a1d3-57e7cd2e0aff nd-table
Segment ND Table
---------------------------------------------------------------------------
Host Kernel Entry
===========================================================================
IP MAC Flags
2001:bd6::c:2957:201:51 00:0c:29:dc:80:b5 0x3
LCP Entry
===========================================================================
IP MAC
2001:bd6::c:2957:201:51 00:0c:29:dc:80:b5
2001:bd6::c:2957:192:212 00:0c:29:f8:cb:9f
fe80::20c:29ff:fedc:80b5 00:0c:29:dc:80:b5
fe80::20c:29ff:fef8:cb9f 00:0c:29:f8:cb:9f
Mode
Basic
Availability
ESXi
Display VTEP groups for the specified segment
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get segment bf543c67-3ffe-44dd-a1d3-57e7cd2e0aff vtep-group
VTEP Group Label: 1001
Type: Gateway
HA Type: Active/Standby
HA State Sync (ms): 18983125
Active Mbr: 0
Label: 1
VTEP IP: None
VTEP MAC: 00:50:56:62:17:2a
State: 1
BFD Count: 2
Mode
Basic
Availability
ESXi
Display the VTEP table for the specified segment.
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
Example
esx-1> get segment bf543c67-3ffe-44dd-a1d3-57e7cd2e0aff vtep-table
Segment VTEP Table
-----------------------------------------------------------------------------------------------
Host Kernel Entry
===============================================================================================
Label VTEP IP Subnet IP Is MTEP VTEP MAC BFD count
114689 192.168.250.60 192.168.250.0 False 02:50:56:00:00:00 1
40961 192.168.250.61 192.168.250.0 False 00:50:56:62:58:be 1
LCP Remote Entry
===============================================================================================
Label VTEP IP Subnet IP VTEP MAC DEVICE NAME
114689 192.168.250.60 192.168.250.0 02:50:56:00:00:00 None
40961 192.168.250.61 192.168.250.0 00:50:56:62:58:be None
LCP Local Entry
===============================================================================================
Label VTEP IP Subnet IP VTEP MAC DEVICE NAME
36865 192.168.250.62 192.168.250.0 00:50:56:69:ba:80 None
Mode
Basic
Availability
ESXi
Display port information for the specified segment.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get segment 857212c6-3d87-4a4a-9700-0c9d23f74f1c ports
SegmentPort-ID Segment-ID Child-UUID Child-EntityType TransportNode-ID
335bbfdc-d6d6-4d87-8fb1-b98614fff1d8 857212c6-3d87-4a4a-9700-0c9d23f74f1c c78a1655-228c-493b-88cf-6b77dafe908d VIF 857212c6-3d87-4a4a-9700-0c9d23f74f1c
593d2540-bb7b-4abe-ad78-8727ebd5c1d2 857212c6-3d87-4a4a-9700-0c9d23f74f1c null LOG_SWITCH 857212c6-3d87-4a4a-9700-0c9d23f74f1c
Mode
Basic
Availability
Manager
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.| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get segment 857212c6-3d87-4a4a-9700-0c9d23f74f1c
VNI UUID Name Type
5000 857212c6-3d87-4a4a-9700-0c9d23f74f1c ls-mtep DEFAULT
or
nsx-controller-1> get segment 5000
VNI UUID Name Type
5000 857212c6-3d87-4a4a-9700-0c9d23f74f1c ls-mtep DEFAULT
Mode
Basic
Availability
Manager
Display local ARP table for the specified segment.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get segment 857212c6-3d87-4a4a-9700-0c9d23f74f1c arp-table
VNI IP MAC TransportNode-ID
5000 172.16.130.12 00:50:56:8e:1b:21 857212c6-3d87-5d5d-9700-0c9d23f74f1d
Mode
Basic
Availability
Manager
Display the ARP table for the specified segment for both local and remote records.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get segment de73518d-26a0-4e9c-8356-ce97c49dc13e arp-table all
Local Records:
VNI IP MAC TransportNode-Id
5000 172.16.130.12 00:50:56:8e:1b:21 857212c6-3d87-5d5d-9700-0c9d23f74f1d
Remote Records:
VNI IP MAC Site-Id
5000 172.16.131.10 00:51:3c:8e:2a:18 957212c6-8a83-53cd-3701-0c8d23f74c1e
Mode
Basic
Availability
Manager
Display the ARP table for the specified segment for both local and remote records
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get segment de73518d-26a0-4e9c-8356-ce97c49dc13e arp-table all verbose
Local Records:
VNI IP MAC TransportNode-Id Timestamp TN-Connection
5000 172.16.130.12 00:50:56:8e:1b:21 857212c6-3d87-5d5d-9700-0c9d23f74f1d 2020-03-30 22:36:09 +0000 true
Remote Records:
VNI IP MAC Site-Id Timestamp
5000 172.16.131.10 00:51:3c:8e:2a:18 957212c6-8a83-53cd-3701-0c8d23f74c1e 2020-03-30 21:31:09 +0000
Mode
Basic
Availability
Manager
Display the ARP table for the specified segment for only remote records.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get segment 857212c6-3d87-4a4a-9700-0c9d23f74f1c arp-table remote
VNI IP MAC Site-Id
5000 172.16.130.12 00:50:56:8e:1b:21 857212c6-3d87-5d5d-9700-0c9d23f74f1d
Mode
Basic
Availability
Manager
Display the ARP table for the specified segment for only remote records.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get segment 857212c6-3d87-4a4a-9700-0c9d23f74f1c arp-table remote verbose
VNI IP MAC Site-Id Timestamp
5000 172.16.130.12 00:50:56:8e:1b:21 857212c6-3d87-5d5d-9700-0c9d23f74f1d 2020-03-30 22:36:09 +0000
Mode
Basic
Availability
Manager
Display local ARP table for the specified segment.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get segment 857212c6-3d87-4a4a-9700-0c9d23f74f1c arp-table verbose
VNI IP MAC TransportNode-Id Timestamp TN-Connection
5000 172.16.130.12 00:50:56:8e:1b:21 857212c6-3d87-5d5d-9700-0c9d23f74f1d 2020-03-30 22:36:09 +0000 true
Mode
Basic
Availability
Manager
Display local MAC address table for the specified Segment.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get segment 857212c6-3d87-4a4a-9700-0c9d23f74f1c mac-table
VNI MAC VTEP-IP TransportNodeId
5000 00:50:56:8e:1b:21 192.168.250.161 957612c6-4321-4a4a-9700-0c9d23f74f1c
5000 00:50:56:8e:9a:a5 192.168.250.160 857212c6-3d87-5d5d-9700-0c9d23f74f1d
Mode
Basic
Availability
Manager
Display the MAC address table for the specified segment for both local and remote mac records.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get segment 71680 mac-table all
Local Records:
VNI MAC VTEP-IP TransportNode-Id
71680 00:0c:29:8a:1d:c8 192.168.20.70 e27f2436-72d3-11ea-babf-b1f46b3dc4af
71680 00:0c:29:c6:84:b3 192.168.24.111 b9aea2c0-72d3-11ea-bbff-49b0b7f6d0fa
Remote Records:
VNI MAC VTEP-GROUP-ID RTEP-GROUP-ID SITE-ID
71680 00:0c:22:2b:c4:d1 35173 82351 7bde6dac-3c95-11ea-b7bc-25a8a2ecc338
Mode
Basic
Availability
Manager
Display the MAC address table for the specified segment for both local and remote records.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get segment 71680 mac-table all verbose
Local Records:
VNI MAC VTEP-IP TransportNode-Id Timestamp TN-Connection
71680 00:0c:29:8a:1d:c8 192.168.20.70 e27f2436-72d3-11ea-babf-b1f46b3dc4af 2020-03-30 22:36:09 +0000 true
71680 00:0c:29:c6:84:b3 192.168.24.111 b9aea2c0-72d3-11ea-bbff-49b0b7f6d0fa 2020-03-30 22:19:48 +0000 true
Remote Records:
VNI MAC VTEP-GROUP-ID RTEP-GROUP-ID SITE-ID Timestamp
67584 00:0c:29:3a:96:81 27834 56912 4edbef90-4d15-11ea-bc9e-579dbd0b1786 2020-02-11 21:39:57 +0000
Mode
Basic
Availability
Manager
Display the MAC address table for the specified Segment for only remote mac records.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get segment 857212c6-3d87-4a4a-9700-0c9d23f74f1c mac-table remote
VNI MAC VTEP-GROUP-ID RTEP-GROUP-ID SITE-ID
71680 00:0c:22:2b:c4:d1 235123 123232 7bde6dac-3c95-11ea-b7bc-25a8a2ecc338
71680 00:0c:29:8b:d4:a1 531231 231523 2b316da4-3d25-11ca-b4ba-15a8a2ecc338
Mode
Basic
Availability
Manager
Display the MAC address table for the specified segment for only remote records.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
get segment 67584 mac-table remote verbose
VNI MAC VTEP-GROUP-ID RTEP-GROUP-ID SITE-ID Timestamp
67584 00:0c:29:04:d3:eb -1 -1 79430382-4d15-11ea-a7f0-31115f864439 2020-02-11 21:53:41 +0000
67584 00:0c:29:3a:96:81 -1 -1 4edbef90-4d15-11ea-bc9e-579dbd0b1786 2020-02-11 21:39:57 +0000
Mode
Basic
Availability
Manager
Display local MAC address table for the specified segment.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get segment 71680 mac-table verbose
VNI MAC VTEP-IP TransportNode-ID Timestamp
71680 00:0c:29:8b:d4:d1 192.168.12.36 7b3e6dac-3c95-11ea-b7bd-15a8a2ecc338 2020-01-21 21:55:21 +0000
71680 00:0c:29:14:48:ec 192.168.20.99 486a38e6-3c95-11ea-b7fd-a90b61f7fe1e 2020-01-21 21:53:53 +0000
Mode
Basic
Availability
Manager
Display RTEP Group synced from remote site
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get segment 4315367d-ee17-4b86-b3d8-29deda88ec59 rtep-group
SITE-ID RTEP-GROUP-ID
1330fc51-370b-4d95-bafa-4885f69b16ae 28473
71b1460b-33ac-4e78-bcf9-cfc00953af29 15324
9bce4707-f951-45a7-a8fc-e3dd2174989e 73619
Mode
Basic
Availability
Manager
Display transport nodes which joined a given segment.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get segment 857212c6-3d87-4a4a-9700-0c9d23f74f1c transport-node-table
TransportNodeId
857212c6-3d87-4a4a-9700-0c9d23f74f1c
857212c6-3d87-3d3d-9700-0c9d23f74f1d
857212c6-3d87-5c5c-9700-0c9d23f74f1f
Mode
Basic
Availability
Manager
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.| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get segment 857212c6-3d87-4a4a-9700-0c9d23f74f1c verbose
VNI UUID SegmentPorts
5000 857212c6-3d87-4a4a-9700-0c9d23f74f1c 29c7254f-f148-46a2-be3d-bbf2707f7e66
837a565a-f88c-4979-a7f0-9955a365bb9
or
nsx-controller-1> get segment 5000 verbose
VNI UUID SegmentPorts
5000 857212c6-3d87-4a4a-9700-0c9d23f74f1c 29c7254f-f148-46a2-be3d-bbf2707f7e66
837a565a-f88c-4979-a7f0-9955a365bb9
Mode
Basic
Availability
Manager
Display all virtual tunnel end points related to the specified segment.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get segment 857212c6-3d87-4a4a-9700-0c9d23f74f1c vtep
VNI IP LABEL Segment MAC TransportNodeId
5000 192.168.250.163 0x18801 192.168.250.0 04:00:c0:a8:fa:a3 857212c6-3d87-4a4a-9700-0c9d23f74f1c
5000 192.168.250.162 0xC801 192.168.250.0 04:00:c0:a8:fa:a2 857212c6-3d87-4a4a-9700-0c9d23f74f1d
5000 192.168.250.161 0x3001 192.168.250.0 00:50:56:62:af:a4 857212c6-3d87-4a4a-9700-0c9d23f74f1e
5000 192.168.250.160 0xF001 192.168.250.0 00:50:56:67:4b:95 857212c6-3d87-4a4a-9700-0c9d23f74f1f
Mode
Basic
Availability
Manager
Display all virtual tunnel end points related to the specified segment.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Mode
Basic
Availability
Manager
Display port information for the specified segment.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get segment port bbe56ae2-0bc1-46c0-b334-a241e2a56193
Port : bbe56ae2-0bc1-46c0-b334-a241e2a56193
IFUID : 280
Segment: 857212c6-3d87-4a4a-9700-0c9d23f74f1c
Peer : 70b21c84-cf3b-4fc3-a442-a941ba86ef48
Mode
Basic
Availability
Autonomous Edge, Edge
Display statistics for the specified segment port.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get segment port 783a05cd-033d-4891-ad11-7c082641e069 stats
Port : 783a05cd-033d-4891-ad11-7c082641e069
RX-Packets : 4474
RX-Bytes : 302966
RX-Drops : 0
Malformed : 0
No-Match : 0
L2-Loop : 0
TX-Packets : 5527
TX-Bytes : 371568
TX-Drops : 0
No-Memory : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display ports for all segments.
Example
nsx-edge-1> get segment ports
Port : 18c26214-ab90-45ab-a2e0-78de070f9eb6
IFUID : 279
Peer : 8c4f10d5-9c4e-40a2-b239-e2eae7d39a33
Port : 271d49b0-f052-4c0c-a79f-44636229e471
IFUID : 264
Peer : a62432b5-68e7-4f95-a3f8-1b63ee4b102a
Port : 7bd1dd3d-97eb-5312-9d0d-b26c148a4fac
IFUID : 261
Peer : c2a03cab-3bad-56f3-b5ae-442ad6599bcf
Port : bbe56ae2-0bc1-46c0-b334-a241e2a56193
IFUID : 280
Peer : 70b21c84-cf3b-4fc3-a442-a941ba86ef48
Port : 58845bb9-19fc-4ec2-826f-bcbe871f99b5
IFUID : 282
Peer : e4be0c73-57bc-4b4f-b10c-f3f858ff8ccc
Port : 783a05cd-033d-4891-ad11-7c082641e069
IFUID : 276
Peer : aaec58d9-5dca-49c7-b39e-cdd8cd75901d
Port : 4ca7839f-2308-43f0-a799-f82d3911c134
IFUID : 287
Peer : 3fe772aa-8594-47cf-8a3e-20a26081ba15
Port : fe9c5ba9-3641-497f-ab95-046ffbc9356f
IFUID : 275
Peer : c7bbfc17-fbb9-4a39-a04b-0df93d788b57
Port : 1ff51f67-9ffb-446a-ae08-0a4a74adbf29
IFUID : 274
Peer : d37160fc-6e17-4c5c-8af1-54064c480798
Port : 286d2aad-ad4e-4ad6-b6c6-5256f38e9265
IFUID : 286
Peer : 6da71663-ce1a-4c2a-8557-ecfd85f031f5
Port : 93e656e1-0625-4ec2-b34c-98f2774bc8d3
IFUID : 281
Peer : 6c03a210-75b7-4a0d-8d66-cedf3c3f0750
Mode
Basic
Availability
Autonomous Edge, Edge
Display port statistics for all segments.
Example
nsx-edge-1> get segment ports stats
Port : 18c26214-ab90-45ab-a2e0-78de070f9eb6
RX-Packets : 11123
RX-Bytes : 1088318
RX-Drops : 0
Malformed : 0
No-Match : 0
L2-Loop : 0
TX-Packets : 11141
TX-Bytes : 1089386
TX-Drops : 0
No-Memory : 0
Port : 271d49b0-f052-4c0c-a79f-44636229e471
RX-Packets : 11141
RX-Bytes : 1089386
RX-Drops : 0
Malformed : 0
No-Match : 0
L2-Loop : 0
TX-Packets : 11123
TX-Bytes : 1088318
TX-Drops : 0
No-Memory : 0
Port : 7bd1dd3d-97eb-5312-9d0d-b26c148a4fac
RX-Packets : 285577
RX-Bytes : 11994234
RX-Drops : 0
Malformed : 0
No-Match : 0
L2-Loop : 0
TX-Packets : 0
TX-Bytes : 0
TX-Drops : 0
No-Memory : 0
.
.
.
Mode
Basic
Availability
Autonomous Edge, Edge
Display a specific segment's local or remote MAC, ARP, or VTEP information.
| Option | Description |
|---|---|
| <vni> | vni Allowed pattern: ^[0-9]+$ |
Example
ESXi-1> get segment local mac-cache 48008
VM MAC VTEP IP VTEP MAC
00:0c:29:67:4e:5c 192.168.90.55 00:50:56:6d:74:bf
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Display information about the specified segment port.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get segment-port 593d2540-bb7b-4abe-ad78-8727ebd5c1d2
SegmentPort-ID Segment-ID Child-UUID Child-EntityType TransportNode-ID
593d2540-bb7b-4abe-ad78-8727ebd5c1d2 857212c6-3d87-4a4a-9700-0c9d23f74f1c null LOG_SWITCH 857212c6-3d87-4a4a-9700-0c9d23f74f1c
Mode
Basic
Availability
Manager
Display the status for segment ports on this hypervisor host.
Example
esx-host-1> get segment-port status
Segment Port UUID Status DVSwitch ID Segment DVPort ID
fa1d9fcb-94cc-4a00-b499-8413f4dcef1e up 4adaf34e-6ee4-4153-844b-485a5e30627c 4adaf34e-6ee4-4153-844b-485a5e30627c
9c6a1a36-b468-404c-8084-bebfb91d5a31 up 65 bf 59 08 cd 4e 42 04-bf b5 93 de 83 ee ba 56 4adaf34e-6ee4-4153-844b-485a5e30627c 12345
Mode
Basic
Availability
ESXi
Display information about all segments.
Example
nsx-controller-1> get segments
VNI UUID
15240 c31126b8-be8d-49a5-a7ab-d7c13f6013eb
5000 857212c6-3d87-4a4a-9700-0c9d23f74f1c
7048 7943ca31-9c8a-402e-adeb-a83f5cf2455d
19336 041d0ce3-4a26-415c-af4b-8324fb0a54fd
11144 718f154a-c1d4-47b6-b692-11c615f91229
41864 9985fd0a-c361-4a82-94cb-de004ce82834
or
nsx-edge-1> get segments
Segment
UUID VLAN DEVICE NAME
22ff0f12-fdfe-4443-a741-68a97020bcb9 11 fp-eth1 ULS_PLR_SR1
e21d35f1-31bf-5c90-9aee-ca57f1cbb73d 10 fp-eth0
UUID VNI ENCAP DEVICE NAME GLOBAL_VNI(FED)
33b1040d-5550-4a12-8c6b-7738178da15d 73730 GENEVE fp-eth0 SERVER_TLR_DOWNLINK_SWITCH_500
01222040-d799-4cd6-9da3-c70b080b9ad2 73729 GENEVE fp-eth0 transit-bp-269fd0be-3e78-4531-a158-109221520922
d636774f-0965-471c-acb4-9dd2ae1fca23 73728 GENEVE fp-eth0 transit-rl-9206a4d9-21e0-454c-a4ff-f5a68785d1f8
0d6f3c26-4980-4d3e-b8b3-00f022a06054 73732 GENEVE fp-eth0 SERVER_TLR_DOWNLINK_SWITCH_501
c501a184-8155-442a-97e8-bce4e6004f04 73731 GENEVE fp-eth0 transit-bp-9206a4d9-21e0-454c-a4ff-f5a68785d1f8
Mode
Basic
Availability
Autonomous Edge, Edge, Manager
Display all segments on this host.
Example
kvm-1> get segments
Segment Summary
====================================================================
Segment UUID VNI/VLAN Port Count Name
16fa7892-df1b-4ffe-af87-3923efc8bdbe vni:64392 0 LS1
aacc41f2-7b32-4e0e-8679-6baff5bcbb64 vni:58248 0 LS2
da091cea-505c-4528-9b09-3f63efb8000d vni:54152 0 LS3
0a8cb2ab-d15b-4b46-a6ee-0a1cd29be34d vni:31624 1 LS4
d114f967-73aa-4dfc-8d59-a16de584b380 vni:52104 0 LS5
8b652ea8-86fe-4b03-9245-997fd2d7dfee vni:48008 0 LS6
or
esx-1> get segments
Segments Summary
------------------------------------------------------------
Overlay Kernel Entry
============================================================
VNI DVS name VIF num
69634 nsxvswitch 2
69636 nsxvswitch 2
69638 nsxvswitch 2
69640 nsxvswitch 1
69641 nsxvswitch 1
69642 nsxvswitch 1
Overlay LCP Entry
============================================================
VNI Segments UUID Name
69636 c7018373-71aa-4c34-916b-aa73db274fe8 22-segment-1112
69638 eb0a435e-fd24-4347-83df-4194fa011c55 21-segment-56
69641 4c969550-4a32-4747-8653-5162aab607ea transit-rl-d39a1cde-552b-4118-8e68-bd80ecebd6cc
69640 327ec38a-6f1a-4077-8bc1-30e356a1b5cf transit-bp-b2a097ea-c9eb-4a89-a043-72438f633e28
69634 f6b2b4fa-1cb5-40f9-9852-ae6184024bac 3-segment-1090
69642 3c73d8d2-16c5-4cff-a206-6b2c33d0ad39 transit-bp-d39a1cde-552b-4118-8e68-bd80ecebd6cc
VLAN Backed Entry
============================================================
Segments UUID VLAN ID
e5e5ff09-99a9-4cc6-9a6f-349776472cb9 1050-1500
1550-2000
2050-2500
2550-3000
7f386f4b-cbd5-42cc-81c9-95de3d34b29a 4087
Mode
Basic
Availability
ESXi, KVM
Display all segment associated with the VIF on this host.
Example
host-1> get logical-switches
Host Segment Summary
============================================================
Segment UUID VNI/VLAN Port Count
4e0f3312-d8c5-42b7-95a5-def111d14671 vni:41864 1
Mode
Basic
Availability
NSX Cloud VM
Display statistics information about the specified Segment.
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get segments 857212c6-3d87-4a4a-9700-0c9d23f74f1c stats
LogSegmentFibMsg.vtep.update 4
LogSegmentFibMsg.vtep.remove 4
LogSegmentFibMsg.vtep.size 4
LogSegmentFibMsg.mac.update 4
LogSegmentFibMsg.mac.remove 4
LogSegmentFibMsg.mac.size 4
LogSegmentFibMsg.ip.update 4
LogSegmentFibMsg.ip.remove 4
LogSegmentFibMsg.ip.size 4
Mode
Basic
Availability
Manager
get segments datapath-stats module <mod_name_arg_esx> counter <ctr_name_arg_esx> description verbose
Display specified counter's detailed description.
| Option | Description |
|---|---|
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
| <counter-name> | Observability counters for specified kernel module Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get segments datapath-stats module nsxt-vdl2 counter leafInDrop1 description verbose
Datapath Observability Counter Description
--------------------------------------------------
COUNTER NAME: leafInDrop2
VERBOSE DESCRIPTION:
Drop counters at leaf for reason2 verbose. This is
expected to be very big as like paragraphs.Thus,
let's test it by printing as much log msg as
possible. So this message is for a counter xxx.
This counter is incremented when the packets are
dropped since they are received with an incorrect
value for x.
Mode
Basic
Availability
ESXi
List all the counters with brief description for the specified module.
| Option | Description |
|---|---|
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get segments datapath-stats module nsxt-vdl2 counters list
Datapath Observability Counters List
------------------------------------------------------------
COUNTER_NAME BRIEF DESCRIPTION
leafInDrop1 drop counters at leaf for reason1
leafInDrop2 drop counters at leaf for reason2
leafIn1 counters at leaf for reason1
leafIn2 counters at leaf for reason2
Mode
Basic
Availability
ESXi
Display specified kernel module's detailed description.
| Option | Description |
|---|---|
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get logical-switches datapath-stats module nsxt-vdl2 description verbose
Datapath Observability Module Description
--------------------------------------------------
MODULE NAME: nsxt-vdr
VERBOSE DESCRIPTION:
Kernel module nsxt-vdr is responsible for any
layer-3 routing decisions.
Mode
Basic
Availability
ESXi
List all the observability enabled kernel modules.
Example
esx-1> get segments datapath-stats modules list
Kernel Modules List
------------------------------------------------------------
MODULE NAME BRIEF DESCRIPTION
nsxt-vdrb nsxt-vdrb-brief-desc
nsxt-vdl2 nsxt-vdl2-brief-desc
Mode
Basic
Availability
ESXi
Display a summary of all segment statistics.
Example
nsx-controller-1> get segments stats
LogSwitchFibMsg.vtep.update 40
LogSwitchFibMsg.vtep.remove 40
LogSwitchFibMsg.vtep.size 40
LogSwitchFibMsg.mac.update 40
LogSwitchFibMsg.mac.remove 40
LogSwitchFibMsg.mac.size 40
LogSwitchFibMsg.ip.update 40
LogSwitchFibMsg.ip.remove 40
LogSwitchFibMsg.ip.size 40
Mode
Basic
Availability
Manager
Display information about the specified service.
| Option | Description |
|---|---|
| <service-name> | Node service argument |
Example
nsx> get service snmp
Service name: snmp
Service state: running
Start on boot: True
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display global logging configuration.
Example
nsx-controller-1> get service controller logging-config
Name: LogLevel: debug
Name: BarrierSplitter LogLevel: debug
Name: BgpConfigSplitter LogLevel: debug
Name: BgpNeighborSplitter LogLevel: debug
Name: BridgeClusterSplitter LogLevel: debug
Name: CommunityListSplitter LogLevel: debug
Name: ContainerSplitter LogLevel: debug
Name: DependencyGraphSpanUpdaterImpl:DepGraph LogLevel: debug
Name: DependencyGraphSpanUpdaterImpl:SrcGraph LogLevel: debug
Name: DhcpIpPoolSplitter LogLevel: debug
Name: DhcpRelaySplitter LogLevel: debug
Name: DhcpStaticBindingSplitter LogLevel: debug
Name: DigraphSpanComputerImpl LogLevel: debug
Name: DneRuleSectionSplitter LogLevel: debug
Name: DneRuleSplitter LogLevel: debug
Name: FilterSpanSplitter LogLevel: debug
Name: GlobalRoutingSplitter LogLevel: debug
.
.
.
Mode
Basic
Availability
Manager
Display the logging configuration for components that have the specified log level.
| Option | Description |
|---|---|
| <level> | The controller service logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Example
nsx-controller-1> get service controller logging-config logging-level error
Name: BgpConfigSplitter LogLevel: error
Name: DhcpIpPoolSplitter LogLevel: error
Mode
Basic
Availability
Manager
Display the logging configuration for the specified component.
| Option | Description |
|---|---|
| <string> | String argument Allowed pattern: ^.*$ |
Example
nsx-controller-1> get service controller logging-config name BgpConfigSplitter
Name: BgpConfigSplitter LogLevel: debug
Mode
Basic
Availability
Manager
Display the logging configuration for components that match the specified pattern. The pattern can be a regular expression.
| Option | Description |
|---|---|
| <string> | String argument Allowed pattern: ^.*$ |
Example
nsx-controller-1> get service controller logging-config pattern Dhcp
Name: DhcpIpPoolSplitter LogLevel: debug
Name: DhcpRelaySplitter LogLevel: debug
Name: DhcpStaticBindingSplitter LogLevel: debug
Name: LogicalDhcpServerSplitter LogLevel: debug
Name: com.vmware.nsx.canary.span.DhcpIpPoolSpanner LogLevel: debug
Name: com.vmware.nsx.canary.span.DhcpStaticBindingSpanner LogLevel: debug
Name: com.vmware.nsx.canary.span.LogicalDhcpServerSpanner LogLevel: debug
Mode
Basic
Availability
Manager
Display the log level for the controller service.
Example
nsx-controller-1> get service controller logging-level
Logging level: debug
Mode
Basic
Availability
Manager
Display the log level of the dataplane service.
Example
nsx-edge-1> get service dataplane logging-level
Log level: INFO
Mode
Basic
Availability
Autonomous Edge, Edge
Display the log level of the dhcp service.
Example
nsx-edge-1> get service dhcp logging-level
Log level: INFO
Mode
Basic
Availability
Autonomous Edge, Edge
Display DHCP pool monitor configuration
Example
nsx-edge-1> get service dhcp pool-monitor
Monitor Flag : on
Monitor Interval : 60
Mode
Basic
Availability
Edge
Display IKE per tunnel debugging configuration
Example
nsx-edge-1> get service ike debug-tunnel
Local IP : 10.0.0.1
Remote IP : 10.1.0.1
Debug Level : midok
------------------------------
Local IP : 10.0.0.1
Remote IP : 10.1.0.2
Debug Level : lowok
------------------------------
Local IP : 2001::1
Remote IP : 2002::1
Debug Level : fail
------------------------------
Local IP : 3001::1
Remote IP : 3002::1
Debug Level : lowstart
------------------------------
nsx-edge-1>
Mode
Basic
Availability
Edge
Display the log level of the IKE service.
Example
nsx-edge-1> get service ike logging-level
Log level: INFO
Mode
Basic
Availability
Autonomous Edge, Edge
Display the log level of the local-controller service.
Example
nsx-edge-1> get service local-controller logging-level
Log level: INFO
Mode
Basic
Availability
Autonomous Edge, Edge
Display the state of the local controller service.
Example
nsx-edge-1> get service local-controller state
Uptime : 3556847.000 seconds (since 2016-09-12 18:07:03.20)
Full Sync State : Completed at {'num': 1, 'time': '2016-09-20 10:19:24.22'}
Controller Session : Up
IPC Channel State
Datapath Config : Up since 2016-09-12 18:07:06.37
Datapath State : Up since 2016-09-12 18:07:05.49
Routing Service : Up since 2016-09-12 18:07:03.37
BFD Config : None
BFD State : None
Mode
Basic
Availability
Autonomous Edge, Edge
Get the log level of the Node Management service.
Example
nsx-manager-1> get service node-mgmt logging-level
Logging level: info
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Get nsd logging level.
Example
nsx-1> get service nsd logging-level
Logging level info
Mode
Basic
Availability
Edge
Get service nsx-agent logging level.
Mode
Basic
Availability
KVM
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.
Example
ESXi-1> get service nsx-cfgagent cache-table config local
ObjectID ObjectType FullSyncVersion PropertyType PropertyValue
007ec6fd-e307-428a-8ccf-d1d0de2a26e5 VIF_STATE 1 INVALID_PROPERTY
007ec6fd-e307-428a-8ccf-d1d0de2a26e5 VIF_STATE 1 VIF_MAC id: "40d4ee0a-087e-4b38-a959-afeb2d67f23b"
vif_mac {
mac: 345046739262
}
ESXi-1> get service nsx-cfgagent cache-table l2 remote
ObjectID ObjectType FullSyncVersion PropertyType PropertyValueKey PropertyValue
ad209a8e-2f4c-40e1-ba63-5459f3922d9a LOG_SWITCH_FIB 1 L2_VTEP 2050 vtep_ip {
ipv4: 2886785032
}
vtep_label {
label: 2050
}
segment_id {
ipv4: 2886778880
}
vtep_mac {
mac: 345046978033
}
ad209a8e-2f4c-40e1-ba63-5459f3922d9a LOG_SWITCH_FIB 1 L2_VM_MAC 345047285093 mac {
mac: 345047285093
}
vtep_ip {
ipv4: 2886785032
}
vtep_mac {
mac: 345046978033
}
ESXi-1> get service nsx-cfgagent cache-table
......
Mode
Basic
Availability
ESXi
Display the status for HyperBus vmknic ports on this hypervisor host.
Example
sc2-rdops-vm06-dhcp-206-27.eng.vmware.com> get service nsx-cfgagent hyperbus vmknic
VIF HostSwitchID IP IP Mask
hyperBusVmknic c1 88 7f ee da 08 47 a2-af fb c5 86 bd 96 df ce 169.254.1.1 255.255.0.0
hyperBusVmknic1 6d 79 76 73 00 00 00 00-00 00 00 00 00 00 00 00 169.253.1.1 255.255.0.0
Mode
Basic
Availability
ESXi
Get service cfgagent hyperbus logging level.
Mode
Basic
Availability
ESXi
Get service cfgagent metrics logging level
Mode
Basic
Availability
ESXi
Get service cfgagent nestdb logging level
Mode
Basic
Availability
ESXi
Get service cfgagent net logging level
Mode
Basic
Availability
ESXi
Get service cfgagent rpc logging level
Mode
Basic
Availability
ESXi
Get service cfgagent SHA client logging level.
Mode
Basic
Availability
ESXi
Get service cfgagent upm logging level.
Mode
Basic
Availability
ESXi
Get service cfgagent workflow logging level.
Mode
Basic
Availability
ESXi
Get service cfgagent workflow trace level.
Mode
Basic
Availability
ESXi
Get service cfgagent logging level.
Mode
Basic
Availability
ESXi
Display the attachment config logical switch on this hypervisor host.
Example
esx-host-1> get service nsx-cfgagent logical-switch attachment-config
LS Parent LS Vlan
69f237fb-96de-4ca6-8a7e-63ddd4582dfd 1429c789-e32f-4fdd-9280-4e2c6911b74e 5
69f237fb-96de-4ca6-8a7e-63ddd4582dfd 5570650c-8302-4342-9c98-81427cb4663b 14
Mode
Basic
Availability
ESXi
Display the extra config list for logical switch on this hypervisor host.
Example
esx-host-1> get service nsx-cfgagent logical-switch extra-config
LS Key Value
69f237fb-96de-4ca6-8a7e-63ddd4582dfd com.vmware.port.extraConfig.global.id 3b510825-2236-477e-90dc-e918a06c9cf1
69f237fb-96de-4ca6-8a7e-63ddd4582dfd com.vmware.port.extraConfig.serviceInsertion.gvm 1
Mode
Basic
Availability
ESXi
Display the extra config list for logical switch port on this hypervisor host.
Example
esx-host-1> get service nsx-cfgagent logical-switch-port extra-config
LSP Key Value
0afe7763-3c7b-4265-86da-cf8723bbd999 com.vmware.port.extraConfig.global.id 3b510825-2236-477e-90dc-e918a06c9c22
Mode
Basic
Availability
ESXi
Get nsx-context-mux feature status.
| Option | Description |
|---|---|
| <feature-type> | Context mux feature type argument Allowed values: nmdb-deprecated, dump-health-info |
Example
nsx-1> get service nsx-context-mux nmdbDeprecated status
ContextMux feature:nmdbDeprecated is enabled
Mode
Basic
Availability
ESXi
Get service daemon log level for context-mux.
Example
nsx-1> get service nsx-context-mux logging-level
Current logging level is info
Mode
Basic
Availability
ESXi
Get current status of IDFW on host
Example
esx> get service nsx-ctxteng idfw status
> Idfw status in MP config (VcClusterHostCfgMsg) : disabled
> Idfw status in OpsAgent config (ctxteng.xml) : enabled
> Overall Idfw status on the Host : disabled
Mode
Basic
Availability
ESXi
Get current status of IDS on host
Example
esx> get service nsx-ctxteng ids status
> Ids status in OpsAgent config : enabled
> Kafka status in OpsAgent config : disabled
Mode
Basic
Availability
ESXi
Get context engine protocol enable in the order TCP UDP ICMP
Example
esx> get service nsx-ctxteng protocol
Current protocol mask is TCP:on UDP:on ICMP:on
Mode
Basic
Availability
ESXi
Get service exporter SmartNIC demux logging level.
Example
nsx-1> get service nsx-exporter lib-sndemux logging-level
Logging level info
Mode
Basic
Availability
ESXi
Get exporter service logging level.
Example
nsx-1> get service nsx-exporter logging-level
Logging level info
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about the nsx-lastline-rapid service.
Example
nsx> get service nsx-lastline-rapid
Service name: nsx-lastline-rapid
Service state: running
Mode
Basic
Availability
Get nsx-lastline-rapid log level
Example
localhost> get service nsx-lastline-rapid logging-level
Current logging level is debug
Mode
Basic
Availability
Get service netopa logging level.
Example
esx> get service nsx-netopa logging-level
Current Netopa logging level is: info
Mode
Basic
Availability
Autonomous Edge, ESXi
Get service opsagent SHA client logging level.
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Get service opsagent SmartNIC demux logging level.
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Get service opsagent workflow logging level.
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Get service opsagent workflow trace level.
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Get service OpsAgent logging level.
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Get service nsx-proxy central logging level.
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Get service nsx-proxy metrics logging level.
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Get service nsx-proxy nestdb logging level.
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Get service nsx-proxy net logging level.
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Get service nsx-proxy rpc logging level.
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Get service nsx-proxy logging level.
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Get service nsx-snproxy central logging level.
Mode
Basic
Availability
ESXi
Get service nsx-snproxy connection info
Example
esx-1> get service nsx-snproxy conn-info
Local Endpoint Local Service
================================================================================
HealthCheck vmware.nsx.healthcheck.HealthCheckHostService
LldpVertical vmware.nsx.lldp.LldpHostService
Traceflow vmware.nsx.traceflow.TraceflowHostService
SwitchingVertical vmware.nsx.messaging.L2HostService
Remote Endpoint
========================================
aaaaaaaa-0000-0000-0000-0000a9fe0001
Mode
Basic
Availability
ESXi
Get service nsx-snproxy net logging level.
Mode
Basic
Availability
ESXi
Get service nsx-snproxy rpc logging level.
Mode
Basic
Availability
ESXi
Get service nsx-snproxy logging level.
Mode
Basic
Availability
ESXi
Display the entire routing configuration.
Example
nsx-edge-1> get service router config
ROUTING CONFIGURATION:
======================
{
"redist": {
"bgp_enabled": true
},
"redistri_rules": [
{
"rule": [
{
"to_proto": 1,
"seq_id": 0,
"flags": 103,
"name": {
"string": "rule3"
},
"description": {
"string": "Rule3"
}
}
]
}
],
"static_route": [
{
"prefix": {
"ipv4": "1.1.1.0",
"prefix_length": 25
},
"nexthops": [
{
"route_type": 3,
"ip": {
"ipv4": "169.254.0.1"
},
"if_index": 6,
"admin_distance": 3
}
]
},
{
"prefix": {
"ipv4": "11.11.1.0",
"prefix_length": 24
},
"nexthops": [
{
"route_type": 4,
"if_index": 1,
"admin_distance": 2
}
]
},
{
"prefix": {
"ipv4": "111.111.0.0",
"prefix_length": 16
},
"nexthops": [
{
"route_type": 3,
"ip": {
"ipv4": "169.254.0.1"
},
"if_index": 6,
"admin_distance": 3
}
]
},
{
"prefix": {
"ipv4": "11.11.2.0",
"prefix_length": 24
},
"nexthops": [
{
"route_type": 5,
"ip": {
"ipv4": "169.254.0.1"
},
"if_index": 6,
"admin_distance": 3
}
]
},
{
"prefix": {
"ipv4": "100.64.1.0",
"prefix_length": 31
},
"nexthops": [
{
"route_type": 7,
"ip": {
"ipv4": "169.254.0.1"
},
"if_index": 6,
"admin_distance": 0
}
]
},
{
"prefix": {
"ipv4": "1.1.3.0",
"prefix_length": 24
},
"nexthops": [
{
"route_type": 6,
"ip": {
"ipv4": "169.254.0.1"
},
"if_index": 6,
"admin_distance": 0
}
]
},
{
"prefix": {
"ipv4": "1.1.2.0",
"prefix_length": 24
},
"nexthops": [
{
"route_type": 3,
"ip": {
"ipv4": "169.254.0.1"
},
"if_index": 6,
"admin_distance": 3
}
]
}
],
"bgp_config": {
"enabled": true,
"local_as": 422,
"graceful_restart": false,
"neighbor": [
{
"enable": true,
"remote_as": 420,
"description": {
"string": "BGP_config created through automation"
},
"hold_down_timer": 4,
"address_family": [
{
"route_map_out": {
"route_map_seq": [
{
"action": 1,
"route_map_set": {},
"id": 1,
"match": {
"prefix_list": [
{
"prefix": [
{
"action": 1,
"index": 109,
"network": {
"ipv4": "1.1.1.0",
"prefix_length": 25
},
"seq_id": 1
}
],
"name": "1.1.1.0/25"
}
]
}
},
{
"action": 1,
"route_map_set": {
"metric": 1000
},
"id": 2,
"match": {
"prefix_list": [
{
"prefix": [
{
"index": 106,
"network": {
"ipv4": "1.1.0.0",
"prefix_length": 16
},
"seq_id": 1,
"less_or_equal_bits": 24,
"action": 1,
"greater_or_equal_bits": 16
}
],
"name": "1.1.0.0/16"
}
]
}
}
],
"name": {
"string": "1.1.0.0"
}
},
"enabled": true,
"type": "IPv4_UNICAST"
}
],
"keep_alive_timer": 1,
"src_ip_address": {
"ipv4": "40.40.40.1"
},
"ip_address": {
"ipv4": "40.40.40.10"
},
"enable_bfd": false,
"name": {
"string": "auto-bgp-config-1"
}
},
{
"enable": true,
"remote_as": 420,
"description": {
"string": "BGP_config created through automation"
},
"hold_down_timer": 3,
"address_family": [
{
"enabled": true,
"type": "IPv4_UNICAST",
"route_map_in": {
"route_map_seq": [
{
"action": 1,
"route_map_set": {
"weight": 200
},
"id": 1,
"match": {
"prefix_list": [
{
"prefix": [
{
"index": 103,
"network": {
"ipv4": "2.1.0.0",
"prefix_length": 16
},
"seq_id": 1,
"less_or_equal_bits": 28,
"action": 1,
"greater_or_equal_bits": 16
}
],
"name": "2.1.0.0"
}
]
}
}
],
"name": {
"string": "2.1.0.0"
}
}
}
],
"keep_alive_timer": 1,
"src_ip_address": {
"ipv4": "90.90.90.2"
},
"ip_address": {
"ipv4": "90.90.90.10"
},
"enable_bfd": false,
"name": {
"string": "auto-bgp-config-4"
}
}
],
"ecmp": true
},
"routing_global": {
"router_id": {
"ipv4": "40.40.40.1"
},
"op_state_up": true,
"role": 2,
"forwarding_up_timer": 0
}
}
Mode
Basic
Availability
Autonomous Edge, Edge
Display the redistribution configuration.
Example
nsx-edge-1> get service router config redist
REDISTRIBUTION CONFIGURATION:
=============================
redist:
{
"bgp_enabled": true
}
redistri_rules:
[
{
"rule": [
{
"to_proto": 1,
"seq_id": 0,
"flags": 103,
"name": {
"string": "rule3"
},
"description": {
"string": "Rule3"
}
}
]
}
]
Mode
Basic
Availability
Autonomous Edge, Edge
Display the route map configuration.
Example
nsx-edge-1> get service router config route-maps
ROUTE MAP CONFIGURATION:
============================
route_map_out:
{
"name": {
"string": "1.1.0.0"
},
"route_map_seq": [
{
"action": 1,
"id": 1,
"match": {
"prefix_list": [
{
"name": "1.1.1.0/25",
"prefix": [
{
"action": 1,
"index": 109,
"network": {
"ipv4": "1.1.1.0",
"prefix_length": 25
},
"seq_id": 1
}
]
}
]
},
"route_map_set": {}
},
{
"action": 1,
"id": 2,
"match": {
"prefix_list": [
{
"name": "1.1.0.0/16",
"prefix": [
{
"action": 1,
"greater_or_equal_bits": 16,
"index": 106,
"less_or_equal_bits": 24,
"network": {
"ipv4": "1.1.0.0",
"prefix_length": 16
},
"seq_id": 1
}
]
}
]
},
"route_map_set": {
"metric": 1000
}
}
]
}
route_map_in:
{
"name": {
"string": "2.1.0.0"
},
"route_map_seq": [
{
"action": 1,
"id": 1,
"match": {
"prefix_list": [
{
"name": "2.1.0.0",
"prefix": [
{
"action": 1,
"greater_or_equal_bits": 16,
"index": 103,
"less_or_equal_bits": 28,
"network": {
"ipv4": "2.1.0.0",
"prefix_length": 16
},
"seq_id": 1
}
]
}
]
},
"route_map_set": {
"weight": 200
}
}
]
}
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about the SecurityHub service.
Example
nsx> get service security-hub
Service name: security-hub
Service state: running
Mode
Basic
Availability
Get EPSEC Library log level
Example
localhost> get service security-hub epsec logging-level
Current logging level for epsec-library is info
Mode
Basic
Availability
Get configured SecurityHub feature details
Example
nsx-1> get service security-hub feature
SecurityHub is configured with feature:fileless subtype:all operation:enable
for vms:all
Mode
Basic
Availability
Get security-hub log level
Example
localhost> get service security-hub logging-level
Current logging level is info
Mode
Basic
Availability
Display the service groups state for the service router
Example
nsx-edge-1(tier0_sr)> get service-groups
Service-Group : a97dea09-a9a9-446d-bd8f-4d6d4f2bc070
Id : 1
Local State : Active
Peer State : Standby
State History
State : Down
Event : Init
Resources :
Time : 2022-01-21 09:31:15.22
State : Standby
Event : Service Router Up
Resources :
Time : 2022-01-21 09:31:15.22
State : Active
Event : Service Router Up
Resources : 0
Time : 2022-01-21 09:31:15.68
Mode
Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display the service groups state for the service router
Example
nsx-edge-1(tier0_sr)> get service-groups details
Service-Group : a97dea09-a9a9-446d-bd8f-4d6d4f2bc070
Id : 1
Local State : Active
Peer State : Standby
State History
State : Down
Event : Init
Reason : Initialize
Resources :
Time : 2022-01-21 09:31:15.22
State : Standby
Event : Service Router Up
Reason : Service Router Up
Resources :
Time : 2022-01-21 09:31:15.22
State : Active
Event : Service Router Up
Reason : Service Router Up
Resources : 0
Time : 2022-01-21 09:31:15.68
Mode
Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display information about Service Insertion.
Example
nsxedge(tier0_sr)> get service-insertion
Service Insertion Policy:
Policy UUID : ffeeddcc-bbaa-bbaa-2332-23fe33221100
Transport type : L2_BRIDGE
BFD status : BFD_DOWN
Redirected packet count north-to-south : 0
Redirected packet count south-to-north : 0
Service link1 IP : 10.10.10.1
Service link2 IP : 20.20.20.1
Service link1 nexthop IP : 10.10.10.2
Service link2 nexthop IP : 20.20.20.2
Failure policy : ON_FAILURE_DROP
Service Insertion Policy:
Policy UUID : 7fbe102d-268c-4b33-bdf5-8f1e608e9864
Transport type : L3_ROUTED
Redirected packet count : 1600
Nexthop IP : 40.40.40.10
Service Insertion Policy:
Policy UUID : dd947221-c3c1-45cd-b231-ee2d17fdfc61
Transport type : EW_NSH
Is EW policy : 1
EW Policy lookup count : 1
Failure Policy : FAIL_DROP
Number of Service Paths : 2
Path Index : 0
Forward Service Path ID : 1
Forward Service Chain ID : 1
Forward Service Index : 2
Forward Service Mac Address : 00:50:56:8b:73:96
Reverse Service Path ID : 2
Reverse Service Chain ID : 1
Reverse Service Index : 2
Reverse Service Mac Address : 00:50:56:8b:89:b2
Path Index : 1
Forward Service Path ID : 3
Forward Service Chain ID : 1
Forward Service Index : 2
Forward Service Mac Address : 00:50:56:8b:4e:b5
Reverse Service Path ID : 4
Reverse Service Chain ID : 1
Reverse Service Index : 2
Reverse Service Mac Address : 00:50:56:8b:89:b2
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about Service Insertion.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsxedge(tier0_sr)> get service-insertion ffeeddcc-bbaa-bbaa-2332-23fe33221100
Service Insertion Policy:
Policy UUID : ffeeddcc-bbaa-bbaa-2332-23fe33221100
BFD status : BFD_DOWN
Redirected packet count north-to-south : 0
Redirected packet count south-to-north : 0
Service link1 IP : 10.10.10.1
Service link2 IP : 20.20.20.1
Service link1 nexthop IP : 10.10.10.2
Service link2 nexthop IP : 20.20.20.2
Failure policy : ON_FAILURE_DROP
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about NS Service Insertion BFD control status.
Example
nsxedge(tier0_sr)> get service-insertion bfd-ctrl
Service Insertion BFD control status:
bfd_fail_gen : 1225
LR active timestamp : 933565834
Number of packets bypassing bfd check : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about Service Insertion flow programming table.
Example
nsxedge(tier0_sr)> get service-insertion flow-prog-table
Flow Programming Table:
Flow Programming Generation : 1
Number of Entries : 1
Flow Programming Entries
Flow ID : 118423680
Action : accept_flow
VRF : 1
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about Service Insertion failed SPI.
Example
nsxedge(tier0_sr)> get service-insertion spi-fail-table
Service Insertion SPI Fail Table:
SPI Fail Generation : 2
SPI Fail entries:
SPI : 1
SPI : 2
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about EW Service Insertion VRF to interface mapping.
Example
nsxedge(tier0_sr)> get service-insertion vrf-to-intf
Service Insertion VRF to Interface Table:
VRF ID : 1
Interface UID : 316
Interface UUID : 9435fb09-7615-4c40-a01e-c33373a402e9
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about all services.
Example
nsx-manager-1> get services
Service name: auth
Service state: running
Service name: http
Service state: running
Session timeout: 1800
Connection timeout: 30000
Client API concurrency limit: 40
Client API rate limit: 100
Global API concurrency limit: 199
Redirect host: (not configured)
Basic authentication: enabled
Cookie-based authentication: enabled
Service name: manager
Service state: running
Logging level: info
Service name: node-mgmt
Service state: running
Service name: nsx-message-bus
Service state: running
Service name: ntp
Service state: running
Service name: install-upgrade
Service state: stopped
Enabled on: 10.10.10.10
Service name: snmp
Service state: running
Start on boot: True
Root login: enabled
Service name: ssh
Service state: running
Start on boot: True
Service name: syslog
Service state: running
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display the remote sites along with their sync status.
Example
nsx-controller-1> get site-replicator remote-sites
Site ID Site Name Status
a7bcbfad-dde5-4510-9e82-328b3f819216 Europe synced
7c72c4ae-8fe8-4449-a4e2-c5e53ab0bb4f North America syncing
Mode
Basic
Availability
Manager
Indicates whether the local SNMP agent is configured with community string(s).
Example
nsx> get snmp v2-configured
True
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Get SNMP v2 Trap Targets.
Example
nsx> get snmp v2-targets
server: 10.20.125.4
port: 1162
community: public
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Indicates whether the local SNMP agent is configured with v3 user(s).
Example
nsx> get snmp v3-configured
True
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Get SNMP v3 Engine ID.
Example
nsx> get snmp v3-engine-id
80001adc80992933638c48f75900000001
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Get SNMP v3 Protocols auth_protocol and priv_protocol.
Example
nsx> get snmp v3-protocols
auth_protocol: SHA1
priv_protocol: AES128
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Get SNMP v3 Trap Targets.
Example
nsx> get snmp v3-targets
server: 10.20.125.4
port: 1162
user: nsx-collector
security_level: AUTH_PRIV
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Get SNMP v3 User IDs.
Example
nsx> get snmp v3-users
user: user1
access: READ_ONLY
security_level: AUTH_PRIV
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display active network connections.
Example
nsx-manager-1> get sockets
Proto Remote Port Local Port In Out
tcp --listen-- 127.0.0.1 7440 0 0
tcp --listen-- 127.0.0.1 9200 0 0
tcp --listen-- 127.0.0.1 7441 0 0
tcp --listen-- --any-- 4369 0 0
tcp --listen-- 192.168.110.42 65012 0 0
tcp --listen-- 127.0.0.1 9300 0 0
tcp --listen-- 127.0.0.1 53 0 0
tcp --listen-- --any-- 22 0 0
tcp --listen-- --any-- 15671 0 0
tcp --listen-- --any-- 7000 0 0
tcp --listen-- --any-- 443 0 0
tcp --listen-- 127.0.0.1 2812 0 0
tcp --listen-- 192.168.110.42 7070 0 0
tcp --listen-- 192.168.110.42 7071 0 0
tcp --listen-- 127.0.0.1 32000 0 0
tcp --listen-- --any-- 8001 0 0
tcp --listen-- 127.0.0.1 32001 0 0
.
.
.
or
nsx-edge> get sockets
Proto Remote Port Local Port In Out
tcp --listen-- 127.0.0.1 7440 0 0
tcp --listen-- 127.0.0.1 9200 0 0
tcp --listen-- 127.0.0.1 7441 0 0
tcp --listen-- --any-- 4369 0 0
tcp --listen-- 192.168.110.42 65012 0 0
tcp --listen-- 127.0.0.1 9300 0 0
tcp --listen-- 127.0.0.1 53 0 0
tcp --listen-- --any-- 22 0 0
tcp --listen-- --any-- 15671 0 0
tcp --listen-- --any-- 7000 0 0
tcp --listen-- --any-- 443 0 0
tcp --listen-- 127.0.0.1 2812 0 0
tcp --listen-- 192.168.110.42 7070 0 0
tcp --listen-- 192.168.110.42 7071 0 0
tcp --listen-- 127.0.0.1 32000 0 0
tcp --listen-- --any-- 8001 0 0
tcp --listen-- 127.0.0.1 32001 0 0
.
.
.
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display spoof guard config for a host switch and dvport.
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get spoof-guard config nsxvswitch b65dcac9-6611-41ce-b96c-69255120b473
Spoof Guard Config
------------------------------------------------------------------------------------------------------------------------
Switch Spoof Guard : Disabled
Port Spoof Guard : Disabled
Mode
Basic
Availability
ESXi
Displays Spoof Guard config for a logical port.
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
Example
kvm-1> get spoof-guard config 77f13067-df92-4a64-81f9-c72f14c21a82
Spoof Guard Config
---------------------------------------------------------------------------
Switch Spoof Guard : Disabled
Port Spoof Guard : Enabled
Mode
Basic
Availability
KVM
Display spoof guard stats for a host switch and dvport.
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get spoof-guard stats nsxvswitch b65dcac9-6611-41ce-b96c-69255120b473
Spoof Guard Stats
------------------------------------------------------------------------------------------------------------------------
Spoof Guard Ipv4 Drop Count : 0
Spoof Guard Ipv6 Drop Count : 0
Spoof Guard ARP Drop Count : 0
Spoof Guard ND Drop Count : 0
Spoof Guard NonIp Drop Count : 0
Spoof Guard Ipv4 Drop Bytes : 0
Spoof Guard Ipv6 Drop Bytes : 0
Spoof Guard ARP Drop Bytes : 0
Spoof Guard ND Drop Bytes : 0
Spoof Guard NonIp Drop Bytes : 0
Mode
Basic
Availability
ESXi
Displays Spoof Guard stats for a logical port.
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
Example
kvm-1> get spoof-guard stats 77f13067-df92-4a64-81f9-c72f14c21a82
Spoof Guard Stats
---------------------------------------------------------------------------
Spoof Guard Ipv4 Drop Count : 1
Spoof Guard Ipv6 Drop Count : 3
Spoof Guard ARP Drop Count : 12
Spoof Guard ND Drop Count : 2
Spoof Guard NonIp Drop Count : 7
Mode
Basic
Availability
KVM
Display spoof guard whitelist for a host switch and dvport.
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get spoof-guard whitelist nsxvswitch b65dcac9-6611-41ce-b96c-69255120b473
Spoof Guard Whitelist
------------------------------------------------------------------------------------------------------------------------
IP MAC VLAN
Mode
Basic
Availability
ESXi
Displays Spoof Guard whitelist for a logical port.
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
Example
kvm-1> get spoof-guard whitelist 77f13067-df92-4a64-81f9-c72f14c21a82
Spoof Guard Whitelist
---------------------------------------------------------------------------
IP MAC VLAN
192.168.166.45 00:23:20:60:2c:7f 0
fe80::223:20ff:fe60:2c7f 00:23:20:60:2c:7f 0
Mode
Basic
Availability
KVM
Display statistics for the logical router in the VRF context.
Example
nsx-edge-1(vrf)> get stats
Logical Router
UUID : 736a80e3-23f6-5a2d-81d6-bbefb2786666
VRF : 0
LR-ID : 0
name : R1
type : TUNNEL
Statistics
Dropped No Memory : 0
Dropped No Route : 0
Mode
VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display the statistics for all interfaces in the path.
Example
nsx-edge-1(path)> get stats
UUID RX PKTS TX PKTS RX BYTES TX BYTES RX Drops TX Drops
de650f56-276d-46ef-959e-960752acfe19 23796 14321 1576814 957858 3 0
140ca8de-61e0-4bba-b429-6a3791b0846a 38 127 2807 9150 15 0
9eff9e4e-9157-4107-a0dd-c79350dce6f7 127 38 9150 2807 0 0
53bab4b1-f0df-451b-af80-0a9d5e580186 38 127 2807 9150 0 0
2a7bf881-1f89-4833-833e-47673b79901a 127 38 9150 2807 8 0
bbf5b23c-3f0a-4afe-b3b3-b19814d4dd2a 29 14 1890 980 0 0
->5b2068d0-8c28-4427-8be4-48f422f92309 14 29 980 1890 0 0
eb3bd495-9ce3-40b4-a955-c2ddc4893cfa 29 14 1890 980 0 0
1fec3ffa-213d-4d2b-ae1b-e12857434846 14 29 980 1890 0 0
13592f56-be3c-4d3d-88de-7d5825dd51bb 17 22 1422 1316 0 0
c588fc5d-dd62-45b2-bc16-3dae466c16c7 22 17 1316 1422 0 0
2120ef07-05e3-477f-8d96-e2be390784db 3 23 126 1394 0 0
3bbbd5e9-2ffe-4fb7-9edb-edc7bba67278 23 3 1394 126 2 0
dd10beb2-3673-43a5-b180-ecc46e830ee0 0 7 0 686 0 0
fdc429ef-d778-421b-bf84-e1063a7bf5ab 7 0 686 0 0 0
Mode
Path
Availability
Autonomous Edge, Edge
Display both local and remote translations for the specified stretched container group. Optionally specify a translation type to display translations of that type.
| Option | Description |
|---|---|
| <uuid> | Cgroup identifier |
| <translation-type> | Translation type Allowed values: logical-objects, ips, vifs, macs, tns, vms, excluded-ips, directory-groups, bms, bmsi |
Example
nsx-controller-1> get stretched cgroup 7899c4dc-621e-4d8b-8a40-2ee299f1ec73 ips
id: 192.108.11.123/32, type: IpSpec, is_local: true
id: 100.108.11.123/32, type: IpSpec, is_local: false, site: db41300c-187d-48a7-9a6c-336131cd4be8,
direct_cgroup: 7899c4dc-621e-4d8b-8a40-2ee299f1ec73, timestamp: 04/09/2020 18:25:46UTC
Mode
Basic
Availability
Manager
Display both local and remote translations for the specified stretched group. Optionally specify a translation type to display translations of that type.
| Option | Description |
|---|---|
| <uuid> | Group identifier |
| <translation-type> | Translation type Allowed values: logical-objects, ips, vifs, macs, tns, vms, excluded-ips, directory-groups, bms, bmsi |
Example
nsx-controller-1> get stretched group 7899c4dc-621e-4d8b-8a40-2ee299f1ec73 ips
id: 192.108.11.123/32, type: IpSpec, is_local: true
id: 100.108.11.123/32, type: IpSpec, is_local: false, site: db41300c-187d-48a7-9a6c-336131cd4be8,
direct_cgroup: 7899c4dc-621e-4d8b-8a40-2ee299f1ec73, timestamp: 04/09/2020 18:25:46UTC
Mode
Basic
Availability
Manager
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.
all, log-age, remove-core-files arguments are not allowed along with eal4-audit argument.| Option | Description |
|---|---|
| <filename> | Name of file to generate, for example support-bundle.tar or support-bundle.tgz Allowed pattern: ^[^/ *;&|]+$ |
Example
nsx-manager-1> get support-bundle
--------------------------------------------------------------------------------
/usr/sbin/arp -n
--------------------------------------------------------------------------------
Address HWtype HWaddress Flags Mask Iface
192.168.110.201 ether 00:50:56:a9:8a:8c C eth0
192.168.110.101 ether 00:50:56:a9:45:29 C eth0
192.168.110.1 ether 68:ef:bd:4e:98:7f C eth0
192.168.110.10 ether 00:50:56:a6:e0:14 C eth0
--------------------------------------------------------------------------------
/bin/df -lT -x securityfs
--------------------------------------------------------------------------------
Filesystem Type 1K-blocks Used Available Use% Mounted on
udev devtmpfs 8206240 4 8206236 1% /dev
tmpfs tmpfs 1643032 772 1642260 1% /run
/dev/sda2 ext4 19554584 2229116 16309100 13% /
none tmpfs 4 0 4 0% /sys/fs/cgroup
none tmpfs 5120 0 5120 0% /run/lock
none tmpfs 8215140 4 8215136 1% /run/shm
none tmpfs 102400 0 102400 0% /run/user
/dev/mapper/nsx-repository ext4 19551512 308428 18226868 2% /repository
.
.
.
nsx-manager-1> get support-bundle file support-bundle.tar
support-bundle.tar created, use the following command to transfer the file:
copy file support-bundle.tar url
After transferring support-bundle.tar, extract it using: tar xf support-bundle.tar
or
nsx-manager-1> get support-bundle file support-bundle-all.tar all remove-core-files
support-bundle-all.tar created, use the following command to transfer the file:
copy file support-bundle-all.tar url
After transferring support-bundle-all.tar, extract it using: tar xf support-bundle-all.tar
or
nsx-manager-1> get support-bundle file support-bundle.tar log-age 10
support-bundle.tar created, use the following command to transfer the file:
copy file support-bundle.tar url
After transferring support-bundle.tar, extract it using: tar xf support-bundle.tar
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Saves support bundle to the specified filename in the filestore.
| Option | Description |
|---|---|
| <filename> | Name of file to generate, for example support-bundle.tar or support-bundle.tgz Allowed pattern: ^[^/ *;&|]+$ |
Example
host-1> get support-bundle file
Name of file to generate, for example support-bundle.tgz
host-1> get support-bundle file support-bundle.tgz
support-bundle.tgz is created in /var/vmware/nsx/file-store
Mode
Basic
Availability
NSX Cloud VM
Display information about the specified IPFIX configuration.
| Option | Description |
|---|---|
| <logical-switch-port-id> | Logical switch port UUID |
Example
kvm-1> get switch-ipfix logical-switch-port 6cb56e83-9ccf-4991-94e7-26471b4ca93e setting
Switch IPFIX setting
============================================================
obsDomainID : 0
activeTimeout : 60
maxFlow : 65535
sampleProbability : 100
vNICFlowOnly : False
collectors : 10.117.7.163 4739
10.117.7.162 4739
Mode
Basic
Availability
KVM, NSX Cloud VM
Display Switch Security config for a host switch and dvport.
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get switch-security config nsxvswitch b65dcac9-6611-41ce-b96c-69255120b473
Switch Security Config
---------------------------------------------------------------------------
BPDU Filter : Disabled
DHCPv4 client block : Disabled
DHCPv4 server block : Enabled
DHCPv6 client block : Disabled
DHCPv6 server block : Enabled
Non-IP traffic block : Disabled
RA Guard : Disabled
Rate Limit Config : Enabled
Mode
Basic
Availability
ESXi
Displays Switch Security config for a logical port.
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
Example
kvm-1> get switch-security config 77f13067-df92-4a64-81f9-c72f14c21a82
Switch Security Config
---------------------------------------------------------------------------
BPDU Filter : Enabled
DHCPv4 Client Block : Disabled
DHCPv4 Server Block : Enabled
DHCPv6 Client Block : Disabled
DHCPv6 Server Block : Enabled
Non-IP Traffic Block : Disabled
RA Guard : Enabled
Mode
Basic
Availability
KVM
Display Switch Security stats for a host switch and dvport.
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
Example
esx-1> get switch-security stats nsxvswitch b65dcac9-6611-41ce-b96c-69255120b473
Switch Security Stats
---------------------------------------------------------------------------
Rate Limit Bcast Tx Drop Count : 0
Rate Limit Bcast Rx Drop Count : 0
Rate Limit Mcast Tx Drop Count : 0
Rate Limit Mcast Rx Drop Count : 0
DHCPv4 Server Block Drop Count : 0
DHCPv6 Server Block Drop Count : 0
DHCPv4 Client Block Drop Count : 0
DHCPv6 Client Block Drop Count : 0
BPDU Filter Drop Count : 0
RA Guard Drop Count : 0
Rate Limit Bcast Tx Drop Bytes : 0
Rate Limit Bcast Rx Drop Bytes : 0
Rate Limit Mcast Tx Drop Bytes : 0
Rate Limit Mcast Rx Drop Bytes : 0
DHCPv4 Server Block Drop Bytes : 0
DHCPv6 Server Block Drop Bytes : 0
DHCPv4 Client Block Drop Bytes : 0
DHCPv6 Client Block Drop Bytes : 0
BPDU Filter Drop Bytes : 0
RA Guard Drop Bytes : 0
Mode
Basic
Availability
ESXi
Displays Switch Security stats for a logical port.
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
Example
kvm-1> get switch-security stats 77f13067-df92-4a64-81f9-c72f14c21a82
Switch Security Stats
---------------------------------------------------------------------------
DHCPv4 Server Block Drop Count : 13
DHCPv6 Server Block Drop Count : 0
DHCPv4 Client Block Drop Count : 3
DHCPv6 Client Block Drop Count : 0
BPDU Filter Drop Count : 0
RA Guard Drop Count : 4
Mode
Basic
Availability
KVM
Display tenant context information for the logical router in the VRF context.
Example
Edge3(tier0_sr[3])> get tenant-context
Sat Jul 15 2023 UTC 00:05:53.365
org : default
proj : maroon
vpc :
Mode
VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display information about all TGWs.
Example
Edge> get tgws
Mon Aug 12 2024 UTC 10:10:21.127
CTGW
UUID VRF Project-ID TGW-ID Type
22355711-21f5-4186-b4d3-73ef9b677e27 1 SRPROJECTABC789 SRTGWXYZ123 SERVICE_ROUTER_TIER0
a759f367-0101-4d1c-b438-e60d0b1c8d50 3 PROJECTABC789 TGWXYZ123 DISTRIBUTED_ROUTER_TIER0
Mode
Basic
Availability
Autonomous Edge, Edge, Manager
Display information about transit gateways on this hypervisor host.
Example
esx-1> get tgws
TGW Routers Summary
-----------------------------------------------------------------------------------------------------------------
VDR UUID Policy Path
d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 /orgs/default/projects/default/transit-gateways/default
Mode
Basic
Availability
ESXi
Display information on transit gateway routers at policy path on this hypervisor host.
| Option | Description |
|---|---|
| <policy-path-string> | DR path string argument Allowed pattern: ^([A-Za-z0-9_:./-]+)$ |
Example
esx-1> get tgws /orgs/default/projects/default/
TGW Routers Summary
-----------------------------------------------------------------------------------------------------------------
TGW DR UUID Policy Path
d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 /orgs/default/projects/default/transit-gateways/default
Mode
Basic
Availability
ESXi
Display TLS inspection information.
Example
nsx-edge-1> get tls-inspection
LR-UUID Enabled
736a80e3-23f6-5a2d-81d6-bbefb2786666 yes
5b8a3359-c6bb-4bc2-b7a0-74986ffeff33 no
Mode
Basic
Availability
Edge
Display TLS inspection action profile details.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get tls-inspection action-profile 00000000-0000-0005-0000-000000000001
UUID : 00000000-0000-0005-0000-000000000001
Name : internal-profile-1
Type : Internal Decryption
Certificate Validation : yes
Invalid Cert Action : block
Trusted CA Bundle(s) : 00000000-0000-0001-0000-000000000002
CRL(s) : 00000000-0000-0002-0000-000000000002
Decryption Fail Action : block
Crypto Enforcement : enforce
Client TLS Versions : [TLSv1.1, TLSv1.2]
Client Cipher Suite : ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-SHA:ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES256-SHA384:AES128-GCM-SHA256:AES128-SHA256:AES256-GCM-SHA384:AES256-SHA256
Server TLS Versions : [TLSv1.1, TLSv1.2]
Server Cipher Suite : ECDHE-RSA-AES128-SHA:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-GCM-SHA384:AES128-SHA:AES128-SHA256:AES128-GCM-SHA256:AES256-SHA:AES256-SHA256:AES256-GCM-SHA384
Idle Timeout : 3000
Server Cert(s) : 00000000-0000-0003-0000-00000000000d
: 00000000-0000-0003-0000-00000000000c
: 00000000-0000-0003-0000-00000000000b
Default Cert : 00000000-0000-0003-0000-00000000000b
OCSP Must Staple : no
Mode
Basic
Availability
Edge
Display TLS inspection action profile information.
Example
nsx-edge-1> get tls-inspection action-profiles
UUID Type Name
736a80e3-23f6-5a2d-81d6-bbefb2786666 external ExternalDecryption
5b8a3359-c6bb-4bc2-b7a0-74986ffeff3f internal InternalDecryption
Mode
Basic
Availability
Edge
Display TLS inspection bypassed sites and the reason.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get tls-inspection bypassed-sites lr-uuid 41be3273-383a-4484-ba9c-b16912a947e4
Bypassed-domain Reason(s)
update.microsoft.com cert pinning
msg.whatsapp.net mutual auth
Mode
Availability
Edge
Display TLS inspection bypassed sites and the reason.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get tls-inspection bypassed-sites sr-uuid 41be3273-383a-4484-ba9c-b16912a947e4
Bypassed-domain Reason(s)
update.microsoft.com cert pinning
msg.whatsapp.net mutual auth
Mode
Availability
Edge
Display TLS inspection CA bundle details.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get tls-inspection ca-bundle daca3359-c6bb-4bc2-b7a0-74986ffeddcc
Total certificates : 1
Common name : Trusted Root CA
Serial number : 01
Alternate name : .rootca.com
Action profile : 1
Id : 3ae7860c-8bbb-4452-8dc8-2f79894bd391
Name : External Policy-external-profile
Health state : usable
Runtime error : none
Mode
Basic
Availability
Edge
Display TLS inspection CA bundle information.
Example
nsx-edge-1> get tls-inspection ca-bundles
UUID
736a80e3-23f6-5a2d-81d6-bbefb2786666
5b8a3359-c6bb-4bc2-b7a0-74986ffeff3f
Mode
Basic
Availability
Edge
Show TLS Inspection Cached Certificate Details.
| Option | Description |
|---|---|
| <cached-certificate-id> | Certificate id string argument Allowed pattern: ^([0-9a-f]*)$ |
Example
nsx-edge-1> get tls-inspection cached-certificate 01bb55d577e05b05526f8e801b3f2a52229e1419
type: generated cert
pvt key present: yes
hits: 43
certificate:
Data:
Version: 3 (0x2)
Serial Number:
01:a2:2a:9f:a3:b4:9d:8c:5e:b9:c6:4b:37:85:2a:7f:d6:15:99:d1
Signature Algorithm: sha256WithRSAEncryption
Issuer: C=US, ST=California, L=Palo Alto, O=VMware, OU=NSX, CN=trusted_ca
Validity
Not Before: Jun 21 04:05:15 2020 GMT
Not After : Jun 19 04:05:15 2030 GMT
Subject: C=US, ST=NY, L=New York, O=Development, CN=server1
Subject Public Key Info:
Public Key Algorithm: rsaEncryption
RSA Public-Key: (2048 bit)
Modulus:
00:ba:4d:3a:4e:51:19:4c:a2:50:93:93:30:70:af:
a9:8b:8d:ca:94:0b:cc:73:95:55:2d:b4:7e:98:93:
65:eb:c0:95:46:02:bd:46:44:cb:72:1e:a6:cc:c0:
c7:3b:0a:a6:3c:78:0f:34:65:67:a9:f1:75:2a:7f:
7b:03:06:48:0e:07:a5:ae:c7:74:d9:18:bd:a0:a0:
ad:1a:6c:ba:96:b2:86:a6:45:f9:bc:96:e9:43:70:
53:a2:70:b7:99:ca:79:f9:04:18:65:c2:23:02:d8:
04:2d:4b:49:22:65:2f:ad:94:5f:69:d7:81:82:97:
25:30:29:b7:0b:fc:6a:fd:06:e0:f0:92:9c:c5:da:
c5:dd:7c:4b:43:83:ed:d3:09:db:f2:e1:d4:a3:15:
c7:22:7b:cc:66:fb:45:2d:5d:30:93:b9:21:93:db:
74:64:e5:bd:06:ba:ec:63:f5:98:64:77:2d:da:17:
5f:e2:b7:ef:3f:ef:a3:34:45:96:76:f9:a9:d7:3a:
0d:e9:09:32:e4:a4:f8:f6:0c:06:8e:91:32:73:a3:
8f:7a:08:64:88:b6:01:52:8c:9b:51:c3:45:c5:05:
31:c8:d1:8e:f1:5e:7b:6f:d4:7a:15:de:93:b3:b4:
54:0f:f2:20:b1:06:4b:9f:4d:52:3d:95:9e:53:9b:
3c:c7
Exponent: 65537 (0x10001)
X509v3 extensions:
X509v3 Basic Constraints:
CA:FALSE
X509v3 Subject Alternative Name:
DNS:*.server1.org, DNS:*.server1.net, DNS:server1.org, DNS:server1.net
X509v3 Subject Key Identifier:
5F:E4:DF:B2:43:EA:E8:79:FC:3B:55:9F:5E:C5:E7:34:73:A3:37:38
Signature Algorithm: sha256WithRSAEncryption
3f:84:86:bb:84:de:80:ca:87:97:ce:e9:99:f4:7d:a6:bf:08:
04:c2:1d:46:91:cb:61:3c:f5:84:c7:da:c8:87:42:c9:13:21:
37:cf:e7:40:15:5f:fe:f9:77:1c:85:4e:21:36:aa:e0:fd:86:
bc:f8:49:e0:e4:f5:6c:f6:47:92:86:21:ae:15:8a:29:86:91:
eb:2e:0f:11:80:1f:c5:4a:81:1f:07:82:f8:18:cc:f3:94:6d:
7c:14:56:ac:1a:e4:b5:fe:66:3e:b9:93:97:19:dc:a3:f3:53:
7d:13:7b:4c:29:af:80:67:12:e2:8c:a2:fc:3f:e3:12:74:63:
ce:2e:e3:76:83:c6:86:41:ff:33:63:0c:f3:c1:db:ae:d7:64:
f9:0d:bf:08:e0:b8:98:46:eb:89:fc:5a:01:6f:d6:f4:cc:9b:
72:03:7f:bf:e1:63:97:99:1a:73:80:d2:20:63:44:53:f8:56:
d0:cf:89:f3:36:f5:af:31:2a:20:60:ec:dd:7e:d5:97:be:9d:
87:1b:c4:07:70:33:47:34:7d:44:ae:c0:2d:1f:95:66:2e:72:
78:25:5b:38:cf:d5:40:aa:19:c8:2b:0d:9e:3b:93:2e:a0:c5:
a0:be:3b:49:b6:6e:de:88:5f:5d:36:a0:7e:4d:e2:03:80:f6:
f3:8f:95:29
Mode
Basic
Availability
Edge
Display TLS inspection cached certificates.
Example
nsx-edge-1> get tls-inspection cached-certificates
id : 01bb55d577e05b05526f8e801b3f2a52229e1419
issued_to : www.news.com
subject_alternative_name : N/A
issued_by : Trusted CA Cert
generated_at : Jun 15 22:58:59 2021
hits : 2
Mode
Basic
Availability
Edge
Show TLS Inspection Certificate Details.
| Option | Description |
|---|---|
| <certificate-uuid> | TLS Certificate UUID |
Example
nsx-edge-1> get tls-inspection certificate 00000000-0000-0005-0000-000000000001
pvt key present: yes
certificate:
Data:
Version: 3 (0x2)
Serial Number:
01:a2:2a:9f:a3:b4:9d:8c:5e:b9:c6:4b:37:85:2a:7f:d6:15:99:d1
Signature Algorithm: sha256WithRSAEncryption
Issuer: C=US, ST=California, L=Palo Alto, O=VMware, OU=NSX, CN=trusted_ca
Validity
Not Before: Jun 21 04:05:15 2020 GMT
Not After : Jun 19 04:05:15 2030 GMT
Subject: C=US, ST=NY, L=New York, O=Development, CN=server1
Subject Public Key Info:
Public Key Algorithm: rsaEncryption
RSA Public-Key: (2048 bit)
Modulus:
00:ba:4d:3a:4e:51:19:4c:a2:50:93:93:30:70:af:
a9:8b:8d:ca:94:0b:cc:73:95:55:2d:b4:7e:98:93:
65:eb:c0:95:46:02:bd:46:44:cb:72:1e:a6:cc:c0:
c7:3b:0a:a6:3c:78:0f:34:65:67:a9:f1:75:2a:7f:
7b:03:06:48:0e:07:a5:ae:c7:74:d9:18:bd:a0:a0:
ad:1a:6c:ba:96:b2:86:a6:45:f9:bc:96:e9:43:70:
53:a2:70:b7:99:ca:79:f9:04:18:65:c2:23:02:d8:
04:2d:4b:49:22:65:2f:ad:94:5f:69:d7:81:82:97:
25:30:29:b7:0b:fc:6a:fd:06:e0:f0:92:9c:c5:da:
c5:dd:7c:4b:43:83:ed:d3:09:db:f2:e1:d4:a3:15:
c7:22:7b:cc:66:fb:45:2d:5d:30:93:b9:21:93:db:
74:64:e5:bd:06:ba:ec:63:f5:98:64:77:2d:da:17:
5f:e2:b7:ef:3f:ef:a3:34:45:96:76:f9:a9:d7:3a:
0d:e9:09:32:e4:a4:f8:f6:0c:06:8e:91:32:73:a3:
8f:7a:08:64:88:b6:01:52:8c:9b:51:c3:45:c5:05:
31:c8:d1:8e:f1:5e:7b:6f:d4:7a:15:de:93:b3:b4:
54:0f:f2:20:b1:06:4b:9f:4d:52:3d:95:9e:53:9b:
3c:c7
Exponent: 65537 (0x10001)
X509v3 extensions:
X509v3 Basic Constraints:
CA:FALSE
X509v3 Subject Alternative Name:
DNS:*.server1.org, DNS:*.server1.net, DNS:server1.org, DNS:server1.net
X509v3 Subject Key Identifier:
5F:E4:DF:B2:43:EA:E8:79:FC:3B:55:9F:5E:C5:E7:34:73:A3:37:38
Signature Algorithm: sha256WithRSAEncryption
3f:84:86:bb:84:de:80:ca:87:97:ce:e9:99:f4:7d:a6:bf:08:
04:c2:1d:46:91:cb:61:3c:f5:84:c7:da:c8:87:42:c9:13:21:
37:cf:e7:40:15:5f:fe:f9:77:1c:85:4e:21:36:aa:e0:fd:86:
bc:f8:49:e0:e4:f5:6c:f6:47:92:86:21:ae:15:8a:29:86:91:
eb:2e:0f:11:80:1f:c5:4a:81:1f:07:82:f8:18:cc:f3:94:6d:
7c:14:56:ac:1a:e4:b5:fe:66:3e:b9:93:97:19:dc:a3:f3:53:
7d:13:7b:4c:29:af:80:67:12:e2:8c:a2:fc:3f:e3:12:74:63:
ce:2e:e3:76:83:c6:86:41:ff:33:63:0c:f3:c1:db:ae:d7:64:
f9:0d:bf:08:e0:b8:98:46:eb:89:fc:5a:01:6f:d6:f4:cc:9b:
72:03:7f:bf:e1:63:97:99:1a:73:80:d2:20:63:44:53:f8:56:
d0:cf:89:f3:36:f5:af:31:2a:20:60:ec:dd:7e:d5:97:be:9d:
87:1b:c4:07:70:33:47:34:7d:44:ae:c0:2d:1f:95:66:2e:72:
78:25:5b:38:cf:d5:40:aa:19:c8:2b:0d:9e:3b:93:2e:a0:c5:
a0:be:3b:49:b6:6e:de:88:5f:5d:36:a0:7e:4d:e2:03:80:f6:
f3:8f:95:29
Mode
Basic
Availability
Edge
Display TLS inspection CRL information.
Example
nsx-edge-1> get tls-inspection crls
UUID Type
736a80e3-23f6-5a2d-81d6-bbefb2786666 x509_crl
5b8a3359-c6bb-4bc2-b7a0-74986ffeff3f one_crl
Mode
Basic
Availability
Edge
Display revoked certs of a TLS inspection CRL matching a serial number.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
Example
nsx-edge-1> get tls-inspection crls 00000000-0000-0002-0000-000000000002 certificate-serial-number 0af85cfa8fbea55c3d00be8df4dd30e83ef28244
Issuer-SHA256 Certificate Serial Number Issuer DN
de87d0dc8d29f6d3547d8242abdf96632ee3dfb1538da253186f94553bcde604 0af85cfa8fbea55c3d00be8df4dd30e83ef28244 C=BM/O=QuoVadis Limited/CN=QuoVadis Root CA 3
Mode
Basic
Availability
Edge
Display revoked certs of a TLS inspection CRL of an issuer.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
Example
nsx-edge-1> get tls-inspection crls 00000000-0000-0002-0000-000000000002 issuer de87d0dc8d29f6d3547d8242abdf96632ee3dfb1538da253186f94553bcde604
Issuer-SHA256 Certificate Serial Number Issuer DN
de87d0dc8d29f6d3547d8242abdf96632ee3dfb1538da253186f94553bcde604 0af85cfa8fbea55c3d00be8df4dd30e83ef28244 C=BM/O=QuoVadis Limited/CN=QuoVadis Root CA 3
de87d0dc8d29f6d3547d8242abdf96632ee3dfb1538da253186f94553bcde604 1af6d97a8ff0b28deeac01a524c87a6f32e79df6 C=BM/O=QuoVadis Limited/CN=QuoVadis Root CA 3
Mode
Basic
Availability
Edge
Display the revoked cert of a TLS inspection CRL that matches the issuer hash and serial number.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
Example
nsx-edge-1> get tls-inspection crls 00000000-0000-0002-0000-000000000002 issuer de87d0dc8d29f6d3547d8242abdf96632ee3dfb1538da253186f94553bcde604 certificate-serial-number 0af85cfa8fbea55c3d00be8df4dd30e83ef28244
Issuer-SHA256 Certificate Serial Number Issuer DN
de87d0dc8d29f6d3547d8242abdf96632ee3dfb1538da253186f94553bcde604 0af85cfa8fbea55c3d00be8df4dd30e83ef28244 C=BM/O=QuoVadis Limited/CN=QuoVadis Root CA 3
Mode
Basic
Availability
Edge
Display the revoked cert of a TLS inspection CRL that matches the public key hash.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
Example
nsx-edge-1> get tls-inspection crls 00000000-0000-0002-0000-000000000002 public-key-hash 15e7ae40cc4b3f7222a5a6fe3e7dc47f6e46ee9a2251839db296d62ada2a0df7
Subject-SHA256 Public Key Hash Subject DN
70c0d4628097e72c1ca75baf4fbdac9a6e8aeeaade1b52d677ee0305f183fb0d 15e7ae40cc4b3f7222a5a6fe3e7dc47f6e46ee9a2251839db296d62ada2a0df7 CN=google.lk
Mode
Basic
Availability
Edge
Display the revoked cert of a TLS inspection CRL that matches the subject SHA256 hash.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
Example
nsx-edge-1> get tls-inspection crls 00000000-0000-0002-0000-000000000002 subject 70c0d4628097e72c1ca75baf4fbdac9a6e8aeeaade1b52d677ee0305f183fb0d
Subject-SHA256 Public Key Hash Subject DN
70c0d4628097e72c1ca75baf4fbdac9a6e8aeeaade1b52d677ee0305f183fb0d 15e7ae40cc4b3f7222a5a6fe3e7dc47f6e46ee9a2251839db296d62ada2a0df7 CN=google.lk
Mode
Basic
Availability
Edge
Display the revoked cert of a TLS inspection CRL that matches the subject and public key hash.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
Example
nsx-edge-1> get tls-inspection crls 00000000-0000-0002-0000-000000000002 subject 70c0d4628097e72c1ca75baf4fbdac9a6e8aeeaade1b52d677ee0305f183fb0d public-key-hash 15e7ae40cc4b3f7222a5a6fe3e7dc47f6e46ee9a2251839db296d62ada2a0df7
Subject-SHA256 Public Key Hash Subject DN
70c0d4628097e72c1ca75baf4fbdac9a6e8aeeaade1b52d677ee0305f183fb0d 15e7ae40cc4b3f7222a5a6fe3e7dc47f6e46ee9a2251839db296d62ada2a0df7 CN=google.lk
Mode
Basic
Availability
Edge
Display revoked certs of a TLS inspection CRL.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> get tls-inspection crls 00000000-0000-0002-0000-000000000002
Issuer-SHA256 Certificate Serial Number Issuer DN
de87d0dc8d29f6d3547d8242abdf96632ee3dfb1538da253186f94553bcde604 0af85cfa8fbea55c3d00be8df4dd30e83ef28244 C=BM/O=QuoVadis Limited/CN=QuoVadis Root CA 3
de87d0dc8d29f6d3547d8242abdf96632ee3dfb1538da253186f94553bcde604 1af6d97a8ff0b28deeac01a524c87a6f32e79df6 C=BM/O=QuoVadis Limited/CN=QuoVadis Root CA 3
ffc863ff300bb524f3276b9365be7d3137ac9a7febe42d5ed80ddccefe3aa09a 5877d30c6f0f3c367f8c34f286fda52843bbb9f3 CN=Information Security Certification Authority/O=ISCA/C=KZ
b46c4c6a33058db6efd50ce4ad4d405d8bfb10c41b93de7dd11ec105ab50e0ff 22b9b175e35a273ebb6f5eee02ad9dd8 C=JP/O=SECOM Trust Systems CO.,LTD./OU=Security Communication RootCA2
Mode
Basic
Availability
Edge
Display TLS inspection global error stats associated with the routers.
Example
nsx-edge-1> get tls-inspection errors
context_map.context_lookup_by_sr_failed 1
log_router.sr_lookup_failed 3
Mode
Basic
Availability
Edge
Display TLS inspection error stats associated with the routers.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get tls-inspection errors lr-uuid ac8eeb6f-a7a1-4f1d-9e57-1499c89911f2
TLS Errors Client-Side Server-Side
mutual auth required 0 0
unexpected message alert 0 0
bad record mac alert 0 0
record overflow alert 0 0
decompression failure alert 0 0
handshake failure alert 0 0
bad certificate alert 5 0
unsupported certificate alert 0 0
certificate revoked alert 0 0
certificate expired alert 0 0
certificate unknown alert 0 0
illegal parameter alert 0 0
unknown ca alert 0 0
access denied alert 0 0
TLS Errors Other Errors
bpf_metadata_lookup_failed 0
tls_rule_matching_incomplete 0
metadata_action_profile_id_empty 0
action_profile_lookup_failed 0
Mode
Basic
Availability
Edge
Display TLS inspection error stats associated with the routers.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get tls-inspection errors sr-uuid 41be3273-383a-4484-ba9c-b16912a947e4
TLS Errors Client-Side Server-Side
mutual auth required: 0 0
unexpected message alert: 0 0
bad record mac alert: 0 0
record overflow alert: 0 0
decompression failure alert: 0 0
handshake failure alert: 0 0
bad certificate alert: 0 0
unsupported certificate alert: 0 0
certificate revoked alert: 0 1
certificate expired alert: 0 0
certificate unknown alert: 0 0
illegal parameter alert: 0 0
unknown ca alert: 1 0
access denied alert: 0 0
decode error alert: 0 0
decrypt error alert: 0 0
protocol version alert: 0 0
insufficient security alert: 0 0
internal error alert: 0 0
user canceled alert: 0 0
no renegotiation alert: 0 0
unsupported extension alert: 0 0
other error: 0 0
Mode
Basic
Availability
Edge
Display TLS inspection logging levels.
Example
nsx-edge-1> get tls-inspection logging
Destination Level
syslog info
console off
Mode
Basic
Availability
Edge
Display TLS inspection rule stats associated with the routers.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get tls-inspection rule-stats ac8eeb6f-a7a1-4f1d-9e57-1499c89911f2
tls inspection rule count: 1
Rule ID : 1021
Input bytes : 88002
Output bytes : 380202
Input packets : 876
Output packets : 789
Evaluations : 231
Hits : 102
Active connections : 0
Mode
Basic
Availability
Edge
Display TLS inspection rule stats associated with the routers.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <rule-id> | Rule ID Allowed pattern: ^[1-9][0-9]*$ |
Example
nsx-edge-1> get tls-inspection rule-stats ac8eeb6f-a7a1-4f1d-9e57-1499c89911f2 1021
Rule ID : 1021
Input bytes : 88002
Output bytes : 380202
Input packets : 876
Output packets : 789
Evaluations : 231
Hits : 102
Active connections : 0
Mode
Basic
Availability
Edge
Display TLS inspection rules brief associated with the routers.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get tls-inspection rules brief ac8eeb6f-a7a1-4f1d-9e57-1499c89911f2
tls inspection rule count: 1
Rule ID : 1022
Rule : inout protocol tcp from addrset {1.1.2.10} to addrset {1.1.3.10} port 9443 with attribute profile 00000000-0000-0002-0000-000000000002 tls_inspect tls_profile 04000000-0000-0000-0100-000000000000 with log
Mode
Basic
Availability
Edge
Display TLS inspection rules brief associated with the routers.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <rule-id> | Rule ID Allowed pattern: ^[1-9][0-9]*$ |
Example
nsx-edge-1> get tls-inspection rules brief ac8eeb6f-a7a1-4f1d-9e57-1499c89911f2 1022
Rule ID : 1022
Rule : inout protocol tcp from addrset {1.1.2.10} to addrset {1.1.3.10} port 9443 with attribute profile 00000000-0000-0002-0000-000000000002 tls_inspect tls_profile 04000000-0000-0000-0100-000000000000 with log
Mode
Basic
Availability
Edge
Display TLS inspection status information.
Example
nsx-edge-1> get tls-inspection
LR-UUID Enabled State HA-Status
5b43f8d2-289e-49a0-8751-3106ed20c1ee yes active active
ac8eeb6f-a7a1-4f1d-9e57-1499c89911f2 yes active active
Mode
Basic
Availability
Edge
Display TLS inspection traffic stats associated with the routers.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get tls-inspection traffic-stats lr-uuid ac8eeb6f-a7a1-4f1d-9e57-1499c89911f2
rule hits : 0
bypassed failed domains : 10
cached certs : 0
cached cert hits : 0
cached cert misses : 0
open connections : 15
total connections : 67
decrypted connections : 0
bypassed due to rules : 0
bypassed due to failures : 0
failed connections : 5
client-to-server bytes : 45
server-to-client bytes : 43879
Mode
Basic
Availability
Edge
Display TLS inspection traffic stats associated with the routers.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get tls-inspection traffic-stats sr-uuid 41be3273-383a-4484-ba9c-b16912a947e4
rule hits : 0
bypassed failed domains : 10
cached cert hits : 0
cached cert misses : 0
open connections : 15
total connections : 67
decrypted connections : 0
bypassed due to rules : 0
bypassed due to failures : 0
failured connections : 5
client-to-server bytes : 45
server-to-client bytes : 43879
Mode
Basic
Availability
Edge
Display information about a TN TEP group.
| Option | Description |
|---|---|
| <tn-tep-group-id> | TN TEP Group ID |
Example
nsx-edge-1> get tn-tep-group 1120211
Remote TN TEP Group : 1120211
Member IP : 10.1.1.12
Member IP : 10.1.1.13
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about all TN TEP groups
Example
nsx-edge-1> get vtep-groups
Local TN TEP Group : 1120210
Member IP : 10.1.1.10
Remote TN TEP Group : 1120211
Member IP : 10.1.1.12
Member IP : 10.1.1.13
Mode
Basic
Availability
Autonomous Edge, Edge
Display the topology of the system.
Example
nsx-edge-1> get topology
Machine (3949MB)
Socket L#0 + Core L#0 + PU L#0 (P#0)
Socket L#1 + Core L#1 + PU L#1 (P#1)
HostBridge L#0
PCI 8086:7111
PCI 15ad:0405
GPU L#0 "card0"
GPU L#1 "controlD64"
PCI 1000:0030
Block L#2 "sda"
PCIBridge
PCI 15ad:07b0
Net L#3 "eth0"
PCIBridge
PCI 15ad:07b0
PCIBridge
PCI 15ad:07b0
PCIBridge
PCI 15ad:07b0
Mode
Basic
Availability
Autonomous Edge, Edge
Display agent status information for the specified transport node.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get transport-node 141211f6-8354-11e8-9574-23265cbb97ba agent-status
TransportNode-ID Agent-Type Status Timestamp
141211f6-8354-11e8-9574-23265cbb97ba NSX_NESTDB UP 08:43:32 07/11/2018
Mode
Basic
Availability
Manager
Display the ARP table for the specified transport node.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get transport-node bfd72df1-ed5f-405f-a9d1-585e550bc677 arp-table
VNI IP MAC TransportNode-ID
17288 172.16.110.11 00:50:56:8e:91:12 bfd72df1-ed5f-405f-a9d1-585e550bc677
Mode
Basic
Availability
Manager
Display the MAC address table for the specified transport node.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get transport-node bfd72df1-ed5f-405f-a9d1-585e550bc677 mac-table
VNI MAC VTEP-IP TransportNode-ID
17288 00:50:56:8e:91:12 192.168.210.100 bfd72df1-ed5f-405f-a9d1-585e550bc677
Mode
Basic
Availability
Manager
Display routing domains joined by the specified transport node.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get transport-node bfd72df1-ed5f-405f-a9d1-585e550bc677 routing-domain
Routing-Domain-ID
133fa69c-756e-4d7e-8ac2-1317b9e02e31
133fa69c-756e-4d7e-8ac2-1317b9e02e32
Mode
Basic
Availability
Manager
Display the routing vtep table for the specified transport node.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get transport-node bfd72df1-ed5f-405f-a9d1-585e550bc677 routing-vtep
Routing-Domain-ID IP LABEL Segment MAC TransportNode-ID
133fa69c-756e-4d7e-8ac2-1317b9e02e31 92.168.210.100 0x15801 192.168.210.0 00:50:56:67:af:f4 bfd72df1-ed5f-405f-a9d1-585e550bc677
133fa69c-756e-4d7e-8ac2-1317b9e02e32 192.168.210.100 0x15801 192.168.210.0 00:50:56:67:af:f4 bfd72df1-ed5f-405f-a9d1-585e550bc677
Mode
Basic
Availability
Manager
Display status information for the specified transport node.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get transport-node bfd72df1-ed5f-405f-a9d1-585e550bc677 status
TransportNode-ID Controller SSL-Enabled Connection-State Supported-Versions
bfd72df1-ed5f-405f-a9d1-585e550bc677 127.0.0.1 true OPENED 1.1.0.0.0.0
Mode
Basic
Availability
Manager
Display status information for the specified transport node after querying all controller nodes in UA cluster.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get transport-node afa6da1b-cdda-47bb-9b4c-f5d46612e69d status-from-all-nodes
TransportNode-ID Remote-Address Controller SSL-Enabled Connection-State Supported-Versions Node-Type Name
afa6da1b-cdda-47bb-9b4c-f5d46612e69d 10.212.233.87:22959 fc3e9fa3-f74f-4ef8-9069-94571cc0c9d0 true OPENED [4.1, 4.0, 3.2] ESXi TN2
Mode
Basic
Availability
Manager
Display status information for the specified transport node.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get transport-node 86e2fd2a-8581-11e8-83f3-02004114d65f threat-status
TransportNode-ID Entity-Type Threat-Type State Timestamp
86e2fd2a-8581-11e8-83f3-02004114d65f THREAT_ENTITY_INTERFACE THREAT_NO_VIF_ATTACHMENT TN_STATE_ERROR 09:04:46 07/12/2018
Mode
Basic
Availability
Manager
Display VIF information for the specified transport node.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get transport-node bfd72df1-ed5f-405f-a9d1-585e550bc677 vifs
VIF LogSwitchPort-ID TransportNode-ID TransportNode-IP
133fa69c-756e-4d7e-8ac2-1317b9e02e31 9a71e870-f386-47c6-ae7f-f5e0895dba8b bfd72df1-ed5f-405f-a9d1-585e550bc677 192.168.210.51
Mode
Basic
Availability
Manager
Display all tunnel end points for the specified transport node.
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-controller-1> get transport-node bfd72df1-ed5f-405f-a9d1-585e550bc677 vtep
VNI IP LABEL Segment MAC TransportNode-ID
39816 192.168.210.100 0x15801 192.168.210.0 00:50:56:67:af:f4 bfd72df1-ed5f-405f-a9d1-585e550bc677
17288 192.168.210.100 0x15801 192.168.210.0 00:50:56:67:af:f4 bfd72df1-ed5f-405f-a9d1-585e550bc677
Mode
Basic
Availability
Manager
Display external IP mapping table entries on the host
Example
esx-1> get transport-node external-ip
External IP Mapping Table
-----------------------------------------------------------------------------------------------------------------------------
External IP Internal IP Discovered Internal IP Seen VNI MAC Address Port ID
11.11.10.2 192.168.1.10 192.168.1.10 19285 00:50:56:11:22:03 1234567
11.11.10.3 192.168.1.11 192.168.1.11 19286 00:50:56:11:22:04 1234568
Mode
Basic
Availability
ESXi
Display external IP mapping table entry on the host
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
esx-1> get transport-node external-ip
External IP Mapping Table Entry
-----------------------------------------------------------------------------------------------------------------------------
External IP Internal IP Discovered Internal IP Seen VNI MAC Address Port ID
11.11.10.2 192.168.1.10 192.168.1.10 19285 00:50:56:11:22:03 1234567
Mode
Basic
Availability
ESXi
Display the health metric for specific transport node nsx stats module.
| Option | Description |
|---|---|
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get transport-node health-metrics module vdl2-health metrics all
Module Health Metrics
----------------------------------------------------------------------
Name: nsxt-vdl2
Health Status: DEGRADED
Err Msg: Vtep ip not set for some of vteps.
StatusUpdateTime: Mon Jul 29 18:22:40.345 2024 GMT
UpTime: 15:45:33
Num Metrics: 7
METRIC NAME METRICS
----------------------------------------------------------------------
lcp_connection_status 0
uplink_not_set_for_vtep_count 0
vtep_ip_not_assigned_count 2
all_bfd_tunnels_from_a_vtep_down_count 0
gw_mac_not_resolved_count 0
pkt_slab_errors 0
heap_alloc_failures 0
Mode
Basic
Availability
ESXi
List all the health metrics with brief description for all the modules.
| Option | Description |
|---|---|
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get transport-node health-metrics module vdl2-health metrics list
Datapath Metrics List
----------------------------------------------------------------
METRIC_NAME BRIEF DESCRIPTION
vdl2_lcp_connection_status vdl2 to lcp channel down
uplink_not_set_for_vtep uplink not present for the vtep
Mode
Basic
Availability
ESXi
List all the health metrics enabled transport node nsx modules.
Example
esx-1> get transport-node health-metrics modules list
Modules List
------------------------------------------------------------
MODULE NAME BRIEF DESCRIPTION
vdl2-health nsxt-vdl2 related health metrics
Mode
Basic
Availability
ESXi
Display specified transport node nsx stats counter's detailed description.
| Option | Description |
|---|---|
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
| <counter-name> | Observability counters for specified kernel module Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get transport-node nsx-stats module nsxt-vdl2 counter leafInDrop1 description verbose
Datapath Observability Counter Description
--------------------------------------------------
COUNTER NAME: leafInDrop1
VERBOSE DESCRIPTION:
Drop counters at leaf for reason2 verbose. This is
expected to be very big as like paragraphs.Thus,
let's test it by printing as much log msg as
possible. So this message is for a counter xxx.
This counter is incremented when the packets are
dropped since they are received with an incorrect
value for x.
Mode
Basic
Availability
ESXi
Display the counters value for specific transport node nsx stats module.
| Option | Description |
|---|---|
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get transport-node nsx-stats module nsxt-vdl2 counters all
Datapath Observability All Counters
----------------------------------------------------------------------
COUNTER NAME COUNTERS
txpps 0.0
txmbps 0.0
txeps 0.0
rxpps 0.0
rxmbps 0.0
rxeps 0.0
rxMissed 0
rxErrorTotal 0
Mode
Basic
Availability
ESXi
List all the nsx stats counters with brief description for the specified module.
| Option | Description |
|---|---|
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get transport-node nsx-stats module nsxt-vdl2 counters list
Datapath Observability Counters List
----------------------------------------------------------------
COUNTER_NAME BRIEF DESCRIPTION
rxeps rx error per second
txeps tx error per second
Mode
Basic
Availability
ESXi
Display specified module's detailed description for observability transport node nsx stats counters.
| Option | Description |
|---|---|
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get transport-node nsx-stats module nsxt-vdr description verbose
Datapath Observability Module Description
--------------------------------------------------
MODULE NAME: nsxt-vdr
VERBOSE DESCRIPTION:
Kernel module nsxt-vdr is responsible for any
layer-3 routing decisions.
Mode
Basic
Availability
ESXi
List all the observability enabled transport node nsx stats modules.
Example
esx-1> get transport-node nsx-stats modules list
Modules List
------------------------------------------------------------
MODULE NAME BRIEF DESCRIPTION
nsxt-vdl2 nsxt-vdl2 related counters
nsxt-vdrb nsxt-vdrb related counters
Mode
Basic
Availability
ESXi
Display specified transport node platform stats counter's detailed description.
| Option | Description |
|---|---|
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
| <counter-name> | Observability counters for specified kernel module Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get transport-node platform-stats module host-vNIC counter rxeps description verbose
Datapath Observability Counter Description
--------------------------------------------------
COUNTER NAME: rxeps
VERBOSE DESCRIPTION:
Receive Errors per second for hot vNIC
Mode
Basic
Availability
ESXi
Display the counters value for specific transport node platform stats module.
| Option | Description |
|---|---|
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get transport-node platform-stats module host-uplink counters all
Datapath Observability All Counters
----------------------------------------------------------------------
COUNTER NAME COUNTERS
txpps 0.0
txmbps 0.0
txeps 0.0
rxpps 0.0
rxmbps 0.0
rxeps 0.0
rxMissed 0
rxErrorTotal 0
Mode
Basic
Availability
ESXi
List all the platform stats counters with brief description for the specified module.
| Option | Description |
|---|---|
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get transport-node platform-stats module host-vNIC counters list
Datapath Observability Counters List
----------------------------------------------------------------
COUNTER_NAME BRIEF DESCRIPTION
rxeps rx error per second
txeps tx error per second
Mode
Basic
Availability
ESXi
Display specified module's detailed description for observability transport node platform stats counters.
| Option | Description |
|---|---|
| <module-name> | Kernel module name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get transport-node platform-stats module host-vNIC description verbose
Datapath Observability Module Description
--------------------------------------------------
MODULE NAME: host-vNIC
VERBOSE DESCRIPTION:
Platform Module Host vNIC is responsible for vNIC switchport related
information.
Mode
Basic
Availability
ESXi
List all the observability enabled transport node platform stats modules.
Example
esx-1> get transport-node platform-stats modules list
Modules List
------------------------------------------------------------
MODULE NAME BRIEF DESCRIPTION
host-vNIC host vnic related counters
host-uplink nsxt-uplink related counters
Mode
Basic
Availability
ESXi
Display status information for all transport nodes.
Example
nsx-controller-1> get transport-nodes status
TransportNode-ID Remote-Address Controller Manager-IP Manager-IPv6 SSL-Enabled Connection-State Supported-Versions Node-Type Name
862e6ce4-1d3f-494c-93af-17a3be722ff4 64fd1e84-c733-4ac4-ac0f-8eade505770c 10.191.233.49 fd00::2:9201 true CLOSED [] ESXi 10.191.113.18
4254fdce-281d-11ec-83d8-02011898bb21 10.191.234.215:45276 a7ed3bc5-a3ea-48bf-b130-137698d5b1ec 10.191.236.157 fd00::2:9202 true OPENED [3.2, 3.1, 3.0] Edge edge-4
831c0df2-281d-11ec-8743-020118f9b65f 64fd1e84-c733-4ac4-ac0f-8eade505770c 10.191.233.49 fd00::2:9201 true CLOSED [] ESXi 10.191.113.19
dfcb2c8e-004f-4274-8d51-cb5d88f1b05e 4b29c96e-7e8f-4681-ab82-2985dadc2f4f 10.191.228.94 fd00::2:9203 true CLOSED [] ESXi 10.221.113.8
Mode
Basic
Availability
Manager
Display status information for all transport nodes after querying all controller nodes in UA cluster.
Example
nsx-controller-1> get transport-nodes status-from-all-nodes
TransportNode-ID Remote-Address Controller Manager-IP Manager-IPv6 SSL-Enabled Connection-State Supported-Versions Node-Type Name
afa6da1b-cdda-47bb-9b4c-f5d46612e69d 10.212.233.87:22959 fc3e9fa3-f74f-4ef8-9069-94571cc0c9d0 10.212.234.68 fd00::2:9201 true OPENED [4.1, 4.0, 3.2] ESXi TN2
e32882cf-2419-4f4f-b2ec-c1bd456bfa36 10.212.239.148:37652 5e868ee0-b1ec-4e39-81e0-41afa79ed8e2 10.212.237.57 fd00::2:9202 true OPENED [4.1, 4.0, 3.2] ESXi TN1
Mode
Basic
Availability
Manager
Display information about the specified tunnel port.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get tunnel-port d87cd7e0-eb91-5dd5-bae4-ceb0a2760bfa
Tunnel : d87cd7e0-eb91-5dd5-bae4-ceb0a2760bfa
IFUID : 295
LOCAL : 192.168.250.162
REMOTE : 192.168.250.160
ENCAP : GENEVE
Mode
Basic
Availability
Autonomous Edge, Edge
Display statistics for the specified tunnel port.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
Example
nsx-edge-1> get tunnel-port 6598ab27-95c6-50ef-85b3-89b7811ab672 stats
Tunnel : 6598ab27-95c6-50ef-85b3-89b7811ab672
RX-Packets : 0
RX-Bytes : 0
RX-Drops : 0
Malformed : 0
No-Match : 0
L2-Loop : 0
TX-Packets : 3498
TX-Bytes : 433752
TX-Drops : 0
No-Memory : 0
No-Route : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about all tunnel ports e.g. Geneve, GRE, VxLAN
Example
nsx-edge-1> get tunnel-ports
Tunnel : d87cd7e0-eb91-5dd5-bae4-ceb0a2760bfa
IFUID : 295
LOCAL : 169.254.64.1
REMOTE : 169.254.64.3
ENCAP : GRE
GRETAP VRFID: 3
Tunnel : 6598ab27-95c6-50ef-85b3-89b7811ab672
IFUID : 296
LOCAL : 192.168.250.162
REMOTE : 192.168.250.161
ENCAP : GENEVE
Mode
Basic
Availability
Autonomous Edge, Edge
Display statistics for all tunnel ports e.g. Geneve, GRE, VxLAN
Example
nsx-edge-1> get tunnel-ports stats
Tunnel : d87cd7e0-eb91-5dd5-bae4-ceb0a2760bfa
RX-Packets : 0
RX-Bytes : 0
RX-Drops : 0
Malformed : 0
No-Match : 0
L2-Loop : 0
TX-Packets : 3325
TX-Bytes : 412300
TX-Drops : 0
No-Memory : 0
No-Route : 0
Tunnel : 6598ab27-95c6-50ef-85b3-89b7811ab672
RX-Packets : 0
RX-Bytes : 0
RX-Drops : 0
Malformed : 0
No-Match : 0
L2-Loop : 0
TX-Packets : 3331
TX-Bytes : 413044
TX-Drops : 0
No-Memory : 0
No-Route : 0
Mode
Basic
Availability
Autonomous Edge, Edge
Display all Multicast Groups the Edge joined in Underlay
Example
Edge-1> get underlay-subscription
Underlay Subscriptions
Overlay Group Multicast Group VTEP IP Ref-Count
Mode
Basic
Availability
Autonomous Edge, Edge
Display the status of the upgrade steps run on the node and details of last upgrade step.
Example
pace-1> get upgrade progress-status
Upgrade info:
From-version: 1.0.1.0.0.0673018
To-version: 1.0.1.0.0.15113624
Upgrade steps:
download_os [2019-11-22 14:01:23.323716 - 2019-11-22 14:01:23.323716] SUCCESS:
shutdown_manager [2019-11-22 14:01:23.323716 - 2019-11-22 14:01:23.323716] SUCCESS:
switch_os [2019-11-22 14:01:23.323716 - 2019-11-22 14:01:23.323716] FAILED:
"status": "Proton failed to start",
"stderr": "Some Error"
"troubleshooting": "System is in a bad state. Please contact GSS to rollback the system to the last working stage"
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display the contents of the specified playbook for the specified upgrade bundle.
| Option | Description |
|---|---|
| <bundle-name> | Name of NSX upgrade bundle in the file store |
| <playbook-file> | Name of Playbook file to use |
Example
nsx-edge-1> get upgrade-bundle VMware-NSX-edge-2.0.0.0.0.5298714 playbook VMware-NSX-edge-2.0.0.0.0.5298714-playbook
steps:
- name: 11-preinstall-enter_maintenance_mode
- name: install_os
- name: reboot
- name: 41-postboot-exit_maintenance_mode
- name: finish_upgrade
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display all playbooks in the file store.
Example
nsx-edge-1> get upgrade-bundle playbooks
playbook
VMware-NSX-edge-2.0.0.0.0.5298714-playbook
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display the system uptime information.
Example
nsx-manager-1> get uptime
16:34:39 up 15 days, 16:16, 1 user, load average: 0.55, 0.25, 0.26
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display reputation and category info about URL
| Option | Description |
|---|---|
| <url-string-arg> | URL string, e.g. www.vmware.com Allowed pattern: ^([a-z]+://)?(www.)?[-a-zA-Z0-9@:%._+~#=]{2,256}.[a-z]{2,6}(/([-a-zA-Z0-9@:%_+.~#?&/=]*))?$ |
Example
nsxedge> get url-classification vmware.com
URL: vmware.com
Reputation: 88
Category:
Business and Economy
Computer and Internet Info
Result status: db ok
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <username> | Username of user |
Example
nsx> get user audit password-expiration
Password expires 90 days after last change
Current password will expire in 80 days
User will receive warning messages 10 days before password expires.
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Get user status for specified non-root user.
| Option | Description |
|---|---|
| <username> | Username of user |
Example
nsx> get user audit status
Full name:
Username: audit
Status: ACTIVE
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Get SSH keys from authorized_keys file for specified user.
| Option | Description |
|---|---|
| <username> | Username of user |
Example
nsx> get user admin ssh-keys
label: user1@domain1
type: ssh-rsa
value:
AAAAB3NzaC1yc2EAAAABIwAAAIEAywWhrwq4FjHt+UuwZcZePxtjtZOENFpOjufycaYso2nTlzNwnAQEQRfbqsUxKVtOtGxgApIkUvjRIjNBdJE6iOzvBXZhhJrM0GUDJragw7SMVIs/5xJBGAyHKJ1YUMGO7+nJTmsCLx6PFOlQYveuriiVVCCZerGCLH+UtSXK3z+l7hx9NiDg3/ylOLc3f3SLxrJKn0gMTgK7BHJFXo4PguuPjWZLVdUDX+XKiqtT2n4IsYs6N9qVFG3zUgNlEjZM47NK/ytAC0max98pK+QNzsuaQOo/IShJ1TOw5wwScflPArVJ2AyROqAe7cfQg7q12I9olASFd3U5NazfZCTYAvWA1kz9UZEWLJ1Br1XOkPqOleMM8KCp/PXzz8H0kISkMIji0/QuiZOPEBsKlszXjlALcXR8Mg1uiZVWy48i9JheyXyj1ToCj6cPScpgFHp3DAGSlKKbE1EFaVfeeyGAnHESuXC9wkSeFZCEyMJ+RgJxMkBXNZmyycbwsSqAeGJpMEUDlwzu2GD0obBz0HXqg9J1Xallop5AVDKfeszZcc=
label: user2@domain2
type: ssh-rsa
value:
AAAAB3NzaC1yc2EAAAABIwAAAIEA0KJDLOiiXj9XdMxiCT9KvaKfuxFQi+CIiklaN5hHsNgYOu7TijqyONEu5fONLoAo/cshLa+KuargyTrtizwcP4TPcTXZhhJrM0GUDJragw7SMVIs/5xJBGAyHKJ1YUMGO7+nJTmsCLx6PFOlQYveuriiVVCCZerGCLH+UtSXK3z+l7hx9NiDg3/ylOLc3f3SLxrJKn0gMTgK7BHJFXo4PguuPjWZLVdUDX+XKiqtT2n4IsYs6N9qVFG3zUgNlEjZM47NK/ytAC0max98pK+QNzsuaQOo/IShJ1TOw5wwScflPArVJ2AyROqAe7cfQg7q12I9olASFd3U5NazfZCTYAvWA1kz9UZEWLJ1Br1XOkPqOleMM8KCp/PXzz8H0kISkMIji0/QuiZOPEBsKlszXjlALcXR8Mg1uiZVWy48i9JheyXyj1ToCj6cPScpgFHp3DAGSlKKbE1EFaVfeeyGAnHESlnDDg3Gq5xSsB9Okqm3V5t8GpFaJbV68BxQ4BK6HJ21A3CinV4LdV3hR/OBUbDG2EcI+ZKRDjlpJuu4YU=
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Display the version of the NSX appliance.
Example
nsx> get version
VMware NSX Software, Version 9.0.0.0.24476664
Technical Support: https://support.broadcom.com
Copyright © 2025 Broadcom. All rights reserved. The term
"Broadcom" refers to Broadcom Inc. and/or subsidiaries.
All trademarks, trade names, service marks, and logos
referenced herein belong to their respective companies.
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, ESXi, KVM, NSX Cloud VM, Manager, NSX on VMC
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).| Option | Description |
|---|---|
| <vif> | VIF ID |
Example
nsx-controller-1> get vif c78a1655-228c-493b-88cf-6b77dafe908d
VIF LogSwitchPort-ID TransportNode-ID TransportNode-IP
c78a1655-228c-493b-88cf-6b77dafe908d 335bbfdc-d6d6-4d87-8fb1-b98614fff1d8 de9dca49-fc90-43ae-aa65-3b0148da4eee 192.168.210.51
Mode
Basic
Availability
Manager
Dump the host's network mode and tagged interface.
Example
host-1> get vm-network-mode
VM-Network-Mode : Overlay
Interface : eth1
Mode
Basic
Availability
NSX Cloud VM
Get VMC migration mode status.
Example
nsx-edge-1> get vmc migration-mode
VMC Migration Mode: true
Mode
Basic
Availability
Edge
Display information about all VPCs.
Example
Edge-4> get vpcs
Mon Aug 12 2024 UTC 09:33:28.830
VPC
UUID VRF Project-ID VPC-ID Type
28fc4197-bfef-40a2-a9d5-18a06fe601ac 10 PROJECT-BANGLORE VPCVIZAG4567 SERVICE_ROUTER_TIER1
dcb640be-8483-441c-ab55-74683eff045d 11 PROJECT-BANGLORE VPCHYD1123 DISTRIBUTED_ROUTER_TIER1
Edge-4>
Mode
Basic
Availability
Autonomous Edge, Edge, Manager
Display information about vpc gateway routers on this hypervisor host.
Example
esx-1> get vpcs
VPC Routers Summary
-----------------------------------------------------------------------------------------------------------------
VPC DR UUID TGW DR ID Policy Path
d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 default /orgs/default/projects/default/vpcs/vpc1
d4c86bd9-cb52-4f38-b6b9-3bf521fa28f9 default /orgs/default/projects/default/vpcs/vpc2
Mode
Basic
Availability
ESXi
Display information on vpc gateway routers on this hypervisor host.
| Option | Description |
|---|---|
| <policy-path-string> | DR path string argument Allowed pattern: ^([A-Za-z0-9_:./-]+)$ |
Example
esx-1> get vpcs /orgs/default/projects/default/
VPC Routers Summary
-----------------------------------------------------------------------------------------------------------------
VPC DR UUID TGW DR ID Policy Path
d4c86bd9-cb52-4f38-b6b9-3bf521fa27f8 default /orgs/default/projects/default/vpcs/vpc1
d4c86bd9-cb52-4f38-b6b9-3bf521fa28f9 default /orgs/default/projects/default/vpcs/vpc2
Mode
Basic
Availability
ESXi
Display information on subnet on this hypervisor host.
| Option | Description |
|---|---|
| <policy-path-string> | DR path string argument Allowed pattern: ^([A-Za-z0-9_:./-]+)$ |
Example
esx-1> get vpcs /orgs/default/projects/default/ subnets
Subnet Summary
----------------------------------------------------------------------------------------------------------------------------------
Gateway Interface UUID VNI Access Mode Subnet Path
No Gateway Interface 68608 ISOLATED /orgs/default/projects/default/vpcs/vpc1/subnets/vpc1-subnet3
7e261266-658b-411c-8e47-3cf95cec25b9 67585 PRIVATE /orgs/default/projects/default/vpcs/vpc2/subnets/vpc2-subnet1-gateway-interface
4c370d4a-713a-4006-ba6b-cda6cac7889a 67584 PRIVATE /orgs/default/projects/default/vpcs/vpc1/subnets/vpc1-subnet2-gateway-interface
Mode
Basic
Availability
ESXi
Display all VRF VNI information.
Example
EVPN-M0-EDGE-ONE(tier0_sr)> get vrf vni
VRF VNI VxLAN IF L3-SVI State Rmac
vrf-2 100000 vxlan-100000 kni-275 Up 02:50:56:56:54:00
Mode
Tier0_sr
Availability
Edge
Display information about EW policy service chain.
Example
nsxedge(tier0_sr)> get vsip-si policy-service-chains
Policy Service Chain:
Chain UUID : 86bea3fc-cf6f-4da3-b9d0-00c5821c8e5d
Chain ID : 1
Path Selection Policy : LOCAL
Mode
Basic
Availability
Autonomous Edge, Edge
Display selected paths info
| Option | Description |
|---|---|
| <service-chain-id> | Service Chain Id |
Example
> get vsip-si selected-service-paths 1
----------------------------------------------------------------------
CCP Path ID :00000000-0aa6-0a85-0000-000000000001
Path ID :1
Chain ID :1
Is Selected :1
Is Updated :0
DelEntry :0
Forward Path
UniPath ID :1
Length :1
Host Cross Count :0
Host Local Count :0
Is Active :1
In Maintenance Mode :0
Forward Hop List
Mac Address :00:50:56:b8:d8:d9
Vif ID :c18723c6-a264-480a-b865-f8cd59e303e6
Is Liveness Support :0
Can Decrement SI :0
Is Active From CCP :1
Is Active From DP :1
SVM Action :redirect
SVM Mode :native
Reverse Path
UniPath ID :2
Length :1
Host Cross Count :0
Host Local Count :0
Is Active :1
In Maintenance Mode :0
Reverse Hop List
Mac Address :00:50:56:b8:d8:d9
Vif ID :c18723c6-a264-480a-b865-f8cd59e303e6
Is Liveness Support :0
Can Decrement SI :0
Is Active From CCP :1
Is Active From DP :1
SVM Action :redirect
SVM Mode :native
Mode
Basic
Availability
ESXi
Display information about EW service chain.
Example
nsxedge(tier0_sr)> get vsip-si service-chains
Service Chain:
Chain UUID : 86bea3fc-cf6f-4da3-b9d0-00c5821c8e5d
Chain ID : 1
Path Selection Policy : LOCAL
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about EW service path.
Example
nsxedge(tier0_sr)> get vsip-si service-paths
Service Path:
Path UUID : 00000000-0aa6-0a85-0000-000000000001
Chain ID : 1
Forward Path:
Path Length(number of hops) : 1
Path ID : 1
Host Cross Count : 0
Is Active : 1
Is In Mantenance Mode : 0
Forward Path Hops:
Mac : 00:50:56:a9:38:32
Active From MP : 1
Active From CCP : 1
Active From DP : 1
Liveness Support : 0
Decrement SI : 0
Action : REDIRECT
Encap Mode : NSH
Reverse Path:
Path Length(number of hops) : 1
Path ID : 2
Host Cross Count : 0
Is Active : 1
Is In Mantenance Mode : 0
Reverse Path Hops:
Mac : 00:50:56:a9:38:32
Active From MP : 1
Active From CCP : 1
Active From DP : 1
Liveness Support : 0
Decrement SI : 0
Action : REDIRECT
Encap Mode : NSH
Mode
Basic
Availability
Autonomous Edge, Edge
Display service paths info
| Option | Description |
|---|---|
| <service-chain-id> | Service Chain Id |
Example
> get vsip-si service-paths 1
Service path count: 1
----------------------------------------------------------------------
CCP Path ID :00000000-0aa6-0a85-0000-000000000001
Path ID :1
Chain ID :1
Is Selected :1
Is Updated :0
DelEntry :0
slot_picked[0] :1
slot_picked[1] :1
slot_picked[2] :1
slot_picked[3] :1
slot_picked[4] :1
slot_picked[5] :1
slot_picked[6] :1
num_slot_picked :7
Forward Path
UniPath ID :1
Length :1
Host Cross Count :0
Host Local Count :0
Is Active :1
In Maintenance Mode :0
Forward Hop List
Mac Address :00:50:56:b8:d8:d9
Vif ID :c18723c6-a264-480a-b865-f8cd59e303e6
Is Liveness Support :0
Can Decrement SI :0
Is Active From CCP :1
Is Active From DP :1
SVM Action :redirect
SVM Mode :native
Reverse Path
UniPath ID :2
Length :1
Host Cross Count :0
Host Local Count :0
Is Active :1
In Maintenance Mode :0
Reverse Hop List
Mac Address :00:50:56:b8:d8:d9
Vif ID :c18723c6-a264-480a-b865-f8cd59e303e6
Is Liveness Support :0
Can Decrement SI :0
Is Active From CCP :1
Is Active From DP :1
SVM Action :redirect
SVM Mode :native
Mode
Basic
Availability
ESXi
Display active service paths info
| Option | Description |
|---|---|
| <service-chain-id> | Service Chain Id |
Example
> get vsip-si service-paths 1 active
Service path count: 1
----------------------------------------------------------------------
CCP Path ID :00000000-0aa6-0a85-0000-000000000001
Path ID :1
Chain ID :1
Is Selected :1
Is Updated :0
DelEntry :0
slot_picked[0] :1
slot_picked[1] :1
slot_picked[2] :1
slot_picked[3] :1
slot_picked[4] :1
slot_picked[5] :1
slot_picked[6] :1
num_slot_picked :7
Forward Path
UniPath ID :1
Length :1
Host Cross Count :0
Host Local Count :0
Is Active :1
In Maintenance Mode :0
Forward Hop List
Mac Address :00:50:56:b8:d8:d9
Vif ID :c18723c6-a264-480a-b865-f8cd59e303e6
Is Liveness Support :0
Can Decrement SI :0
Is Active From CCP :1
Is Active From DP :1
SVM Action :redirect
SVM Mode :native
Reverse Path
UniPath ID :2
Length :1
Host Cross Count :0
Host Local Count :0
Is Active :1
In Maintenance Mode :0
Reverse Hop List
Mac Address :00:50:56:b8:d8:d9
Vif ID :c18723c6-a264-480a-b865-f8cd59e303e6
Is Liveness Support :0
Can Decrement SI :0
Is Active From CCP :1
Is Active From DP :1
SVM Action :redirect
SVM Mode :native
Mode
Basic
Availability
ESXi
Display service paths info
| Option | Description |
|---|---|
| <service-chain-id> | Service Chain Id |
Example
> get vsip-si service-paths 1 all
Service path count: 1
----------------------------------------------------------------------
CCP Path ID :00000000-0aa6-0a85-0000-000000000001
Path ID :1
Chain ID :1
Is Selected :1
Is Updated :0
DelEntry :0
slot_picked[0] :1
slot_picked[1] :1
slot_picked[2] :1
slot_picked[3] :1
slot_picked[4] :1
slot_picked[5] :1
slot_picked[6] :1
num_slot_picked :7
Forward Path
UniPath ID :1
Length :1
Host Cross Count :0
Host Local Count :0
Is Active :1
In Maintenance Mode :0
Forward Hop List
Mac Address :00:50:56:b8:d8:d9
Vif ID :c18723c6-a264-480a-b865-f8cd59e303e6
Is Liveness Support :0
Can Decrement SI :0
Is Active From CCP :1
Is Active From DP :1
SVM Action :redirect
SVM Mode :native
Reverse Path
UniPath ID :2
Length :1
Host Cross Count :0
Host Local Count :0
Is Active :1
In Maintenance Mode :0
Reverse Hop List
Mac Address :00:50:56:b8:d8:d9
Vif ID :c18723c6-a264-480a-b865-f8cd59e303e6
Is Liveness Support :0
Can Decrement SI :0
Is Active From CCP :1
Is Active From DP :1
SVM Action :redirect
SVM Mode :native
Mode
Basic
Availability
ESXi
Display maintanence service paths info
| Option | Description |
|---|---|
| <service-chain-id> | Service Chain Id |
Example
> get vsip-si service-paths 1 maintenance-mode
Service path count: 1
----------------------------------------------------------------------
CCP Path ID :00000000-0aa6-0a85-0000-000000000001
Path ID :1
Chain ID :1
Is Selected :0
Is Updated :0
DelEntry :0
slot_picked[0] :1
slot_picked[1] :1
slot_picked[2] :1
slot_picked[3] :1
slot_picked[4] :1
slot_picked[5] :1
slot_picked[6] :1
num_slot_picked :7
Forward Path
UniPath ID :1
Length :1
Host Cross Count :0
Host Local Count :0
Is Active :1
In Maintenance Mode :0
Forward Hop List
Mac Address :00:50:56:b8:d8:d9
Vif ID :c18723c6-a264-480a-b865-f8cd59e303e6
Is Liveness Support :0
Can Decrement SI :0
Is Active From CCP :1
Is Active From DP :1
SVM Action :redirect
SVM Mode :native
Reverse Path
UniPath ID :2
Length :1
Host Cross Count :0
Host Local Count :0
Is Active :1
In Maintenance Mode :1
Reverse Hop List
Mac Address :00:50:56:b8:d8:d9
Vif ID :c18723c6-a264-480a-b865-f8cd59e303e6
Is Liveness Support :0
Can Decrement SI :0
Is Active From CCP :1
Is Active From DP :1
SVM Action :redirect
SVM Mode :native
Mode
Basic
Availability
ESXi
Display information about EW service path with specific chain id.
| Option | Description |
|---|---|
| <number> | Datapath service chain ID argument Allowed pattern: ^[0-9]+$ |
Example
nsxedge(tier0_sr)> get vsip-si service-paths 1
Service Path:
Path UUID : 00000000-0aa6-0a85-0000-000000000001
Chain ID : 1
Forward Path:
Path Length(number of hops) : 1
Path ID : 1
Host Cross Count : 0
Is Active : 1
Is In Mantenance Mode : 0
Forward Path Hops:
Mac : 00:50:56:a9:38:32
Active From MP : 1
Active From CCP : 1
Active From DP : 1
Liveness Support : 0
Decrement SI : 0
Action : REDIRECT
Encap Mode : NSH
Reverse Path:
Path Length(number of hops) : 1
Path ID : 2
Host Cross Count : 0
Is Active : 1
Is In Mantenance Mode : 0
Reverse Path Hops:
Mac : 00:50:56:a9:38:32
Active From MP : 1
Active From CCP : 1
Active From DP : 1
Liveness Support : 0
Decrement SI : 0
Action : REDIRECT
Encap Mode : NSH
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about service policies.
Example
nsxedge(tier0_sr)> get vsip-si service-policies
Service Insertion Policy:
Policy UUID : dd947221-c3c1-45cd-b231-ee2d17fdfc61
Transport type : EW_NSH
Is EW policy : 1
Service Ports:
port UUID : 3c2673c4-fd0d-4545-8334-c0753f3fbebb
port UUID : e10c1f74-c66a-487e-b8df-d1232f353e1e
port UUID : e28c1645-0c4d-4930-b1b1-d14e445e328e
Forward Service Mode : REDIRECT
Forward Service Liveness Detection : REQUIRED
Reserve Service Mode : REDIRECT
Reserve Service Liveness Detection : REQUIRED
Failure Policy : ON_FAILURE_DROP
Number of service paths : 2
Path Index : 0
Forward Service Path ID : 1
Forward Service Chain ID : 1
Forward Service Index : 2
Forward Service Mac Address : 00:50:56:8b:73:96
Reverse Service Path ID : 2
Reverse Service Chain ID : 1
Reverse Service Index : 2
Reverse Service Mac Address : 00:50:56:8b:89:b2
Path Index : 1
Forward Service Path ID : 3
Forward Service Chain ID : 1
Forward Service Index : 2
Forward Service Mac Address : 00:50:56:8b:4e:b5
Reverse Service Path ID : 4
Reverse Service Chain ID : 1
Reverse Service Index : 2
Reverse Service Mac Address : 00:50:56:8b:89:b2
Service Insertion Policy:
Policy UUID : 379efe49-15ef-4d81-abef-98db335ae795
Transport type : L2_BRIDGE
Is EW policy : 0
Is BFD enabled : TRUE
Service link1 IP : 169.254.16.3
Service link2 IP : 169.254.17.3
Service link1 nexthop IP : 169.254.16.2
Service link2 nexthop IP : 169.254.17.2
Service link1 UUID : 379ac7fd-0d3b-4d40-a371-a8fdb59d7546
Service link2 UUID : 3864edbf-5545-418d-94d7-e1aa0b597f22
Failure Policy : ON_FAILURE_DROP
Mode
Basic
Availability
Autonomous Edge, Edge
Get MAC Table associated with a Team of a vswitch
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
Example
esx-1> get vswitch mac-table team nsxvswitch
MAC: 00:00:0c:07:ac:66 vid: 0 vni: 0 type: learned aging: yes elapsed: 0 mac-move: 0
MAC: 02:08:20:37:63:bb vid: 0 vni: 0 type: learned aging: yes elapsed: 24 mac-move: 0
MAC: 00:14:4f:e3:f6:84 vid: 0 vni: 0 type: learned aging: yes elapsed: 98 mac-move: 0
MAC: 04:3f:72:a4:ea:c4 vid: 0 vni: 0 type: learned aging: yes elapsed: 43 mac-move: 0
MAC: 02:08:20:88:3b:29 vid: 0 vni: 0 type: learned aging: yes elapsed: 50 mac-move: 0
MAC: 02:08:20:9a:45:f4 vid: 0 vni: 0 type: learned aging: yes elapsed: 81 mac-move: 0
MAC: 24:6e:96:b2:55:ac vid: 0 vni: 0 type: learned aging: yes elapsed: 111 mac-move: 0
MAC: 00:0c:29:3a:fa:58 vid: 1010 vni: 0 type: learned aging: yes elapsed: 105 mac-move: 0
esx-1>
Mode
Basic
Availability
ESXi
Display all vSwitch runtime options on this host.
Example
esx-1> get vswitch runtime
IGMPQueries: 2
IGMPQueryInterval: 125
IGMPRouterIP: 0.0.0.0
IGMPV3MaxSrcIPNum: 10
IGMPVersion: 3
MLDRouterIP: FE80::FFFF:FFFF:FFFF:FFFF
MLDV2MaxSrcIPNum: 10
MLDVersion: 2
MaxRARPsPerInterval: 128
RARPAdvertisementDuration: 60
TeamPolicyUpDelay: 100
Mode
Basic
Availability
ESXi
Display all VTEP records for specific VTEP GROUP
| Option | Description |
|---|---|
| <int> | Integer Allowed pattern: ^([0-9]+)$ |
Example
nsx-controller-1> get vtep-group 24539 vtep
VNI IP MAC LABEL Segment TransportNode-Id TN-Connection HA-STATE
67482 66.170.99.2 00:00:01:33:c9:68 0x64 0.0.22.46 1c3b3eec-0f2b-459d-8610-25a642aee761 true True
Mode
Basic
Availability
Manager
Display all VTEP records for specific VTEP GROUP
| Option | Description |
|---|---|
| <int> | Integer Allowed pattern: ^([0-9]+)$ |
Example
nsx-controller-1> get vtep-group 26539 vteps-staleness-status
VNI IP MAC LABEL Segment TransportNode-Id TN-Connection HA-STATE STALE-RECORD
67482 66.170.99.2 00:00:01:33:c9:68 0x64 0.0.22.46 1c3b3eec-0f2b-459d-8610-25a642aee761 true True False
Mode
Basic
Availability
Manager
Display information about a VTEP group.
| Option | Description |
|---|---|
| <vtep-group-id> | VTEP Group ID |
Example
nsx-edge-1> get vtep-group 1120211
Remote VTEP Group : 1120211
Member IP : 10.1.1.12
Member State : Active
Member IP : 10.1.1.13
Member State : Standby
Mode
Basic
Availability
Autonomous Edge, Edge
Display information about all VTEP groups
Example
nsx-controller-1> get vtep-groups
VTEP-GROUP-ID VNI LS-UUID
58984 29123 ee235ae5-9a62-4094-88e6-30dcc6e2577c
or
nsx-edge-1> get vtep-groups
Local VTEP Group : 1120210
Member IP : 10.1.1.10
Member State : Active
Remote VTEP Group : 1120211
Member IP : 10.1.1.12
Member State : Active
Member IP : 10.1.1.13
Member State : Standby
Mode
Basic
Availability
Autonomous Edge, Edge, Manager
Display information about all tunnel endpoints.
Example
nsx-edge-1> get vteps
Remote VTEP IP : 192.168.250.161
Remote VTEP Label : 12289
Local VTEP IP : 192.168.250.162
Local VTEP Label : 51201
Remote VTEP IP : 192.168.250.160
Remote VTEP Label : 61441
Mode
Basic
Availability
Autonomous Edge, Edge
Get vxlan uplink queue filter.
| Option | Description |
|---|---|
| <dvs-name> | DVS name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> get vxlan-uplink-queue-filter dvs nsxvswitch
Vxlan Uplink Queue Filter: false
Mode
Basic
Availability
ESXi
Display CLI command help information.
Example
nsx-manager-1> help
NSX CLI help is available via a variety of different ways:
1. From the command prompt, enter: help
This full help message is shown.
2. Tab completion
Tab completion is always available to either complete a valid
command word or complete a valid argument. If completion cannot
be performed, a message is shown to indicate the reason.
For example: ge<tab>
3. Pressing ?
At any time, pressing ? shows possible options for the command
entered. If no options are available, a helpful message is
shown to indicate the reason.
For example: get ?
4. From the command prompt, enter: list
View all supported commands and command parameters.
Mode
Availability
Autonomous Edge, Edge, Global Manager, ESXi, KVM, NSX Cloud VM, Manager, NSX on VMC
Install NSX Edge service container image.
| Option | Description |
|---|---|
| <image-name> | Edge service container image name |
| <image-version> | Edge service container image version |
Example
nsx-edge> install image nsx-edge-mdproxy version ob-22302541
Image installed successfully
Mode
Basic
Availability
Autonomous Edge, Edge
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.| Option | Description |
|---|---|
| <ip-address[:port]> | IPv4 or IPv6 address of an NSX Manager and optional port |
| <cluster-id> | Cluster ID of existing cluster to join Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <username> | Manager API username |
| <password> | Manager API password |
| <thumbprint> | Manager API thumbprint |
Example
nsx-manager-1> join 10.162.59.72:443 cluster-id 076dcdbd-0db9-41a7-931d-3b102a128d6e username admin password VMwarensbu_1 thumbprint 4e282b0811b40d93ed85cb24cf261c3296d6d3dbdb6fb2d596d848ba4a292c5a force
Join operation successful. Services are being restarted. Cluster may take some time to stabilize.
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Join this node to the management plane.
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | Hostname or IPv4 or IPv6 address of an NSX Manager and optional port |
| <thumbprint> | Manager API thumbprint |
| <token> | Manager API token Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-edge> join management-plane 192.168.110.105 node-uuid 692eef9a-026e-4e24-8494-251990b2b4e3 thumbprint 7f1374c339b592da504b352857a0bdc4e77b9b998a9971f9335633210f667c97 token fd872487-07db-43c6-9067-acb2b9fe1fe4
Node successfully registered as Fabric Node: 692eef9a-026e-4e24-8494-251990b2b4e3
Mode
Basic
Availability
Edge
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.
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | Hostname or IPv4 or IPv6 address of an NSX Manager and optional port |
| <username> | Manager API username |
| <thumbprint> | Manager API thumbprint |
| <password> | Manager API password |
Example
host-1> join management-plane 192.168.110.105 username admin thumbprint 898b75618e3e56615d53f987a720ff22b6381f4b85bec1eb973214ff7361f8b8
Password for API user:
Node successfully joined
Mode
Basic
Availability
ESXi, KVM
Join this node to the management plane.
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | Hostname or IPv4 or IPv6 address of an NSX Manager and optional port |
| <username> | Manager API username |
| <thumbprint> | Manager API thumbprint |
| <password> | Manager API password |
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Example
nsx-edge> join management-plane 192.168.110.105 username admin thumbprint 7f1374c339b592da504b352857a0bdc4e77b9b998a9971f9335633210f667c97
Password for API user:
Node successfully registered as Fabric Node: 692eef9a-026e-4e24-8494-251990b2b4e3
Mode
Basic
Availability
Edge
This command lists all available commands.
Mode
Availability
Autonomous Edge, Edge, Global Manager, ESXi, KVM, NSX Cloud VM, Manager, NSX on VMC
Configure livetrace session.
| Option | Description |
|---|---|
| <action-type> | Livetrace action. Allowed values: counter, follow |
| <port-uuid-name> | Datapath String argument |
| <proto-num> | IP protocol number. Allowed values: TCP, UDP, ICMP, ICMP6, ESP, ALL |
| <prefix> | Network Address argument |
| <l4-port-range> | TCP/UDP port range (0-65535:0-65535) |
| <time-out> | Time measurement in milliseconds Allowed pattern: ^[0-9]+$ |
Example
nsx-edge> livetrace config counter aada6983-4a83-407e-ba38-1a23388600fb protocol ICMP
source-ip 192.168.100.50/24 10:4000 dest-ip 2.2.5.10/24 10:4000 timeout 10
success : Session 0 created at slot 255 on aada6983-4a83-407e-ba38-1a23388600fb.
Mode
Basic
Availability
Edge
Configure livetrace session for ESP protocol with IP..
| Option | Description |
|---|---|
| <action-type> | Livetrace action. Allowed values: counter, follow |
| <port-uuid-name> | Datapath String argument |
| <proto-num> | IP protocol number. Allowed values: TCP, UDP, ICMP, ICMP6, ESP, ALL |
| <prefix> | Network Address argument |
| <time-out> | Time measurement in milliseconds Allowed pattern: ^[0-9]+$ |
Example
nsx-edge> livetrace config follow 49b01e83-b4d3-4a1d-be94-7883c13f2143
protocol ESP source-ip 192.168.100.50/24 dest-ip 2.2.5.10/24 timeout 10
success : Session 0 created at slot 255 on 49b01e83-b4d3-4a1d-be94-7883c13f2143.
Mode
Basic
Availability
Edge
Configure livetrace session for ESP protocol with SPI..
| Option | Description |
|---|---|
| <action-type> | Livetrace action. Allowed values: counter, follow |
| <port-uuid-name> | Datapath String argument |
| <proto-num> | IP protocol number. Allowed values: TCP, UDP, ICMP, ICMP6, ESP, ALL |
| <spi-value> | SPI value Allowed pattern: ^0x[a-f0-9]+$ |
| <time-out> | Time measurement in milliseconds Allowed pattern: ^[0-9]+$ |
Example
nsx-edge> livetrace config follow 49b01e83-b4d3-4a1d-be94-7883c13f2143
protocol ESP spi 0x189c7f00 timeout 10
success : Session 0 created at slot 255 on 49b01e83-b4d3-4a1d-be94-7883c13f2143.
Mode
Basic
Availability
Edge
Configure livetrace session for all packets.
| Option | Description |
|---|---|
| <action-type> | Livetrace action. Allowed values: counter, follow |
| <port-uuid-name> | Datapath String argument |
| <proto-num> | IP protocol number. Allowed values: TCP, UDP, ICMP, ICMP6, ESP, ALL |
| <time-out> | Time measurement in milliseconds Allowed pattern: ^[0-9]+$ |
Example
nsx-edge> livetrace config counter aada6983-4a83-407e-ba38-1a23388600fb protocol ALL
timeout 10
success : Session 0 created at slot 255 on aada6983-4a83-407e-ba38-1a23388600fb.
Mode
Basic
Availability
Edge
Retrieve live trace session information.
Example
nsx-edge> livetrace show
Livetrace Session Info:
COUNT : 10
PORT_ID : 58634ac9-af5d-54cf-9637-5c4c14c3125a
TIMESTAMP : 2020-06-10 22:10:56.347287
TYPE : logical_tunnel_port
COUNT : 10
PORT_ID : 5c483216-d527-4daf-90f5-4ab39b0b7780
TIMESTAMP : 2020-06-10 22:10:56.347289
TYPE : logical_router_port
Mode
Basic
Availability
Edge
Extract the specified rollback scripts and start rollback.
Example
manager1> node-rollback run-step step1_start_rollback
This will start rollback process to rollback node to version 3.2.0.0.0.18420180. All changes done after starting MP upgrade will be lost.
- Manager node will reboot as part of this step.
- Run step2_restore_data on one of the Manager nodes after step1 is successful on all Manager nodes.
Do you want to continue? (yes/no): y
2021-08-11 10:22:48,144 - Setting up rollback scripts for rollback to 3.2.0.0.0.18420180
2021-08-11 10:22:48,192 - Rollback scripts set up for rollback to 3.2.0.0.0.18420180
2021-08-11 10:22:48,193 - Rollback info
{
"state": 1,
"state_text": "CMD_SUCCESS",
"info": "",
"body": {
"meta": {
"rollback_to_version": "3.2.0.0.0.18420180",
"rollback_from_version": "3.2.0.0.0.18420180",
"rollback_dir_path": "/image/VMware-NSX-unified-appliance-3.2.0.0.0.18420180-rollback",
"old_os_fs_uuid": "cf6fdfde-c506-4276-b42e-e709e16ef10d",
"alt_os_fs_uuid": "b59f9bf3-3ea6-47e3-aad3-46431c6717b2"
},
"history": []
}
}
2021-08-11 10:22:48,889 - Running backup_version_check
2021-08-11 10:22:53,958 - Backup version check passed
2021-08-11 10:22:53,958 - Start running step step1_start_rollback
2021-08-11 10:22:53,991 - Running "cleanup_bundle" (task 1 of 4)
2021-08-11 10:22:59,063 - Running "reboot_into_rollback_version" (task 2 of 4)
2021-08-11 10:22:59,084 -
System will now reboot.
Run step2_restore_data on one of the nodes after this step is complete on all Manager nodes.
{
"state": 1,
"state_text": "CMD_SUCCESS",
"info": "",
"body": null
}
Mode
Basic
Availability
Global Manager, Manager
None
Example
manager2> node-rollback run-step step2_restore_data
This will restore data-store to a snapshot taken at the beginning of upgrade.
- Run this command only on one of the Manager nodes.
- Please make sure that step1_start_rollback step is successful on all nodes of cluster before starting this step.
- After this step, run step3_exit_rollback on all the nodes to continue the rollback.
Do you want to continue? (yes/no): y
2021-08-11 10:31:16,899 - Running node_version_check
2021-08-11 10:31:21,950 - Node version checks passed
2021-08-11 10:31:21,962 - Running restore_ready_check
2021-08-11 10:31:26,997 - Node restore ready checks passed
2021-08-11 10:31:26,997 - Start running step step2_restore_data
2021-08-11 10:31:27,019 - Running "run_db_restore" (task 1 of 1)
2021-08-11 10:31:52,099 - Step finished successfully
Run step3_exit_rollback on all Manager nodes to continue the rollback.
{
"state": 1,
"state_text": "CMD_SUCCESS",
"info": "",
"body": null
}
Mode
Basic
Availability
Global Manager, Manager
None
Example
manager3> node-rollback run-step step3_exit_rollback
This will start services in restored version.
- Please make sure step2_restore_data is successful on one of the MP nodes before running this step.
Do you want to continue? (yes/no): y
2021-08-11 10:34:18,672 - Running restore_complete_check
2021-08-11 10:34:23,731 - Node restore complete checks passed
2021-08-11 10:34:23,731 - Start running step step3_exit_rollback
2021-08-11 10:34:23,754 - Running "start_services" (task 1 of 2)
2021-08-11 10:42:04,625 - Running "finish_rollback" (task 2 of 2)
2021-08-11 10:42:04,722 - Step finished successfully
{
"state": 1,
"state_text": "CMD_SUCCESS",
"info": "",
"body": null
}
Mode
Basic
Availability
Global Manager, Manager
Display nslookup information.
| Option | Description |
|---|---|
| <hostname> | System hostname argument |
Example
nsx-edge> nslookup nsx-edge-1
Server: ns1.corp.local
Address: 192.168.110.10
Name: nsx-edge-1
Address: 192.168.110.101
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
Example
nslookup from an NSX Manager:
nsx-manager-1> nslookup nsx-manager-2
Server: 127.0.0.1
Address: 127.0.0.1#53
Name: nsx-manager-2.corp.local
Address: 192.168.110.202
nslookup from an NSX Controller:
nsx-controller-1> nslookup nsx-manager-2
Server: 192.168.110.10
Address: 192.168.110.10#53
Name: nsx-manager-2.corp.local
Address: 192.168.110.202
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Display Nslookup DNS Forwarder result.
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1(tier0_sr)> nslookup dns-forwarder host1.vmc.example.com server-ip 3.3.5.10 source-ip 99.99.99.2
ERR_MSG:
RESULT:
; <<>> DiG 9.10.3-P4-Ubuntu <<>> @3.3.5.10 -b 99.99.99.2 host1.vmc.example.com +timeout=5 +tries=3 +nosearch
; (1 server found)
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 6128
;; flags: qr rd ra; QUERY: 1, ANSWER: 2, AUTHORITY: 1, ADDITIONAL: 2
;; OPT PSEUDOSECTION:
; EDNS: version: 0, flags:; udp: 4096
;; QUESTION SECTION:
;host1.vmc.example.com. IN A
;; ANSWER SECTION:
host1.vmc.example.com. 524344 IN A 199.199.2.10
host1.vmc.example.com. 524344 IN A 199.199.2.11
;; AUTHORITY SECTION:
vmc.example.com. 524344 IN NS vmns21.vmc.example.com.
;; ADDITIONAL SECTION:
vmns21.vmc.example.com. 524344 IN A 3.3.5.20
;; Query time: 5 msec
;; SERVER: 3.3.5.10#53(3.3.5.10)
;; WHEN: Thu Jan 03 06:45:10 UTC 2019
;; MSG SIZE rcvd: 119
STATE: ACTIVE
UUID: a5a8ad3f-ec30-44d6-8fe3-00cfc50f3e7e
Mode
Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Display Nslookup DNS Forwarder result.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <hostname-or-ip-address> | A hostname or IP address |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> nslookup dns-forwarder a5a8ad3f-ec30-44d6-8fe3-00cfc50f3e7e host1.vmc.example.com server-ip 3.3.5.10 source-ip 99.99.99.21
ERR_MSG:
RESULT:
; <<>> DiG 9.10.3-P4-Ubuntu <<>> @3.3.5.10 -b 99.99.99.2 host1.vmc.example.com +timeout=5 +tries=3 +nosearch
; (1 server found)
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 56620
;; flags: qr rd ra; QUERY: 1, ANSWER: 2, AUTHORITY: 1, ADDITIONAL: 2
;; OPT PSEUDOSECTION:
; EDNS: version: 0, flags:; udp: 4096
;; QUESTION SECTION:
;host1.vmc.example.com. IN A
;; ANSWER SECTION:
host1.vmc.example.com. 524568 IN A 199.199.2.10
host1.vmc.example.com. 524568 IN A 199.199.2.11
;; AUTHORITY SECTION:
vmc.example.com. 524568 IN NS vmns21.vmc.example.com.
;; ADDITIONAL SECTION:
vmns21.vmc.example.com. 524568 IN A 3.3.5.20
;; Query time: 2 msec
;; SERVER: 3.3.5.10#53(3.3.5.10)
;; WHEN: Thu Jan 03 06:41:27 UTC 2019
;; MSG SIZE rcvd: 119
STATE: ACTIVE
UUID: a5a8ad3f-ec30-44d6-8fe3-00cfc50f3e7e
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
Example
nsx-edge-1> path de650f56-276d-46ef-959e-960752acfe19 172.16.10.11
nsx-edge-1(path)>
Mode
Basic
Availability
Autonomous Edge, Edge
Ping an IP address. Use Control-C to stop the ping command.
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
Example
nsx-edge-1> ping 192.168.110.1
PING 192.168.110.1 (192.168.110.1): 56 data bytes
64 bytes from 192.168.110.1: icmp_seq=0 ttl=64 time=0.610 ms
64 bytes from 192.168.110.1: icmp_seq=1 ttl=64 time=0.645 ms
64 bytes from 192.168.110.1: icmp_seq=2 ttl=64 time=0.889 ms
^C
--- 192.168.110.1 ping statistics ---
3 packets transmitted, 3 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = 0.610/0.715/0.889/0.124 ms
Mode
Basic
Availability
Autonomous Edge, Edge
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.| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
Example
nsx-manager-1> ping 10.192.43.71
PING 10.192.43.71 (10.192.43.71) 56(84) bytes of data.
64 bytes from 10.192.43.71: icmp_seq=1 ttl=58 time=1.66 ms
64 bytes from 10.192.43.71: icmp_seq=2 ttl=58 time=0.961 ms
64 bytes from 10.192.43.71: icmp_seq=3 ttl=58 time=0.962 ms
64 bytes from 10.192.43.71: icmp_seq=4 ttl=58 time=0.883 ms
64 bytes from 10.192.43.71: icmp_seq=5 ttl=58 time=1.15 ms
^C
--- 10.192.43.71 ping statistics ---
5 packets transmitted, 5 received, 0% packet loss, time 4003ms
rtt min/avg/max/mdev = 0.883/1.125/1.665/0.285 ms
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
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.
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <dfbit-state> | Enable the DF bit Allowed values: enable |
Example
nsx-edge-1(tier0_sr)> ping 172.16.110.11 source 192.168.130.3 repeat 3
PING 172.16.110.11 (172.16.110.11) from 192.168.130.3: 56 data bytes
64 bytes from 172.16.110.11: icmp_seq=0 ttl=62 time=4.300 ms
64 bytes from 172.16.110.11: icmp_seq=1 ttl=62 time=1.879 ms
64 bytes from 172.16.110.11: icmp_seq=2 ttl=62 time=1.406 ms
--- 172.16.110.11 ping statistics ---
3 packets transmitted, 3 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = 1.406/2.528/4.300/1.268 ms
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <dfbit-state> | Enable the DF bit Allowed values: enable |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
Example
nsx-edge-1> ping 172.16.110.11 vrf 3 source 192.168.130.3 repeat 3
PING 172.16.110.11 (172.16.110.11) from 192.168.130.3: 56 data bytes
64 bytes from 172.16.110.11: icmp_seq=0 ttl=62 time=6.203 ms
64 bytes from 172.16.110.11: icmp_seq=1 ttl=62 time=3.908 ms
64 bytes from 172.16.110.11: icmp_seq=2 ttl=62 time=4.633 ms
--- 172.16.110.11 ping statistics ---
3 packets transmitted, 3 packets received, 0.0% packet loss
round-trip min/avg/max/stddev = 3.908/4.915/6.203/0.958 ms
Mode
Basic
Availability
Autonomous Edge, Edge
Ping an IPv6 address. Use Control-C to stop the ping command.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
Example
nsxedge-ob-9722447-1-ipv6test> ping6 2005::2828:280a size 100 vrfid 1 repeat 10
PING6(148=40+8+100 bytes) :: --> 2005::2828:280a
108 bytes from 2005::2828:280a, icmp_seq=0 hlim=64 time=1.878 ms
108 bytes from 2005::2828:280a, icmp_seq=1 hlim=64 time=2.626 ms
108 bytes from 2005::2828:280a, icmp_seq=2 hlim=64 time=2.072 ms
108 bytes from 2005::2828:280a, icmp_seq=3 hlim=64 time=1.861 ms
108 bytes from 2005::2828:280a, icmp_seq=4 hlim=64 time=1.657 ms
108 bytes from 2005::2828:280a, icmp_seq=5 hlim=64 time=2.059 ms
108 bytes from 2005::2828:280a, icmp_seq=6 hlim=64 time=1.769 ms
108 bytes from 2005::2828:280a, icmp_seq=7 hlim=64 time=2.305 ms
108 bytes from 2005::2828:280a, icmp_seq=8 hlim=64 time=1.948 ms
108 bytes from 2005::2828:280a, icmp_seq=9 hlim=64 time=1.789 ms
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <uuid> | Datapath UUID argument |
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Issue a ping command for IPv6 host.
The repeat argument specifies how many ping packets to transmit.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Ping an IPv6 address. Use Control-C to stop the ping command.
The size argument specifies the size of the ping packet.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <uuid> | Datapath UUID argument |
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
Mode
Basic
Availability
Autonomous Edge, Edge
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
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | Hostname or IPv4 or IPv6 address of an NSX Manager and optional port |
| <username> | Manager API username |
| <thumbprint> | Manager API thumbprint |
Example
host-1> push host-certificate 192.168.110.105 username admin thumbprint 898b75618e3e56615d53f987a720ff22b6381f4b85bec1eb973214ff7361f8b8
Password for API user:
Host certificate was pushed to management plane successfully
Mode
Basic
Availability
Edge, ESXi, KVM
Reboot the system. If you specify the
force argument, the system will reboot immediately without prompting for confirmation.Example
nsx> reboot
Are you sure you want to reboot (yes/no): yes
Broadcast message from root@nsx
(unknown) at 1:21 ...
The system is going down for reboot NOW!
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Reset the corelist-related boot time option to factory default.
Example
nsx-edge-1> reset dataplane corelist
0000:0b:00.0 already bound to driver vfio-pci, skipping
0000:1b:00.0 already bound to driver vfio-pci, skipping
0000:13:00.0 already bound to driver vfio-pci, skipping
INFO: Config was written to: /config/vmware/edge/config.json
Generating grub configuration file ...
Found linux image: /vmlinuz-3.14.17-nn4-server
Found initrd image: //initrd.img-3.14.17-nn4-server
File descriptor 4 (/tmp/ffix5oWn5 (deleted)) leaked on lvs invocation. Parent PID 30810: /bin/sh
done
INFO: Updated grub. Please reboot to take effect.
Mode
Basic
Availability
Autonomous Edge, Edge
Reset custom list of supported devices on the system.
Example
edge> reset dataplane device list
edge>
Mode
Basic
Availability
Autonomous Edge, Edge
Reset the hugepage-related boot time option to factory default.
Example
nsx-edge-1> reset dataplane hugepage
0000:0b:00.0 already bound to driver vfio-pci, skipping
0000:1b:00.0 already bound to driver vfio-pci, skipping
0000:13:00.0 already bound to driver vfio-pci, skipping
INFO: Config was written to: /config/vmware/edge/config.json
Generating grub configuration file ...
Found linux image: /vmlinuz-3.14.17-nn4-server
Found initrd image: //initrd.img-3.14.17-nn4-server
File descriptor 4 (/tmp/ffinvYglp (deleted)) leaked on lvs invocation. Parent PID 32203: /bin/sh
done
INFO: Updated grub. Please reboot to take effect.
Mode
Basic
Availability
Autonomous Edge, Edge
Reset the DHCP Server IPv6 Stats Entries.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> reset dhcp server f587ea74-4e67-4097-bca1-baf510837643 ipv6-stats
nsx-edge-1>
Mode
Availability
Edge
Reset the DHCP Server IPv4 Stats Entries.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> reset dhcp server 9effbeb4-971d-43b4-9769-3dce3bf49449 stats
nsx-edge-1>
Mode
Availability
Edge
Clear the DNS Forwarder cache
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> reset dns-forwarder 9b032ded-a109-42ee-b49b-ae05e7b9edf6 cache
Mode
Basic
Availability
Autonomous Edge, Edge
Reset the DNS Forwarder Stats Entries.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Example
nsx-edge-1> reset dns-forwarder 9b032ded-a109-42ee-b49b-ae05e7b9edf6 stats
STATS:
CACHED_ENTRIES: 3
CONDITIONAL_FORWARDER_STATISTICS:
DOMAIN_NAMES:
vmc.example.com
UPSTREAM_STATISTICS:
QUERIES_FAILED: 0
QUERIES_SUCCEEDED: 0
UPSTREAM_SERVER: 3.3.5.10
DOMAIN_NAMES:
2.199.199.in-addr.arpa
UPSTREAM_STATISTICS:
QUERIES_FAILED: 0
QUERIES_SUCCEEDED: 0
UPSTREAM_SERVER: 3.3.5.20
CONFIGURED_CACHE_SIZE: 300
DEFAULT_FORWARDER_STATISTICS:
DOMAIN_NAMES:
UPSTREAM_STATISTICS:
QUERIES_FAILED: 0
QUERIES_SUCCEEDED: 0
UPSTREAM_SERVER: 1.1.5.10
QUERIES_FAILED: 0
QUERIES_SUCCEEDED: 0
UPSTREAM_SERVER: 1.1.5.20
QUERIES_ANSWERED_LOCALLY: 0
QUERIES_FORWARDED: 0
RECEIVED_QUERIES_NUMBER: 0
TIME_STAMP: 2018-07-24 10:05:19.895000 (timestamp: 1532426719895)
USED_CACHE_SIZE: 0
UUID: 9b032ded-a109-42ee-b49b-ae05e7b9edf6
Mode
Basic
Availability
Autonomous Edge, Edge
Clear the DNS Forwarder Cache Per SR.
Example
nsx-edge-1(tier0_sr)> reset dns-forwarder cache
Mode
Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
Reset the DNS Forwarder Stats Entries Per SR.
Example
nsx-edge-1(tier0_sr)> reset dns-forwarder stats
STATS:
CACHED_ENTRIES: 3
CONDITIONAL_FORWARDER_STATISTICS:
DOMAIN_NAMES:
vmc.example.com
UPSTREAM_STATISTICS:
QUERIES_FAILED: 0
QUERIES_SUCCEEDED: 0
UPSTREAM_SERVER: 3.3.5.10
DOMAIN_NAMES:
2.199.199.in-addr.arpa
UPSTREAM_STATISTICS:
QUERIES_FAILED: 0
QUERIES_SUCCEEDED: 0
UPSTREAM_SERVER: 3.3.5.20
CONFIGURED_CACHE_SIZE: 300
DEFAULT_FORWARDER_STATISTICS:
DOMAIN_NAMES:
UPSTREAM_STATISTICS:
QUERIES_FAILED: 0
QUERIES_SUCCEEDED: 0
UPSTREAM_SERVER: 1.1.5.10
QUERIES_FAILED: 0
QUERIES_SUCCEEDED: 0
UPSTREAM_SERVER: 1.1.5.20
QUERIES_ANSWERED_LOCALLY: 0
QUERIES_FORWARDED: 0
RECEIVED_QUERIES_NUMBER: 0
TIME_STAMP: 2018-07-24 10:05:19.895000 (timestamp: 1532426719895)
USED_CACHE_SIZE: 0
UUID: 630ccdc4-4b8e-4d2e-9242-b27b689e0feb
Mode
Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | Hostname or IPv4 or IPv6 address of an NSX Manager and optional port |
| <username> | Manager API username |
| <thumbprint> | Manager API thumbprint |
| <password> | Manager API password |
Example
host-1> reset management-plane 192.168.110.105 username admin thumbprint 898b75618e3e56615d53f987a720ff22b6381f4b85bec1eb973214ff7361f8b8
Password for API user:
Node successfully joined
Mode
Basic
Availability
ESXi, KVM
Restart the specified service.
| Option | Description |
|---|---|
| <service-name> | Node service argument |
Example
nsx> restart service snmp
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Restart the nsx-lastline-rapid service.
Example
nsx> restart service nsx-lastline-rapid
nsx>
Mode
Basic
Availability
Restart the Security Hub service.
Example
nsx> restart service security-hub
nsx>
Mode
Basic
Availability
Resume an upgrade after running the command
start upgrade-bundle <bundle-name> playbook <playbook-file> and the system was rebooted.| Option | Description |
|---|---|
| <bundle-name> | Name of NSX upgrade bundle in the file store |
Example
nsx-edge-1> resume upgrade-bundle VMware-NSX-edge-2.0.0.0.0.5298714 playbook
Resuming paused playbook /var/vmware/nsx/file-store/VMware-NSX-edge-2.0.0.0.0.5298714-playbook.yml
Validating playbook /var/vmware/nsx/file-store/VMware-NSX-edge-2.0.0.0.0.5298714-playbook.yml
Running "41-postboot-exit_maintenance_mode" (step 4 of 5)
Running "finish_upgrade" (step 5 of 5)
Playbook finished successfully
{
"info": "",
"body": null,
"state": 1,
"state_text": "CMD_SUCCESS"
}
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Search for a string to get its mapping
| Option | Description |
|---|---|
| <input-query> | Input query argument. If query contains double quotes, enclose it in single quotes, and vice versa. e.g. '"fd00::2:3f10"' |
Example
nsx-manager> search 8ba31c66-6af9-11ed-8589-060624c0b332
UUID : ['8ba31c66-6af9-11ed-8589-060624c0b332']
Display Name : ['nsx-edge-svc.nsxedge-ob-20820852-4-pq']
Resource Type : ['TransportNode']
IP : [['10.206.184.78']]
nsx-manager> search 4823e9a6-7ab8-11ed-b166-02005057972a
UUID : ['4823e9a6-7ab8-11ed-b166-02005057972a-edgetn']
Display Name : [None]
Resource Type : ['GenericPolicyRealizedResource']
UUID : ['1']
Display Name : ['nsx-edge-svc.nsxedge-ob-20932932-4-xx']
Resource Type : ['PolicyEdgeNode']
Path : ['/infra/tier-1s/production_t1']
UUID : ['4823e9a6-7ab8-11ed-b166-02005057972a']
Display Name : ['nsx-edge-svc.nsxedge-ob-20932932-4-xx']
Resource Type : ['TransportNode']
IP : [['10.92.37.65']]
Mode
Availability
Global Manager, Manager
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.
| Option | Description |
|---|---|
| <lockout-period> | Lockout period in the range of 0 to 9000 seconds |
Example
nsx> set auth-policy api lockout-period 900
nsx>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
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.
| Option | Description |
|---|---|
| <lockout-reset-period> | Lockout reset period in the range of 0 to 9000 seconds |
Example
nsx> set auth-policy api lockout-reset-period 300
nsx>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the number of failed API authentication attempts that are
allowed before the account is locked. If set to 0, account
lockout is disabled.
| Option | Description |
|---|---|
| <auth-failures> | Number of authentication failures in the range of 0 to 50 to trigger lockout |
Example
nsx> set auth-policy api max-auth-failures 5
nsx>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
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.
| Option | Description |
|---|---|
| <lockout-period> | Lockout period in the range of 0 to 604800 seconds |
Example
nsx> set auth-policy cli lockout-period 900
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set the number of failed CLI authentication attempts that are
allowed before the account is locked. If set to 0, account
lockout is disabled.
| Option | Description |
|---|---|
| <auth-failures> | Number of authentication failures in the range of 0 to 10 to trigger lockout |
Example
nsx> set auth-policy cli max-auth-failures 5
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set the minimum number of characters that passwords must have. The
smallest value that can be set is 8.
| Option | Description |
|---|---|
| <password-length> | Password length argument |
Example
nsx> set auth-policy minimum-password-length 12
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set the vidm service's enabled property.
Example
nsx-manager-1> set auth-policy vidm enabled
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the vidm's properties.
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
| <thumbprint> | The thumbprint of the vidm host |
| <vidm-client-id> | vIDM client id parameter Allowed pattern: .* |
| <vidm-client-secret> | vIDM client secret parameter Allowed pattern: .* |
Example
nsx-manager-1> set auth-policy vidm hostname jt-vidm.eng.vmware.com thumbprint
898b75618e3e56615d53f987a720ff22b6381f4b85bec1eb973214ff7361f8b8
client-id myClient client-secret mySecret node-hostname
jt-nsx.eng.vmware.com
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the external load balancer enabled property.
Example
nsx-manager-1> set auth-policy vidm lb-extern enabled
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the security banner or message of the day.
Example
nsx> set banner
Enter TEXT message. End with 'Ctrl-D'
Authorized access only
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set the specified bridge port HA state to Active
| Option | Description |
|---|---|
| <uuid> | UUID argument |
Example
nsx-edge-1> set bridge 76c85110-b041-4e9f-a3e3-b54179a88ceb state active
Successfully brought L2Bridge 76c85110-b041-4e9f-a3e3-b54179a88ceb to active state
nsx-edge-1>
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
Example
kvm-1(path)> set capture session 1
01:39:58.374489 20:00:00:00:00:f1 > 33:33:00:00:00:16, ethertype IPv6 (0x86dd), length 90: fe80::2200:ff:fe00:f1 > ff02::16: HBH ICMP6, multicast listener report v2, 1 group record(s), length 28
<base64>MzMAAAAWIAAAAADxht1gAAAAACQAAf6AAAAAAAAAIgAA//4AAPH/AgAAAAAAAAAAAAAAAAAWOgAFAgAAAQCPAE4nAAAAAQQAAAD/AgAAAAAAAAAAAAH/AADx<base64>
01:39:58.374506 20:00:00:00:00:f1 > 33:33:00:00:00:02, ethertype IPv6 (0x86dd), length 70: fe80::2200:ff:fe00:f1 > ff02::2: ICMP6, router solicitation, length 16
<base64>MzMAAAACIAAAAADxht1gAAAAABA6//6AAAAAAAAAIgAA//4AAPH/AgAAAAAAAAAAAAAAAAAChQA5TAAAAAABASAAAAAA8Q==<base64>
.
.
.
or
nsx-edge-1(path)> set capture session 1
01:39:58.374489 20:00:00:00:00:f1 > 33:33:00:00:00:16, ethertype IPv6 (0x86dd), length 90: fe80::2200:ff:fe00:f1 > ff02::16: HBH ICMP6, multicast listener report v2, 1 group record(s), length 28
<base64>MzMAAAAWIAAAAADxht1gAAAAACQAAf6AAAAAAAAAIgAA//4AAPH/AgAAAAAAAAAAAAAAAAAWOgAFAgAAAQCPAE4nAAAAAQQAAAD/AgAAAAAAAAAAAAH/AADx<base64>
01:39:58.374506 20:00:00:00:00:f1 > 33:33:00:00:00:02, ethertype IPv6 (0x86dd), length 70: fe80::2200:ff:fe00:f1 > ff02::2: ICMP6, router solicitation, length 16
<base64>MzMAAAACIAAAAADxht1gAAAAABA6//6AAAAAAAAAIgAA//4AAPH/AgAAAAAAAAAAAAAAAAAChQA5TAAAAAABASAAAAAA8Q==<base64>
.
.
.
Mode
Basic, Path
Availability
Autonomous Edge, Edge, KVM
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.
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
Example
nsx-edge-1(path)> set capture session 1 direction both
nsx-edge-1(path)>
Mode
Path
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
| <interface-name> | Network interface argument |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
Example
kvm-1> set capture session 1 interface b592a7c8-4e21-493e-b0fc-0b1d152c949c direction dual
kvm-1> get capture session 1
Packet Capture Session
ID : 1
PORTS : ['b592a7c8-4e21-493e-b0fc-0b1d152c949c']
Mode
Basic
Availability
KVM
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.
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
| <filename> | Capture file name Allowed pattern: ^[^/ *;&|]+$ |
| <packet-count> | Packet count value greater than or equal to 1 |
| <expression> | Packet capture expression Allowed pattern: ^.*$ |
Example
kvm-1> set capture session 1 count 1 expression host 192.168.130.254 and port 22
02:59:09.825531 00:50:56:8e:29:c7 > 02:50:56:00:00:01, ethertype 802.1Q (0x8100), length 78: vlan 130, p 0, ethertype IPv4, 192.168.130.254.36792 > 192.168.130.3.22: Flags [S], seq 2401912755, win 29200, options [mss 1460,sackOK,TS val 60617296 ecr 0,nop,wscale 6], length 0
kvm-1>
or
kvm-1> set capture session 1 file capturefile count 5 expression port 22
Capture 5 packets to file initiated,
enter Ctrl-C to terminate before all packets captured
5 packets captured
5 packets received by filter
0 packets dropped by kernel
110 packets dropped by interface
Mode
Basic
Availability
KVM
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.
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
| <filename> | Capture file name Allowed pattern: ^[^/ *;&|]+$ |
| <packet-count> | Packet count value greater than or equal to 1 |
| <expression> | Packet capture expression Allowed pattern: ^.*$ |
Example
nsx-edge-1> set capture session 1 count 1 expression host 192.168.130.254 and port 22
02:59:09.825531 00:50:56:8e:29:c7 > 02:50:56:00:00:01, ethertype 802.1Q (0x8100), length 78: vlan 130, p 0, ethertype IPv4, 192.168.130.254.36792 > 192.168.130.3.22: Flags [S], seq 2401912755, win 29200, options [mss 1460,sackOK,TS val 60617296 ecr 0,nop,wscale 6], length 0
nsx-edge-1>
or
nsx-edge-1> set capture session 1 file capturefile count 5 expression port 22
Capture 5 packets to file initiated,
enter Ctrl-C to terminate before all packets captured
5 packets captured
5 packets received by filter
0 packets dropped by kernel
110 packets dropped by interface
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
| <port-uuid-name> | Datapath String argument |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <core-id> | Core id for packet capture session Allowed pattern: ^[0-9]+$ |
Example
nsx-edge-1> set capture session 1 interface fp-eth0 direction dual core 1
nsx-edge-1> set capture session 1 interface fp-eth1 direction dual core 1
nsx-edge-1> get capture session 1
Packet Capture Session
ID : 1
PORTS : ['fp-eth0', 'fp-eth1']
Mode
Basic
Availability
Autonomous Edge, Edge
Set status to display datetime stamp in command output.
| Option | Description |
|---|---|
| <datetime-arg> | DateTime stamp status argument Allowed values: disable, enable |
Example
nsx> set cli-output datetime disable
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, ESXi, KVM, NSX Cloud VM, Manager, NSX on VMC
Set status to display deprecate warning in command output.
| Option | Description |
|---|---|
| <deprecate-warn-arg> | Command deprecate warning status argument Allowed values: disable, enable |
Example
nsx> set cli-output deprecate-warning disable
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, ESXi, KVM, NSX Cloud VM, Manager, NSX on VMC
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.
| Option | Description |
|---|---|
| <esxio-cli-state> | ESXio CLI output state argument Allowed values: disable, enable |
Example
nsx> set cli-output esxio disable
nsx>
Mode
Basic
Availability
ESXi
Set inactivity timeout in seconds. To disable the timeout, specify 0.
| Option | Description |
|---|---|
| <timeout> | Number of seconds before timeout or 0 to disable timeout |
Example
nsx> set cli-timeout 0
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Enable or disable basic authentication in API calls.
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
Example
nsx-manager-1> set cluster api-service basic-authentication enabled
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the cluster API service API per-client concurrency limit value.
| Option | Description |
|---|---|
| <api-service-client-api-concurrency-limit> | Cluster API service API per-client concurrency limit value in the range of 0 - 9223372036854775807 |
Example
nsx-manager-1> set cluster api-service client-api-concurrency-limit 40
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the cluster API service API per-client rate limit value.
| Option | Description |
|---|---|
| <api-service-client-api-rate-limit> | Cluster API service API per-client rate limit in calls per second |
Example
nsx-manager-1> set cluster api-service client-api-rate-limit 100
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the cluster api service connection timeout value.
| Option | Description |
|---|---|
| <api-service-conn-timeout> | Cluster API service connection timeout in seconds |
Example
nsx-manager-1> set cluster api-service connection-timeout 60
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Enable or disable cookie-based authentication in API calls.
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
Example
nsx-manager-1> set cluster api-service cookie-based-authentication enabled
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the Cluster API ServiceAPI global concurrency limit value.
| Option | Description |
|---|---|
| <api-service-global-api-concurrency-limit> | Cluster API service API global concurrency limit value in the range of 0 - 9223372036854775807 |
Example
nsx-manager-1> set cluster api-service global-api-concurrency-limit 100
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the cluster api service redirect host.
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
Example
nsx-manager-1> set cluster api-service redirect-host 10.0.0.1
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the cluster api service session timeout value.
| Option | Description |
|---|---|
| <api-service-session-timeout> | Cluster API service session timeout in seconds |
Example
nsx-manager-1> set cluster api-service session-timeout 60
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set Cluster Virtual IP.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-manager-1> set cluster vip 10.10.10.10
Mode
Basic
Availability
Global Manager, Manager
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.
| Option | Description |
|---|---|
| <core-dump-limit> | Core dump numeric argument |
Example
nsx> set core-dump global file-limit 3
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
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.
| Option | Description |
|---|---|
| <core-dump-limit> | Core dump numeric argument |
Example
nsx> set core-dump global frequency-threshold 900
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
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.
| Option | Description |
|---|---|
| <process-name> | Core dump process name |
| <core-dump-limit> | Core dump numeric argument |
Example
nsx> set core-dump process nginx file-limit 4
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Enable/disable control packet prioritization
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
Example
nsx-edge-1> set dataplane ctrl-prio disabled
INFO: Please restart dataplane service for change to take effect.
Mode
Basic
Availability
Autonomous Edge, Edge
Set the custom list of physical NICs.
| Option | Description |
|---|---|
| <pci-address-arg> | PCI address Allowed pattern: ^([0-9a-fA-F]{4}:[0-9a-fA-F]{2}:[0-9]{2}\.[0-9],{0,1})+$ |
Example
edge> set dataplane device list 0000:1b:00.0,0000:13:00.0
Updating custom NIC list...
0000:13:00.0 already bound to driver vfio-pci, skipping
0000:1b:00.0 already bound to driver vfio-pci, skipping
INFO: Config was written to: /config/vmware/edge/config.json
INFO: Grub backup already exists. Skipping.
INFO: Grub config is good.
Mode
Basic
Availability
Autonomous Edge, Edge
Enable or disable flow cache.
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
Example
nsx-edge-1> set dataplane flow-cache enabled
Please restart dataplane service for the change to take effect.
Mode
Basic
Availability
Autonomous Edge, Edge
Set the flow cache size for each core
| Option | Description |
|---|---|
| <flow-cache-size> | Flow cache size of a core (8 minimum, must be power of two) |
Example
nsx-edge-1> set dataplane flow-cache-size 524288
0000:0b:00.0 already bound to driver vfio-pci, skipping
0000:1b:00.0 already bound to driver vfio-pci, skipping
0000:13:00.0 already bound to driver vfio-pci, skipping
INFO: Config was written to: /config/vmware/edge/config.json
INFO: Updated flow cache size. Please reboot to take effect.
Mode
Basic
Availability
Autonomous Edge, Edge
Enable or disable geneve critical bit.
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
Example
nsx-edge-1> set dataplane geneve-cbit enabled
Mode
Basic
Availability
Autonomous Edge, Edge
Enable or disable interrupt mode.
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
Example
nsx-edge-1> set dataplane interrupt-mode enabled
Please restart datapathd service for change to take effect.
Mode
Basic
Availability
Autonomous Edge, Edge
Change the jumbo mbuf pool size
| Option | Description |
|---|---|
| <jumbo-mbuf-pool-size> | Size of jumbo mbuf pool (1024 minimum, 4096 by defualt) |
Example
nsx-edge-1> set dataplane jumbo-mbuf-pool-size 1024
Updated jumbo mbuf pool size. Please restart service dataplane to take effect.
Mode
Basic
Availability
Autonomous Edge, Edge
Enable or disable pmtu message generation in l2vpn.
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
Example
nsx-edge-1> set dataplane l2vpn-pmtu enabled
Mode
Basic
Availability
Autonomous Edge, Edge
Change the per-core packet queue limit
| Option | Description |
|---|---|
| <number> | Max number of packets queued by each core |
Example
nsx-edge-1> set dataplane packet-queue-limit 1024
Please restart datapathd service for change to take effect.
Mode
Basic
Availability
Autonomous Edge, Edge
Enable or disable pmtu learning in dataplane.
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
Example
nsx-edge-1> set dataplane pmtu-learning enabled
Mode
Basic
Availability
Autonomous Edge, Edge
Enable or disable QAT device usage for IPsec.
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
Example
nsx-edge-1> set dataplane qat disabled
QAT feature disabled. Restart the dataplane service for the change to take effect.
Mode
Basic
Availability
Autonomous Edge, Edge
Set Rx/Tx queue number per port per core
| Option | Description |
|---|---|
| <queue-num-per-port-per-core-arg> | The number of queues Dataplane allocates per port per core |
Example
nsx-edge-1> set dataplane queue-num-per-port-per-core 2
INFO: Please restart dataplane service for the change to take effect.
Mode
Basic
Availability
Autonomous Edge, Edge
Set the rx ring size for physical ports.
| Option | Description |
|---|---|
| <ring-size> | Ring size (128 - 4096) |
Example
nsx-edge-1> set dataplane ring-size rx 1024
0000:0b:00.0 already bound to driver vfio-pci, skipping
0000:1b:00.0 already bound to driver vfio-pci, skipping
0000:13:00.0 already bound to driver vfio-pci, skipping
INFO: Config was written to: /config/vmware/edge/config.json
Please restart datapathd service for change to take effect.
Mode
Basic
Availability
Autonomous Edge, Edge
Set the tx ring size for physical ports.
| Option | Description |
|---|---|
| <ring-size> | Ring size (128 - 4096) |
Example
nsx-edge-1> set dataplane ring-size tx 1024
0000:0b:00.0 already bound to driver vfio-pci, skipping
0000:1b:00.0 already bound to driver vfio-pci, skipping
0000:13:00.0 already bound to driver vfio-pci, skipping
INFO: Config was written to: /config/vmware/edge/config.json
Please restart datapathd service for change to take effect.
Mode
Basic
Availability
Autonomous Edge, Edge
Configure NSX DPI Lib Log Level.
| Option | Description |
|---|---|
| <dpilibloglevel> | Library Log level Allowed values: off, debug, verbose, noise, trace |
Example
> set dpi lib-dfw logging-level debug
Result: Success
Mode
Basic
Availability
ESXi
Configure NSX DPI Log Level.
| Option | Description |
|---|---|
| <dpiloglevel> | Log level Allowed values: off, fatal, error, warn, info, debug, trace |
Example
> set dpi logging-level info
Result: Success
Mode
Basic
Availability
ESXi
Disable flow cache for all switches
Example
esx-1> set ens flow-table disable
esx-1>
Mode
Basic
Availability
ESXi
Disable flow cache for a specific switch
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
Example
esx-1> set ens flow-table disable 0
esx-1>
Mode
Basic
Availability
ESXi
Enable flow cache for all switches
Example
esx-1> set ens flow-table enable
esx-1>
Mode
Basic
Availability
ESXi
Enable flow cache for a specific switch
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
Example
esx-1> set ens flow-table enable 0
esx-1>
Mode
Basic
Availability
ESXi
Set flow table size per Lcore. Rounded up to nearest power of 2.
| Option | Description |
|---|---|
| <size-value> | Flow table size per Lcore Allowed pattern: ^([4-9]|[1-9]\d{1,5}|[1-4]\d{5}|52[0-3]\d{4}|52428[0-8])$ |
Example
esx-1> set ens flow-table size 32768
esx-1>
Mode
Basic
Availability
ESXi
Enable/disable global FPO and configure FPO model
| Option | Description |
|---|---|
| <fpo-config> | FPO configuration, choose from (separated by comma) [enable,disable,Model1Level1,Model1Level2,Model2A,Model3A,Model3B,ip-discovery-dhcp,no-ip-discovery-dhcp,ip-discovery-icmp6-nd,no-ip-discovery-icmp6-nd,geneve-critical,no-geneve-critical] |
Example
esx-1> set ens fpo enable,Model1Level1,ip-discovery-dhcp,ip-discovery-icmp6-nd,geneve-critical
esx-1>
Mode
Basic
Availability
ESXi
Enable/disable per switch FPO and configure FPO model
| Option | Description |
|---|---|
| <fpo-config> | FPO configuration, choose from (separated by comma) [enable,disable,Model1Level1,Model1Level2,Model2A,Model3A,Model3B,ip-discovery-dhcp,no-ip-discovery-dhcp,ip-discovery-icmp6-nd,no-ip-discovery-icmp6-nd,geneve-critical,no-geneve-critical] |
| <host-switch-name> | Host switch name |
Example
esx-1> set ens fpo enable,Model1Level1,ip-discovery-dhcp,ip-discovery-icmp6-nd,geneve-critical nsxvswitch
esx-1>
Mode
Basic
Availability
ESXi
Change mode of enhanced datapath lcore assignment.
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <ens-lc-mode> | ENS lcore assignment mode name Allowed values: vNIC-count, cpu-usage |
Example
esx-1> set ens lcore-assignment-mode nsxvswitch cpu-usage
esx-1>
Mode
Basic
Availability
ESXi
Migrate port queue between lcores
| Option | Description |
|---|---|
| <switch-id> | Switch ID Allowed pattern: ^(0|([1-9]|1[0-5]))$ |
| <ens-port-id> | ENS port ID in ENS switch Allowed pattern: ^[0-9]+$ |
| <queue-id> | Queue ID for a port in multiple queue case Allowed pattern: ^([0-9]|[1-5][0-9]|6[0-3])$ |
| <dir> | 0 for ingress to switch, 1 for egress out of switch Allowed pattern: ^[01]$ |
| <lcore-ID> | Lcore ID Allowed pattern: ^([0-9]|[1-5][0-9]|6[0-3])$ |
Example
esx-1> set ens port migrate 0 0 0 0 0
esx-1>
Mode
Basic
Availability
ESXi
Disable usePerVnicQCb option of ENS switch
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
Example
esx-1> set ens switch use-per-vnic-qcb disable nsxvswitch
esx-1>
Mode
Basic
Availability
ESXi
Enable usePerVnicQCb option of ENS switch
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
Example
esx-1> set ens switch use-per-vnic-qcb enable nsxvswitch
esx-1>
Mode
Basic
Availability
ESXi
Disable automatic thread load balancing
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
Example
esx-1> set ens tlb status disable nsxvswitch
esx-1>
Mode
Basic
Availability
ESXi
Enable automatic thread load balancing
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
Example
esx-1> set ens tlb status enable nsxvswitch
esx-1>
Mode
Basic
Availability
ESXi
Enable automatic thread load balancing based on metric
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <metric> | Thread load balancing metric, either "count" (use port) or "cpu" (use CPU usage) Allowed values: count, cpu |
Example
esx-1> set ens tlb status enable nsxvswitch count
esx-1>
Mode
Basic
Availability
ESXi
Set Tx and Rx ring size of an uplink
| Option | Description |
|---|---|
| <uplink> | Uplink identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| <tx-ring-size> | Tx ring size, integer range Allowed pattern: ^[0-9]+$ |
| <rx-ring-size> | Rx ring size, integer range Allowed pattern: ^[0-9]+$ |
Example
esx-1> set ens uplink ring-size vmnic1 4096 2048
esx-1>
Mode
Basic
Availability
ESXi
Set the acceptance of the end user license agreement.
Example
nsx-manager-1> set eula accepted
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
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.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| <ip-address> | Network IP address argument |
| <uuid> | UUID argument |
Example
nsx-edge> set firewall e159f0db-d8e4-4973-9cbb-8cc30def2c3e local-ip 192.168.250.62 sync-peer e159f0db-d8e4-4973-9cbb-8cc30def2c3e sync-peer-ip 192.168.250.63
nsx-edge>
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| <sync-rank> | One of {primary|secondary} Allowed values: primary, secondary |
| <sync-mode> | One of {active|passive} Allowed values: active, passive |
Example
nsx-edge> set firewall e159f0db-d8e4-4973-9cbb-8cc30def2c3e sync-rank primary sync-mode active
nsx-edge>
Mode
Basic
Availability
Autonomous Edge, Edge
Set geneve critical bit.
| Option | Description |
|---|---|
| <boolean-arg> | Boolean enum value Allowed values: true, false |
| <dvs-name> | DVS name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> set geneve-cbit false dvs nsxvswitch
esx-1>
Mode
Basic
Availability
ESXi
Set GRUB menu timeout.
| Option | Description |
|---|---|
| <grub-menu-timeout> | GRUB menu timeout in seconds |
Example
nsx-manager> set grub menu timeout 4
nsx-manager>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set GRUB user password.
| Option | Description |
|---|---|
| <grub-username> | Username of GRUB user |
| <grub-password> | Password for the GRUB user |
Example
nsx-manager> set grub user root password Str0ng_Pwd!Wins$
nsx-manager>
or
nsx-manager> set grub user root password
Enter password:
Confirm password:
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set command history size.
| Option | Description |
|---|---|
| <history-size> | Integer value for history size or 0 to display all commands |
Example
nsx> set history limit 100
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, ESXi, KVM, NSX Cloud VM, Manager, NSX on VMC
Set the mcast filter mode for the specified host switch.
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <mcast-filter-mode> | Mode of mcast filter Allowed values: legacy, snooping |
Example
esx-1> set host-switch nsxvswitch mcast-filter snooping
esx-1>
Mode
Basic
Availability
ESXi
Set host switch upgrade status.
| Option | Description |
|---|---|
| <boolean-arg> | Boolean enum value Allowed values: true, false |
Example
esx-1> set host-switch upgrade-status true
esx-1>
Mode
Basic
Availability
ESXi
Set the system hostname. Changing the hostname changes the command line prompt.
| Option | Description |
|---|---|
| <hostname> | System hostname argument |
Example
nsx> set hostname nsx-3
nsx-3>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set the hugepage reserve size for the data plane using system default.
Example
nsx-edge-1> set hugepage-reserve auto
0000:0b:00.0 already bound to driver vfio-pci, skipping
0000:1b:00.0 already bound to driver vfio-pci, skipping
0000:13:00.0 already bound to driver vfio-pci, skipping
INFO: Config was written to: /config/vmware/edge/config.json
Generating grub configuration file ...
Found linux image: /vmlinuz-3.14.17-nn4-server
Found initrd image: //initrd.img-3.14.17-nn4-server
File descriptor 4 (/tmp/ffisOHe0b (deleted)) leaked on lvs invocation. Parent PID 5321: /bin/sh
done
INFO: Updated grub. Please reboot to take effect.
Mode
Basic
Availability
Autonomous Edge, Edge
Set the hugepage reserve size for the data plane.
| Option | Description |
|---|---|
| <hugepage-size> | Hugepage size in MB or GB Allowed pattern: ^[0-9]+([M|G]B)?$ |
Example
nsx-edge-1> set hugepage-reserve size 1003MB
0000:0b:00.0 already bound to driver vfio-pci, skipping
0000:1b:00.0 already bound to driver vfio-pci, skipping
0000:13:00.0 already bound to driver vfio-pci, skipping
INFO: Config was written to: /config/vmware/edge/config.json
Generating grub configuration file ...
Found linux image: /vmlinuz-3.14.17-nn4-server
Found initrd image: //initrd.img-3.14.17-nn4-server
File descriptor 4 (/tmp/ffilsggoY (deleted)) leaked on lvs invocation. Parent PID 3853: /bin/sh
done
INFO: Updated grub. Please reboot to take effect.
Mode
Basic
Availability
Autonomous Edge, Edge
Configure NSX IDS Engine Fast Log.
| Option | Description |
|---|---|
| <idsengalertlog> | Engine Fast Log Allowed values: disable, enable |
Example
> set ids engine alertlog enable
Result: Success
Mode
Basic
Availability
ESXi
Configure IDS Engine Fast Log.
| Option | Description |
|---|---|
| <ids-eng-fastlog-arg> | IDS Engine Fast Log setting Allowed values: disable, enable |
Example
> set ids engine fastlog disable
fast log is disabled. fast log is deleted: /var/log/fastlog_dpd.log
Mode
Availability
Edge
Configure NSX IDS Engine Log Level.
| Option | Description |
|---|---|
| <idsengloglevel> | Engine Log level Allowed values: off, emergency, alert, critical, error, warning, notice, info, perf, config, debug |
Example
> set ids engine logging-level info
Result: Success
Mode
Basic
Availability
ESXi
Sets the IDS logging level.
| Option | Description |
|---|---|
| <ids-logging-level-arg> | Edge IDS logging level Allowed values: debug, emer, error, info, trace, warn |
Example
nsx-edge-1> set ids engine logging-level info
Succeeded
Mode
Availability
Edge
clear IDS Event Engine stats.
Example
esx> set ids events stats clear
Status OK
Mode
Basic
Availability
ESXi
Configure NSX IDS Log Level.
| Option | Description |
|---|---|
| <idsloglevel> | Log level Allowed values: off, fatal, error, warn, info, debug, trace |
Example
> set ids logging-level info
Result: Success
Mode
Basic
Availability
ESXi
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.
| Option | Description |
|---|---|
| <interface-name> | Configurable network interface argument |
Example
nsx-edge> set interface eth0 dhcp
nsx-edge>
Mode
Basic
Availability
Autonomous Edge, Edge
Configure the specified interface to use DHCP.
| Option | Description |
|---|---|
| <interface-name> | Configurable network interface argument |
| <plane> | Interface plane argument Allowed values: mgmt, debug |
| <mode> | Bond mode (e.g. active-backup) Allowed values: active-backup |
| <members> | Bond member devices (e.g. eth0,eth1) |
| <primary> | Bond primary device (in active-backup mode, e.g. eth0) |
Example
nsx-edge> set interface bond0 dhcp plane mgmt mode active-backup members eth0,eth1 primary eth0
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <interface-name> | Configurable network interface argument |
| <prefix-ipv46> | CIDR notation argument for IPv4/IPv6 address |
| <gateway-ipv46> | Gateway IPv4/IPv6 address argument |
| <plane> | Interface plane argument Allowed values: mgmt, debug |
| <mode> | Bond mode (e.g. active-backup) Allowed values: active-backup |
| <members> | Bond member devices (e.g. eth0,eth1) |
| <primary> | Bond primary device (in active-backup mode, e.g. eth0) |
Example
nsx-edge> set interface bond0 ip 192.168.110.111/24 gateway 192.168.110.1 plane mgmt mode active-backup members eth0,eth1 primary eth0
Mode
Basic
Availability
Autonomous Edge, Edge
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.| Option | Description |
|---|---|
| <interface-name> | Configurable network interface argument |
| <vlan> | VLAN id <1-4094> Allowed pattern: ^([1-9]|[1-9][0-9]|[1-9][0-9]{2}|[1-3][0-9]{3}|40[0-9][0-4])$ |
Example
nsx-edge> set interface eth0 vlan 100 plane mgmt
nsx-edge> Interface eth0.100 created. Use 'set interface eth0.100' to configure.
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <interface-name> | Configurable network interface argument |
| <prefix-ipv46> | CIDR notation argument for IPv4/IPv6 address |
| <gateway-ipv46> | Gateway IPv4/IPv6 address argument |
| <plane> | Interface plane argument Allowed values: mgmt, debug |
Example
nsx-edge> set interface eth0 plane mgmt
nsx-edge>
or
nsx-edge> set interface eth0 dhcp plane mgmt
nsx-edge>
or
nsx-edge> set interface eth0 ip 192.168.110.111/24 gateway 192.168.110.1 plane mgmt
nsx-edge>
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <interface-name> | Configurable network interface argument |
| <prefix-ipv46> | CIDR notation argument for IPv4/IPv6 address |
| <gateway-ipv46> | Gateway IPv4/IPv6 address argument |
Example
nsx-edge> set interface eth0 ip 192.168.110.110/24 gateway 192.168.110.1
nsx-edge>
Mode
Basic
Availability
Autonomous Edge, Edge
Set IPv6 static interface. If IPv6 interface already configured then user cannot configure it again.
| Option | Description |
|---|---|
| <interface-name> | Configurable network interface argument |
| <prefix-ipv6> | CIDR notation argument for IPv6 address |
Example
nsx-mgr> set interface eth0 ipv6 fd01:0:106:8:0:85ff:fe5b:4784/64
Node restart is required after adding IPv6 address. Do you want to proceed to set IPv6 address (yes/no): yes
IPv6 address successfully updated. Node may take some time for IPv6 migration.
Node restart is required for IPv6 functionality to work properly.
or
nsx-mgr> set interface eth0 ipv6 2620:124:6020:1045::21/64 gateway 2620:124:6020:1045::253
Node restart is required after adding IPv6 address. Do you want to proceed to set IPv6 address (yes/no): yes
IPv6 address successfully updated. Node may take some time for IPv6 migration.
Node restart is required for IPv6 functionality to work properly.
or
nsx-mgr> set interface eth0 ipv6 2620:124:6020:1045::21/64
Node restart is required after adding IPv6 address. Do you want to proceed to set IPv6 address (yes/no): no
User specified 'no' on set IPv6 address confirmation. Set IPv6 address cancelled.
Mode
Basic
Availability
Global Manager, Manager
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.| Option | Description |
|---|---|
| <mac-address> | Configurable mac address argument |
| <vlan> | VLAN id <1-4094> Allowed pattern: ^([1-9]|[1-9][0-9]|[1-9][0-9]{2}|[1-3][0-9]{3}|40[0-9][0-4])$ |
Example
nsx-edge> set interface mac 00:0c:29:5d:a6:39 vlan 100 in-band plane mgmt
nsx-edge> Interface eth0.100 created in-band. Use 'set interface eth0.100' to configure.
Mode
Basic
Availability
Autonomous Edge, Edge
Enable or disable rule log for a specific load balancer.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
Example
nsx-edge-1> set load-balancer ed785df6-2143-4944-b918-66470886be83 rule-log enabled
Mode
Basic
Availability
Autonomous Edge, Edge
Enable or disable rule log for a specific pool.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <pool-uuid> | Pool UUID argument |
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
Example
nsx-edge-1> set load-balancer ed785df6-2143-4944-b918-66470886be83 rule-log pool ed785df6-2143-4944-b918-66470886be82 enabled
Mode
Basic
Availability
Autonomous Edge, Edge
Enable or disable rule log for a specific virtual server.
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
Example
nsx-edge-1> set load-balancer ed785df6-2143-4944-b918-66470886be83 rule-log virtual-server ed785df6-2143-4944-b918-66470886be81 enabled
Mode
Basic
Availability
Autonomous Edge, Edge
Apply edge parameters to accelerate load balancer performance.
| Option | Description |
|---|---|
| <perf-profile-type> | Performance profile type argument Allowed values: http, https, l4 |
Example
nsx-edge-1> set load-balancer perf-profile http
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | A hostname or IPv4 or IPv6 (enclose between []) address with optional port delimited by a colon |
| <proto> | Logging server protocol Allowed values: tcp, udp, tls, li, li-tls |
| <level> | Level of log entries to export Allowed values: emerg, alert, crit, err, warning, notice, info, debug |
| <facility> | Comma delimited list of facilities of log entries to export |
| <messageid> | Comma delimited list of MSGIDs of log entries to export |
| <filename> | Existing file argument |
| <structured-data> | Structured data of log entries to export Allowed pattern: ^(alarmId|alarmState|audit|comp|depr|entId|eReqId|errorCode|eventFeatureName|eventId|eventSev|eventState|eventType|euser|inst|level|method|nodeId|org|path|proj|security|site|subcomp|s2comp|splitId|splitIndex|tenantId|tid|tname|update|username|vpc|namespace)=.+$ |
Example
nsx> set logging-server 192.168.110.60 proto udp level info facility syslog messageid SYSTEM,FABRIC structured-data audit=true
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Add a name server to the DNS configuration.
| Option | Description |
|---|---|
| <ip-address> | Name server IP v4 or v6 address argument |
Example
nsx> set name-servers 192.168.110.10
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set kubeconfig file of the NAPP Kubernetes cluster. This operation
overrides any existing NAPP kubeconfig file.
Example
nsx> set napp kubeconfig
Enter Enter the KUBECONFIG file content. End with 'Ctrl-D'
Authorized access only
nsx>
Mode
Basic
Availability
Manager
Ignore Central Config from the Manager to this appliance.
Example
nsx> set node central-config disabled
nsx>
Mode
Availability
Edge, Global Manager, KVM, Manager
Synchronize Central Config from the Manager to this appliance.
Example
nsx> set node central-config enabled
nsx>
Mode
Availability
Edge, Global Manager, KVM, Manager
Configure a new NTP server.
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
Example
nsx-manager-1> set ntp-server 172.31.32.2
nsx-manager-1>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Configure password complexity requirements.
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.
- 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
- Minimum password length: 12
- Lower case characters: -1
- Upper case characters: 2
- Digits: -1
- Special case characters: -1
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.
Example
nsx> set password-complexity
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set the specified physical port mtu to given value.
| Option | Description |
|---|---|
| <physical-port-name> | Datapath String argument |
| dpd-physical-port-mtu-arg | MTU for a physical port (1500-9000) |
Example
nsx-edge-1> set physical-port fp-eth2 mtu 1500
Mode
Basic
Availability
Autonomous Edge
Set the specified physical port admin state up or down.
| Option | Description |
|---|---|
| <physical-port-name> | Datapath String argument |
| <physical-port-state> | One of {up|down} Allowed values: up, down |
Example
nsx-edge-1> set physical-port fp-eth2 state down
nsx-edge-1>
Mode
Basic
Availability
Autonomous Edge, Edge
Set current node's IP address as repository IP.
This command will restart the install-upgrade service.
Example
nsx-manager-1> set repository-ip
Make sure that repository synchronization status on this node is successful. You can check the synchronization status on 'System'->'Appliances' page under 'VIEW DETAILS' tab on GUI.
Do you want to continue? (yes/no): yes
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Add IPv4 network route. You can also just set a gateway by specifying a
prefix value of 0.0.0.0/0.| Option | Description |
|---|---|
| <prefix> | CIDR notation argument |
| <ip-route-metric> | IP route metric argument Allowed pattern: ^[0-9]+$ |
| <gateway-ip> | Gateway IP address argument |
| <interface-name> | Configurable network interface argument |
Example
nsx> set route prefix 10.79.224.0/20 gateway 10.78.239.254
nsx>
or
nsx> set route prefix 10.79.224.0/20 interface eth0
nsx>
or
nsx> set route prefix 10.79.224.0/20 gateway 10.78.239.254 metric 256
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge
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.| Option | Description |
|---|---|
| <prefix-ipv46> | CIDR notation argument for IPv4/IPv6 address |
| <ip-route-metric> | IP route metric argument Allowed pattern: ^[0-9]+$ |
| <gateway-ipv46> | Gateway IPv4/IPv6 address argument |
| <interface-name> | Configurable network interface argument |
Example
nsx> set route prefix 10.79.224.0/20 gateway 10.78.239.254
nsx>
or
nsx> set route prefix fd01:0:106:10::/64 gateway fd01:0:106:10::253
nsx>
or
nsx> set route prefix fd01:0:106:8::/64 gateway fe80::106:8:1 metric 256
nsx>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Add a domain name to the DNS search list.
| Option | Description |
|---|---|
| <domain> | Search domain argument |
Example
nsx> set search-domains example.com
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set the log level of the async replicator service.
| Option | Description |
|---|---|
| <async-replicator-level> | Async replicator logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
Example
nsx-manager-1> set service async_replicator logging-level warn
Logging level: warn
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the log level of the Auth service.
| Option | Description |
|---|---|
| <auth-level> | Auth logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
Example
nsx-manager-1> set service auth logging-level info
Logging level: info
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the log level for the controller service.
| Option | Description |
|---|---|
| <level> | The controller service logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Example
nsx-controller-1> set service controller logging-level info
nsx-controller-1>
Mode
Basic
Availability
Manager
Set the log level for the specified component.
| Option | Description |
|---|---|
| <string> | String argument Allowed pattern: ^.*$ |
| <level> | The controller service logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Example
nsx-controller-1> set service controller logging-level name BgpConfigSplitter error
Name: BgpConfigSplitter LogLevel: error
Mode
Basic
Availability
Manager
Set the log level for components that match the specified pattern. The pattern can be a regular expression.
| Option | Description |
|---|---|
| <string> | String argument Allowed pattern: ^.*$ |
| <level> | The controller service logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Example
nsx-controller-1> set service controller logging-level pattern Dhcp error
Name: DhcpIpPoolSplitter LogLevel: error
Name: DhcpRelaySplitter LogLevel: error
Name: DhcpStaticBindingSplitter LogLevel: error
Name: LogicalDhcpServerSplitter LogLevel: error
Name: com.vmware.nsx.canary.span.DhcpIpPoolSpanner LogLevel: error
Name: com.vmware.nsx.canary.span.DhcpStaticBindingSpanner LogLevel: error
Name: com.vmware.nsx.canary.span.LogicalDhcpServerSpanner LogLevel: error
Mode
Basic
Availability
Manager
Set the log level of the Dataplane service.
| Option | Description |
|---|---|
| <level> | Edge service logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
Example
nsx-edge-1> set service dataplane logging-level warn
nsx-edge-1>
Mode
Basic
Availability
Autonomous Edge, Edge
Set the log level of the DHCP service.
| Option | Description |
|---|---|
| <level> | Edge service logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
Example
nsx-edge-1> set service dhcp logging-level warn
nsx-edge-1>
Mode
Basic
Availability
Autonomous Edge, Edge
Enable or disable DHCP pool monitor and set monitor interval in seconds
| Option | Description |
|---|---|
| <mode> | DHCP Pool Monitor Enable/Disable Flag Allowed values: on, off |
| <number> | DHCP Pool Monitor Interval |
Example
nsx-edge-1> set service dhcp pool-monitor on monitor-interval 60
nsx-edge-1>
Mode
Basic
Availability
Edge
Enable or disable basic authentication in API calls.
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
Example
nsx-manager-1> set service http basic-authentication enabled
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the HTTP API per-client concurrency limit value.
| Option | Description |
|---|---|
| <http-client-api-concurrency-limit> | HTTP API per-client concurrency limit value in the range of 0 - 9223372036854775807 |
Example
nsx-manager-1> set service http client-api-concurrency-limit 40
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the HTTP API per-client rate limit value.
| Option | Description |
|---|---|
| <http-client-api-rate-limit> | HTTP API per-client rate limit in calls per second |
Example
nsx-manager-1> set service http client-api-rate-limit 100
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the HTTP service connection timeout value.
| Option | Description |
|---|---|
| <http-conn-timeout> | HTTP connection timeout in seconds |
Example
nsx-manager-1> set service http connection-timeout 60
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Enable or disable cookie-based authentication in API calls.
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
Example
nsx-manager-1> set service http cookie-based-authentication enabled
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the HTTP API global concurrency limit value.
| Option | Description |
|---|---|
| <http-global-api-concurrency-limit> | HTTP API global concurrency limit value in the range of 0 - 9223372036854775807 |
Example
nsx-manager-1> set service http global-api-concurrency-limit 100
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the log level of the HTTP service.
| Option | Description |
|---|---|
| <http-level> | HTTP logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
Example
nsx-manager-1> set service http logging-level warn
Logging level: warn
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the HTTP service redirect host.
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
Example
nsx-manager-1> set service http redirect-host 10.0.0.1
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the HTTP service session timeout value.
| Option | Description |
|---|---|
| <http-session-timeout> | HTTP session timeout in seconds |
Example
nsx-manager-1> set service http session-timeout 60
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Enable or disable ike per tunnel debug mode
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| <debug-level-arg> | IKE Debug level Allowed values: off, fail, highok, highstart, uncommon, midok, midstart, lowok, lowstart |
Example
nsx-edge-1> set service ike debug-tunnel local-ip 10.0.0.1 remote-ip 10.1.0.1 debug-level midok
nsx-edge-1> set service ike debug-tunnel local-ip 2001::1 remote-ip 2002::1 debug-level lowstart
Mode
Basic
Availability
Edge
Enable or disable ike per tunnel debug mode
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| <debug-level-arg> | IKE Debug level Allowed values: off, fail, highok, highstart, uncommon, midok, midstart, lowok, lowstart |
Example
nsxedge> set service ike debug-tunnel local-ip 192.168.128.1 remote-ip 1.1.5.100 debug-level midok follow
29-May-2019 20:53:28 ssh_stack IKEv2 packet S(192.168.128.1:500 -> 1.1.5.100:500): len= 80, mID=165, HDR
29-May-2019 20:53:28 ssh_stack responder INFO completed
29-May-2019 20:53:58 ssh_stack [670ba4b198/349435e0b00] R: IKE SA REFCNT: 1
Mode
Basic
Availability
Edge
Set the log level of the IKE service.
| Option | Description |
|---|---|
| <level> | Edge service logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
Example
nsx-edge-1> set service ike logging-level warn
nsx-edge-1>
Mode
Basic
Availability
Autonomous Edge, Edge
Set the install-upgrade service's enabled property.
Example
nsx-manager-1> set service install-upgrade enabled
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the log level of the Local Controller service.
| Option | Description |
|---|---|
| <level> | Edge service logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
Example
nsx-edge-1> set service local-controller logging-level warn
nsx-edge-1>
Mode
Basic
Availability
Autonomous Edge, Edge
Set the log level of the manager service.
| Option | Description |
|---|---|
| <level> | Manager logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
Example
nsx-manager-1> set service manager logging-level warn
Logging level: warn
Mode
Basic
Availability
Global Manager, Manager
Set the log level of the specified package in manager service.
| Option | Description |
|---|---|
| <level> | Manager logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
| <manager-package-name> | Manager package name argument |
Example
nsx-manager-1> set service manager logging-level debug package org.corfudb
Logging level for package org.corfudb: debug
Mode
Basic
Availability
Global Manager, Manager
Set the log level of the Monitoring service.
| Option | Description |
|---|---|
| <monitoring-level> | Monitoring logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
Example
nsx-manager-1> set service monitoring logging-level warn
Logging level: warn
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Set the log level of the Node Management service.
| Option | Description |
|---|---|
| <node-mgmt-level> | Node Mgmt logging level argument Allowed values: off, error, warn, info, debug, critical |
Example
nsx-manager-1> set service node-mgmt logging-level warn
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Dynamically set nsd log level.
| Option | Description |
|---|---|
| <level> | Exporter service logging level argument Allowed values: fatal, error, warn, info, debug, trace |
Example
nsx-1> set service nsd logging-level warn
Logging level updated
Mode
Basic
Availability
Edge
Dynamically set service daemon log level.
| Option | Description |
|---|---|
| <level> | NSX Agent service logging level argument Allowed values: fatal, error, warn, info, debug, trace, off |
Example
nsx-1> set service nsx-agent logging-level warn
Logging level updated
Mode
Basic
Availability
KVM
Set service cfgagent hyperbus logging level.
| Option | Description |
|---|---|
| <level> | Cfgagent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Mode
Basic
Availability
ESXi
Set service cfgagent metrics logging level
| Option | Description |
|---|---|
| <level> | Cfgagent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Mode
Basic
Availability
ESXi
Set service cfgagent nestdb logging level
| Option | Description |
|---|---|
| <level> | Cfgagent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Mode
Basic
Availability
ESXi
Set service cfgagent net logging level
| Option | Description |
|---|---|
| <level> | Cfgagent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Mode
Basic
Availability
ESXi
Set service cfgagent rpc logging level
| Option | Description |
|---|---|
| <level> | Cfgagent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Mode
Basic
Availability
ESXi
Set service cfgagent SHA client logging level.
| Option | Description |
|---|---|
| <level> | Cfgagent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Mode
Basic
Availability
ESXi
Set service cfgagent upm logging level.
| Option | Description |
|---|---|
| <level> | Cfgagent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Mode
Basic
Availability
ESXi
Set service cfgagent workflow logging level.
| Option | Description |
|---|---|
| <level> | Cfgagent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Mode
Basic
Availability
ESXi
Set service cfgagent workflow trace level.
| Option | Description |
|---|---|
| <level> | Cfgagent trace level Allowed values: off, warn, info, debug, trace |
Mode
Basic
Availability
ESXi
Set service cfgagent logging level.
| Option | Description |
|---|---|
| <level> | Cfgagent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Mode
Basic
Availability
ESXi
Enable/Disable ContextMux feature
| Option | Description |
|---|---|
| <feature-type> | Context mux feature type argument Allowed values: nmdb-deprecated, dump-health-info |
| <feature-operation> | ContextMux operation argument Allowed values: enable, disable |
Example
nsx-1> set service nsx-context-mux nmdbDeprecated enable
ContextMux feature:nmdbDeprecated operation:enable written successfully
Mode
Basic
Availability
ESXi
Dynamically set service daemon log level.
| Option | Description |
|---|---|
| <level> | Context mux logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
Example
nsx-1> set service nsx-context-mux logging-level warn
Logging level updated
Mode
Basic
Availability
ESXi
Enable/disable TCP UDP ICMP events
| Option | Description |
|---|---|
| <idfwprotocol> | Context Engine event protocol Allowed values: tcp, udp, icmp |
| <idfwenable> | Context Engine event protocol enable Allowed values: off, on |
Example
esx> set service nsx-ctxteng protocol udp off
CliServer: Successfully set protocol mask to TCP:on UDP:on ICMP:off
Mode
Basic
Availability
ESXi
Set service exporter SmartNIC demux logging level.
| Option | Description |
|---|---|
| <level> | Exporter service logging level argument Allowed values: fatal, error, warn, info, debug, trace |
Example
nsx-1> set service nsx-exporter lib-sndemux logging-level warn
Setting log level from debug to warn successfully
Mode
Basic
Availability
ESXi
Dynamically set service daemon log level.
| Option | Description |
|---|---|
| <level> | Exporter service logging level argument Allowed values: fatal, error, warn, info, debug, trace |
Example
nsx-1> set service nsx-exporter logging-level warn
Logging level updated
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, ESXi, KVM, Manager
Dynamically set nsx-lastline-rapid log level
| Option | Description |
|---|---|
| <level> | Rapid logging level argument Allowed values: default, debug |
Example
localhost> set service rapid logging-level debug
Logging level updated. Need to restart nsx-lastline-rapid for changes to take effect
Mode
Basic
Availability
Set service netopa logging level.
| Option | Description |
|---|---|
| <level> | Netopa logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Example
esx> set service nsx-netopa logging-level debug
Setting Netopa logging level from info to debug successfully
Mode
Basic
Availability
Autonomous Edge, ESXi
Set service opsagent SHA client logging level.
| Option | Description |
|---|---|
| <level> | OpsAgent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Set service opsagent SmartNIC demux logging level.
| Option | Description |
|---|---|
| <level> | OpsAgent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Set service opsagent workflow logging level.
| Option | Description |
|---|---|
| <level> | OpsAgent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Set service opsagent workflow trace level.
| Option | Description |
|---|---|
| <level> | OpsAgent trace level Allowed values: off, warn, info, debug, trace |
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Set service OpsAgent logging level.
| Option | Description |
|---|---|
| <level> | OpsAgent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Dynamically set service daemon log level.
| Option | Description |
|---|---|
| <level> | Platform client service logging level argument Allowed values: fatal, error, warn, info, debug, trace |
Example
nsx-1> set service nsx-platform-client logging-level warn
Logging level updated
Mode
Basic
Availability
Edge, Global Manager, ESXi, KVM, Manager
Set service nsx-proxy central logging level
| Option | Description |
|---|---|
| <level> | NsxProxy logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Set service nsx-proxy metrics logging level.
| Option | Description |
|---|---|
| <level> | NsxProxy logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Set service nsx-proxy nestdb logging level.
| Option | Description |
|---|---|
| <level> | NsxProxy logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Set service nsx-proxy net logging level.
| Option | Description |
|---|---|
| <level> | NsxProxy logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Set service nsx-proxy rpc logging level.
| Option | Description |
|---|---|
| <level> | NsxProxy logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Set service nsx-proxy logging level.
| Option | Description |
|---|---|
| <level> | NsxProxy logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Set service nsx-snproxy central logging level
| Option | Description |
|---|---|
| <level> | NsxSNProxy logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Example
esx-1> set service nsx-snproxy central logging-level debug
Setting central logging level from info to debug successfully
Mode
Basic
Availability
ESXi
Set service nsx-snproxy net logging level.
| Option | Description |
|---|---|
| <level> | NsxSNProxy logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Example
esx-1> set service nsx-snproxy lib-net logging-level debug
Setting net logging level from info to debug successfully
Mode
Basic
Availability
ESXi
Set service nsx-snproxy rpc logging level.
| Option | Description |
|---|---|
| <level> | NsxSNProxy logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Example
esx-1> set service nsx-snproxy lib-rpc logging-level debug
Setting rpc logging level from info to debug successfully
Mode
Basic
Availability
ESXi
Set service nsx-snproxy logging level.
| Option | Description |
|---|---|
| <level> | NsxSNProxy logging level Allowed values: off, fatal, error, warn, info, debug, trace |
Example
esx-1> set service nsx-snproxy logging-level debug
Setting proxy logging level from info to debug successfully
Mode
Basic
Availability
ESXi
Configure the NTP service to start on boot.
Example
nsx> set service ntp start-on-boot
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set the log level of the FRR service.
| Option | Description |
|---|---|
| <destination> | Edge Routing service logging destination argument Allowed values: file, syslog |
| <level> | Edge Routing service logging level argument Allowed values: off, error, warning, notification, informational, debug |
Example
nsx-edge-1> set service router logging-level syslog debug
nsx-edge-1>
Mode
Basic
Availability
Autonomous Edge, Edge
Set the log level of the routing platform and config services.
| Option | Description |
|---|---|
| <level> | Edge Routing Platform service logging level argument Allowed values: off, fatal, error, warn, info, debug |
Example
nsx-edge-1> set service routing-platform logging-level dbg
nsx-edge-1>
Mode
Basic
Availability
Autonomous Edge, Edge
Dynamically set EPSEC Library log level
| Option | Description |
|---|---|
| <level> | EPSec Lib logging level argument Allowed values: off, fatal, error, warn, info, debug, trace, stats |
Example
localhost> set service security-hub epsec logging-level warn
Logging level updated
Mode
Basic
Availability
Enable/Disable SecurityHub Fileless feature and sub-features
| Option | Description |
|---|---|
| <fileless-feature-subtype> | SecurityHub Fileless Feature Subtype argument Allowed values: all |
| <feature-operation> | SecurityHub operation argument Allowed values: enable, disable |
| <feature-target> | SecurityHub Feature Target argument Allowed values: all |
Example
nsx-1> set service security-hub fileless all enable vms all
SecurityHub feature:fileless subtype:all operation:enable for vms:all
written and sent successfully
Mode
Basic
Availability
Dynamically set security-hub log level
| Option | Description |
|---|---|
| <level> | Security Hub logging level argument Allowed values: error, warn, info, debug |
Example
localhost> set service security-hub logging-level warn
Logging level updated
Mode
Basic
Availability
Configure the snmp service to start on boot.
Example
nsx> set service snmp start-on-boot
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Configure the SSH service to start on boot.
Example
nsx> set service ssh start-on-boot
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set the log level of the Telemetry service.
| Option | Description |
|---|---|
| <telemetry-level> | Telemetry logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
Example
nsx-manager-1> set service telemetry logging-level warn
Logging level: warn
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
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.
Example
nsx> set snmp community
Community string:
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
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.
| Option | Description |
|---|---|
| <community-string> | SNMP community string Allowed pattern: ^[\S]{1,64}$ |
Example
nsx> set snmp community Q_cHeHUBe7Ud2+sayuReq2t3
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set SNMP v2 Trap Targets.
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | A hostname or IPv4 or IPv6 (enclose between []) address with optional port delimited by a colon |
| <community-string> | SNMP community string Allowed pattern: ^[\S]{1,64}$ |
Example
nsx> set snmp v2-targets 10.20.125.6:1162 community public
nsx>
or
nsx> set snmp6 v2-targets [fd01:1:2:2919:0:a:0:d03]:123 community public
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set SNMP v3 Engine ID.
| Option | Description |
|---|---|
| <v3-engine-id> | SNMP v3 Engine ID Allowed pattern: ^[0-9a-fA-F]{10,64}$ |
Example
nsx> set snmp v3-engine-id 80001adc80992933638c48f75900000002
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set SNMP v3 Protocols auth_protocol and priv_protocol.
| Option | Description |
|---|---|
| <v3-auth-protocol> | SNMP v3 Auth Protocol Allowed values: SHA1, SHA256, SHA384, SHA512 |
| <v3-priv-protocol> | SNMP v3 Priv Protocol Allowed values: AES128, AES192, AES256 |
Example
nsx> set snmp v3-protocols auth-protocol SHA1 priv-protocol AES128
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set SNMP v3 Trap Targets.
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | A hostname or IPv4 or IPv6 (enclose between []) address with optional port delimited by a colon |
| <v3-user> | SNMP v3 user Allowed pattern: ^[\S]{1,32}$ |
Example
nsx> set snmp v3-targets 10.20.125.6:1162 user user2
nsx>
or
nsx> set snmp v3-targets [fd01:1:2:2919:0:a:0:d03]:1162 user user2
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set SNMP v3 users,auth-password,priv-password in cipher text.
| Option | Description |
|---|---|
| <v3-user> | SNMP v3 user Allowed pattern: ^[\S]{1,32}$ |
Example
nsx> set snmp v3-users user1
New auth password:
Confirm new auth password:
New priv password:
Confirm new priv password:
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set SNMP v3 users auth-password,priv-password in plain text.
| Option | Description |
|---|---|
| <v3-user> | SNMP v3 user Allowed pattern: ^[\S]{1,32}$ |
| <auth-password> | SNMP v3 User Auth Password |
| <priv-password> | SNMP v3 user Priv Password |
Example
nsx> set snmp v3-users user1 auth-password 12345678 priv-password 87654321
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Enable SSH Root login property
Example
nsx> set ssh root-login
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set the system timezone.
| Option | Description |
|---|---|
| <timezone> | Timezone (e.g. UTC, America/New_York, Asia/Tokyo, Europe/Zurich) |
Example
nsx> set timezone America/Los_Angeles
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set TLS inspection logging level for all destinations.
| Option | Description |
|---|---|
| <level> | Edge service logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
Example
nsx-edge-1> set tls-inspection logging-level debug
Destination Level
syslog dbg
console dbg
Mode
Basic
Availability
Edge
Set TLS inspection logging level for a destination.
| Option | Description |
|---|---|
| <level> | Edge service logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
| <dest> | TLS Inspection logging destination argument Allowed values: syslog, console |
Example
nsx-edge-1> set tls-inspection logging-level trace destination syslog
Destination Level
syslog trace
console off
Mode
Basic
Availability
Edge
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.
| Option | Description |
|---|---|
| <username> | Username of active user account |
| <password> | Password of user |
Example
nsx> set user audit password Str0ng_Pwd!New$
nsx>
or
nsx> set user audit password
New password:
Confirm new password:
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set number of days the user's password is valid after a password change.
| Option | Description |
|---|---|
| <username> | Username of user |
| <password-expiration-days> | Number of days password valid after change (1 - 9999) |
Example
nsx> set user audit password-expiration 120
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set number of days prior user receives warning message before password expires. Set 0 to disable warning messages for password expiry.
| Option | Description |
|---|---|
| <username> | Username of user |
| <password-expiration-warn-days> | Number of days password warn messages before change (1 - 9999) |
Example
nsx> set user audit password-expiration-warning 10
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Set new user name for the specified non-root user.
| Option | Description |
|---|---|
| <username> | Username of user |
| <new-username> | Username of user |
Example
nsx> set user audit username audit-user1
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
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.
| Option | Description |
|---|---|
| <username> | Username of logged in user |
| <password> | Password of user |
| <old-password> | Current password of user |
Example
nsx> set user admin password NewPass789! old-password OldPass123$
nsx>
or
nsx> set user admin password NewerPass789!
Current password:
nsx>
or
nsx> set user admin password
Current password:
New password:
Confirm new password:
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
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.
| Option | Description |
|---|---|
| <username> | Username of user |
| <key-label> | Unique label for SSH key |
| <key-type> | SSH key type Allowed values: ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, ecdsa-sha2-nistp521, ssh-dss, ssh-ed25519, ssh-rsa |
| <key-value> | SSH key value |
| <password> | Password of user |
Example
nsx> set user admin ssh-keys label user1@domain1 type ssh-rsa key AAAAB3NzaC1yc2EAAAABIwAAAIEAywWhrwq4FjHt+UuwZcZePxtjtZOENFpOjufycaYso2nTlzNwnAQEQRfbqsUxKVtOtGxgApIkUvjRIjNBdJE6iOzvBXZhhJrM0GUDJragw7SMVIs/5xJBGAyHKJ1YUMGO7+nJTmsCLx6PFOlQYveuriiVVCCZerGCLH+UtSXK3z+l7hx9NiDg3/ylOLc3f3SLxrJKn0gMTgK7BHJFXo4PguuPjWZLVdUDX+XKiqtT2n4IsYs6N9qVFG3zUgNlEjZM47NK/ytAC0max98pK+QNzsuaQOo/IShJ1TOw5wwScflPArVJ2AyROqAe7cfQg7q12I9olASFd3U5NazfZCTYAvWA1kz9UZEWLJ1Br1XOkPqOleMM8KCp/PXzz8H0kISkMIji0/QuiZOPEBsKlszXjlALcXR8Mg1uiZVWy48i9JheyXyj1ToCj6cPScpgFHp3DAGSlKKbE1EFaVfeeyGAnHESuXC9wkSeFZCEyMJ+RgJxMkBXNZmyycbwsSqAeGJpMEUDlwzu2GD0obBz0HXqg9J1Xallop5AVDKfeszZcc= password Pa$$w0rd
nsx>
or
nsx> set user admin ssh-keys label user1@domain1 type ssh-rsa key AAAAB3NzaC1yc2EAAAABIwAAAIEAywWhrwq4FjHt+UuwZcZePxtjtZOENFpOjufycaYso2nTlzNwnAQEQRfbqsUxKVtOtGxgApIkUvjRIjNBdJE6iOzvBXZhhJrM0GUDJragw7SMVIs/5xJBGAyHKJ1YUMGO7+nJTmsCLx6PFOlQYveuriiVVCCZerGCLH+UtSXK3z+l7hx9NiDg3/ylOLc3f3SLxrJKn0gMTgK7BHJFXo4PguuPjWZLVdUDX+XKiqtT2n4IsYs6N9qVFG3zUgNlEjZM47NK/ytAC0max98pK+QNzsuaQOo/IShJ1TOw5wwScflPArVJ2AyROqAe7cfQg7q12I9olASFd3U5NazfZCTYAvWA1kz9UZEWLJ1Br1XOkPqOleMM8KCp/PXzz8H0kISkMIji0/QuiZOPEBsKlszXjlALcXR8Mg1uiZVWy48i9JheyXyj1ToCj6cPScpgFHp3DAGSlKKbE1EFaVfeeyGAnHESuXC9wkSeFZCEyMJ+RgJxMkBXNZmyycbwsSqAeGJpMEUDlwzu2GD0obBz0HXqg9J1Xallop5AVDKfeszZcc=
Password (required only for users root and admin):
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
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.
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
Example
nsx-edge-1> set vmc migration-mode disabled
Mode
Basic
Availability
Edge
Set a runtime option for the specified vSwitch.
| Option | Description |
|---|---|
| <option-name> | Runtime option name Allowed values: IGMPQueries, IGMPQueryInterval, IGMPRouterIP, IGMPV3MaxSrcIPNum, IGMPVersion, MLDRouterIP, MLDV2MaxSrcIPNum, MLDVersion, MaxRARPsPerInterval, RARPAdvertisementDuration, TeamPolicyUpDelay |
| <option-value> | Runtime option value Allowed pattern: ^(([0-9]+)|(((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9]).){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9]))|(([A-Za-z0-9]{0,4}:){5}[A-Za-z0-9]{0,4}))$ |
Example
esx-1> set vswitch runtime IGMPQueries 1
esx-1>
Mode
Basic
Availability
ESXi
Set vxlan uplink queue filter.
| Option | Description |
|---|---|
| <boolean-arg> | Boolean enum value Allowed values: true, false |
| <dvs-name> | DVS name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
Example
esx-1> set vxlan-uplink-queue-filter false dvs nsxvswitch
esx-1>
Mode
Basic
Availability
ESXi
Shut down the system. If you specify the
force argument, the system will shut down immediately without prompting for confirmation.Example
nsx> shutdown
Are you sure you want to shutdown (yes/no): yes
Broadcast message from root@nsx
(unknown) at 1:26 ...
The system is going down for halt NOW!
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
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.| Option | Description |
|---|---|
| <esx-dvfilter-name> | dvfilter name argument |
Example
esx-1> start capture dvfilter nic-1000053347-eth0-vmware-sfw.2
The name of the dvfilter is nic-1000053347-eth0-vmware-sfw.2
No server port specifed, select 31661 as the port
Output the packet info to console.
Local CID 2
Listen on port 31661
Accept...Vsock connection from port 1030 cid 2
22:09:38.563545[1] Captured at PreDVFilter point, TSO not enabled, Checksum not offloaded and not verified, length 60.
Segment[0] ---- 2048 bytes:
0x0000: ffff ffff ffff 0200 2b8a 60e6 0806 0001
0x0010: 0800 0604 0001 0200 2b8a 60e6 0ac0 5ec2
0x0020: 0000 0000 0000 0ac0 57eb 0000 0000 0000
0x0030: 0000 0000 0000 0000 0000 0000
22:09:38.569533[2] Captured at PreDVFilter point, TSO not enabled, Checksum not offloaded and not verified, length 60.
Segment[0] ---- 2048 bytes:
0x0000: ffff ffff ffff 0200 2d8b a5c2 0806 0001
0x0010: 0800 0604 0001 0200 2d8b a5c2 0ac0 49f8
0x0020: 0000 0000 0000 0ac0 5561 0000 0000 0000
0x0030: 0000 0000 0000 0000 0000 0000
.
.
.
Mode
Basic
Availability
ESXi
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.
| Option | Description |
|---|---|
| <interface-name> | Network interface argument |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <capture-snaplen> | Packet capture snapshot length |
| <filename> | Capture file name Allowed pattern: ^[^/ *;&|]+$ |
| <file-count> | File count for rotating capture (1-25) |
| <expression> | Packet capture expression Allowed pattern: ^.*$ |
Mode
Basic
Availability
Autonomous Edge, Edge
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 |
| Option | Description |
|---|---|
| <interface-name> | Network interface argument |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <filename> | Capture file name Allowed pattern: ^[^/ *;&|]+$ |
| <packet-count> | Packet count value greater than or equal to 1 |
| <expression> | Packet capture expression Allowed pattern: ^.*$ |
Example
nsx> start capture interface eth0 direction output file capture.pcap count 5 expression ip 10.160.198.196 port 22
Capture 5 packets to file initiated,
enter Ctrl-C to terminate before all packets captured
5 packets captured
11 packets received by filter
0 packets dropped by kernel
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, ESXi, KVM, Manager, NSX on VMC
Start packet capture in standalone mode with given fcport.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <fcport-id> | Packet capture fcport id parameter Allowed pattern: ^[0-9]+$ |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 fcport 100 direction input
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in standalone mode with given fcport.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <fcport-id> | Packet capture fcport id parameter Allowed pattern: ^[0-9]+$ |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <arguments> | Packet capture option parameter |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 fcport 100 direction input parameters srcport 1556
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in steam mode with given fcport.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <fcport-id> | Packet capture fcport id parameter Allowed pattern: ^[0-9]+$ |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 fcport 100 direction input stream-to 127.0.0.1 port 4754
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in steam mode with given fcport.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <fcport-id> | Packet capture fcport id parameter Allowed pattern: ^[0-9]+$ |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| <arguments> | Packet capture option parameter |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 fcport 100 direction input stream-to 127.0.0.1 port 4754 parameters srcport 1556
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in standalone mode with given filter.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <filter-name> | Packet capture filter name parameter |
| <stage-type> | Packet capture filter stage parameter Allowed values: pre, post |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 filter nic-1000052870-eth1-vmware-sfw.2 stage pre
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in standalone mode with given filter.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <filter-name> | Packet capture filter name parameter |
| <stage-type> | Packet capture filter stage parameter Allowed values: pre, post |
| <arguments> | Packet capture option parameter |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 filter nic-1000052870-eth1-vmware-sfw.2 stage pre parameters srcport 1556
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in stream mode with given filter.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <filter-name> | Packet capture filter name parameter |
| <stage-type> | Packet capture filter stage parameter Allowed values: pre, post |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 filter nic-1000052870-eth1-vmware-sfw.2 stage pre stream-to 127.0.0.1 port 4754
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in stream mode with given filter.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <filter-name> | Packet capture filter name parameter |
| <stage-type> | Packet capture filter stage parameter Allowed values: pre, post |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| <arguments> | Packet capture option parameter |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 filter nic-1000052870-eth1-vmware-sfw.2 stage pre stream-to 127.0.0.1 port 4754 parameters srcport 1556
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in standalone mode with given interface.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <cap-interface-id> | Interface id Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 interface fed75492-d335-11e7-ac91-c3fa7e7f6b23 direction input
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in standalone mode with given interface.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <cap-interface-id> | Interface id Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <arguments> | Packet capture option parameter |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 interface fed75492-d335-11e7-ac91-c3fa7e7f6b23 direction input parameters srcport 1556
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in stream mode with given interface.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <cap-interface-id> | Interface id Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 interface fed75492-d335-11e7-ac91-c3fa7e7f6b23 direction input stream-to 127.0.0.1 port 9999
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in stream mode with given interface.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <cap-interface-id> | Interface id Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| <arguments> | Packet capture option parameter |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 interface fed75492-d335-11e7-ac91-c3fa7e7f6b23 direction input stream-to 127.0.0.1 port 9999 parameters srcport 1556
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in standalone mode with given pnic.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <pnic-value> | Packet capture pnic value parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 pnic eth0 direction input
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in standalone mode with given pnic.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <pnic-value> | Packet capture pnic value parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <arguments> | Packet capture option parameter |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 pnic eth0 direction input parameters srcport 1556
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in steam mode with given pnic.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <pnic-value> | Packet capture pnic value parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 pnic eth0 direction input stream-to 127.0.0.1 port 4754
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in steam mode with given pnic.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <pnic-value> | Packet capture pnic value parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| <arguments> | Packet capture option parameter |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 pnic eth0 direction input stream-to 127.0.0.1 port 4754 parameters srcport 1556
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in standalone mode with given parameters.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vdrport-id> | Vdrport id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 vdrport vdr-vdrPort direction input
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in standalone mode with given parameters.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vdrport-id> | Vdrport id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <arguments> | Packet capture option parameter |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 vdrport vdr-vdrPort direction input parameters srcport 1556
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture on ESXi node with given parameters.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vdrport-id> | Vdrport id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 vdrport vdr-vdrPort direction input stream-to 127.0.0.1 port 4754
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture on ESXi node with given parameters.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vdrport-id> | Vdrport id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| <arguments> | Packet capture option parameter |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 vdrport vdr-vdrPort direction input stream-to 127.0.0.1 port 4754 parameters srcport 1556
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in standalone mode with given vif.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vif> | VIF ID |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 vif facb8cd1-2bf4-49c3-bb30-ed826986499b direction input
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in standalone mode with given vif.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vif> | VIF ID |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <arguments> | Packet capture option parameter |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 vif facb8cd1-2bf4-49c3-bb30-ed826986499b direction input parameters srcport 1556
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in stream mode with given vif.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vif> | VIF ID |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 vif facb8cd1-2bf4-49c3-bb30-ed826986499b direction input stream-to 127.0.0.1 port 4754
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in stream mode with given vif.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vif> | VIF ID |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| <arguments> | Packet capture option parameter |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 vif facb8cd1-2bf4-49c3-bb30-ed826986499b direction input stream-to 127.0.0.1 port 4754 parameters srcport 1556
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in standalone mode on ESXi node with given vmknic.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vmknic-id> | Vmknic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 vmknic vmk0 direction input
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in standalone mode with given parameters.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vmknic-id> | Vmknic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <arguments> | Packet capture option parameter |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 vmknic vmk0 direction input parameters srcport 1556
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture on ESXi node with given vmknic.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vmknic-id> | Vmknic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 vmknic vmk0 direction input stream-to 127.0.0.1 port 4754
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture on ESXi node with given vmknic.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vmknic-id> | Vmknic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| <arguments> | Packet capture option parameter |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 vmknic vmk0 direction input stream-to 127.0.0.1 port 4754 parameters srcport 1556
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in standalone mode on ESXi node with given vmnic.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vmnic-id> | Vmnic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 vmnic vmnic0 direction input
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in standalone mode with given parameters.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vmnic-id> | Vmnic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <arguments> | Packet capture option parameter |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 vmnic vmnic0 direction input parameters srcport 1556
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture on ESXi node with given vmnic.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vmnic-id> | Vmnic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 vmnic vmnic0 direction input stream-to 127.0.0.1 port 4754
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture on ESXi node with given vmnic.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vmnic-id> | Vmnic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| <arguments> | Packet capture option parameter |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 vmnic vmnic0 direction input stream-to 127.0.0.1 port 4754 parameters srcport 1556
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in standalone mode on ESXi node with given vnic.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vnic-id> | Vnic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 vnic e21e1397-c5c1-4b37-b7f0-1741d1809e61 direction input
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture in standalone mode with given parameters.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vnic-id> | Vnic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <arguments> | Packet capture option parameter |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 vnic e21e1397-c5c1-4b37-b7f0-1741d1809e61 direction input parameters srcport 1556
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture on ESXi node with given vnic.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vnic-id> | Vnic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 vnic e21e1397-c5c1-4b37-b7f0-1741d1809e61 direction input stream-to 127.0.0.1 port 4754
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Start packet capture on ESXi node with given vnic.
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vnic-id> | Vnic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| <arguments> | Packet capture option parameter |
Example
nsx-manager-1> start capture node fed75492-d335-11e7-ac91-c3fa7e7f6b23 vnic e21e1397-c5c1-4b37-b7f0-1741d1809e61 direction input stream-to 127.0.0.1 port 4754 parameters srcport 1556
nsx-manager-1>
Mode
Basic
Availability
Global Manager, Manager
Display a packet capture on all available interfaces.
Example
esx-1> start capture trace
22:51:17.831714[61] Captured at PktFree point, TSO not enabled, Checksum not offloaded and not verified, length 60.
PATH:
+- [22:51:17.831582] | UplinkRcvKernel
+- [22:51:17.831584] | PortInput
+- [22:51:17.831585] | IOChain
+- [22:51:17.831587] | EtherswitchDispath
+- [22:51:17.831591] | EtherswitchOutput
+- [22:51:17.831591] | PortOutput
+- [22:51:17.831594] | IOChain
+- [22:51:17.831595] | IOChain
+- [22:51:17.831597] | EtherswitchOutput
+- [22:51:17.831597] | PortOutput
+- [22:51:17.831599] | IOChain
+- [22:51:17.831600] | EtherswitchOutput
Segment[0] ---- 2048 bytes:
0x0000: ffff ffff ffff 0200 2d26 a8ff 0806 0001
0x0010: 0800 0604 0001 0200 2d26 a8ff 0ac0 5c53
0x0020: 0000 0000 0000 0ac0 5157 0000 0000 0000
0x0030: 0000 0000 0000 0000 0000 0000
.
.
.
Mode
Basic
Availability
ESXi
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.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
Example
nsx-edge> start firewall e159f0db-d8e4-4973-9cbb-8cc30def2c3e bulk-sync
nsx-edge>
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <core-id> | Core id for packet capture session Allowed pattern: ^[0-9]+$ |
| <time> | Time measurement in seconds Allowed pattern: [1-9][0-9]*$ |
Example
nsx-edge-1> start flow-monitor core 1 timeout 10
flow_mon.tgz will be available in edge filestore in 10 seconds. Go to edge CLI, use the following command to transfer the file: copy file flow_mon.tgz url
Mode
Basic
Availability
Edge
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`
| Option | Description |
|---|---|
| <runbook-id> | Runbook ID |
| <runbook-param> | Runbook parameters |
Example
nsx > start invocation runbook EdgeDpBfd runbook-arg --src_ip 212.149.55.92 --dst_ip 212.149.55.93
Runbook Invocation Report
Invocation ID : a4774982-17da-40ee-9282-e1c2dd8cb1de
Timestamp : 2023-11-01 02:20:51
System Info
Host Name : nsx
OS Name : Linux
OS Version : 5.15.123-nn2-server
Arch : x86_64
Runbook Info
Runbook ID : EdgeDpBfd
Version : 2.0
Publisher : VMware, Inc.
Report Type : VALID
Conclusion : Edge BFD session (212.149.55.92 <-> 212.149.55.93) never went down.
Recommendation : No action needs to be taken.
Artifact Bundle : /a4774982-17da-40ee-9282-e1c2dd8cb1de.offline.tar.gz
Steps
Step Number : 1
Step Action : Fetch BFD session
Step Result : Edge BFD session (212.149.55.92 <-> 212.149.55.93) is (up), last remote state: (up), local diag: (No Diagnostic), last remote diag: (No Diagnostic), last down time: (N/A), local down reason: (No Diagnostic), remote down reason: (No Diagnostic).
Step Number : 2
Step Action : Fetch BFD session stats
Step Result : Edge BFD session (212.149.55.92 <-> 212.149.55.93) never went down.
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, ESXi, KVM, Manager
Execute recover of search service datastore.
Example
nsx> start search recover
Index name : nsx_policy_rolebinding
Recovery status : success
Mode
Basic
Availability
Global Manager, Manager
Execute full or partial re-sync of search service datastore.
| Option | Description |
|---|---|
| <search-scope> | Search scope argument |
Example
nsx> start search resync manager
nsx>
Mode
Basic
Availability
Global Manager, Manager
Start the specified service.
| Option | Description |
|---|---|
| <service-name> | Node service argument |
Example
nsx> start service snmp
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Start the nsx-lastline-rapid service.
Example
nsx> start service nsx-lastline-rapid
nsx>
Mode
Basic
Availability
Start the Security Hub service.
Example
nsx> start service security-hub
nsx>
Mode
Basic
Availability
Start an upgrade with the specified upgrade bundle and according to the specified playbook.
| Option | Description |
|---|---|
| <bundle-name> | Name of NSX upgrade bundle in the file store |
| <playbook-file> | Name of Playbook file to use |
Example
nsx-edge-1> start upgrade-bundle VMware-NSX-edge-2.0.0.0.0.5298714 playbook VMware-NSX-edge-2.0.0.0.0.5298714-playbook
Validating playbook /var/vmware/nsx/file-store/VMware-NSX-edge-2.0.0.0.0.5298714-playbook.yml
Running "11-preinstall-enter_maintenance_mode" (step 1 of 5)
Running "install_os" (step 2 of 5)
System will now reboot (step 3 of 5)
After the system reboots, use "resume" to start the next step, "41-postboot-exit_maintenance_mode".
{
"info": "",
"body": null,
"state": 1,
"state_text": "CMD_SUCCESS"
}
nsx-edge-1>
Broadcast message from admin@nsx-edge-1
(unknown) at 1:33 ...
The system is going down for reboot NOW!
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Stop packet capture by session id.
| Option | Description |
|---|---|
| <session-id-arg> | Packet capture session id parameter |
Mode
Basic
Availability
Global Manager, Manager
Stop firewall bulk synchronization for the logical router interface.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
Example
nsx-edge> stop firewall e159f0db-d8e4-4973-9cbb-8cc30def2c3e bulk-sync
nsx-edge>
Mode
Basic
Availability
Autonomous Edge, Edge
Stop the specified service.
| Option | Description |
|---|---|
| <service-name> | Node service argument |
Example
nsx> stop service snmp
nsx> stop service druid force
nsx>
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Stop the nsx-lastline-rapid service.
Example
nsx> stop service nsx-lastline-rapid
nsx>
Mode
Basic
Availability
Stop the Security Hub service.
Example
nsx> stop service security-hub
nsx>
Mode
Basic
Availability
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.
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | Hostname or IPv4 or IPv6 address of an NSX Manager and optional port |
| <username> | Manager API username |
| <thumbprint> | Manager API thumbprint |
Example
host-1> sync aph-certificate 192.168.110.105 username admin thumbprint 898b75618e3e56615d53f987a720ff22b6381f4b85bec1eb973214ff7361f8b8
Password for API user:
APH certificates are synced from management plane successfully
Mode
Basic
Availability
Edge, ESXi, KVM
Move to the top of the path. The arrow moves to show which interface is current.
Example
nsx-edge-1(path)> top
->interface : ee749ae4-93cc-418d-b5f5-e94ad4723862 : loopback + SR-ContainerT1
interface : a19e4784-92dc-4731-bbf7-11985d348c34 : uplink + ContainerT0-ContainerT1-t1_lrp
port : 617770c9-ec83-4229-98e1-41ff66068ecf : vni:65537 + ContainerT0-ContainerT1-t1_lrp
port : 683f7226-6711-4d6f-80c4-0a1fe6412745 : vni:65537 + ContainerT0-ContainerT1-t0_lrp
interface : c4adf8c5-edec-448f-a45a-2b7113e8704f : downlink + ContainerT0-ContainerT1-t0_lrp
interface : 64b419b5-4f55-4e75-9b1e-d00f3a56b5e2 : uplink + tier0-interface200
port : 6858f1bc-7965-45e8-bc47-60f9a0101d57 : vlan:untagged + tier0-interface200
Mode
Path
Availability
Autonomous Edge, Edge
Trace the specified packet.
| Option | Description |
|---|---|
| <port-uuid-name> | Datapath String argument |
| <base64-string> | Datapath Base64 Encoded String argument (max packet size 1000 bytes) |
Example
nsx-edge-1> traceflow fp-eth1 AQAMzMzNaO+9TphYADKqqgMAAAwBCwAAAAAAgG5o771OmEAAAAAAgG5o771OmECAGQAAFAACAA8AAAAAAAIAbg==
Packet Trace Results
EVENT : physical_received
PACKET_BASE64 : AQAMzMzNaO+9TphYADKqqgMAAAwBCwAAAAAAgG5o771OmEAAAAAAgG5o771OmECAGQAAFAACAA8AAAAAAAIAbg==
PACKET_HEADER : 68:ef:bd:4e:98:58 > 01:00:0c:cc:cc:cd, 802.3, length 64: LLC, dsap SNAP (0xaa) Individual, ssap SNAP (0xaa) Command, ctrl 0x03: oui Cisco (0x00000c), pid PVST (0x010b): STP 802.1d, Config, Flags [none], bridge-id 806e.68:ef:bd:4e:98:40.8019, length 42
PARENT_UUID : 3284f707-98f9-4e7c-b573-f7898dfa12ba
TIMESTAMP : 2018-06-14 21:40:54.830903
TRACE_UUID : 09c4513c-9c8e-11e6-b333-005056a94529
TYPE : physical_node
EVENT : logical_forwarded
PACKET_BASE64 : AQAMzMzNaO+9TphYADKqqgMAAAwBCwAAAAAAgG5o771OmEAAAAAAgG5o771OmECAGQAAFAACAA8AAAAAAAIAbg==
PACKET_HEADER : 68:ef:bd:4e:98:58 > 01:00:0c:cc:cc:cd, 802.3, length 64: LLC, dsap SNAP (0xaa) Individual, ssap SNAP (0xaa) Command, ctrl 0x03: oui Cisco (0x00000c), pid PVST (0x010b): STP 802.1d, Config, Flags [none], bridge-id 806e.68:ef:bd:4e:98:40.8019, length 42
PARENT_UUID : 6e8ad2e8-15eb-553a-ae2e-e3a6bcd890cc
TIMESTAMP : 2018-06-14 21:40:54.883850
TRACE_UUID : 09c4513c-9c8e-11e6-b333-005056a94529
TYPE : logical_switch_port
UUID : 6fea361f-cf04-5391-bac1-281119bce14d
EVENT : logical_received
PACKET_BASE64 : AQAMzMzNaO+9TphYADKqqgMAAAwBCwAAAAAAgG5o771OmEAAAAAAgG5o771OmECAGQAAFAACAA8AAAAAAAIAbg==
PACKET_HEADER : 68:ef:bd:4e:98:58 > 01:00:0c:cc:cc:cd, 802.3, length 64: LLC, dsap SNAP (0xaa) Individual, ssap SNAP (0xaa) Command, ctrl 0x03: oui Cisco (0x00000c), pid PVST (0x010b): STP 802.1d, Config, Flags [none], bridge-id 806e.68:ef:bd:4e:98:40.8019, length 42
PARENT_UUID : 736a80e3-23f6-5a2d-81d6-bbefb2786666
TIMESTAMP : 2018-06-14 21:40:54.936503
TRACE_UUID : 09c4513c-9c8e-11e6-b333-005056a94529
TYPE : logical_router_port
UUID : c96c41bc-f689-5e28-9b04-d614a746fa1a
EVENT : logical_dropped
PACKET_BASE64 : AQAMzMzNaO+9TphYADKqqgMAAAwBCwAAAAAAgG5o771OmEAAAAAAgG5o771OmECAGQAAFAACAA8AAAAAAAIAbg==
PACKET_HEADER : 68:ef:bd:4e:98:58 > 01:00:0c:cc:cc:cd, 802.3, length 64: LLC, dsap SNAP (0xaa) Individual, ssap SNAP (0xaa) Command, ctrl 0x03: oui Cisco (0x00000c), pid PVST (0x010b): STP 802.1d, Config, Flags [none], bridge-id 806e.68:ef:bd:4e:98:40.8019, length 42
PARENT_UUID : 736a80e3-23f6-5a2d-81d6-bbefb2786666
TIMESTAMP : 2018-06-14 21:40:54.989125
TRACE_UUID : 09c4513c-9c8e-11e6-b333-005056a94529
TYPE : logical_router_port
Mode
Basic
Availability
Autonomous Edge, Edge
Trace the route to the specified IPv4 address or host.
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
Example
nsx-manager-1> traceroute 10.192.43.71
traceroute to 10.192.43.71 (10.192.43.71), 30 hops max, 60 byte packets
1 10.160.127.251 (10.160.127.251) 0.824 ms 2.589 ms 1.529 ms
2 10.250.228.1 (10.250.228.1) 2.570 ms 10.250.228.9 (10.250.228.9) 1.992 ms 1.116 ms
3 10.250.22.25 (10.250.22.25) 1.647 ms 10.250.22.85 (10.250.22.85) 2.487 ms 10.250.22.25 (10.250.22.25) 1.529 ms
4 10.250.22.186 (10.250.22.186) 2.464 ms 1.903 ms 2.425 ms
5 10.250.23.26 (10.250.23.26) 1.553 ms 1.676 ms 2.504 ms
6 10.250.232.34 (10.250.232.34) 2.355 ms 10.250.232.42 (10.250.232.42) 1.229 ms 10.250.232.38 (10.250.232.38) 1.379 ms
7 10.192.43.71 (10.192.43.71) 1.398 ms 1.689 ms 1.619 ms
Mode
Basic
Availability
Global Manager, Manager, NSX on VMC
Trace the route to the specified IPv4 address or host.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Example
nsx-edge> traceroute 10.192.43.71
traceroute to 10.192.43.71 (10.192.43.71), 30 hops max, 60 byte packets
1 10.160.127.251 (10.160.127.251) 0.824 ms 2.589 ms 1.529 ms
2 10.250.228.1 (10.250.228.1) 2.570 ms 10.250.228.9 (10.250.228.9) 1.992 ms 1.116 ms
3 10.250.22.25 (10.250.22.25) 1.647 ms 10.250.22.85 (10.250.22.85) 2.487 ms 10.250.22.25 (10.250.22.25) 1.529 ms
4 10.250.22.186 (10.250.22.186) 2.464 ms 1.903 ms 2.425 ms
5 10.250.23.26 (10.250.23.26) 1.553 ms 1.676 ms 2.504 ms
6 10.250.232.34 (10.250.232.34) 2.355 ms 10.250.232.42 (10.250.232.42) 1.229 ms 10.250.232.38 (10.250.232.38) 1.379 ms
7 10.192.43.71 (10.192.43.71) 1.398 ms 1.689 ms 1.619 ms
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
Example
nsx-edge-1(tier0_sr)> traceroute 172.16.110.11 source 192.168.130.3
edge-tracert to 172.16.110.11 (172.16.110.11) from VRF 3, 64 hops max, 52 byte packets
1 100.64.1.1 (100.64.1.1) 0.656 ms 0.354 ms 0.353 ms
2 172.16.110.11 (172.16.110.11) 28.142 ms 4.427 ms 2.765 ms
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
Example
nsx-edge-1> traceroute 172.16.110.11 source 192.168.130.3 vrfid 3
edge-tracert to 172.16.110.11 (172.16.110.11) from VRF 3, 64 hops max, 52 byte packets
1 100.64.1.1 (100.64.1.1) 0.560 ms 0.261 ms 0.366 ms
2 172.16.110.11 (172.16.110.11) 3.544 ms 5.696 ms 3.928 ms
Mode
Basic
Availability
Autonomous Edge, Edge
Trace the route to target IPv6 address.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
Example
nsxedge-ob-9722447-1-ipv6test> traceroute6 2005::2828:280a vrfid 1 maxttl 10
traceroute6 to 2005::2828:280a (2005::2828:280a), 10 hops max, 12 byte packets
1 * * *
2 * * *
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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.| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
Mode
Basic
Availability
Autonomous Edge, Edge
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.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
Mode
Basic
Availability
Autonomous Edge, Edge
Move up the path. The arrow moves to show which interface is current.
Example
nsx-edge-1(path)> get path
interface : 08a9e0e2-27c0-4676-892b-bcc88ae28ce7 : backplane + bp-sr0-port
interface : ca237e2a-27f6-4f68-98df-8e55b0bb36e7 : uplink + ContainerT0-domain-c9:aa317e48-b458-4b0f-acf6-197ff61aa550-t1_lrp
port : c00823ee-2c85-476b-b657-ffc64afbb2e8 : vni:65540 + ContainerT0-domain-c9:aa317e48-b458-4b0f-acf6-197ff61aa550-t1_lrp
->port : 7685f62d-9f55-4c4c-8726-f26c0de75e09 : vni:65540 + ContainerT0-domain-c9:aa317e48-b458-4b0f-acf6-197ff61aa550-t0_lrp
interface : af9f8664-cd47-48c0-ad27-b03a009911ff : downlink + ContainerT0-domain-c9:aa317e48-b458-4b0f-acf6-197ff61aa550-t0_lrp
interface : 64b419b5-4f55-4e75-9b1e-d00f3a56b5e2 : uplink + tier0-interface200
port : 6858f1bc-7965-45e8-bc47-60f9a0101d57 : vlan:untagged + tier0-interface200
nsx-edge-1(path)> up
interface : 08a9e0e2-27c0-4676-892b-bcc88ae28ce7 : backplane + bp-sr0-port
interface : ca237e2a-27f6-4f68-98df-8e55b0bb36e7 : uplink + ContainerT0-domain-c9:aa317e48-b458-4b0f-acf6-197ff61aa550-t1_lrp
->port : c00823ee-2c85-476b-b657-ffc64afbb2e8 : vni:65540 + ContainerT0-domain-c9:aa317e48-b458-4b0f-acf6-197ff61aa550-t1_lrp
port : 7685f62d-9f55-4c4c-8726-f26c0de75e09 : vni:65540 + ContainerT0-domain-c9:aa317e48-b458-4b0f-acf6-197ff61aa550-t0_lrp
interface : af9f8664-cd47-48c0-ad27-b03a009911ff : downlink + ContainerT0-domain-c9:aa317e48-b458-4b0f-acf6-197ff61aa550-t0_lrp
interface : 64b419b5-4f55-4e75-9b1e-d00f3a56b5e2 : uplink + tier0-interface200
port : 6858f1bc-7965-45e8-bc47-60f9a0101d57 : vlan:untagged + tier0-interface200
Mode
Path
Availability
Autonomous Edge, Edge
VDS Migrate Apply Topology
Example
nsx-manager-1> vds-migrate apply-topology
Apply topology successfully.
Mode
Basic
Availability
Manager
VDS Migrate delete Topology
Example
nsx-manager-1> vds-migrate delete-topology
Delete topology successfully.
Mode
Basic
Availability
Manager
VDS Migrate Disable
Example
nsx-manager-1> vds-migrate disable-migrate
Migrate disabled successfully.
Mode
Basic
Availability
Manager
Migrate NVDS to VDS By Cluster Id
| Option | Description |
|---|---|
| <cluster-id> | ESXi Cluster ID |
| <timeout> | Timeout for ESX enter maintenance mode in minutes. Allowed pattern: ^([0-9]+)$ |
Example
nsx-manager-1> vds-migrate esxi-cluster-id 233f96f5-2244-4a8f-8a59-80e6cf88562f:domain-c9 maintenance-timeout 15
VDS Migration Done:
3 Transport-Nodes Migrate Successfully
0 Transport-Nodes Migrate Failed
More info see /var/log/nsx-cli/nsxcli.log
Mode
Basic
Availability
Manager
Migrate NVDS to VDS By Cluster Name
| Option | Description |
|---|---|
| <cluster-name> | ESXi Cluster Name |
| <timeout> | Timeout for ESX enter maintenance mode in minutes. Allowed pattern: ^([0-9]+)$ |
Example
nsx-manager-1> vds-migrate esxi-cluster-name os-compute-cluster-1 maintenance-timeout 15
VDS Migration Done:
3 Transport-Nodes Migrate Successfully
0 Transport-Nodes Migrate Failed
More info see /var/log/nsx-cli/nsxcli.log
Mode
Basic
Availability
Manager
VDS Migrate Precheck
Example
nsx-manager-1> vds-migrate precheck
Precheck Id: 0a26d126-7116-11e5-9d70-feff819cdc9f
Mode
Basic
Availability
Manager
VDS Migrate Show Topology
Example
nsx-manager-1> vds-migrate show-topology
Precheck Id: 137d2a87-0544-4914-829d-d8b7e33b13f2
NVDS: nvds1(19cca902-9455-4316-92e2-65f4f5b4b138)
Compute Manager Topology:
[
{
"compute_manager_id": "fd37ed6e-0eae-4d65-b29a-d40eee1d5d47",
"dvswitch": [
{
"transport_node_id": [
"4d011ade-a010-4eea-b45a-b2569c0bb9ad"
],
"data_center_id": "datacenter-3",
"vmknic": [],
"vds_name": "CVDS-nvds1-datacenter-3"
}
]
}
]
Mode
Basic
Availability
Manager
Migrate NVDS to VDS By Tn List
| Option | Description |
|---|---|
| <configfile> | Transport node list file |
| <timeout> | Timeout for ESX enter maintenance mode in minutes. Allowed pattern: ^([0-9]+)$ |
Example
nsx-manager-1> vds-migrate tn-list /opt/tnid maintenance-timeout 15
VDS Migration Done:
3 Transport-Nodes Migrate Successfully
0 Transport-Nodes Migrate Failed
More info see /var/log/nsx-cli/nsxcli.log
Mode
Basic
Availability
Manager
Verify controllers certificate from configuration file in the host.
Example
nsx> verify controllers certificate
Controller IP Port CRL Status Certificate Status
10.168.196.243 1235 CERTIFICATE_NOT_REVOKED Certificate Verified
10.168.196.75 1235 CERTIFICATE_NOT_REVOKED HOST_REJECTED_CONTROLLER_CERT
10.168.195.11 1235 CERTIFICATE_NOT_REVOKED CONTROLLER_REJECTED_HOST_CERT
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Verify NSX Edge service container image file.
| Option | Description |
|---|---|
| <image-filename> | Edge service container image filename |
Example
nsx-edge> verify image VMware-nsx-edge-mdproxy-2.5.0.0.0.22302541.pub
Image verified successfully
Mode
Basic
Availability
Autonomous Edge, Edge
Verify iptables rules for all logging servers and update if needed
Example
nsx> verify logging-servers
Logging servers verified
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
Verify managers certificate from configuration file in the host.
Example
nsx-controller1> verify managers certificate
Manager IP Port CRL Status Certificate Status
10.168.195.11 1234 CERTIFICATE_REVOKED Certificate Verified
10.168.196.243 1234 CERTIFICATE_REVOKED MANAGER_REJECTED_HOST_CERT
10.168.196.75 1234 CERTIFICATE_REVOKED HOST_REJECTED_MANAGER_CERT
Mode
Basic
Availability
Autonomous Edge, Edge, ESXi, KVM
Verify and extract the specified upgrade bundle to the default location.
| Option | Description |
|---|---|
| <bundle-name> | Name of NSX upgrade bundle in the file store |
Example
nsx-edge-1> verify upgrade-bundle VMware-NSX-edge-2.0.0.0.0.5298714
Checking upgrade bundle /var/vmware/nsx/file-store/VMware-NSX-edge-2.0.0.0.0.5298714.nub contents
Verifying bundle VMware-NSX-edge-2.0.0.0.0.5298714.bundle with signature VMware-NSX-edge-2.0.0.0.0.5298714.bundle.sig
Moving bundle to /image/VMware-NSX-edge-2.0.0.0.0.5298714.bundle
Extracting bundle payload
Successfully verified upgrade bundle
Bundle manifest:
appliance_type: 'nsx-edge'
version: '2.0.0.0.0.5298714'
os_image_path: 'files/nsx-root.fsa'
Current upgrade info:
{
"info": "",
"body": {
"meta": {
"from_version": "1.1.0.0.0.5214485",
"old_config_dev": "/dev/mapper/nsx-config",
"to_version": "2.0.0.0.0.5298714",
"new_config_dev": "/dev/mapper/nsx-config__bak",
"old_os_dev": "/dev/sda2",
"bundle_path": "/image/VMware-NSX-edge-2.0.0.0.0.5298714",
"new_os_dev": "/dev/sda3"
},
"history": []
},
"state": 1,
"state_text": "CMD_SUCCESS"
}
Mode
Basic
Availability
Autonomous Edge, Edge, Global Manager, Manager, NSX on VMC
This command enters VRF context mode. You can find VRF IDs with the
get logical-routers command.| Option | Description |
|---|---|
| <uuid-vrfid> | Datapath UUID or VRF ID argument |
Example
nsx-edge-1> vrf 3
nsx-edge-1(tier0_sr[3])>
or
nsx-edge-1> vrf 19772688-b220-4a34-94a3-8a094dcdd979
nsx-edge-1(tier0_sr[3])>
Mode
Basic, VRF, Tier0_sr, Tier1_sr
Availability
Autonomous Edge, Edge