NSX CLI Guide

Associated Commands:

CLI Description Command

Display a gateway


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

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

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


Display information about the specified gateway.
get gateway <gateway_uuid_arg_esx>

Display logical router virtual IPs


Display virtual IPs for the specified logical router instance.
get gateway <gateway_uuid_arg_esx> service virtual-ip

Display a gateway


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

Display the gateway statistics


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

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 gateways


Display information about all gateways.
get gateways

Display gateway summary


Display information about gateways on this hypervisor host.
get gateways

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 gateways and stats


Display statistics for all gateways.
get gateways stats

Display a logical router


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

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


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

Display logical router virtual IPs


Display virtual IPs for the specified logical router instance.
get logical-router <gateway_uuid_arg_esx> service virtual-ip (Deprecated)

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)

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 a logical router


Display information about the specified logical router.
get logical-router <uuid-arg> (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 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 information about all logical routers


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

Display logical routers


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

Display logical router summary


Display information about logical routers on this hypervisor 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 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 subnet vlan extension details per vni


Display information about subnet vlan extension for given vni
get subnet-vlan-extension <subnet_vlan_ext_vni_arg_esx>

Display subnet vlan extension mac table for given vni id


Display information about subnet vlan extension for given vni
get subnet-vlan-extension <subnet_vlan_ext_vni_arg_esx> mac-table

Display subnet vlan extension stats per vni


Display information about subnet vlan extension stats for given vni
get subnet-vlan-extension <subnet_vlan_ext_vni_arg_esx> stats

Display subnet vlan extension summary


Display information about subnet vlan extensions on this hypervisor host
get subnet-vlan-extensions

Display Configured Connectivity Policies on CTGW


Display information about connectivity policies under CTGW
get tgw <dpd-uuid-lrouter-arg> connectivity-policy

Display Configured Connectivity Policy on CTGW for a given policy


Display information about connectivity policy under CTGW for a given policy
get tgw <dpd-uuid-lrouter-arg> connectivity-policy <vpc-policy-id>

Display Configured TGWs


Display information about all TGWs.
get tgws

Display transit gateway summary


Display information about transit gateways on this hypervisor host.
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 inter vpc connectivity policy summary for tgw


Display information on inter vpc connectivity polices for tgw.
get tgws <policy-path-string-arg> connectivity-policy

Display inter vpc connectivity policy summary for tgw for given policy id.


Display information on inter vpc connectivity polices for tgw.
get tgws <policy-path-string-arg> connectivity-policy <policy-id-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 virtual IP table entries on the host


Display virtual IP table entries on the host.
get transport-node service-virtual-ip

Display virtual IP table entries on the host


Display virtual IP table entries on the host.
get transport-node service-virtual-ip <ip-address>

Display a service instance


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

Display the forwarding table of a VPC


Display the forwarding table for the specified VPC. Use the get vpcs command to get a list of VPCs and their types.
get vpc <dpd-uuid-lrouter-arg> forwarding

Display VPC high availability state history


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

Display the VPC high availability status


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

Display a service instance


Display information about the specified VPC.
get vpc <vpc-policy-path-string-arg>

Display the forwarding table of a VPC


Display the forwarding table for the specified VPC. Use the get vpcs command to get a list of VPCs and their types.
get vpc <vpc-policy-path-string-arg> forwarding

Display VPC high availability state history


Display the high availability state history for the specified VPC. Only service routers have a high availability status. Use the get vpcs command to get a list of VPCs and their types.
get vpc <vpc-policy-path-string-arg> high-availability history state

Display the VPC high availability status


Display the high availability status for the specified VPC. Only service routers have a high availability status. Use the get vpcs command to get a list of VPCs and their types.
get vpc <vpc-policy-path-string-arg> high-availability status

Display Configured VPCs


Display information about all VPCs.
get vpc-policy-paths

Display vpc gateway summary


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

Display Configured VPCs


Display information about all VPCs.
get vpcs

Display vpc gateway router summary


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

Display connectivity policy summary for vpc


Display information on connectivity polices for vpc.
get vpcs <policy-path-string-arg> connectivity-policy

Display connectivity policy summary for vpc for the given policy id.


Display information on connectivity polices for vpc.
get vpcs <policy-path-string-arg> connectivity-policy <policy-id-arg>

Display Intra connectivity policy workload summary for vpc


Display information on intra connectivity polices workload information for vpc.
get vpcs <policy-path-string-arg> connectivity-policy-workload

Display Intra connectivity policy workload summary for vpc for the given policy id.


Display information on intra connectivity polices workload information for vpc.
get vpcs <policy-path-string-arg> connectivity-policy-workload <policy-id-arg>

Display vpc segment summary


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

Total commands: 72