NSX CLI Guide

Associated Commands:

CLI Description Command

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

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

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

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

Clear all PIM BSM data & messages


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

Display logical router BFD config


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

Display info for a BFD session


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

Display stats for a BFD session


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

Display info about BFD sessions


Display information about BFD sessions.
get bfd-sessions

Display logical router BFD sessions


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

Display BFD sessions stats


Display the BFD sessions statistics.
get bfd-sessions stats

Display all IPv4 & IPv6 BGP routes


Display all IPv4 & IPv6 BGP routes.
get bgp

Display detailed information about BGP IPv4 route


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

Display detailed information about BGP IPv6 route


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

Display all BGP NLRI matching the community.


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

Display BGP EVPN routes


Display BGP EVPN routes.
get bgp evpn

Display BGP EVPN Ethernet Segment information


Display BGP EVPN Ethernet Segment information.
get bgp evpn es

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


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

Display BGP EVPN overlay information for all RDs


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

Display BGP EVPN VNI information


Display BGP EVPN VNI information.
get bgp evpn vni

Display all IPv4 BGP routes


Display all IPv4 BGP routes.
get bgp ipv4

Display all IPv6 BGP routes


Display all IPv6 BGP routes.
get bgp ipv6

Display all BGP NLRI matching the large-community.


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

Display all BGP neighbor information


Display all BGP neighbor information.
get bgp neighbor

Display information about a specific BGP neighbor


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

Display routes advertised to a BGP neighbor in internal debug context


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

Display routes advertised to a BGP neighbor


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

Display routes learnt from a BGP neighbor


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

Display routes learnt from a BGP neighbor in internal debug context


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

Display a specific BGP neighbor diagnostic information


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

Display BGP neighbor diagnostic information


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

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


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

Display summarized BGP neighbor information


Display summarized BGP neighbor information.
get bgp neighbor summary

Display summarized BGP neighbor information for a given address-family


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

Display all IPv4 & IPv6 BGP routes of shadow VRF


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

Generate BGP/BFD diagnostic report


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

Display EVPN All VNIs ARP information


Display EVPN All VNIs ARP information.
get evpn arp

Display EVPN VNI ARP information


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

Display EVPN deployment Mode information


Display EVPN deployment Mode information.
get evpn deployment-mode

Display EVPN Ethernet Segment information


Display EVPN Ethernet Segment information.
get evpn es

Display particular EVPN Ethernet Segment information


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

Display EVPN VNI MAC information


Display EVPN VNI MAC information.
get evpn mac

Display EVPN VNI MAC information


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

Display router MACs for all VNIs


Display router MACs for all VNIs.
get evpn rmac

Display all EVPN VNI information


Display all EVPN VNI information.
get evpn vni

Display the MAC table or IP FIB


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

Display the forwarding table


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

Display a gateway


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

Display gateway BFD config


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

Display IgmpSnooping Table of the Gateway


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

Display IgmpSnooping Table of the Gateway


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

Display a gateway's interfaces


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

Display the interface stats for a gateway


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

Display the gateway multicast forwarding table


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

Display multicast forwarding entries matching a multicast group


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

Display the gateway's neighbor table


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

Display neighbors and stats for a gateway


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

Display QoS config for a gateway


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

Display stats for a gateway


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

Display a gateway's tenant context


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

Display information about the specified Gateway


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

Display the routing table for the specified Gateway


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

Display a specific IPv4 route on the specified Gateway


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

Display information about a specific interface on the specified Gateway


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

Display all interfaces on the specified gateway


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

Get all routing Config entities on the specified Service Gateway


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

Display gateway high availability state history


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

Display gateway high availability state history


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

Display the gateway high availability status


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

Display a gateway


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

Display forwarding information for a gateway


Display forwarding for the specified gateway.
get gateway <uuid-arg> forwarding

Display forwarding information for a gateway


Display forwarding for the specified gateway, filtered by prefix.
get gateway <uuid-arg> forwarding <network46-address>

Display forwarding information for a gateway


Display forwarding for the specified gateway filtered on prefix.
get gateway <uuid-arg> forwarding <network46-address>

Display IPv4 forwarding for a gateway


Display IPv4 forwarding for the specified gateway.
get gateway <uuid-arg> forwarding ipv4

Display IPv6 forwarding for a gateway


Display IPv6 forwarding for the specified gateway.
get gateway <uuid-arg> forwarding ipv6

Display Mcast Groups information for a gateway


Display Mcast Groups for the specified gateway.
get gateway <uuid-arg> igmp membership

Display Mcast Groups information for a gateway


Display Mcast Groups for the specified gateway.
get gateway <uuid-arg> igmp membership <ip-address>

Display a gateway interface


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

Display interface instance for a gateway


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

Display gateway interface instance policy table reference


Display policy table reference information for the specified gateway instance.
get gateway <uuid-arg> interface <uuid-arg> policy-table-ref

Display a gateway interface statistics


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

Display interface instance stats for a gateway


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

Display a gateway interface statistics


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

Display interface instance stats for a gateway (ipv4)


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

Display interface instance stats for a gateway (ipv6)


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

Display interfaces for a gateway


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

Display neighbor for a gateway


Display neighbor information (ARP/ND cache) for the specified gateway, using IP or MAC.
get gateway <uuid-arg> neighbor <ipormac-address>

Display neighbors for a gateway


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

Display gateway BFD sessions


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

Display the gateway forwarding table


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

Display gateway BFD config


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

Display gateway BFD sessions


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

Display the forwarding table


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

Display the gateway high availability state history


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

Display the gateway high availability status


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

Display interface info for a gateway


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

Display ARP proxy table for a gateway port


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

Display interface-group info for gateway interface


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

Display the neighbor table of the gateway interface


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

Display shadow port mac list for gateway port


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

Get the shadow port MAC address selected for specific IP address


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

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


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

Display the gateway interface stats


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

Display a gateway's interfaces


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

Display the gateway ports


Display information for all gateway interfaces.
get gateway interfaces

Display the gateway interface stats


Display statistics for all gateway interfaces.
get gateway interfaces stats

Display the interface statistics of the gateway


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

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


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

Display multicast forwarding entries matching a multicast group in VRF


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

Display the neighbors table


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

Display the gateway's neighbor table


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

Display specific IPv4 routes from all the Gateway


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

Display the gateway statistics


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

Display a gateway's tenant context


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

Display a proximity routing policy table


Display information about the specified proximity routing policy table.
get gateway-policy-table <policy_table_id_arg_esx>

Display proximity gateway policy tables summary


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

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


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

Display gateway summary


Display information about gateways on this hypervisor host.
get gateways

Display gateways


Display information about all gateways.
get gateways

Display gateways and stats


Display statistics for all gateways.
get gateways stats

Display info about GRE keepalive


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

Display info for a GRE keepalive


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

Display stats for a GRE keepalive


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

Display stats for GRE keepalive


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

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


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

Display IgmpSnooping Table


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

Display IgmpSnooping Table


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

Display IgmpSnooping Stats


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

Display network interface properties


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

Display network interface properties


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

Display the logical router interface-groups high availability status


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

Display a logical router's interfaces


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

Display all network interface properties


Display information about all network interfaces.
get interfaces

Display the interface statistics of the logical router


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

Display a logical router


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

Display logical router BFD config


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

Display all IPv4 & IPv6 BGP routes


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

Display all BGP NLRI matching the community.


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

Display BGP EVPN Ethernet Segment information


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

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


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

Display all BGP NLRI matching the large-community.


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

Display all BGP neighbor information


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

Display EVPN VNI ARP information


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

Display EVPN Mode information


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

Display EVPN Ethernet Segment information


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

Display particular EVPN Ethernet Segment information


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

Display EVPN VNI MAC information


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

Display IgmpSnooping Table of the LR


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

Display IgmpSnooping Table of the LR


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

Display a logical router's interfaces


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

Display the interface stats for a logical router


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

Display the logical router multicast forwarding table


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

Display multicast forwarding entries matching a multicast group


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

Display multicast load-balancing selection for a logical router


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

Display the logical router's neighbor table


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

Display neighbors and stats for a logical router


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

Display OSPF information


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

Display OSPF database summary


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

Display ASBR-Summary LSAs


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

Display ASBR-Summary LSAs


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

Display external LSAs


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

Display external LSAs


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

Display Network LSAs


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

Display Network LSAs


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

Display NSSA external LSAs


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

Display NSSA external LSAs


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

Display router LSAs


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

Display router LSAs


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

Display summary LSAs


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

Display summary LSAs


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

Display OSPF Graceful Restart information


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

Display OSPF interface information


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

Display OSPF neighbor list


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

Display OSPF routes


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

Show external summary addresses


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

Display QoS config for a logical router


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

Display all OSPF routes in RIB


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

Display stats for a logical router


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

Display a logical router's tenant context


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

Display information about the specified logical router


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

Display the routing table for the specified logical router


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

Display a specific IPv4 route on the specified logical router


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

Display information about a specific interface on the specified logical router


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

Display all interfaces on the specified logical router


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

Get all routing Config entities on the specified Service Router


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

Display logical router high availability state history


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

Display logical router high availability state history


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

Display the logical router high availability status


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

Display logical router high availability status of interface-groups


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

Display a logical router


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

Display forwarding information for a logical router


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

Display forwarding information for a logical router


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

Display forwarding information for a logical router


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

Display IPv4 forwarding for a logical router


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

Display IPv6 forwarding for a logical router


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

Display Mcast Groups information for a logical router


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

Display Mcast Groups information for a logical router


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

Display interface instance for a logical router


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

Display a logical router interface


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

Display logical router interface instance policy table reference


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

Display a logical router interface statistics


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

Display interface instance stats for a logical router


Display interface instance stats for a logical router.
get logical-router <uuid-arg> interface <uuid-arg> stats (Deprecated)

Display a logical router interface statistics


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

Display interface instance stats for a logical router (ipv4)


Display interface instance stats for a logical router (ipv4).
get logical-router <uuid-arg> interface <uuid-arg> stats ipv4 (Deprecated)

Display interface instance stats for a logical router (ipv6)


Display interface instance stats for a logical router (ipv6).
get logical-router <uuid-arg> interface <uuid-arg> stats ipv6 (Deprecated)

Display interfaces for a logical router


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

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


Display Mcast router backplane IP for load-balancing a multicast group
get logical-router <uuid-arg> multicast load-balancing <ip-address>

Display neighbor for a logical router


Display neighbor information (ARP/ND cache) for the specified logical router, using IP or MAC.
get logical-router <uuid-arg> neighbor <ipormac-address> (Deprecated)

Display neighbors for a logical router


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

Display logical router BFD sessions


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

Display BGP EVPN routes


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

Display BGP EVPN overlay information for all RDs


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

Display BGP EVPN VNI information


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

Display information about a specific BGP neighbor


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

Display routes advertised to a BGP neighbor


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

Display routes learnt from a BGP neighbor


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

Display a specific BGP neighbor diagnostic information


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

Display BGP neighbor diagnostic information


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

Display summarized BGP neighbor information


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

Display summarized BGP neighbor information for a given address-family


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

Generate BGP/BFD diagnostic report


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

Display EVPN VNI ARP information


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

Display EVPN VNI MAC information


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

Display router MACs for all VNIs


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

Display all EVPN VNI information


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

Display the logical router forwarding table


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

Display multicast routes


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

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


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

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

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

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


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

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

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

Display IPv4 BGP routes for a specified prefix in RIB


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

Display IPv4 Connected routes for a specified prefix in RIB


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

Display IPv4 OSPF routes for a specified prefix in RIB


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

Display IPv4 Static routes for a specified prefix in RIB


Display IPv4 Static routes for a specified prefix in RIB.

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

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

Display the multicast HA role.


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

Display all VRF VNI information


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

Display interface info for a logical router


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

Display ARP proxy table for a logical router port


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

Display interface-group info for logical router port


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

Display the neighbor table of the logical router interface


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

Display shadow port mac list for lrouter port


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

Get the shadow port MAC address selected for specific IP address


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

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


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

Display the logical router interface stats


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

Display the logical router ports


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

Display the logical router interface stats


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

Display the neighbor table


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

Display specific IPv4 routes from all the logical routers


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

Display a proximity routing policy table


Display information about the specified proximity routing policy table.
get logical-router-policy-table <policy_table_id_arg_esx>

Display proximity routing policy tables summary


Display information about proximity routing policy tables on this hypervisor host.
get logical-router-policy-tables

Display information about the specified logical router port.


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

Display logical router summary


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

Display logical routers


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

Display information about all logical routers


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

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


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

Display logical routers and stats


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

Display external IP and internal IP of LSP


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

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>

Display the logical router's neighbor table


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

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 state of BSM message processing.


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

Display logical objects related to the specified logical port


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

Display Ports


Display information about all ports.
get ports

Display port information


Display port information on the current host.
get ports

Display info about redirection Policy


Display information about Redirection Policy
get redirection-policy

Display info about Redirection POlicy


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

Display info about Redirection Policy BFD control status.


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

Display info about Redirection Policy flow programming table.


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

Display info about Redirection Policy failed SPI.


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

Display info about EW Redirection VRF to interface mapping.


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

Display detailed information of an IPv6 route in RIB


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

Display detailed information of an IPv4 route in RIB


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

Display IPv4 BGP routes for a specified prefix in RIB


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

Display IPv4 Connected routes for a specified prefix in RIB


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

Display all OSPF routes in RIB


Display all OSPF routes in RIB.
get route ospf

Display IPv4 OSPF routes for a specified prefix in RIB


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

Display a specific IPv4 route or IPv6 routes for the prefix


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

Display specific IPv4 or IPv6 routes for the prefix


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

Display IPv4 Static routes for a specified prefix in RIB


Display IPv4 Static routes for a specified prefix in RIB.

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

get route static [<prefix>]

Display routes across Tier0 and all its associated VRFs


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

Display IPv4 routes


Display all configured IPv4 routes.
get routes

Display IPv4 and IPv6 routes


Display all configured IPv4 and IPv6 routes.
get routes

Display IPv4 or IPv6 routes


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

Display a routing domain


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

Display a routing domain mtep


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

Display a routing domain


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

Display information about all logical switches in a routing domains


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

Display information about all logical switches in a routing domains


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

Display information about all logical switches in a routing domains


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

Display information about all routing domains


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

Display routing domain


Display information about all routing domains.
get routing-domains

Display routing domain mtep


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

Display routing domains from the application


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

Display routing domains from Pigeon


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

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 the logical router statistics


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

Display the stats of all ifaces in the path


Display the statistics for all interfaces in the path.
get stats

Display a logical router's tenant context


Display tenant context information for the logical router in the VRF context.
get tenant-context

Display transit gateway summary


Display information about transit gateways on this hypervisor host.
get tgws

Display Configured TGWs


Display information about all TGWs.
get tgws

Display transit gateway summary


Display information on transit gateway routers at policy path on this hypervisor host.
get tgws <policy-path-string-arg>

Display external IP mapping table entries on the host


Display external IP mapping table entries on the host
get transport-node external-ip

Display external IP mapping table entry on the host


Display external IP mapping table entry on the host
get transport-node external-ip <ip-address>

Display Multicast Underlay subscriptions


Display all Multicast Groups the Edge joined in Underlay
get underlay-subscription

Display Configured VPCs


Display information about all VPCs.
get vpcs

Display vpc gateway summary


Display information about vpc gateway routers on this hypervisor host.
get vpcs

Display vpc gateway router summary


Display information on vpc gateway routers on this hypervisor host.
get vpcs <policy-path-string-arg>

Display vpc segment summary


Display information on subnet on this hypervisor host.
get vpcs <policy-path-string-arg> subnets

Display all VRF VNI information


Display all VRF VNI information.
get vrf vni

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

Add IPv4 or IPv6 network route


Add IPv4 or IPv6 network route. You can also just set a gateway by specifying a prefix value of 0.0.0.0/0 for Ipv4 and ::/0 for Ipv6. Default value for the IPv6 route metric is 1024.
set route prefix <prefix> [gateway <gateway-ip>] [interface <interface-name>] [metric <ip-route-metric>]

Add IPv4 network route


Add IPv4 network route. You can also just set a gateway by specifying a prefix value of 0.0.0.0/0.
set route prefix <prefix> [gateway <gateway-ip>] [interface <interface-name>] [metric <ip-route-metric>]

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