NSX CLI Guide

Associated Commands:

CLI Description	Command
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
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 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
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 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 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'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 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)
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 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 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 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 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 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
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>]

Total commands: 65