Associated Commands:

CLI Description Command

Move to the bottom of the path

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

bottom

Clear security banner or message of the day

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

clear banner

Clear a BFD session stats

Clear the statistics for the specified BFD session

clear bfd-session local-ip <ip46-address> remote-ip <ip46-address> stats

Clear BFD sessions stats

Clear the statistics for all BFD sessions.

clear bfd-sessions stats

Reset specific BGP neighbor session

Reset specific BGP neighbor session.

clear bgp <ip46-address>

Reset all BGP neighbor sessions

Reset all BGP neighbor sessions.

clear bgp neighbors

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

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

clear bootup error message

Reset flow cache stats for all fastpath cores

Clear flow cache statistics for all fastpath cores.

clear dataplane flow-cache stats

Clear Edge Cluster state history

Clear the Edge cluster state history.

clear edge-cluster history state

Clear the gateway high availability state history

Clear the high availability state history for the specified gateway. Only service gateways have a high availability status. Use the get gateway command to get a list of gateways and their types.

clear gateway <nsxa-uuid-service-router-arg> high-availability history state

Clear the gateway high availability state history

Clear the high availability state history for the gateway in the VRF context.

clear gateway high-availability history state

Clear the stats of a specific gateway interface

Clear the statistic counters for the specified gateway interface.

clear gateway interface <dpd-uuid-lrouter-port-arg> stats

Clear stats for a high-availability channel

Clear statistics for the specified high-availability channel

clear high-availability channel local-ip <ip-address> remote-ip <ip-address> stats

Clear stats for high-availability channels

Clear statistics for all high-availability channels.

clear high-availability channels stats

Clear the logical router high availability state history

Clear the high availability state history for the logical router in the VRF context.

clear high-availability history state

Clear stats for a high-availability session

Clear statistics for the specified high-availability session

clear high-availability session local-service-id <service-id-arg> peer-service-id <service-id-arg> stats

Clear stats for high-availability sessions

Clear statistics for all high-availability sessions.

clear high-availability sessions stats

Delete VLAN and/or bond network interface

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

clear interface <configurable-interface-name>

Remove network IP configuration from the interface

Remove all network configuration from the specified interface.

clear interface <configurable-interface-name> ip

Clear the interface plane

Clear the network interface plane configuration.

clear interface <configurable-interface-name> plane

Deletes LLDP Neighbor information on all devices

Deletes LLDP Neighbor information on all devices.

clear lldp neighbors

Deletes LLDP Neighbor information on given device

Deletes LLDP Neighbor information on given device.

clear lldp neighbors <lldp-interface-name>

Deletes LLDP Statistics on all devices

Deletes LLDP Statistics on all devices.

clear lldp stats

Deletes LLDP Statistics on given device

Deletes LLDP Statistics on given device.

clear lldp stats <lldp-interface-name>

Clear statistics of a specified pool

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

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

Clear statistics of all pools

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

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

Clear load balancer statistics

Clear the statistics for a specific load balancer.

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

Clear statistics of a specified virtual server

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

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

Clear statistics of all virtual servers

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

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

Clear load balancer performance profile settings

Clear load balancer performance profile parameter settings from edge.

clear load-balancer perf-profile

Clear all configured logging-servers

Clear all logging server configuration.

clear logging-servers

Clear the logical router high availability state history

Clear the high availability state history for the specified logical router. Only service routers have a high availability status. Use the get logical-routers command to get a list of logical routers and their router types.

clear logical-router <nsxa-uuid-service-router-arg> high-availability history state

Clear the stats of a specific logical router interface

Clear the statistic counters for the specified logical router interface.

clear logical-router interface <dpd-uuid-lrouter-port-arg> stats

Clear all name servers

Clear all name servers from the DNS configuration.

clear name-servers

Reset specific OSPF neighbor session

Reset specific OSPF neighbor session.

clear ospf <ip-address>

Reset all OSPF neighbor sessions

Reset all OSPF neighbor sessions.

clear ospf neighbors

Resets configured password complexity requirements to default

Resets configured password complexity requirements to default.

clear password-complexity

Clear physical port stats by name

Clear statistics for the specified physical port.

clear physical-port <dpd-name-physical-port-arg> stats

Clear all PIM BSM data & messages

Clear all PIM BSM data & messages.

clear pim bsr-data

Clear search domains

Remove all domain names from the DNS search list.

clear search-domains

Clear NTP service start on boot

Configure the NTP service to not start on boot.

clear service ntp start-on-boot

Clear snmp service start on boot

Configure the snmp service to not start on boot.

clear service snmp start-on-boot

Clear SSH service start on boot

Configure the SSH service to not start on boot.

clear service ssh start-on-boot

Clear SSH Root login property

Disable SSH Root login property

clear ssh root-login

Disable password expiration for the user

Disable password expiration for the user.

clear user <node-all-username> password-expiration

Disable password expiration warning for the user

Disable password expiration warning for the user.

clear user <node-all-username> password-expiration-warning

Copy core dumps to remote file

Copy system generated core dumps to a remote destination.

copy core-dump <core-dump-file-arg> url <scp-file-url-arg>

Copy a local file to remote file

Copy a local file to a remote destination.

copy file <existing-file-arg> url <scp-file-url-arg>

Copy a remote file to the local file store

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

copy url <url> [file <filename>]

Copy a remote https url file with same filename

Copy a remote https url file to local file using same filename.

copy url <url> thumbprint <thumbprint> [file <filename>]

Delete a configured packet capture session

Delete a packet capture session configuration.

del capture session <dpd-number-session-id-arg>

Delete packet capture session

Delete a packet capture session configuration.

del capture session <dpd-number-session-id-arg>

Delete an interface from a packet capture session

Delete the specified interface from a packet capture session configuration. If you are only monitoring one interface, this deletes the monitoring session configuration.

del capture session <dpd-number-session-id-arg> interface <dpd-uuid-name-port-arg>

Delete core dump files in the system

Delete core dump files in the system.

del core-dump [all|<core-dump-file-arg>]

Delete local file

Delete a local file.

del file <existing-file-or-pattern-arg>

Delete NSX Edge service container image

Delete NSX Edge service container image. Only images that are not in use can be deleted.

del image <configurable-image-name> version <configurable-image-version>

Delete logging-server

Delete the specified logging server configuration. You can use the get logging-servers command to display the current logging server configuration.

del logging-server <hostname-or-ip-address[:port]> proto <proto> level <level> [facility <facility>] [messageid <messageid>] [structured-data <structured-data>]

Delete name server

Delete the specified name server from the DNS configuration.

del name-server <name-server-arg>

Remove NTP server

Remove an existing NTP server.

del ntp-server <hostname-or-ip-address>

Delete IPv4 network route

Delete the specified network IPv4 network route.

del route prefix <prefix> [gateway <gateway-ip>] [interface <interface-name>] [metric <ip-route-metric>]

Delete a domain name

Delete the specified domain name from the DNS search list.

del search-domains <search-domain-arg>

Delete SNMP v2 Trap Targets

Delete SNMP v2 Trap Targets.

del snmp v2-targets <hostname-or-ip-address-optional-port-arg>

Delete SNMP v3 Trap Targets

Delete SNMP v3 Trap Targets.

del snmp v3-targets <hostname-or-ip-address-optional-port-arg>

Delete SNMP v3 Users

Delete SNMP v3 Users.

del snmp v3-users <user-id-arg>

Delete SSH service known host

Delete the specified host entry from the SSH known hosts file.

del ssh-known-host <hostname-or-ip-address-optional-port-arg>

Delete existing local users.

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

Note: Deleted users cannot be created again.

del user <username>

Delete SSH service keys from authorized_keys file for specified user

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

del user <username> ssh-keys label <key-label> [password <password>]

Move down the path

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

down

Exit the CLI

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

exit

Show system arp cache

Display the ARP table.

get arp-table

Get CLI account lockout period

Get the amount of time, in seconds, that an account will remain locked out of the CLI after exceeding the maximum number of failed authentication attempts.

get auth-policy cli lockout-period

Get CLI maximum authentication faliures

Get the number of failed CLI authentication attempts that are allowed before the account is locked. If set to 0, account lockout is disabled.

get auth-policy cli max-auth-failures

Get minimum allowable password length

Get the minimum number of characters that passwords must have.

get auth-policy minimum-password-length

Display logical router BFD config

Display parameters defined in global logical router BFD

get bfd-config

Display info for a BFD session

Display information about the specified BFD session.

get bfd-session local-ip <ip46-address> remote-ip <ip46-address>

Display stats for a BFD session

Display statistics for the specified BFD session.

get bfd-session local-ip <ip46-address> remote-ip <ip46-address> stats

Display info about BFD sessions

Display information about BFD sessions.

get bfd-sessions

Display logical router BFD sessions

Display BFD sessions in a logical router

get bfd-sessions [stats]

Display BFD sessions stats

Display the BFD sessions statistics.

get bfd-sessions stats

Display all IPv4 & IPv6 BGP routes

Display all IPv4 & IPv6 BGP routes.

get bgp

Display detailed information about BGP IPv4 route

Display detailed information about BGP IPv4 route.

get bgp <network-address>

Display detailed information about BGP IPv6 route

Display detailed information about BGP IPv6 route.

get bgp <network6-address>

Display all BGP NLRI matching the community.

get bgp community { NO_EXPORT | NO_ADVERTISE | NO_EXPORT_SUBCONFED | AA:NN }

Display all IPv4 BGP routes

Display all IPv4 BGP routes.

get bgp ipv4

Display all IPv6 BGP routes

Display all IPv6 BGP routes.

get bgp ipv6

Display all BGP NLRI matching the large-community.

get bgp large-community <bgp-large-community-arg>

Display all BGP neighbor information

Display all BGP neighbor information.

get bgp neighbor

Display information about a specific BGP neighbor

Display information about a specifie BGP neighbor.

get bgp neighbor <ip-address>

Display routes advertised to a BGP neighbor

Display routes advertised to a BGP neighbor.

get bgp neighbor <ip-address> advertised-routes

Display routes learnt from a BGP neighbor

Display routes learnt from a BGP neighbor.

get bgp neighbor <ip-address> routes

Display summarized BGP neighbor information

Display summarized BGP neighbor information.

get bgp neighbor summary

Display summarized BGP neighbor information for a given address-family

Display summarized BGP neighbor information for a given address-family.

get bgp neighbor summary <address-family>

Get bond interface stats

Display the bond interface with the specified name. Specify the stats argument to display the statistics for the interface.

get bond <bond name> [stats]

Get bond interface stats

Display all bond interfaces. Specify the stats argument to display the statistics for the interfaces.

get bonds [stats]

Show all bridge ports configuration and state

Show all bridge ports configuration and state.

get bridge

Show bridge port configuration and state

Show bridge port configuration and state.

get bridge <dpd-uuid-lswitch-port-arg>

Display high-availability history of bridge port

Display high-availability history of bridge port.

get bridge <dpd-uuid-lswitch-port-arg> high-availability-history

Display mac-sync table on a bridge port

Display Mac Sync table on an bridge port.

get bridge <dpd-uuid-lswitch-port-arg> mac-sync-table

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

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

get bridge logical-switch <dpd-uuid-lswitch-arg>

Display mac-sync table on bridge ports

Display mac-sync table on bridge ports.

get bridge mac-sync-table

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

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

get bridge name <bridge-lswitch-name-arg>

Display summary of bridge ports

Display summary of bridge ports.

get bridge summary

Show bridge ports configuration and state with specified vlan

Show bridge ports configuration and state with specified vlan.

get bridge vlan <vlan-id-arg>

Display a packet capture session

Display information about the specified packet capture session.

get capture session <dpd-number-session-id-arg>

Display packet capture sessions

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

get capture sessions

Display API server certificate

Display the API server's certificate.

get certificate api

Display API server certificate thumbprint

Display the API server's certificate thumbprint.

get certificate api thumbprint

Show status to display datetime stamp

Show status to display datetime stamp in command output.

get cli-output datetime

Show inactivity timeout

Show inactivity timeout in seconds.

get cli-timeout

Display system clock

Display the current date and time.

get clock

Display commands history

Display the commands history in command output.
To show all command history set size to 0.

Note:Outputs command history from version 3.2.0 and above.

get command history

Show system configuration

Display configuration settings in command line syntax.

get configuration

Display controller connection

Display the controllers connected to this node.

get controllers

Get core dump config

Get core dump generation and rotation configurations

get core-dump config

List core dump files in the system

Display information about the core dump files in the system.

get core-dumps

Show the system CPU status

Display the system CPU information.

get cpu-stats

Display the current port or interface

Display information about the current interface.

get current

Get dataplane configurations

Display Data Plane Development Kit (DPDK) configurations, which include fastpath cores, hugepage reserved, NUMA, physical port bindings, etc.

get dataplane

Get the cpu stats for dataplane

Display data plane cpu statistics.

get dataplane cpu stats

Get the list of supported devices on the system

Get the list of supported devices on the system.

get dataplane device list

Get flow cache configuration

Display the flow cache configurations.

get dataplane flow-cache config

Get flow cache stats for all fastpath cores

Display flow cache statistics for all fastpath cores.

get dataplane flow-cache stats

Get flow cache stats for cores selected in coremask

Display the flow cache statistics for the specified fastpath cores.

get dataplane flow-cache stats <lcore-list-all-arg>

Get geneve critical bit configuration

Display geneve critical bit configurations.

get dataplane geneve-cbit config

Get l2vpn pmtu message generation settings

Display l2vpn pmtu message generation settings.

get dataplane l2vpn-pmtu config

Get the memory stats for dataplane

Display data plane memory statistics.

get dataplane memory stats

Get dataplane perf stats

Display data plane performance statistics.

get dataplane perfstats <interval-arg>

Get dataplane pmtu learning settings

Display dataplane pmtu learning settings.

get dataplane pmtu-learning config

Get admin and operational state of QAT crypto acceleration

Get admin and operational state of QAT crypto acceleration.

get dataplane qat

Calculate all nics throughput given an interval

get dataplane throughput <time>

Show dhcp ip pool

Display a specific DHCP IP pool.

get dhcp ip-pool <uuid-string-arg>

Show all dhcp ip pool

Display all DHCP IP pools.

get dhcp ip-pools

Show dhcp ip pools matched server uuid

Display DHCP IP pools which matched a specific server UUID.

get dhcp ip-pools server-uuid <uuid-string-arg>

Show DHCPv6 IP pool

Display a specific DHCPv6 IP pool.

get dhcp ipv6-ip-pool <uuid-string-arg>

Show all DHCPv6 IP pools

Display all DHCPv6 IP pools.

get dhcp ipv6-ip-pools

Show DHCPv6 IP pools matching server uuid

Display DHCPv6 IP pools which match a specific server UUID.

get dhcp ipv6-ip-pools server-uuid <uuid-string-arg>

Show all non-released DHCPv6 leases by search string

Display all non-released DHCPv6 leases by search string.

get dhcp ipv6-lease <string-arg>

Show all DHCPv6 leases by search string

Display all DHCPv6 leases(both released and non-released) by search string.

get dhcp ipv6-lease <string-arg> all

Show all non-released DHCPv6 leases

Display all non-released DHCPv6 leases.

get dhcp ipv6-leases

Show all DHCPv6 leases

Display all DHCPv6 leases.

get dhcp ipv6-leases all

Show DHCPv6 static binding

Display a specific DHCPv6 static binding.

get dhcp ipv6-static-binding <uuid-string-arg>

Show all DHCPv6 static bindings

Display all DHCPv6 static bindings.

get dhcp ipv6-static-bindings

Show DHCPv6 static bindings matching server uuid

Display DHCPv6 static bindings which match a specific server UUID.

get dhcp ipv6-static-bindings server-uuid <uuid-string-arg>

Show non-released DHCP lease

Display a specific DHCP lease. You can specify a DHCP server's UUID, or a MAC address, or an IP address.

get dhcp lease <string-arg>

Show DHCP lease

Display a specific DHCP lease. You can specify a DHCP server's UUID, or a MAC address, or an IP address.

get dhcp lease <string-arg> all

Show all non-released dhcp leases

Display all non-released DHCP leases.

get dhcp leases

Show all dhcp leases

Display all DHCP leases.

get dhcp leases all

Show logical dhcp server

Display a specific DHCP server. Optionally specify an argument to display only the status or the synchronization information.

get dhcp server <uuid> [status | sync]

Show all logical DHCP server

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

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

get dhcp servers [status | sync]

Show dhcp static binding

Display a specific DHCP static binding.

get dhcp static-binding <uuid-string-arg>

Show all dhcp static binding

Display all DHCP static bindings.

get dhcp static-bindings

Show dhcp static bindings matched server uuid

Display a specific DHCP static bindings which matched a specific server UUID.

get dhcp static-bindings server-uuid <uuid-string-arg>

Get edge config diagnosis

get diagnosis config

Get runtime federation health check report

get diagnosis health-check

Check for inconsistency

Check for any inconsistency on local edge

get diagnosis inconsistency

Get diagnosis analysis

get diagnosis log

Get number of diagnosis entries

get diagnosis log limit <log-num>

Get two number of diagnosis entries

get diagnosis log limit <log-num> context <context-line-num>

Get edge logical topology

Get logical topology on edge

get diagnosis topology

Display DNS Forwarder Cache Entries

Display the DNS Forwarder Cache Entries.

get dns-forwarder <uuid-string-arg> cache

Display DNS Forwarder Config

Display the DNS Forwarder Config.

get dns-forwarder <uuid-string-arg> config

Display DNS Forwarder Stats Entries

Display the DNS Forwarder Stats Entries.

get dns-forwarder <uuid-string-arg> stats

Display DNS Forwarder Status

get dns-forwarder <uuid-string-arg> status

Display DNS Forwarder Entries

Display the DNS Forwarder Entries.

get dns-forwarder <uuid-string-arg> table

Live debugging DNS Forwarder

Live debugging the DNS Forwarder

get dns-forwarder <uuid> live-debug [server-ip <ip-address>] [lookup <hostname-or-ip-address>]

Display DNS Forwarder Cache Entries Per SR

Display the DNS Forwarder Cache Entries Per SR.

get dns-forwarder cache

Live debugging DNS forwarder

Live debugging the DNS Forwarder

get dns-forwarder live-debug [server-ip <ip-address>] [lookup <hostname-or-ip-address>]

Display DNS Forwarder Stats Entries Per SR

Display the DNS Forwarder Stats Entries Per SR.

get dns-forwarder stats

Display DNS Forwarder Status Per SR

Display the DNS Forwarder Entries Per SR.

get dns-forwarder status

Display DNS Forwarder Entries Per SR

Display the DNS Forwarder Entries Per SR.

get dns-forwarder table

Display DNS Forwarders Config

Display the DNS Forwarders Config.

get dns-forwarders config

Display DNS Forwarders Status

Display DNS Forwarder Status

get dns-forwarders status

Get Edge Cluster state history

Display the Edge cluster state history.

get edge-cluster history state

Get Edge Cluster status

Display the Edge cluster status.

get edge-cluster status

List file in the filestore

Display information about the specified file in the filestore.

get file <existing-file-arg>

Display file thumbprint

Display the file thumbprint.

get file <existing-file-arg> thumbprint

List files in the filestore

Display information about the files in the filestore.

get files

Show the system storage capacity

Display the file system information.

get filesystem-stats

Display the specified firewall address set

Display the specified firewall address set for the logical router interface.

get firewall <dpd-uuid-firewall-port-arg> addrset name <string-arg>

Display all the firewall address sets

Display all the firewall address sets for the logical router interface.

get firewall <dpd-uuid-firewall-port-arg> addrset sets

Display the specified firewall attribute set

Display the specified firewall attribute set for the logical router interface.

get firewall <dpd-uuid-firewall-port-arg> attrset name <string-arg>

Display all the firewall attribute sets

Display all the firewall attribute sets for the logical router interface.

get firewall <dpd-uuid-firewall-port-arg> attrset sets

Display firewall connection information

Display the firewall connections on the specified logical router interface.

get firewall <dpd-uuid-firewall-port-arg> connection

Display firewall connection count

Display the firewall connection count.

get firewall <dpd-uuid-firewall-port-arg> connection count

Display firewall connection information

Display the firewall connections on the specified logical router interface.

get firewall <dpd-uuid-firewall-port-arg> connection raw

Display firewall connection state

Display the state of the firewall connections.

get firewall <dpd-uuid-firewall-port-arg> connection state

Display firewall interface statistics

Display firewall interface statistics for the specified logical router interface.

get firewall <dpd-uuid-firewall-port-arg> interface stats

Display firewall active/standby configuration

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

get firewall <dpd-uuid-firewall-port-arg> sync config

Display firewall synchronization statistics

Display the firewall synchronization statistics.

get firewall <dpd-uuid-firewall-port-arg> sync stats

Display the fixed timeouts for connection events

Display the fixed timeouts for connection events.

get firewall <dpd-uuid-firewall-port-arg> timeouts

Display specific firewall L7 profile info on given Logical Router UUID

Display specific firewall L7 profile information on given Logical Router UUID.

get firewall <dpd-uuid-lrouter-port-arg> l7-profile <uuid-string-arg>

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

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

get firewall <dpd-uuid-lrouter-port-arg> l7-profile <uuid-string-arg> stats

Display all firewall L7 profiles info on given Logical Router UUID

Display all firewall L7 profiles information on given Logical Router UUID.

get firewall <dpd-uuid-lrouter-port-arg> l7-profiles

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

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

get firewall <dpd-uuid-lrouter-port-arg> l7-profiles stats

Display IKE policy

Display IKE policy for the specified logical router interface.

get firewall <uuid> ike policy [<rule-id>]

Display firewall rules

Display firewall rules with expanded address sets for the specified logical router interface.

get firewall <uuid> ruleset [type <rule-type>] rules [<ruleset-detail>]

Display firewall rule statistics

Display firewall rule statistics for the specified logical router interface.

get firewall <uuid> ruleset [type <rule-type>] stats

Display firewall interfaces

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

get firewall [logical-switch <uuid>] interfaces

Display firewall connection state

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

get firewall connection state

Display firewall interface statistics

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

get firewall interface stats

Display firewall interfaces

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

get firewall interfaces

Display firewall sync interfaces

Display sync configuration for logical router interfaces with firewall rules.

get firewall interfaces sync

Display specific firewall L7 profile info based on UUID

Display specific firewall L7 profile information based on UUID.

get firewall l7-profile <uuid-string-arg>

Display specific firewall L7 profile entry stats based on UUID

Display specific firewall L7 profile entry stats information based on UUID.

get firewall l7-profile <uuid-string-arg> stats

Display all firewall L7 profiles info

Display all firewall L7 profiles information.

get firewall l7-profiles

Display all firewall L7 profile entry stats

Display all firewall L7 profile entry stats information.

get firewall l7-profiles stats

Display firewall active/standby configuration

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

get firewall sync config

Display firewall synchronization statistics

Display the firewall synchronization statistics in the VRF context.

get firewall sync stats

Display the MAC table or IP FIB

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

get forwarding

Display the forwarding table

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

get forwarding [<prefix>]

Display a gateway

Display information about the specified gateway.

get gateway <dpd-uuid-lrouter-arg>

Display gateway BFD config

Display parameters defined in global gateway BFD

get gateway <dpd-uuid-lrouter-arg> bfd-config

Display IgmpSnooping Table of the Gateway

Display information about IGMP reports snooped in the Gateway

get gateway <dpd-uuid-lrouter-arg> igmp-snooping-table

Display IgmpSnooping Table of the Gateway

Display information about IGMP reports snooped in the Gateway filtered by multicast group

get gateway <dpd-uuid-lrouter-arg> igmp-snooping-table <ip-address>

Display a gateway's interfaces

Display interface information for the specified gateway.

get gateway <dpd-uuid-lrouter-arg> interfaces

Display the interface stats for a gateway

Display the interface statistics for the specified gateway.

get gateway <dpd-uuid-lrouter-arg> interfaces stats

Display the gateway multicast forwarding table

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

get gateway <dpd-uuid-lrouter-arg> mfib

Display multicast forwarding entries matching a multicast group

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

get gateway <dpd-uuid-lrouter-arg> mfib <ip-address>

Display the gateway's neighbor table

Display the neighbor table for the specified gateway.

get gateway <dpd-uuid-lrouter-arg> neighbors

Display neighbors and stats for a gateway

Display the neighbor table and statistics for the specified gateway.

get gateway <dpd-uuid-lrouter-arg> neighbors stats

Display QoS config for a gateway

Display QoS config for the specified gateway.

get gateway <dpd-uuid-lrouter-arg> qos-config

Display stats for a gateway

Display statistics for the specified gateway.

get gateway <dpd-uuid-lrouter-arg> stats

Display gateway high availability state history

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

get gateway <nsxa-uuid-service-router-arg> high-availability history state

Display gateway high availability state history

get gateway <nsxa-uuid-service-router-arg> high-availability history state details

Display the gateway high availability status

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

get gateway <nsxa-uuid-service-router-arg> high-availability status

Display gateway BFD sessions

Display BFD sessions in a gateway

get gateway <uuid> bfd-sessions [stats]

Display the gateway forwarding table

Display the forwarding table for the specified gateway. Optionally specify a prefix to display only the entry that matches that network.

get gateway <uuid> forwarding [<prefix>]

Display gateway BFD config

Display parameters defined in global gateway BFD

get gateway bfd-config

Display gateway BFD sessions

Display BFD sessions in a gateway

get gateway bfd-sessions [stats]

Display the forwarding table

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

get gateway forwarding [<prefix>]

Display the gateway high availability state history

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

get gateway high-availability history state

Display the gateway high availability status

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

get gateway high-availability status

Display interface info for a gateway

Display interface information for the specified gateway.

get gateway interface <dpd-uuid-lrouter-port-arg>

Display ARP proxy table for a gateway port

Display ARP proxy for a gateway port.

get gateway interface <dpd-uuid-lrouter-port-arg> arp-proxy

Display interface-group info for gateway interface

get gateway interface <dpd-uuid-lrouter-port-arg> interface-groups high-availability

Display the neighbor table of the gateway interface

Display the neighbor table for the specified gateway interface.

get gateway interface <dpd-uuid-lrouter-port-arg> neighbors

Display shadow port mac list for gateway port

get gateway interface <dpd-uuid-lrouter-port-arg> shadow-macs

Get the shadow port MAC address selected for specific IP address

get gateway interface <dpd-uuid-lrouter-port-arg> shadow-macs ip <ip46-address>

Display the gateway interface stats

Display statistics for the specified gateway interface.

get gateway interface <dpd-uuid-lrouter-port-arg> stats

Display a gateway's interfaces

Display interface information for the gateway in the VRF context.

get gateway interfaces

Display the gateway ports

Display information for all gateway interfaces.

get gateway interfaces

Display the gateway interface stats

Display statistics for all gateway interfaces.

get gateway interfaces stats

Display the interface statistics of the gateway

Display the interface statistics for the gateway in the VRF context.

get gateway interfaces stats

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

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

get gateway mfib

Display multicast forwarding entries matching a multicast group in VRF

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

get gateway mfib <ip-address>

Display the neighbors table

Display the neighbors table for all gateway interfaces.

get gateway neighbors

Display the gateway's neighbor table

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

get gateway neighbors

Display the gateway statistics

Display statistics for the gateway in the VRF context.

get gateway stats

Display gateways

Display information about all gateways.

get gateways

Display gateways and stats

Display statistics for all gateways.

get gateways stats

Display GRUB menu timeout

Display GRUB menu timeout.

get grub menu timeout

Display info for a high-availability channel

Display information about the specified high-availability channel.

get high-availability channel local-ip <ip-address> remote-ip <ip-address>

Display stats for a high-availability channel

Display statistics for the specified high-availability channel.

get high-availability channel local-ip <ip-address> remote-ip <ip-address> stats

Display info about high-availability channels

Display information about high-availability channels.

get high-availability channels

Display high-availability channel stats

Display statistics for the high-availability channels.

get high-availability channels stats

Display the logical router high availability state history

Display the high availability state history for the logical router in the VRF context.

get high-availability history state

Display the logical router high availability state history

Display the high availability state history for the logical router in the VRF context.

get high-availability history state details

Display info for a high-availability session

Display information about the specified high-availability session.

get high-availability session local-service-id <service-id-arg> peer-service-id <service-id-arg>

Display stats for a high-availability session

Display statistics for the specified high-availability session.

get high-availability session local-service-id <service-id-arg> peer-service-id <service-id-arg> stats

Display info about high-availability sessions

Display information about high-availability sessions.

get high-availability sessions

Display info about high-availability sessions of specified channel

Display information about high-availability sessions by remote-ip of the channel

get high-availability sessions remote-ip <ip-address>

Display info about high-availability sessions of specified service-type

Display information about high-availability sessions by service-type.

get high-availability sessions service-type <service-type-arg>

Display info about high-availability sessions of specified service-type and channel

Display information about high-availability sessions by service-type and remote-ip of the channel

get high-availability sessions service-type <service-type-arg> remote-ip <ip-address>

Display stats for high-availability sessions of specified service-type

Display statistics for the high-availability sessions of specified service-type.

get high-availability sessions service-type <service-type-arg> stats

Display high-availability sessions that have completed synchronization

Displays any high-availability sessions of a given type who have completed synchronization with peer

get high-availability sessions service-type <service-type-arg> sync complete

Display high-availability sessions whose synchronization is ongoing

Displays any high-availability sessions of a given type who have not yet completed synchronization with peer

get high-availability sessions service-type <service-type-arg> sync in-progress

Display high availability session synchronization status summary

Display the synchronization status of high-availability sessions of a given type on current node

get high-availability sessions service-type <service-type-arg> sync summary

Display stats for high-availability sessions

Display statistics for the high-availability sessions.

get high-availability sessions stats

Display the logical router high availability status

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

get high-availability status

Display VLAN table for the host switch

Display VLAN table for the host switch.

get host-switch vlan-table

Display host switches

Display information about all host switches.

get host-switches

Display system hostname

Display the system hostname.

get hostname

Get hugepage info of the system

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

get hugepage

Display IgmpSnooping Table

Display information about all IGMP reports snooped in the LR

get igmp-snooping-table

Display IgmpSnooping Table

Display information about all IGMP reports snooped by the Edge

get igmp-snooping-table

Display IgmpSnooping Table

Display information about all IGMP reports snooped in the LR

get igmp-snooping-table <multicast-ip-address>

Display IgmpSnooping Stats

Display statistics about IGMP reports snooped by the Edge

get igmp-snooping-table stats

List all container images for given service

List all container images for given service.

get image <configurable-image-name>

List install history of container images for given service

List install history of container images for given service.

get image <configurable-image-name> install history

List all service container images

List all service container images.

get images

List install history for all service container images

List install history for all service container images.

get images install history

Display network interface properties

Display information about the specified network interface.

get interface <edge-view-interface-name>

Display the logical router interface-groups high availability status

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

get interface-groups high-availability

Display all network interface properties

Display information about all network interfaces.

get interfaces

Display a logical router's interfaces

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

get interfaces

Display the interface statistics of the logical router

Display the interface statistics for the logical router in the VRF context.

get interfaces stats

Display full information from CA Certificate

Display full information from a specific CA Certificate

get ipsecvpn ca-certificate <uuid-string-arg>

Display Subject Name from CA Certificates

Display Subject Name from all CA Certificates.

get ipsecvpn ca-certificates

Display full information from CA Certificates

Display full information from all CA Certificates.

get ipsecvpn ca-certificates verbose

Display complete information from Certificates

Display complete information from a specific Certifiate.

get ipsecvpn certificate <uuid-string-arg>

Display Subject Name from Certificates

Display Subject Names from all Certificates.

get ipsecvpn certificates

Display complete information from Certificates

Display complete information from all Certificates.

get ipsecvpn certificates verbose

Display all configured Dead Peer Detection profiles

Display all configured Dead Peer Detection profiles.

get ipsecvpn config dpd-profile

Display configured Dead Peer Detection profile

Display configured Dead Peer Detection profile.

get ipsecvpn config dpd-profile <uuid-string-arg>

Display all configured IKE profiles

Display all configured IKE profiles.

get ipsecvpn config ike-profile

Display configured IKE profile

Display configured IKE profile.

get ipsecvpn config ike-profile <uuid-string-arg>

Display all configured IPSec local endpoint profiles

Display all configured IPSec local endpoint profiles.

get ipsecvpn config local-endpoint

Display configured IPSec local endpoint profile

Display configured IPSec local endpoint profile.

get ipsecvpn config local-endpoint <uuid-string-arg>

Display CA-Certificates configured for IPsec Local Endpoint

Display all CA-Certificates for a specific IPsec Local Endpoint.

get ipsecvpn config local-endpoint <uuid-string-arg> ca-certificates

Display Certificate configured for IPsec Local Endpoint

Display Certificate for a specific IPsec Local Endpoint.

get ipsecvpn config local-endpoint <uuid-string-arg> certificate

Display CRL configured for IPsec Local Endpoint

Display all CRLs for a specific IPsec Local Endpoint.

get ipsecvpn config local-endpoint <uuid-string-arg> crls

Display all configured MultiPath Groups

Display all configured MultiPath Groups.

get ipsecvpn config multi-path-group

Display configured MultiPath Group

Display configured MultiPath Group.

get ipsecvpn config multi-path-group <uuid-string-arg>

Display all configured IPSec peer endpoint profiles

Display all configured IPSec peer endpoint profiles.

get ipsecvpn config peer-endpoint

Display configured IPSec peer endpoint profile

Display configured IPSec peer endpoint profile.

get ipsecvpn config peer-endpoint <uuid-string-arg>

Display IPSec Service configuration from NestDB

Display IPSec Servicce configuration from NestDB.

get ipsecvpn config service

Display all configured IPSec VPN sessions

Display all configured IPSec VPN sessions.

get ipsecvpn config session

Display a configured IPSec VPN session

Display a configured IPSec VPN session.

get ipsecvpn config session <uuid-string-arg>

Display a configured IPSec VPN session with specific endpoints

Display a configured IPSec VPN session with specific endpoints.

get ipsecvpn config session local-ip <ip46-address> remote-ip <ip46-address>

Display all configured IPSec tunnel profiles

Display all configured IPsec tunnel profiles.

get ipsecvpn config tunnel-profile

Display configured IPSec tunnel profile

Display configured IPSec tunnel profile.

get ipsecvpn config tunnel-profile <uuid-string-arg>

Display complete information from CRL certificate

Display complete information from a specific CRL certificate.

get ipsecvpn crl <uuid-string-arg>

Display Issuer Name from CRL Certificates

Display Issuer Name from all CRL certificates.

get ipsecvpn crls

Display complete information from CRL certificates

Display complete information from all CRL certificates.

get ipsecvpn crls verbose

Display all IKE SAs

Display all IKE SAs.

get ipsecvpn ikesa

Display all IKE security associations in active state

Display all IKE security associations in active state.

get ipsecvpn ikesa active

Display all IKE security associations in active state

Display all IKE security associations in active state.

get ipsecvpn ikesa active logical-router <uuid-string-arg>

Display IKE security association in active state on given Logical Router

Display IKE security association in active state on given Logical Router.

get ipsecvpn ikesa active logical-router <uuid-string-arg> sessionid <ipsec-vpn-session-id-arg>

Display IKE security association in active state

Display IKE security association in active state.

get ipsecvpn ikesa active sessionid <ipsec-vpn-session-id-arg>

Display all IKE SAs on given Logical Router

Display all IKE SAs on given Logical Router.

get ipsecvpn ikesa logical-router <uuid-string-arg>

Display an IKE SA on given Logical Router

Display an IKE SA on given Logical Router.

get ipsecvpn ikesa logical-router <uuid-string-arg> sessionid <ipsec-vpn-session-id-arg>

Display all IKE security associations in negotiating state

Display all IKE security associations in negotiating state.

get ipsecvpn ikesa negotiating

Display all IKE security associations in negotiating state

Display all IKE security associations in negotiating state.

get ipsecvpn ikesa negotiating logical-router <uuid-string-arg>

Display IKE security association in negotiating state

Display IKE security association in negotiating state.

get ipsecvpn ikesa negotiating logical-router <uuid-string-arg> sessionid <ipsec-vpn-session-id-arg>

Display IKE security association in negotiating state

Display IKE security association in negotiating state.

get ipsecvpn ikesa negotiating sessionid <ipsec-vpn-session-id-arg>

Display IKE SA with specific session id

Display an IKE SA.

get ipsecvpn ikesa sessionid <ipsec-vpn-session-id-arg>

Display all IPSec SAs from control plane

Display all IPSec SAs from control plane.

get ipsecvpn ipsecsa

Display all IPSec SAs from control plane on a LogicalRouter

Display all IPSec SAs from control plane.

get ipsecvpn ipsecsa logical-router <uuid-string-arg>

Display IPSec SA with specific rule id from control plane

Display IPSec SA with specific rule id from control plane.

get ipsecvpn ipsecsa logical-router <uuid-string-arg> ruleid <ipsec-vpn-rule-id-arg>

Display an IPSec SA with specific session id from control plane

Display an IPSec SA with specific session id from control plane.

get ipsecvpn ipsecsa logical-router <uuid-string-arg> sessionid <ipsec-vpn-session-id-arg>

Display IPSec SA with specific rule id from control plane

Display IPSec SA with specific rule id from control plane.

get ipsecvpn ipsecsa ruleid <ipsec-vpn-rule-id-arg>

Display an IPSec SA with specific session id from control plane

Display an IPSec SA with specific session id from control plane.

get ipsecvpn ipsecsa sessionid <ipsec-vpn-session-id-arg>

Display all active MultiPath Groups information

Display all active MultiPath Groups information.

get ipsecvpn multi-path-group

Display active MultiPath Group information

Display active MultiPath Group information.

get ipsecvpn multi-path-group <uuid-string-arg>

Display active MultiPath tunnels probe history information

Display active MultiPath tunnels probe history information.

get ipsecvpn multi-path-group <uuid-string-arg> probe history

Display active MultiPath group probe statistics

Display active MultiPath group probe statistics.

get ipsecvpn multi-path-group <uuid-string-arg> probe stats

Display active MultiPath Group verbose information

Display active MultiPath Group verbose information.

get ipsecvpn multi-path-group <uuid-string-arg> verbose

Display all active MultiPath tunnels probe history information

Display all active MultiPath tunnels probe history information.

get ipsecvpn multi-path-group probe history

Display all active MultiPath group probe statistics

Display all active MultiPath group probe statistics.

get ipsecvpn multi-path-group probe stats

Display all active MultiPath Groups verbose information

Display all active MultiPath Groups verbose information.

get ipsecvpn multi-path-group verbose

Display all IPSec VPN policy rules

Display all IPSec VPN policy rules.

get ipsecvpn policy

Display all IPSec VPN policy rules for a LogicalRouter

Display all IPSec VPN policy rules for a LogicalRouter.

get ipsecvpn policy logical-router <uuid-string-arg>

Display an IPSec policy rule for a LogicalRouter

Display an IPSec policy rule for a LogicalRouter.

get ipsecvpn policy logical-router <uuid-string-arg> rules <uuid-string-arg>

Display an IPSec policy rule

Display an IPSec policy rule.

get ipsecvpn policy rules <uuid-string-arg>

Display summary of IPSec VPN policy rules

Display summary of IPSec VPN policy rules.

get ipsecvpn policy summary

Display summary of IPSec VPN policy rules per logical router

get ipsecvpn policy summary logical-router <uuid-string-arg>

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

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

get ipsecvpn sad

Display IPSec SA present in Security Association Database(datapath)

Display IPSec SA present in Security Association Database(datapath).

get ipsecvpn sad <uuid-string-arg>

Display IPSec SA present in Security Association Database(datapath)

Display IPSec SA present in Security Association Database(datapath).

get ipsecvpn sad logical-router <uuid-string-arg>

Display IPSec SA present in Security Association Database(datapath)

Display IPSec SA present in Security Association Database(datapath).

get ipsecvpn sad session <uuid-string-arg>

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

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

get ipsecvpn sad summary

Display all IPSec Services

Display all IPSec Services Information.

get ipsecvpn service

Display IPSec Service

Display IPSec Service Information.

get ipsecvpn service <uuid-string-arg>

Display detail information of a IPSec Service

Display all IPSec Service Information in detail.

get ipsecvpn service <uuid-string-arg> verbose

Display detail information of all IPSec Services

Display IPSec Service Information in detail.

get ipsecvpn service verbose

Display all IPSec VPN sessions

Display all IPSec VPN sessions.

get ipsecvpn session

Display specific IPSec VPN session

Display specific IPSec VPN session.

get ipsecvpn session <uuid-string-arg>

Display specific IPSec VPN session history

Display IPsec VPN session history using session uuid as the filter

get ipsecvpn session <uuid-string-arg> history

Display all IPSec VPN sessions in active state

Display all IPSec VPN sessions in active state.

get ipsecvpn session active

Display an IPSec VPN session in active state

Display an IPSec VPN session in active state.

get ipsecvpn session active <uuid-string-arg>

Display IPSec VPN session in active state for specific endpoints

Display IPSec VPN session in active state for specific endpoints.

get ipsecvpn session active local-ip <ip46-address> remote-ip <ip46-address>

Display an IPSec VPN session in active state

Display an IPSec VPN session in active state.

get ipsecvpn session active sessionid <ipsec-vpn-session-id-arg>

Display all IPsec VPN sessions in down state

Display all IPsec VPN sessions in down state.

get ipsecvpn session down

Display an IPsec VPN session in down state

Display an IPsec VPN session in down state.

get ipsecvpn session down <uuid-string-arg>

Display IPsec VPN session in down state for specific endpoints

Display IPsec VPN session in down state for specific endpoints.

get ipsecvpn session down local-ip <ip46-address> remote-ip <ip46-address>

Display an IPsec VPN session in down state

Display an IPsec VPN session in down state.

get ipsecvpn session down sessionid <ipsec-vpn-session-id-arg>

Display all IPsec VPN sessions history

Display all IPsec VPN sessions history.

get ipsecvpn session history

Display IPSec VPN session for specific endpoints

Display IPSec VPN session for specific endpoints.

get ipsecvpn session local-ip <ip46-address> remote-ip <ip46-address>

Display IPSec VPN session history for specific endpoints

Display IPSec VPN session history for specific endpoints.

get ipsecvpn session local-ip <ip46-address> remote-ip <ip46-address> history

Display all IPSec VPN sessions of Logical Router

Display all IPSec VPN sessions of Logical Router.

get ipsecvpn session logical-router <uuid-string-arg>

Display specific IPSec VPN session of Logical Router

Display specific IPSec VPN session of Logical Router.

get ipsecvpn session logical-router <uuid-string-arg> <uuid-string-arg>

Display an IPsec VPN session in negotiating state of Logical Router

Display an IPsec VPN session in negotiating state of Logical Router.

get ipsecvpn session logical-router <uuid-string-arg> <uuid-string-arg> negotiating

Display all IPSec VPN sessions in active state of Logical Router

Display all IPSec VPN sessions in active state of Logical Router.

get ipsecvpn session logical-router <uuid-string-arg> active

Display an IPSec VPN session in active state of Logical Router

Display an IPSec VPN session in active state of Logical Router.

get ipsecvpn session logical-router <uuid-string-arg> active <uuid-string-arg>

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

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

get ipsecvpn session logical-router <uuid-string-arg> active local-ip <ip46-address> remote-ip <ip46-address>

Display an IPSec VPN session in active state of Logical Router

Display an IPSec VPN session in active state of Logical Router.

get ipsecvpn session logical-router <uuid-string-arg> active sessionid <ipsec-vpn-session-id-arg>

Display all IPsec VPN sessions in down state of Logical Router

Display all IPsec VPN sessions in down state of Logical Router.

get ipsecvpn session logical-router <uuid-string-arg> down

Display an IPsec VPN session in down state of Logical Router

Display an IPsec VPN session in down state of Logical Router.

get ipsecvpn session logical-router <uuid-string-arg> down <uuid-string-arg>

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

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

get ipsecvpn session logical-router <uuid-string-arg> down local-ip <ip46-address> remote-ip <ip46-address>

Display an IPsec VPN session in down state of Logical Router

Display an IPsec VPN session in down state of Logical Router.

get ipsecvpn session logical-router <uuid-string-arg> down sessionid <ipsec-vpn-session-id-arg>

Display IPSec VPN session history for a Logical Router

Display IPSec VPN session history for a Logical Router.

get ipsecvpn session logical-router <uuid-string-arg> history

Display IPSec VPN session for specific endpoints on Logical Router

Display IPSec VPN session for specific endpoints on Logical Router.

get ipsecvpn session logical-router <uuid-string-arg> local-ip <ip46-address> remote-ip <ip46-address>

Display IPSec VPN session history for specific endpoints on Logical Router

Display IPSec VPN session history for specific endpoints on Logical Router.

get ipsecvpn session logical-router <uuid-string-arg> local-ip <ip46-address> remote-ip <ip46-address> history

Display all IPsec VPN sessions in negotiating state of Logical Router

Display all IPsec VPN sessions in negotiating state of Logical Router.

get ipsecvpn session logical-router <uuid-string-arg> negotiating

Display IPsec VPN session in negotiating state for specific endpoints

Display IPsec VPN session in negotiating state for specific endpoints.

get ipsecvpn session logical-router <uuid-string-arg> negotiating local-ip <ip46-address> remote-ip <ip46-address>

Display all IPSec VPN sessions of Logical Router

Display all IPSec VPN sessions of Logical Router.

get ipsecvpn session logical-router <uuid-string-arg> sessionid <ipsec-vpn-session-id-arg>

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

get ipsecvpn session logical-router <uuid-string-arg> sessionid <ipsec-vpn-session-id-arg> history

Display IPSec VPN session status for a LogicalRouter

Display IPSec VPN session status for a Logical Router.

get ipsecvpn session logical-router <uuid-string-arg> status

Display summary of all IPSec VPN sessions for a Logical Router

Display summary of all IPSec VPN sessions for a Logical Router.

get ipsecvpn session logical-router <uuid-string-arg> summary

Display all IPsec VPN sessions in negotiating state

Display all IPsec VPN sessions in negotiating state.

get ipsecvpn session negotiating

Display an IPsec VPN session in negotiating state

Display an IPsec VPN session in negotiating state.

get ipsecvpn session negotiating <uuid-string-arg>

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

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

get ipsecvpn session negotiating local-ip <ip46-address> remote-ip <ip46-address>

Display an IPsec VPN session in negotiating state of Logical Router

Display an IPsec VPN session in negotiating state of Logical Router.

get ipsecvpn session negotiating logical-router <uuid-string-arg> sessionid <ipsec-vpn-session-id-arg>

Display an IPsec VPN session in negotiating state

Display an IPsec VPN session in negotiating state.

get ipsecvpn session negotiating sessionid <ipsec-vpn-session-id-arg>

Display all IPSec VPN sessions

Display all IPSec VPN sessions.

get ipsecvpn session sessionid <ipsec-vpn-session-id-arg>

Display IPsec VPN sessions history for specific session

Display IPsec VPN session history with sessionid as the filter

get ipsecvpn session sessionid <ipsec-vpn-session-id-arg> history

Display IPSec VPN session status

Display IPSec VPN session status.

get ipsecvpn session status

Display summary of all IPSec VPN sessions

Display summary of all IPSec VPN sessions.

get ipsecvpn session summary

Display all IPSec VPN synced sessions

Display all IPSec VPN synced sessions.

get ipsecvpn sync-session

Display specific IPSec VPN synced session

Display specific IPSec VPN synced session.

get ipsecvpn sync-session session-uuid <uuid-string-arg>

Display IPSec tunnel statistics and multipath statistics

Display IPSec SA tunnel statistics and multipath statistics.

get ipsecvpn tunnel multipath stats

Display IPSec tunnel statistics and multipath statistics.

get ipsecvpn tunnel multipath stats <uuid-string-arg>

Display all IPSec SA tunnel statistics

Display all IPSec SA tunnel statistics.

get ipsecvpn tunnel stats

Display IPSec SA tunnel statistics

Display IPSec SA tunnel statistics.

get ipsecvpn tunnel stats <ipsec-vpn-keypolicy-id-arg>

Display all IPSec VPN VTI Rules

Displays all IPSec VPN VTI Rules.

get ipsecvpn vti rules

Display an IPSec VPN VTI rule

Display an IPSec VPN VTI rule.

get ipsecvpn vti rules <uuid-string-arg>

Show L2VPN sessions configuration for a given L2VPN service

Display L2VPN sessions configuration for a given L2VPN service.

get l2vpn service <uuid-string-arg> sessions config

Show all L2VPN services configuration

Display all L2VPN services configuration.

get l2vpn services config

Display stretched logical switch behind L2VPN session

Display stretched logical switch behind L2VPN session.

get l2vpn session <dpd-uuid-l2vpn-session-arg> logical-switch <dpd-uuid-lswitch-arg>

Display remote macs learnt on L2VPN stretched logical-switch

Display remote macs learnt on L2VPN stretched logical-switch.

get l2vpn session <dpd-uuid-l2vpn-session-arg> logical-switch <dpd-uuid-lswitch-arg> remote-macs

Display stats for stretched logical-switch behind L2VPN session

Display stats for stretched logical-switch behind L2VPN session.

get l2vpn session <dpd-uuid-l2vpn-session-arg> logical-switch <dpd-uuid-lswitch-arg> stats

Display stretched logical switches behind given L2VPN session

Display stretched logical switches behind given L2VPN session.

get l2vpn session <dpd-uuid-l2vpn-session-arg> logical-switches

Display stats for specific L2VPN session

Display stats for L2VPN session

get l2vpn session <dpd-uuid-l2vpn-session-arg> stats

Display status of specific L2VPN session

Display status of specific L2VPN session.

get l2vpn session <dpd-uuid-l2vpn-session-arg> status

Display all L2VPN sessions

Display all L2VPN sessions information.

get l2vpn sessions

Show all L2VPN sessions configuration

Display all L2VPN sessions configuration.

get l2vpn sessions config

Display all L2VPN sessions on a logical-router

Display all L2VPN sessions information on a logical-router.

get l2vpn sessions logical-router <uuid-string-arg>

Display L2VPN sessions stats

get l2vpn sessions stats

Display LLDP configuration on all devices

Display LLDP configuration on all devices.

get lldp config

Displays LLDP Configuration on given device

Displays LLDP configuration given device.

get lldp config <lldp-interface-name>

Display LLDP Neighbor information on all devices

Display LLDP Neighbor information on all devices.

get lldp neighbors

Displays LLDP Neighbor information on given device

Displays LLDP Neighbor information on given device.

get lldp neighbors <lldp-interface-name>

Displays LLDP Statistics on all devices

Displays LLDP Statistics on all devices.

get lldp stats

Displays LLDP Statistics on given device

Displays LLDP Statistics on given device.

get lldp stats <lldp-interface-name>

Show load balancer

Display a specific load balancer.

get load-balancer <lb-uuid-arg>

Show load balancer diagnosis information

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

Show the error log for the specified load balancer

Display the error log file for a specific load balancer.

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

Follow the error log for the specified load balancer

Display the last 10 lines of the error log file for a specific load balancer and all new messages that are written to the log file.

get load-balancer <lb-uuid-arg> error-log follow

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

Display error log messages containing strings that match the given regular expression pattern for a specific load balancer.

get load-balancer <lb-uuid-arg> error-log reg-filter <regex>

Show health check table of a specific load balancer

Display the health check table of a specific load balancer.

get load-balancer <lb-uuid-arg> health-check-table

Show HA state of a specific load balancer

Display the HA state of a specific load balancer.

get load-balancer <lb-uuid-arg> high-availability-state

Show a load balancer monitor

Display a specific load balancer monitor.

get load-balancer <lb-uuid-arg> monitor <monitor-uuid-arg>

Show a load balancer monitor status.

Show the health check table of a load balancer monitor.

get load-balancer <lb-uuid-arg> monitor <monitor-uuid-arg> status

Show load balancer monitors

Display the monitors for a specific load balancer.

get load-balancer <lb-uuid-arg> monitors

Show persistence tables of a specific load balancer

Display the persistence tables of a specific load balancer.

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

Show a load balancer pool

Display a specific load balancer pool.

get load-balancer <lb-uuid-arg> pool <pool-uuid-arg>

Display information about an LB pool

Display information about an LB pool.

get load-balancer <lb-uuid-arg> pool <pool-uuid-arg> snat-pools

Show statistics of the specified load balancer and pool

Display the statistics for a specific load balancer and pool.

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

Show status for the given pool

Display the status of a specific load balancer and pool.

get load-balancer <lb-uuid-arg> pool <pool-uuid-arg> status

Show load balancer pools

Display the pools of a specific load balancer.

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

Show statistics of all pools of the specified load balancer

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

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

Show status for all pools of the given load balancer

Display the status of all the pools of a specific load balancer.

get load-balancer <lb-uuid-arg> pools status

Show sessions of a specific load balancer

Display the sessions of a specific load balancer.

get load-balancer <lb-uuid-arg> session-tables

Get load balancer L4 session table

Get the load balancer L4 session table with the expiration time.

get load-balancer <lb-uuid-arg> session-tables l4

Get load balancer L7 session table

Get the load balancer L7 session table with the expiration time.

get load-balancer <lb-uuid-arg> session-tables l7

Get LB pool information, especially port usage

Get load-balancer snat pools' information.

get load-balancer <lb-uuid-arg> snat-pools

Show statistics for the specified load balancer

Display the statistics for a specific load balancer.

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

Show status for the specified load balancer

Display the status of a specific load balancer.

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

Show a load balancer virtual server

Display a specific load balancer virtual server.

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

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

Display the access log file for a specific load balancer and virtual server.

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

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

Display the last 10 lines of the access log file for a specific virtual server of load balancer and all new messages that are written to the log file.

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

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

Display access log messages containing strings that match the given regular expression pattern for a specific load balancer.

get load-balancer <lb-uuid-arg> virtual-server <vs-uuid-arg> access-log reg-filter <regex>

Show load balancer rules

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

get load-balancer <lb-uuid-arg> virtual-server <vs-uuid-arg> lbrules

Show statistics of the specified load balancer and virtual server

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

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

Show status for the given virtual server

Display the status of a specific load balancer virtual server.

get load-balancer <lb-uuid-arg> virtual-server <vs-uuid-arg> status

Show load balancer virtual servers

Display the virtual servers of a specific load balancer.

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

Show statistics of all virtual servers of the specified load balancer

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

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

Show status for all virtual servers of the given load balancer

Display the status of all virtual servers of a specific load balancer.

get load-balancer <lb-uuid-arg> virtual-servers status

Get load balancer performance config

Get edge parameters configured by load balancer for performance.

get load-balancer perf-profile config

Show all load balancers

Display all load balancers.

get load-balancers

Show status for all load balancers

Display the status of all load balancers.

get load-balancers status

Show log file contents

Display the contents of the specified log file.

get log-file <log-file-arg>

Show log file contents

Display the last 10 lines of the specified log file and all new messages that are written to the log file.

get log-file <log-file-arg> follow

Display all configured logging servers

Display logging server configuration.

get logging-servers

Display a logical router

Display information about the specified logical router.

get logical-router <dpd-uuid-lrouter-arg>

Display logical router BFD config

Display parameters defined in global logical router BFD

get logical-router <dpd-uuid-lrouter-arg> bfd-config

Display all IPv4 & IPv6 BGP routes

Display all IPv4 & IPv6 BGP routes.

get logical-router <dpd-uuid-lrouter-arg> bgp

Display all BGP NLRI matching the community.

get logical-router <dpd-uuid-lrouter-arg> bgp community <bgp-community-arg>

Display all BGP NLRI matching the large-community.

get logical-router <dpd-uuid-lrouter-arg> bgp large-community <bgp-large-community-arg>

Display all BGP neighbor information

Display all BGP neighbor information.

get logical-router <dpd-uuid-lrouter-arg> bgp neighbor

Display IgmpSnooping Table of the LR

Display information about IGMP reports snooped in the LR

get logical-router <dpd-uuid-lrouter-arg> igmp-snooping-table

Display IgmpSnooping Table of the LR

Display information about IGMP reports snooped in the LR filtered by multicast group

get logical-router <dpd-uuid-lrouter-arg> igmp-snooping-table <multicast-ip-address>

Display a logical router's interfaces

Display interface information for the specified logical router.

get logical-router <dpd-uuid-lrouter-arg> interfaces

Display the interface stats for a logical router

Display the interface statistics for the specified logical router.

get logical-router <dpd-uuid-lrouter-arg> interfaces stats

Display the logical router multicast forwarding table

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

get logical-router <dpd-uuid-lrouter-arg> mfib

Display multicast forwarding entries matching a multicast group

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

get logical-router <dpd-uuid-lrouter-arg> mfib <multicast-ip-address>

Display multicast load-balancing selection for a logical router

Display the multicast load-balancing selection for the specified logical router.

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

Display the logical router's neighbor table

Display the neighbor table for the specified logical router.

get logical-router <dpd-uuid-lrouter-arg> neighbor

Display neighbors and stats for a logical router

Display the neighbor table and statistics for the specified logical router.

get logical-router <dpd-uuid-lrouter-arg> neighbor stats

Display OSPF information

Display OSPF information.

get logical-router <dpd-uuid-lrouter-arg> ospf

Display OSPF database summary

Display OSPF database summary.

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

Display ASBR-Summary LSAs

Display ASBR-Summary LSAs.

get logical-router <dpd-uuid-lrouter-arg> ospf database asbr-summary

Display ASBR-Summary LSAs

Display ASBR-Summary LSAs.

get logical-router <dpd-uuid-lrouter-arg> ospf database asbr-summary <ip-address>

Display external LSAs

Display external LSAs.

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

Display external LSAs

Display external LSAs.

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

Display Network LSAs

Display Network LSAs.

get logical-router <dpd-uuid-lrouter-arg> ospf database network

Display Network LSAs

Display Network LSAs.

get logical-router <dpd-uuid-lrouter-arg> ospf database network <ip-address>

Display NSSA external LSAs

Display NSSA external LSAs.

get logical-router <dpd-uuid-lrouter-arg> ospf database nssa-external

Display NSSA external LSAs

Display NSSA external LSAs.

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

Display router LSAs

Display router LSAs.

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

Display router LSAs

Display router LSAs.

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

Display summary LSAs

Display summary LSAs.

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

Display summary LSAs

Display summary LSAs.

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

Display OSPF Graceful Restart information

Display OSPF Graceful Restart information.

get logical-router <dpd-uuid-lrouter-arg> ospf graceful-restart

Display OSPF interface information

Display OSPF interface information.

get logical-router <dpd-uuid-lrouter-arg> ospf interface

Display OSPF neighbor list

Display OSPF neighbor list.

get logical-router <dpd-uuid-lrouter-arg> ospf neighbor

Display OSPF routes

Display OSPF routes.

get logical-router <dpd-uuid-lrouter-arg> ospf route

Show external summary addresses

Show external summary addresses.

get logical-router <dpd-uuid-lrouter-arg> ospf summary-address

Display QoS config for a logical router

Display QoS config for the specified logical router.

get logical-router <dpd-uuid-lrouter-arg> qos-config

Display all OSPF routes in RIB

Display all OSPF routes in RIB.

get logical-router <dpd-uuid-lrouter-arg> route ospf

Display stats for a logical router

Display statistics for the specified logical router.

get logical-router <dpd-uuid-lrouter-arg> stats

Display logical router high availability state history

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

get logical-router <nsxa-uuid-service-router-arg> high-availability history state

Display logical router high availability state history

get logical-router <nsxa-uuid-service-router-arg> high-availability history state details

Display the logical router high availability status

Display the high availability status for the specified logical router. Only service routers have a high availability status. Use the get logical-routers command to get a list of logical routers and their router types.

get logical-router <nsxa-uuid-service-router-arg> high-availability status

Display logical router high availability status of interface-groups

Display the high availability status of interface-groups for the logical router

get logical-router <nsxa-uuid-service-router-arg> interface-groups high-availability

Display service groups of the service router

Display the service groups state for the service router

get logical-router <nsxa-uuid-service-router-arg> service-groups

Display service groups of the service router

Display the service groups state for the service router

get logical-router <nsxa-uuid-service-router-arg> service-groups details

Display logical router BFD sessions

Display BFD sessions in a logical router

get logical-router <uuid> bfd-sessions [stats]

Display information about a specific BGP neighbor

Display information about a specific BGP neighbor.

get logical-router <uuid> bgp neighbor <ip-address>

Display routes advertised to a BGP neighbor

Display routes advertised to a BGP neighbor.

get logical-router <uuid> bgp neighbor <ip-address> advertised-routes

Display routes learnt from a BGP neighbor

Display routes learnt from a BGP neighbor.

get logical-router <uuid> bgp neighbor <ip-address> routes

Display summarized BGP neighbor information

Display summarized BGP neighbor information.

get logical-router <uuid> bgp neighbor summary

Display summarized BGP neighbor information for a given address-family

Display summarized BGP neighbor information for a given address-family.

get logical-router <uuid> bgp neighbor summary <address-family>

Display the logical router forwarding table

Display the forwarding table for the specified logical router. Optionally specify a prefix to display only the entry that matches that network.

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

Display multicast routes

Display all the multicast learnt routes.

get logical-router <uuid> mroute <ip-address>

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

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

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

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

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

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

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

Display IPv4 BGP routes for a specified prefix in RIB

Display IPv4 BGP routes for a specified prefix in RIB.

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

Display IPv4 Connected routes for a specified prefix in RIB

Display IPv4 Connected routes for a specified prefix in RIB.

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

Display IPv4 OSPF routes for a specified prefix in RIB

Display IPv4 OSPF routes for a specified prefix in RIB.

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

Display the multicast HA role.

Display the multicast HA role. Active - Multicast is running in Active mode. Standby - Multicast is running in Standby mode. None - Multicast is not running.

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

Display IPv4 Static routes for a specified prefix in RIB

Display IPv4 Static routes for a specified prefix in RIB.

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

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

Display interface info for a logical router

Display interface information for the specified logical router.

get logical-router interface <dpd-uuid-lrouter-port-arg>

Display ARP proxy table for a logical router port

Display ARP proxy for a logical router port.

get logical-router interface <dpd-uuid-lrouter-port-arg> arp-proxy

Display interface-group info for logical router port

get logical-router interface <dpd-uuid-lrouter-port-arg> interface-groups high-availability

Display the neighbor table of the logical router interface

Display the neighbor table for the specified logical router interface.

get logical-router interface <dpd-uuid-lrouter-port-arg> neighbor

Display shadow port mac list for lrouter port

get logical-router interface <dpd-uuid-lrouter-port-arg> shadow-macs

Get the shadow port MAC address selected for specific IP address

get logical-router interface <dpd-uuid-lrouter-port-arg> shadow-macs ip <ip46-address>

Display the logical router interface stats

Display statistics for the specified logical router interface.

get logical-router interface <dpd-uuid-lrouter-port-arg> stats

Display the logical router ports

Display information for all logical router interfaces.

get logical-router interfaces

Display the logical router interface stats

Display statistics for all logical router interfaces.

get logical-router interfaces stats

Display the neighbor table

Display the neighbor table for all logical router interfaces.

get logical-router neighbor

Display logical routers

Display information about all logical routers.

get logical-routers

Display logical routers and stats

Display statistics for all logical routers.

get logical-routers stats

Show logical service binding

Display a specific logical service binding.

get logical-service binding <uuid-string-arg>

Show all logical service bindings

Display all logical service bindings.

get logical-service bindings

Display a specific logical service port

Display information for the specified logical service port. Optionally specify an argument to display the statistics.

get logical-service port <uuid> [stats]

Display the logical service ports

Display information for all logical service ports. Optionally specify an argument to display the statistics.

get logical-service ports [stats]

Show logical service state

Display the state of a specific logical service.

get logical-service state <uuid-string-arg>

Show all logical service states

Display the state of all logical services.

get logical-service states

Display logical switch information

Display information about the specified logical switch.

get logical-switch <dpd-uuid-lswitch-arg>

Display l2forwarder for a logical switch

Display the l2forwarder for the specified logical switch.

get logical-switch <dpd-uuid-lswitch-arg> l2forwarders

Display mac table for a logical switch

Display the mac address table for the specified logical switch.

get logical-switch <dpd-uuid-lswitch-arg> mac-address-table

Display mcast offload tunnel

Display mcast offload tunnel.

get logical-switch <dpd-uuid-lswitch-arg> mcast-offload-tunnel source <ip-address> group <multicast-ip-address>

Display neighbor(ARP/NDP) table for a logical switch

Display the ARP/NDP table for the specified logical switch.

get logical-switch <dpd-uuid-lswitch-arg> neighbor

Display ports on a logical switch

Display port information for the specified logical switch.

get logical-switch <dpd-uuid-lswitch-arg> ports

Display port statistics for a logical switch

Display port statistics for the specified logical switch.

get logical-switch <dpd-uuid-lswitch-arg> ports stats

Display remote rtep-group mac addresses for a logical switch

Display remote rtep-group mac addresses for a logical switch.

get logical-switch <dpd-uuid-lswitch-arg> rtep-group-mac-address-table

Display remote rtep-group mac addresses

Display remote rtep-group mac addresses.

get logical-switch <dpd-uuid-lswitch-arg> rtep-group-mac-address-table <rtep-group-id-arg>

Display remote rtep-groups for a logical switch

get logical-switch <dpd-uuid-lswitch-arg> rtep-groups

Display tunnel information for a logical switch

Display the tunnel information for the specified logical switch.

get logical-switch <dpd-uuid-lswitch-arg> tunnel-ports

Display VTEP table for a logical switch

Display the tunnel endpoint table for the specified logical switch.

get logical-switch <dpd-uuid-lswitch-arg> vtep-table

Display L2Forwarder high-availability history of a switch

get logical-switch <nsxa-uuid-lswitch-arg> l2forwarders high-availability history state

Display l2forwarder HA information of switch

Display l2forwarder configuration and HA information of switch

get logical-switch <nsxa-uuid-lswitch-arg> l2forwarders high-availability state

Display ports for a logical switch

Display port information for the specified logical switch.

get logical-switch port <dpd-uuid-lswitch-port-arg>

Display stats for a logical switch port

Display statistics for the specified logical switch port.

get logical-switch port <dpd-uuid-lswitch-port-arg> stats

Display logical switch ports

Display ports for all logical switches.

get logical-switch ports

Display ports stats for all logical switches

Display port statistics for all logical switches.

get logical-switch ports stats

Get logical switch local mac

Display a specific logical switch's local or remote MAC, ARP, or VTEP information.

get logical-switch {local | remote} {mac-cache | arp-cache | vtep-cache} <vni>

Display logical switches

Display information about all logical switches.

get logical-switches

Get maintenance mode

Get maintenance mode status.

get maintenance-mode

Show managers

Show the current list of configured managers.

get managers

Show logical mdproxy server

Display a specific metadata proxy server.

get mdproxy server <uuid-string-arg>

Show all logical mdproxy server

Display all metadata proxy servers.

get mdproxy servers

Show the system memory status

Display the system memory information.

get memory-stats

Display multicast forwarding table

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

get mfib

Display multicast forwarding entries matching a multicast group in VRF

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

get mfib <multicast-ip-address>

Display multicast routes

Display all the multicast learnt routes.

get mroute <ip-address>

Display load-balancing selection for multicast group in VRF

Display the load-balancing selection for a multicast group for the specified logical router in the VRF context.

get multicast load-balancing <multicast-ip-address>

Get all name servers

Get all name servers in the DNS configuration.

get name-servers

Show namespace config

Display a specific namespace config

get namespace status <string-arg>

Show all namespace configs

Display all namespace configs.

get namespaces status

Display the logical router's neighbor table

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

get neighbor

Show the system network statistics

Display the system network statistics.

get network-stats

Show NTP associations

Display the status of the NTP system. The delay, offset and dispersion values are in seconds.

get ntp-server associations

Show NTP servers

Display all NTP servers.

get ntp-servers

Display OSPF information

Display OSPF information.

get ospf

Display OSPF database summary

Display OSPF database summary.

get ospf database

Display ASBR-Summary LSAs

Display ASBR-Summary LSAs.

get ospf database asbr-summary

Display ASBR-Summary LSAs

Display ASBR-Summary LSAs.

get ospf database asbr-summary <ip-address>

Display external LSAs

Display external LSAs.

get ospf database external

Display external LSAs

Display external LSAs.

get ospf database external <ip-address>

Display Network LSAs

Display Network LSAs.

get ospf database network

Display Network LSAs

Display Network LSAs.

get ospf database network <ip-address>

Display NSSA external LSAs

Display NSSA external LSAs.

get ospf database nssa-external

Display NSSA external LSAs

Display NSSA external LSAs.

get ospf database nssa-external <ip-address>

Display router LSAs

Display router LSAs.

get ospf database router

Display router LSAs

Display router LSAs.

get ospf database router <ip-address>

Display summary LSAs

Display summary LSAs.

get ospf database summary

Display summary LSAs

Display summary LSAs.

get ospf database summary <ip-address>

Display OSPF Graceful Restart information

Display OSPF Graceful Restart information.

get ospf graceful-restart

Display OSPF interface information

Display OSPF interface information.

get ospf interface

Display OSPF neighbor list

Display OSPF neighbor list.

get ospf neighbor

Display OSPF routes

Display OSPF routes.

get ospf route

Show external summary addresses

Show external summary addresses.

get ospf summary-address

Display the parent of current port or interface

Display the parent of the current interface.

get parent

Get configured password complexity requirements

Get configured password complexity requirements.

get password-complexity

Display the path

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

get path

Show physical port by name

Display the specified physical port.

get physical-port <dpd-name-physical-port-arg>

Show physical port stats by name

Display statistics for the specified physical port.

get physical-port <dpd-name-physical-port-arg> stats

Show physical port verbose stats by name

Display verbose statistics for the specified physical port.

get physical-port <dpd-name-physical-port-arg> stats verbose

Show physical port xstats by name

Display x statistics for the specified physical port.

get physical-port <dpd-name-physical-port-arg> xstats

Show physical port

Display all physical ports.

get physical-ports

Display the state of BSM message processing.

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

get pim bsm state

Display logical objects related to the specified logical port

Display logical objects related to the specified logical port.

get port <uuid-string-arg> [api-args]

Display Ports

Display information about all ports.

get ports

Display system processes

Display a snapshot of the system processes.

get processes

Display process monitor

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

get processes monitor

Display info about redirection Policy

Display information about Redirection Policy

get redirection-policy

Display info about Redirection POlicy

Display information about Redirection Policy.

get redirection-policy <dpd-uuid-service-insertion-arg>

Display info about Redirection Policy BFD control status.

Display information about Redirection Policy BFD control status.

get redirection-policy bfd-ctrl

Display info about Redirection Policy flow programming table.

Display information about Redirection Policy flow programming table.

get redirection-policy flow-prog-table

Display info about Redirection Policy failed SPI.

Display information about Redirection Policy failed SPI.

get redirection-policy spi-fail-table

Display info about EW Redirection VRF to interface mapping.

Display information about EW Redirection VRF to interface mapping.

get redirection-policy vrf-to-intf

Display detailed information of an IPv6 route in RIB

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

get route [<prefix>]

Display detailed information of an IPv4 route in RIB

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

get route [<prefix>]

Display IPv4 BGP routes for a specified prefix in RIB

Display IPv4 BGP routes for a specified prefix in RIB.

get route bgp [<prefix>]

Display IPv4 Connected routes for a specified prefix in RIB

Display IPv4 Connected routes for a specified prefix in RIB.

get route connected [<prefix>]

Display all OSPF routes in RIB

Display all OSPF routes in RIB.

get route ospf

Display IPv4 OSPF routes for a specified prefix in RIB

Display IPv4 OSPF routes for a specified prefix in RIB.

get route ospf [<prefix>]

Display a specific IPv4 route or IPv6 routes for the prefix

Display the specified IPv4 route or IPv6 routes for the prefix.

get route prefix <cidr46-notation>

Display IPv4 Static routes for a specified prefix in RIB

Display IPv4 Static routes for a specified prefix in RIB.

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

get route static [<prefix>]

Display routes across Tier0 and all its associated VRFs

Display routes across Tier0 and all its associated VRFs.

get route vrf all <ip-version>

Display IPv4 routes

Display all configured IPv4 routes.

get routes

Display a routing domain

Display information about the specified routing domain.

get routing-domain <dpd-uuid-routing-domain-arg>

Display a routing domain mtep

Display mtep information about the specified routing domain.

get routing-domain <dpd-uuid-routing-domain-arg> mtep

Display routing domain

Display information about all routing domains.

get routing-domains

Display routing domain mtep

Display mtep information about all routing domains.

get routing-domains mtep

Display information of RTEP group

Display information about a RTEP group.

get rtep-group <rtep-group-id-arg>

Display RTEP group's stats

Display stats about a RTEP group.

get rtep-group <rtep-group-id-arg> stats

Display RTEP group information

Display information about all RTEP groups

get rtep-groups

Display RTEP groups' stats

Display stats about all RTEP groups.

get rtep-groups stats

Display RTEP information

Display information about all rtep tunnel endpoints.

get rteps

Get all search domains

Get all domain names in the DNS search list.

get search-domains

Display segment information

Display information about the specified segment.

get segment <dpd-uuid-lswitch-arg>

Display l2forwarder for a segment

Display the l2forwarder for the specified segment.

get segment <dpd-uuid-lswitch-arg> l2forwarders

Display mac table for a segment

Display the mac address table for the specified segment.

get segment <dpd-uuid-lswitch-arg> mac-address-table

Display neighbor(ARP/NDP) table for a segment

Display the ARP/NDP table for the specified segment.

get segment <dpd-uuid-lswitch-arg> neighbor

Display ports on a segment

Display port information for the specified segment.

get segment <dpd-uuid-lswitch-arg> ports

Display port statistics for a segment

Display port statistics for the specified segment.

get segment <dpd-uuid-lswitch-arg> ports stats

Display remote rtep-group mac addresses for a segment

Display remote rtep-group mac addresses for a segment.

get segment <dpd-uuid-lswitch-arg> rtep-group-mac-address-table

Display remote rtep-group mac addresses

Display remote rtep-group mac addresses.

get segment <dpd-uuid-lswitch-arg> rtep-group-mac-address-table <rtep-group-id-arg>

Display remote rtep-groups for a segment

get segment <dpd-uuid-lswitch-arg> rtep-groups

Display tunnel information for a segment

Display the tunnel information for the specified segment.

get segment <dpd-uuid-lswitch-arg> tunnel-ports

Display VTEP table for a segment

Display the tunnel endpoint table for the specified segment.

get segment <dpd-uuid-lswitch-arg> vtep-table

Display L2Forwarder high-availability history of a segment

get segment <nsxa-uuid-lswitch-arg> l2forwarders high-availability history state

Display l2forwarder HA information of segment

Display l2forwarder configuration and HA information of segment

get segment <nsxa-uuid-lswitch-arg> l2forwarders high-availability state

Display ports for a segment

Display port information for the specified segment.

get segment port <dpd-uuid-lswitch-port-arg>

Display stats for a segment port

Display statistics for the specified segment port.

get segment port <dpd-uuid-lswitch-port-arg> stats

Display segment ports

Display ports for all segments.

get segment ports

Display ports stats for all segments

Display port statistics for all segments.

get segment ports stats

Get segment local mac

Display a specific segment's local or remote MAC, ARP, or VTEP information.

get segment {local | remote} {mac-cache | arp-cache | vtep-cache} <vni>

Display segments

Display information about all segments.

get segments

Display service properties

Display information about the specified service.

get service <service-name-arg>

Get the dataplane service logging level

Display the log level of the dataplane service.

get service dataplane logging-level

Get the dhcp service logging level

Display the log level of the dhcp service.

get service dhcp logging-level

Get the IKE service logging level

Display the log level of the IKE service.

get service ike logging-level

Get the local-controller service logging level

Display the log level of the local-controller service.

get service local-controller logging-level

Get local-controller service state

Display the state of the local controller service.

get service local-controller state

Get service exporter SmartNIC demux logging level

Get service exporter SmartNIC demux logging level.

get service nsx-exporter lib-sndemux logging-level

Get service netopa logging level

Get service netopa logging level.

get service nsx-netopa logging-level

Get service opsagent SHA client logging level

Get service opsagent SHA client logging level.

get service nsx-opsagent lib-sha logging-level

Get service opsagent SmartNIC demux logging level

Get service opsagent SmartNIC demux logging level.

get service nsx-opsagent lib-sndemux logging-level

Get service opsagent workflow logging level

Get service opsagent workflow logging level.

get service nsx-opsagent lib-wft logging-level

Get service opsagent workflow trace level

Get service opsagent workflow trace level.

get service nsx-opsagent lib-wft trace-level

Get service OpsAgent logging level

Get service OpsAgent logging level.

get service nsx-opsagent logging-level

Get service nsx-proxy central logging level

Get service nsx-proxy central logging level.

get service nsx-proxy central logging-level

Get service nsx-proxy metrics logging level

Get service nsx-proxy metrics logging level.

get service nsx-proxy lib-metrics logging-level

Get service nsx-proxy nestdb logging level

Get service nsx-proxy nestdb logging level.

get service nsx-proxy lib-nestdb logging-level

Get service nsx-proxy net logging level

Get service nsx-proxy net logging level.

get service nsx-proxy lib-net logging-level

Get service nsx-proxy rpc logging level

Get service nsx-proxy rpc logging level.

get service nsx-proxy lib-rpc logging-level

Get service nsx-proxy logging level

Get service nsx-proxy logging level.

get service nsx-proxy logging-level

Get the entire routing configuration

Display the entire routing configuration.

get service router config

Get redistribution configuration

Display the redistribution configuration.

get service router config redist

Get route maps configuration

Display the route map configuration.

get service router config route-maps

Display service groups of the service router

Display the service groups state for the service router

get service-groups

Display service groups of the service router

Display the service groups state for the service router

get service-groups details

Display info about Service Insertion

Display information about Service Insertion.

get service-insertion

Display info about Service Insertion

Display information about Service Insertion.

get service-insertion <dpd-uuid-service-insertion-arg>

Display info about NS Service Insertion BFD control status.

Display information about NS Service Insertion BFD control status.

get service-insertion bfd-ctrl

Display info about Service Insertion flow programming table.

Display information about Service Insertion flow programming table.

get service-insertion flow-prog-table

Display info about Service Insertion failed SPI.

Display information about Service Insertion failed SPI.

get service-insertion spi-fail-table

Display info about EW Service Insertion VRF to interface mapping.

Display information about EW Service Insertion VRF to interface mapping.

get service-insertion vrf-to-intf

Display service properties

Display information about all services.

get services

Get SNMP v2 configured status

Indicates whether the local SNMP agent is configured with community string(s).

get snmp v2-configured

Get SNMP v2 Trap Targets

Get SNMP v2 Trap Targets.

get snmp v2-targets

Get SNMP v3 configured status

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

get snmp v3-configured

Get SNMP v3 Engine ID

Get SNMP v3 Engine ID.

get snmp v3-engine-id

Get SNMP v3 Protocols

Get SNMP v3 Protocols auth_protocol and priv_protocol.

get snmp v3-protocols

Get SNMP v3 Trap Targets

Get SNMP v3 Trap Targets.

get snmp v3-targets

Get SNMP v3 User IDs

Get SNMP v3 User IDs.

get snmp v3-users

Show active network connections

Display active network connections.

get sockets

Display the stats of all ifaces in the path

Display the statistics for all interfaces in the path.

get stats

Display the logical router statistics

Display statistics for the logical router in the VRF context.

get stats

Save support bundle in filestore

Display 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. This support bundle does not contain core or audit log files. To include those files, specify the 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.

get support-bundle [file <filename> [log-age <no-of-days>] [all]]

Get the topology of the system

Display the topology of the system.

get topology

Display information about a tunnel port

Display information about the specified tunnel port.

get tunnel-port <dpd-uuid-tunnel-port-arg>

Display stats for a tunnel port

Display statistics for the specified tunnel port.

get tunnel-port <dpd-uuid-tunnel-port-arg> stats

Display tunnel ports

Display information about all tunnel ports.

get tunnel-ports

Display stats for all tunnel ports

Display statistics for all tunnel ports.

get tunnel-ports stats

Display Multicast Underlay subscriptions

Display all Multicast Groups the Edge joined in Underlay

get underlay-subscription

Display progress status of last upgrade step

Display the status of the upgrade steps run on the node and details of last upgrade step.

get upgrade progress-status

Display playbook contents

Display the contents of the specified playbook for the specified upgrade bundle.

get upgrade-bundle <bundle-name-arg> playbook <playbook-file-arg>

List all playbooks in the filestore

Display all playbooks in the file store.

get upgrade-bundle playbooks

Show the system uptime

Display the system uptime information.

get uptime

Display reputation and category info about URL

get url-classification <url-string-arg>

Get number of days od details user password expiration details

Get number of days the user's password is valid after a password change and number of days before user receives password expiration warning message.

get user <node-all-username> password-expiration

Get user status for specified non-root user

Get user status for specified non-root user.

get user <node-all-username> status

Get SSH keys from authorized_keys file for specified user

Get SSH keys from authorized_keys file for specified user.

get user <node-username> ssh-keys

Display system version

Display the version of the NSX appliance.

get version

Display info about EW policy service chain

Display information about EW policy service chain.

get vsip-si policy-service-chains

Display info about EW service chain

Display information about EW service chain.

get vsip-si service-chains

Display info about EW service path.

Display information about EW service path.

get vsip-si service-paths

Display info about EW service path with specific chain id.

Display information about EW service path with specific chain id.

get vsip-si service-paths <dpd-id-service-chain-arg>

Display info about service policies

Display information about service policies.

get vsip-si service-policies

Display information of a VTEP group

Display information about a VTEP group.

get vtep-group <vtep-group-id-arg>

Display VTEP group information

Display information about all VTEP groups

get vtep-groups

Display VTEP information

Display information about all tunnel endpoints.

get vteps

Display help for specified command or list available commands

Display help information. See the example below.

help

Install NSX Edge service container image

Install NSX Edge service container image.

install image <configurable-image-name> version <configurable-image-version>

List available commands

This command lists all available commands.

list

nslookup

Display nslookup information.

nslookup <hostname-arg>

Display Nslookup DNS Forwarder result

Display Nslookup DNS Forwarder result.

nslookup dns-forwarder <hostname-or-ip-address> [[server-ip <ip-address>] [source-ip <ip-address>]]

Display Nslookup DNS Forwarder result

Display Nslookup DNS Forwarder result.

nslookup dns-forwarder <uuid> <hostname-or-ip-address> [server-ip <ip-address>] [source-ip <ip-address>]

Enter path context mode

Enter path context mode. This mode allows you to get information about each interface that is in the path between the specified logical router port and the specified IP address.

You can get a list of logical router interfaces with the get logical-router interfaces command.

Once you are in the path context, use the path commands to navigate and get information, for example, get path, get current, up and down.

path <dpd-uuid-lrouter-port-arg> <ip46-address>

Ping host

Ping an IP address. Use Control-C to stop the ping command.

ping <hostname-or-ip-address>

Ping host

Ping an IP address. Use Control-C to stop the ping command. The repeat argument specifies how many ping packets to transmit. The size argument specifies the size of the ping packet. The dfbit argument specifies whether to set the "don't fragment" bit in the ping packet. If enabled, the packet will not be fragmented.

The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.

ping <hostname-or-ip-address> [repeat <number>] [size <number>] [source <hostname-or-ip-address>] [dfbit enable]

Ping host

Ping an IP address. Use Control-C to stop the ping command. The repeat argument specifies how many ping packets to transmit. The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command. The size argument specifies the size of the ping packet. The dfbit argument specifies whether to set the "don't fragment" bit in the ping packet. If enabled, the packet will not be fragmented.

ping <hostname-or-ip-address> [repeat <number>] [size <number>] [source <hostname-or-ip-address>] [dfbit enable] [vrfid <vrf-id>]

Ping IPv6 host

Ping an IPv6 address. Use Control-C to stop the ping command.

ping6 <ip6-address>

Ping IPv6 host

Issue a ping command for IPv6 host.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address

ping6 <ip6-address> [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The repeat argument specifies how many ping packets to transmit.

ping6 <ip6-address> [repeat <number>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

The repeat argument specifies how many ping packets to transmit.

ping6 <ip6-address> [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host

Ping an IPv6 address. Use Control-C to stop the ping command.

The size argument specifies the size of the ping packet.

ping6 <ip6-address> [size <number>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The size argument specifies the size of the ping packet.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

ping6 <ip6-address> [size <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The repeat argument specifies how many ping packets to transmit.

The size argument specifies the size of the ping packet.

ping6 <ip6-address> [size <number>] [repeat <number>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The size argument specifies the size of the ping packet.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

The repeat argument specifies how many ping packets to transmit.

ping6 <ip6-address> [size <number>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host

Ping an IPv6 address. Use Control-C to stop the ping command.

ping6 <ip6-address> [source <ip6-address>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address

ping6 <ip6-address> [source <ip6-address>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The repeat argument specifies how many ping packets to transmit.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address

ping6 <ip6-address> [source <ip6-address>] [repeat <number>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

The size argument specifies the size of the ping packet.

ping6 <ip6-address> [source <ip6-address>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The size argument specifies the size of the ping packet.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

ping6 <ip6-address> [source <ip6-address>] [size <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The size argument specifies the size of the ping packet.

The repeat argument specifies how many ping packets to transmit.

ping6 <ip6-address> [source <ip6-address>] [size <number>] [repeat <number>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The repeat argument specifies how many ping packets to transmit.

The size argument specifies the size of the ping packet.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

ping6 <ip6-address> [source <ip6-address>] [size <number>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

ping6 <ip6-address> [source <ip6-address>] [vrfid <vrf-id>]

Ping IPv6 host

Ping an IPv6 address. Use Control-C to stop the ping command.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

ping6 <ip6-address> [vrfid <vrf-id>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address

ping6 <ip6-address> [vrfid <vrf-id>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The repeat argument specifies how many ping packets to transmit.

ping6 <ip6-address> [vrfid <vrf-id>] [repeat <number>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The repeat argument specifies how many ping packets to transmit.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The size argument specifies the size of the ping packet.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

ping6 <ip6-address> [vrfid <vrf-id>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The size argument specifies the size of the ping packet.

ping6 <ip6-address> [vrfid <vrf-id>] [size <number>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The size argument specifies the size of the ping packet.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

ping6 <ip6-address> [vrfid <vrf-id>] [size <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The repeat argument specifies how many ping packets to transmit.

The size argument specifies the size of the ping packet.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

ping6 <ip6-address> [vrfid <vrf-id>] [size <number>] [repeat <number>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The repeat argument specifies how many ping packets to transmit.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The size argument specifies the size of the ping packet.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

ping6 <ip6-address> [vrfid <vrf-id>] [size <number>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The repeat argument specifies how many ping packets to transmit.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The size argument specifies the size of the ping packet.

ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [repeat <number>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The repeat argument specifies how many ping packets to transmit.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The size argument specifies the size of the ping packet.

ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [size <number>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The size argument specifies the size of the ping packet.

The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.

ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [size <number>] [egress <dpd-uuid-lrouter-port-arg>]

Ping IPv6 host

Issue a ping command for IPv6 host. Ping an IPv6 address. Use Control-C to stop the ping command.

The repeat argument specifies how many ping packets to transmit.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The size argument specifies the size of the ping packet.

ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [size <number>] [repeat <number>]

Ping IPv6 host

Issue a ping command for IPv6 host.

The repeat argument specifies how many ping packets to transmit.

The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.

The size argument specifies the size of the ping packet.

ping6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [size <number>] [repeat <number>] [egress <dpd-uuid-lrouter-port-arg>]

Reboot system

Reboot the system. If you specify the force argument, the system will reboot immediately without prompting for confirmation.

reboot [force]

Reset corelist related boot time option to factory default

Reset the corelist-related boot time option to factory default.

reset dataplane corelist

Reset custom list of supported devices on the system

Reset custom list of supported devices on the system.

reset dataplane device list

Reset hugepage related boot time option to factory default

Reset the hugepage-related boot time option to factory default.

reset dataplane hugepage

Clear DNS Forwarder cache

Clear the DNS Forwarder cache

reset dns-forwarder <uuid-string-arg> cache

Reset DNS Forwarder Stats and Display the Latest Entries

Reset the DNS Forwarder Stats Entries.

reset dns-forwarder <uuid-string-arg> stats

Clear DNS Forwarder Cache Per SR

Clear the DNS Forwarder Cache Per SR.

reset dns-forwarder cache

Reset DNS Forwarder Stats and Display Entries Per SR

Reset the DNS Forwarder Stats Entries Per SR.

reset dns-forwarder stats

Restart service

Restart the specified service.

restart service <restartable-service-name-arg>

Execute playbook resume action

Resume an upgrade after running the command start upgrade-bundle <bundle-name> playbook <playbook-file> and the system was rebooted.

resume upgrade-bundle <bundle-name-arg> playbook

Set CLI account lockout period

Sets the amount of time, in seconds, that an account will remain locked out of the CLI after exceeding the maximum number of failed authentication attempts. While the lockout period is in effect, additional authentication attempts restart the lockout period, even if a valid password is specified.

set auth-policy cli lockout-period <lockout-period-arg>

Set CLI maximum authentication faliures

Set the number of failed CLI authentication attempts that are allowed before the account is locked. If set to 0, account lockout is disabled.

set auth-policy cli max-auth-failures <auth-failures-arg>

Set minimum allowable password length

Set the minimum number of characters that passwords must have. The smallest value that can be set is 8.

set auth-policy minimum-password-length <password-length-arg>

Set security banner or message of the day

Set the security banner or message of the day.

set banner

Set the specified bridge port HA state to Active

set bridge <nsxa-uuid-lswitch-port-arg> state active

Display packet capture on session

Start a packet capture. You must have already configured the packet capture with the set capture session <session-number> interface <port-uuid-name> direction <direction> command in basic mode, or with the set capture session <session-number> direction <direction> command in path mode.

Use the get capture sessions command in basic mode to see all configured capture sessions.

set capture session <dpd-number-session-id-arg>

Monitor current port in a packet capture session

Configure a packet capture using the current interface in the path. You can change the current interface and run this command again to configure multiple interfaces on the same packet capture session.

Start the packet capture with the set capture session <session-number> command in either basic or path mode, or with the set capture session <session-number> [file <filename> [count <packet-count> [expression <expression> command in basic mode.

Use the get capture sesssions command in basic mode to see all configured capture sessions.

set capture session <dpd-number-session-id-arg> direction <capture-direction-arg>

Start packet capture for the specified session

Start a packet capture. You must have already configured the packet capture with the

set capture session
<session-number> interface <port-uuid-name>
direction <direction>

command.

If you don't specify a file, the output displays on the terminal.

If file is specified, the file count can be specified to enable rotating capture files, where each file will be of size 100MB. Multiple files will be bundled into single tarfile.

Type Control-C to end the packet capture.

You can filter the capture using tcpdump expressions. The expression must be the last argument of the command.

Use the get capture sessions command to see all configured capture sessions.

set capture session <session-number> [file <filename>] [file-count <file-count>] [count <packet-count>] [expression <expression>]

Monitor a port on a certain core in a packet capture session

Configure a packet capture using the specified interface. You can run this command multiple times to configure multiple interfaces on the same packet capture session.

To run the packet capture using this configuration, use the set capture session <session-number> [file <filename>] [count <packet-count>] [expression <expression>] command.

If you need to capture packets from only one interface, you can configure and run the packet capture with a single command: start capture interface <interface-name> [direction <direction>] [file <filename>] [count <packet-count>] [expression <expression>].

Use the get capture sessions command to see all configured capture sessions.

set capture session <session-number> interface <port-uuid-name> direction <capture-direction> [core <core-id>]

Set status to display datetime stamp

Set status to display datetime stamp in command output.

set cli-output datetime <datetime-arg>

Set inactivity timeout

Set inactivity timeout in seconds. To disable the timeout, specify 0.

set cli-timeout <timeout-arg>

Set core dump file limit global config

Global limit for count to preserve latest core dump files generated for all processes or applications. By default lastest 2 core dump files will be preserved. To disable this config, set value to 0.

Note, disabling config may consume higher disk space and can cause disk outage.

set core-dump global file-limit <core-dump-limit>

Set core dump frequency threshold global config

Global limit for setting threshold in seconds for frequency of generated core dump files for all processes or applications. Any application generating core dump within threshold seconds will be neglected and new core dump request will only be in effect after expired threshold period. By default processes generating core dump within threshold frequency of 600 seconds will be denied. To disable this config, set value to 0.

Note, disabling config may consume higher disk space and can cause disk outage.

set core-dump global frequency-threshold <core-dump-limit>

Set Core dump limit config per application

Limit for count to preserve latest core dump files generated per process or application. To disable this config, set value to 0.

Note, disabling config may consume higher disk space and can cause disk outage.

set core-dump process <process-name> file-limit <core-dump-limit>

Enable/disable control packet prioritization

set dataplane ctrl-prio <enabled-arg>

Set the custom list of physical NICs

Set the custom list of physical NICs.

set dataplane device list <pci-address-arg>

Enable/disable flow cache

Enable or disable flow cache.

set dataplane flow-cache <enabled-arg>

Set the flow cache size for each core

set dataplane flow-cache-size <flow-cache-size-arg>

Enable/disable geneve critical bit

Enable or disable geneve critical bit.

set dataplane geneve-cbit <enabled-arg>

Enable/disable interrupt mode

Enable or disable interrupt mode.

set dataplane interrupt-mode <enabled-arg>

Change the size of the buffer pool for jumbo frame crypto operations

Change the jumbo mbuf pool size

set dataplane jumbo-mbuf-pool-size <jumbo-mbuf-pool-size-arg>

Enable/disable pmtu message generation in l2vpn

Enable or disable pmtu message generation in l2vpn.

set dataplane l2vpn-pmtu <enabled-arg>

Change the max number of packets that can be queued on each core

Change the per-core packet queue limit

set dataplane packet-queue-limit <packet-queue-limit-arg>

Enable/disable pmtu learning in dataplane

Enable or disable pmtu learning in dataplane.

set dataplane pmtu-learning <enabled-arg>

Enable/disable QAT device usage for IPsec (bare metal edge only)

Enable or disable QAT device usage for IPsec.

set dataplane qat <enabled-arg>

Set Rx/Tx queue number per port per core

set dataplane queue-num-per-port-per-core <queue-num-per-port-per-core-arg>

Set the rx ring size for physical ports

Set the rx ring size for physical ports.

set dataplane ring-size rx <ring-size-arg>

Set the tx ring size for physical ports

Set the tx ring size for physical ports.

set dataplane ring-size tx <ring-size-arg>

Set peer configuration for firewall active/standby

Set the peer configuration for active/standby configuration. This configuration happens automatically when firewall rules are added to an active/standby logical router via the NSX Manager web interface or API.

This command should be used for advanced configuration or troubleshooting only.

If you manually configure the active/standby peer on an edge node, you must also configure its peer.

set firewall <dpd-uuid-firewall-port-arg> local-ip <ip-address> sync-peer <nsxa-uuid-lrouter-port-arg> sync-peer-ip <ip-address>

Set mode for firewall synchronization

Set the firewall synchronization mode for active/standby configuration. This configuration happens automatically when firewall rules are added to an active/standby logical router via the NSX Manager web interface or API.

This command should be used for advanced configuration or troubleshooting only.

If you manually configure the active/standby sync, you must correctly configure both edge nodes in the active/standby configuration. One node must be configured as primary and one as secondary. One node must be configured as active, and one as passive.

set firewall <dpd-uuid-firewall-port-arg> sync-rank <fw-primary-arg> sync-mode <fw-active-arg>

Set GRUB menu timeout

Set GRUB menu timeout.

set grub menu timeout <grub-menu-timeout>

Set GRUB user password

Set GRUB user password.

set grub user <grub-username> password [<grub-password>]

Set commands history size

Set command history size.

set history limit <history-size>

Set system hostname

Set the system hostname. Changing the hostname changes the command line prompt.

set hostname <hostname-arg>

Reserve hugepage for dataplane using system default

Set the hugepage reserve size for the data plane using system default.

set hugepage-reserve auto

Reserve hugepage for dataplane

Set the hugepage reserve size for the data plane.

set hugepage-reserve size <hugepage-size-arg>

Configure the specified interface to use DHCP

Configure the specified interface to use DHCP. You cannot configure DHCP for NSX Manager or a controller because both must have a static IP address.

set interface <configurable-interface-name> dhcp

Configure the specified interface to use DHCP

Configure the specified interface to use DHCP.

set interface <configurable-interface-name> dhcp plane <interface-plane-arg> mode <bond-mode-arg> members <bond-slaves-arg> primary <bond-primary-arg>

Configure a bond interface and set the interface plane mode

Create bond interface and set the plane property of the interface and config the IP address. If plane is set to mgmt, it is reported as such to the management plane (MP) via MPA, and the slave devices are not consumed by dataplane for dataplane operations.

You can configure the bond interface with a DHCP or static IP address. If you configure a static IP address, make sure an appropriate network route is also configured.

set interface <configurable-interface-name> ip <cidr46-notation> gateway <gateway-ip46-address-arg> plane <interface-plane-arg> mode <bond-mode-arg> members <bond-slaves-arg> primary <bond-primary-arg>

Create VLAN network interface

Create a VLAN network interface from the specified parent interface and VLAN id. The new vlan network interface name will be of format interface. and the interface's plane property will be set to mgmt. Any existing configuration on the parent interface will be deleted. Users must use the newly created VLAN network interface for configuration.

set interface <configurable-interface-name> vlan <vlan-id> plane mgmt

Set the interface plane mode

Set the plane property of the interface and optionally configure the IP address. By default, the plane property is not configured, the dataplane component takes control of the interface for the data path and the interface is not visible to the Linux kernel. If plane is set to mgmt, it is reported as such to the management plane (MP) via MPA, and the corresponding interface is not consumed by the dataplane for dataplane operations and is available for configuration from the CLI. If it is set to debug, the dataplane does not consume the interface for dataplane operations and the interface is available for configuration from the CLI.

Optionally, you can configure the interface with a DHCP or static IP address. If you configure a static IP address, make sure an appropriate network route is also configured. You can use the optional gateway argument, or set a route using the set route command.

For NSX Manager or a controller, you cannot configure the plane property. You also cannot configure a DHCP or static IP address because both NSX Manager and a controller have a static IP address that is set at installation and cannot be changed.

set interface <interface-name> [ip <prefix-ipv46> [gateway <gateway-ip>] | dhcp] plane <plane>

Set network IP address and netmask

Configure a static IP address and netmask. Make sure an appropriate network route is also configured. You can use the optional gateway argument, or set a route using the set route command.

You cannot configure a static IP address for NSX Manager or a controller because their static IP address is set at installation and cannot be changed.

set interface <interface-name> ip <prefix-ipv46> [gateway <gateway-ip>]

Create an in-band VLAN network interface

Create an in-band VLAN network interface from the physical interface identified by the mac. If the physical interface is not already owned by the edge dataplane, the dataplane service will be restarted in order to claim the physical interface. The new inband vlan network interface name will be of format ethX.vlan and the interface's plane property will be set to mgmt. Users must use the newly created in-band VLAN network interface for configuration.

set interface mac <configurable-mac-address> vlan <vlan-id> in-band plane mgmt

Enable/disable rule log

Enable or disable rule log for a specific load balancer.

set load-balancer <lb-uuid-arg> rule-log <enabled-arg>

Enable/disable rule log

Enable or disable rule log for a specific pool.

set load-balancer <lb-uuid-arg> rule-log pool <pool-uuid-arg> <enabled-arg>

Enable/disable rule log

Enable or disable rule log for a specific virtual server.

set load-balancer <lb-uuid-arg> rule-log virtual-server <vs-uuid-arg> <enabled-arg>

Set load balancer performance profile

Apply edge parameters to accelerate load balancer performance.

set load-balancer perf-profile <perf-profile-type-arg>

Set logging-server

Configure a logging server. The logging system uses the facility codes defined in RFC 5424. Facility local7 is used for audit messages, and local6 is used for non-audit messages.

set logging-server <hostname-or-ip-address[:port]> proto <proto> level <level> [facility <facility>] [messageid <messageid>] [serverca <filename>] [clientca <filename>] [certificate <filename>] [key <filename>] [structured-data <structured-data>]

Set logging-server

Configure a logging server. The logging system uses the facility codes defined in RFC 5424. Facility local7 is used for audit messages, and local6 is used for non-audit messages.

set logging-server <hostname-or-ip-address[:port]> proto <proto> level <level> [facility <facility>] [messageid <messageid>] [serverca <filename>] [structured-data <structured-data>]

Add name server

Add a name server to the DNS configuration.

set name-servers <name-server-arg>

Set kubeconfig file of the NAPP Kubernetes cluster

Set kubeconfig file of the NAPP Kubernetes cluster. This operation overrides any existing NAPP kubeconfig file.

set napp kubeconfig

Add NTP server

Configure a new NTP server.

set ntp-server <hostname-or-ip-address>

Configure password complexity requirements

Configure password complexity requirements.

Minimum password length: minimum number of characters expected in password; user can not set their password of length lesser than this parameter. Default: 12, Minimum: 8, Maximum: 128

Maximum password length: maximum number of characters allowed in password; user can not set their password of length greater than this parameter. Default: 128, Minimum: 8, Maximum: 128

Lower characters: number of lower case characters (a..z) expected in user password.
N < 0, to set minimum credit for having lower case character in the new password, i.e. this is the minimum number of lower case character that must be met for a new password.

N > 0, to set maximum credit for having lower case character in the new password, i.e. per occurrence of lower case character in password will attribute additional credit of +1 towards meeting the current minimum password length value upto N lower case characters.

N = 0, to disable the policy check.
Default: -1, Minimum: -128, Maximum: 128

Upper characters: number of upper case characters (A..Z) expected in user password.
N < 0, to set minimum credit for having upper case character in the new password, i.e. this is the minimum number of lower case characters that must be met for a new password.

N > 0, to set maximum credit for having upper case characters in the new password, i.e. per occurrence of upper case character in password will attribute additional credit of +1 towards meeting the current minimum password length value upto N upper case characters.

N = 0, to disable the policy check.
Default: -1, Minimum: -128, Maximum: 128

Numeric characters: number of digits (0..9) expected in user password.
N < 0, to set minimum credit for having digits in the new password, i.e. this is the minimum number of digits that must be met for a new password.

N > 0, to set maximum credit for having digits in the new password, i.e. per occurrence of digit in password will attribute additional credit of +1 towards meeting the current minimum password length value upto N digits.

N = 0, to disable the policy check.
Default: -1, Minimum: -128, Maximum: 128

Special characters: number of special characters (!@#$&*..) expected in user password.
N < 0, to set minimum credit for having special characters in the new password, i.e. this is the minimum number of special characters that must be met for a new password.

N > 0, to set maximum credit for having special characters in the new password, i.e. per occurrence of special case character in password will attribute additional credit of +1 towards meeting the current minimum password length value upto N special case characters..

N = 0, to disable the policy check.
Default: -1, Minimum: -128, Maximum: 128

Minimum unique characters: number of character changes in the new password that differentiate it from the old password. To disable the check, value should be set to 0. Default: 0, Minimum: 0, Maximum: 128

Allowed similar consecutives: reject passwords which contain more than N same consecutive characters. To disable the check, value should be set to 0. Default: 0, Minimum: 0, Maximum: 128

Allowed monotonic sequence: reject passwords which contain more than N monotonic character sequences. Monotonic sequences can be '12345' or 'fedcb'. To disable the check, value should be set to 0. Default: 0, Minimum: 0, Maximum: 128

Hash algorithm: sets hash/cryptographic algorithm type for new passwords. Default: sha512. Enum: [ sha512, sha256 ]

Password remembrance: limit using a password that was used in past; users can not set the same password within the N generations. To disable the check, value should be set to 0. Default: 0, Minimum: 0

Understanding PAM's maximum credit values with an example, consider password complexity configured as follows:

Minimum password length: 12
Lower case characters: -1
Upper case characters: 2
Digits: -1
Special case characters: -1

above values represent a password to be atleast of length 12 (or credits) which should consist atleast 1 lower case character, atleast 1 digit, atleast 1 special case character and any number of upper case characters.
If included, for first 2 upper case characters additional credit of +2 will be secured.
Which signifies password having 1 upper case character with additional 10 or more characters of required complexity will be allowed to set where total password length would be 11 or more,
password having 2 upper case characters with additional 8 or more characters of required complexity will be allowed to set where total password length would be 10 or more,
whereas password with 3 upper case characters shall still require 7 or more characters with above minimum value requirements, as there's only maximum credit of 2 configured for upper case characters.

Few valid passwords with respect to configured example complexity requirements:

hivmware@123 - consists of required minimum 1 - lower case character, special case character, digit and overall length is 12
Hivmware@12 - consists of required minimum 1 - lower case character, special case character, digit; whereas length is 11 but inclusion of 1 upper case character attributes an extra +1 credit, hence password is valid
HiVmware@1 - consists of required minimum 1 - lower case character, special case character, digit; whereas length is 10 but inclusion of 2 upper case characters attributes an extra +2 credit, hence password is valid

whereas following passwords will be invalid:

hivmware@12 - required length of 12 is not fulfilled
hivmware1234 - required minimum 1 special case character is not fulfilled
HiVMwar@1 - there are 3 upper case characters out which only maximum 2 characters will be considered for extra credit, third occurrence of upper case character will be attributed as 1 credit only, hence the overall credit score 11 does not fulfills complexity

Note, passwords less than 8 characters are never allowed.

set password-complexity [<complexity-name> <complexity-value>]

Set the specified physical port mtu to given value

Set the specified physical port mtu to given value.

set physical-port <dpd-name-physical-port-arg> mtu <dpd-physical-port-mtu-arg>

Set the specified physical port admin state up or down

Set the specified physical port admin state up or down.

set physical-port <dpd-name-physical-port-arg> state <dpd-physical-port-state-arg>

Add IPv4 network route

Add IPv4 network route. You can also just set a gateway by specifying a prefix value of 0.0.0.0/0.

set route prefix <prefix> [gateway <gateway-ip>] [interface <interface-name>] [metric <ip-route-metric>]

Add a domain name

Add a domain name to the DNS search list.

set search-domains <search-domain-arg>

Set the Dataplane service logging level

Set the log level of the Dataplane service.

set service dataplane logging-level <edge-service-logging-level-arg>

Set the DHCP service logging level

Set the log level of the DHCP service.

set service dhcp logging-level <edge-service-logging-level-arg>

Set the IKE service logging level

Set the log level of the IKE service.

set service ike logging-level <edge-service-logging-level-arg>

Set the Local Controller service logging level

Set the log level of the Local Controller service.

set service local-controller logging-level <edge-service-logging-level-arg>

Set service exporter SmartNIC demux logging level

Set service exporter SmartNIC demux logging level.

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

Set the log level of exporter service.

Dynamically set service daemon log level.

set service nsx-exporter logging-level <level>

Set service netopa logging level

Set service netopa logging level.

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

Set service opsagent SHA client logging level

Set service opsagent SHA client logging level.

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

Set service opsagent SmartNIC demux logging level

Set service opsagent SmartNIC demux logging level.

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

Set service opsagent workflow logging level

Set service opsagent workflow logging level.

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

Set service opsagent workflow trace level

Set service opsagent workflow trace level.

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

Set service OpsAgent logging level

Set service OpsAgent logging level.

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

Set service nsx-proxy central logging level

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

Set service nsx-proxy metrics logging level

Set service nsx-proxy metrics logging level.

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

Set service nsx-proxy nestdb logging level

Set service nsx-proxy nestdb logging level.

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

Set service nsx-proxy net logging level

Set service nsx-proxy net logging level.

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

Set service nsx-proxy rpc logging level

Set service nsx-proxy rpc logging level.

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

Set service nsx-proxy logging level

Set service nsx-proxy logging level.

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

Set NTP service start on boot

Configure the NTP service to start on boot.

set service ntp start-on-boot

Set log level for routing service

Set the log level of the FRR service.

set service router logging-level <edge-routing-service-logging-destination-arg> <edge-routing-service-logging-level-arg>

Set log level for routing platform service

Set the log level of the routing platform and config services.

set service routing-platform logging-level <edge-routing-platform-service-logging-level-arg>

Set snmp service start on boot

Configure the snmp service to start on boot.

set service snmp start-on-boot

Set SSH service start on boot

Configure the SSH service to start on boot.

set service ssh start-on-boot

Set SNMP service v1/v2c community string

Set the SNMP service v1/v2c community string in ciper text. This must be set before MIBs can be queried. Choose a string that is difficult to guess.

set snmp community

Set SNMP service v1/v2c community string

Set the SNMP service v1/v2c community string. This must be set before MIBs can be queried. Choose a string that is difficult to guess.

set snmp community <snmp-community-arg>

Set SNMP v2 Trap Targets

Set SNMP v2 Trap Targets.

set snmp v2-targets <hostname-or-ip-address-optional-port-arg> community <snmp-community-arg>

Set SNMP v3 Engine ID

Set SNMP v3 Engine ID.

set snmp v3-engine-id <v3-engine-id-arg>

Set SNMP v3 Protocols

Set SNMP v3 Protocols auth_protocol and priv_protocol.

set snmp v3-protocols auth-protocol <v3-auth-protocol-arg> priv-protocol <v3-priv-protocol-arg>

Set SNMP v3 Trap Targets

Set SNMP v3 Trap Targets.

set snmp v3-targets <hostname-or-ip-address-optional-port-arg> user <user-id-arg>

Set SNMP v3 users

Set SNMP v3 users,auth-password,priv-password in cipher text.

set snmp v3-users <user-id-arg>

Set SNMP v3 users

Set SNMP v3 users auth-password,priv-password in plain text.

set snmp v3-users <user-id-arg> auth-password <auth-password-arg> priv-password <priv-password-arg>

Set SSH Root login property

Enable SSH Root login property

set ssh root-login

Set system timezone

Set the system timezone.

set timezone <timezone-arg>

Set number of days the user's password is valid after a password change

Set number of days the user's password is valid after a password change.

set user <node-all-username> password-expiration <password-expiration-arg>

Set number of days prior user receives warning message before password expires

Set number of days prior user receives warning message before password expires. Set 0 to disable warning messages for password expiry.

set user <node-all-username> password-expiration-warning <password-expiration-warn-arg>

Set new username for specified non-root user

Set new user name for the specified non-root user.

set user <node-all-username> username <new-node-username>

Set user password

Set the password for the specified user. If you do not specify the password on the command line, you will be prompted for it. For details on setting passwords during installation, see the NSX Installation Guide.

set user <username> password [<password> [old-password <old-password>]]

Add SSH service key to authorized_keys file for specified user

Add SSH service key to authorized_keys file for specified user. If password is not provided in the command then you are prompted to enter it. Password is required only for users root and admin.

set user <username> ssh-keys label <key-label> type <key-type> value <key-value> [password <password>]

Shutdown system

Shut down the system. If you specify the force argument, the system will shut down immediately without prompting for confirmation.

shutdown [force]

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

Start a packet capture on the specified interface in the given direction and core. If you do not specify a file, the output is displayed on the terminal. If file is specified, the file count can be specified to enable rotating capture files, where each file will be of size 100MB. Multiple files will be bundled into single tarfile. Type Control-C to end the packet capture. You can filter the capture using tcpdump expressions. The expression must be the last argument of the command. The expression is a keyword followed by a value. You can specify multiple keyword-value pairs.

start capture interface <interface-name> [direction <direction>] [core <core-id>] [snaplen <capture-snaplen-arg] [file <filename>] [file-count <file-count>] [expression <expression>]

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

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

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

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

Start firewall synchronization for the logical router interface

Start firewall synchronization for the logical router interface. Synchronization happens automatically, but you can optionally start a bulk sync to more quickly synchronize a new or restarted standby router. The sync must be started from the primary router.

start firewall <dpd-uuid-firewall-port-arg> bulk-sync

Start service

Start the specified service.

start service <start-stoppable-service-name-arg>

Execute a playbook given a valid playbook file

Start an upgrade with the specified upgrade bundle and according to the specified playbook.

start upgrade-bundle <bundle-name-arg> playbook <playbook-file-arg>

Stop firewall bulk synchronization for the logical router interface

Stop firewall bulk synchronization for the logical router interface.

stop firewall <dpd-uuid-firewall-port-arg> bulk-sync

Stop service

Stop the specified service.

stop service <service name> [force]

Move to the top of the path

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

top

Trace an injected packet

Trace the specified packet.

traceflow <dpd-uuid-name-port-arg> <dpd-string-base64-arg>

traceroute

Trace the route to the specified IPv4 address or host.

traceroute <ip-address>

traceroute

Trace the route to the specified IP address.

The maxttl specifies the maximum time-to-live, or maximum number of routers the traceroute packet will traverse.

The source argument specifies which source IP address to use for traceroute. This may be required in some circumstances for traceroute to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, traceroute packets from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the traceroute packets will reach the virtual machines.

traceroute <ip-address> [source <ip-address>] [maxttl <number>]

traceroute

Trace the route to the specified IP address. The maxttl specifies the maximum time-to-live, or maximum number of routers the traceroute packet will traverse.

The vrfid argument specifies which VRF to send the traceroute packets from. You can get a list of available VRFs with the get logical-routers command.

traceroute <ip-address> [source <ip-address>] [maxttl <number>] [vrfid <vrf-id>]

traceroute6

Trace the route to target IPv6 address.

traceroute6 <ip6-address>

traceroute6

Trace the route to the specified IPv6 address. The maxttl specifies the maximum time-to-live, or maximum number of routers the traceroute packet will traverse.

traceroute6 <ip6-address> [maxttl <number>]

traceroute6

Trace the route to the specified IPv6 address.

traceroute6 <ip6-address> [source <ip6-address>]

traceroute6

Trace the route to the specified IPv6 address.

The maxttl specifies the maximum time-to-live, or maximum number of routers the traceroute packet will traverse.

traceroute6 <ip6-address> [source <ip6-address>] [maxttl <number>]

traceroute6

Trace the route to the specified IPv6 address.

The vrfid argument specifies which VRF to send the traceroute packets from. You can get a list of available VRFs with the get logical-routers command.

traceroute6 <ip6-address> [vrfid <vrf-id>]

traceroute6

Trace the route to the specified IPv6 address. The maxttl specifies the maximum time-to-live, or maximum number of routers the traceroute packet will traverse.

The vrfid argument specifies which VRF to send the traceroute packets from. You can get a list of available VRFs with the get logical-routers command.

traceroute6 <ip6-address> [vrfid <vrf-id>] [maxttl <number>]

traceroute6

Trace the route to the specified IPv6 address.

The vrfid argument specifies which VRF to send the traceroute packets from. You can get a list of available VRFs with the get logical-routers command.

traceroute6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>]

traceroute6

Trace the route to the specified IPv6 address.

The maxttl specifies the maximum time-to-live, or maximum number of routers the traceroute packet will traverse.

The vrfid argument specifies which VRF to send the traceroute packets from. You can get a list of available VRFs with the get logical-routers command.

traceroute6 <ip6-address> [vrfid <vrf-id>] [source <ip6-address>] [maxttl <number>]

Move up the path

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

Verify NSX Edge service container image file

Verify NSX Edge service container image file.

verify image <configurable-image-filename>

Verify all configured logging servers

Verify iptables rules for all logging servers and update if needed

verify logging-servers

Verify and extract bundle to default location

Verify and extract the specified upgrade bundle to the default location.

verify upgrade-bundle <bundle-name-arg>

Enter VRF context mode.

This command enters VRF context mode. You can find VRF IDs with the get logical-routers command.

vrf <dpd-uuid-vrfid-lrouter-arg>

Total commands: 891

Autonomous Edge

Associated Commands:

Move to the bottom of the path

Clear security banner or message of the day

Clear a BFD session stats

Clear BFD sessions stats

Reset specific BGP neighbor session

Reset all BGP neighbor sessions

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

Reset flow cache stats for all fastpath cores

Clear Edge Cluster state history

Clear the gateway high availability state history

Clear the gateway high availability state history

Clear the stats of a specific gateway interface

Clear stats for a high-availability channel

Clear stats for high-availability channels

Clear the logical router high availability state history

Clear stats for a high-availability session

Clear stats for high-availability sessions

Delete VLAN and/or bond network interface

Remove network IP configuration from the interface

Clear the interface plane

Deletes LLDP Neighbor information on all devices

Deletes LLDP Neighbor information on given device

Deletes LLDP Statistics on all devices

Deletes LLDP Statistics on given device

Clear statistics of a specified pool

Clear statistics of all pools

Clear load balancer statistics

Clear statistics of a specified virtual server

Clear statistics of all virtual servers

Clear load balancer performance profile settings

Clear all configured logging-servers

Clear the logical router high availability state history

Clear the stats of a specific logical router interface

Clear all name servers

Reset specific OSPF neighbor session

Reset all OSPF neighbor sessions

Resets configured password complexity requirements to default

Clear physical port stats by name

Clear all PIM BSM data & messages

Clear search domains

Clear NTP service start on boot

Clear snmp service start on boot

Clear SSH service start on boot

Clear SSH Root login property

Disable password expiration for the user

Disable password expiration warning for the user

Copy core dumps to remote file

Copy a local file to remote file

Copy a remote file to the local file store

Copy a remote https url file with same filename

Delete a configured packet capture session

Delete packet capture session

Delete an interface from a packet capture session

Delete core dump files in the system

Delete local file

Delete NSX Edge service container image

Delete logging-server

Delete name server

Remove NTP server

Delete IPv4 network route

Delete a domain name

Delete SNMP v2 Trap Targets

Delete SNMP v3 Trap Targets

Delete SNMP v3 Users

Delete SSH service known host

Delete existing local users.

Delete SSH service keys from authorized_keys file for specified user

Move down the path

Exit the CLI

Show system arp cache

Get CLI account lockout period

Get CLI maximum authentication faliures

Get minimum allowable password length

Display logical router BFD config

Display info for a BFD session

Display stats for a BFD session

Display info about BFD sessions

Display logical router BFD sessions