NSX CLI Guide

Debug Commands


Following is list of Debug commands. To execute debug commands user need to enable debug mode in NSX CLI prompt.

To enter into debug mode command set debug-mode needs to be issued and to exit from debug mode clear debug-mode is required.

Associated Commands:

CLI Description Command

Debug connection with particular port


Issue a debug connection with particular port check.
debug connection <hostname-or-ip-address> port <number>

Delete log files


Delete log files to claim space in /var/log partition.
del files partition log

Get IP address from int


Get IP address from int
get ip from int <int-arg>

Get int from IP


Get int from IP
get int from ip <ip-address>

Get UUID from left and right


Get UUID from left and right
get uuid from left <int-arg> right <int-arg>

Get left and right ints from UUID


Get left and right ints from UUID
get int from uuid <uuid-arg>

Start performance monitoring


Start performance monitoring
start monitor interval <int-arg> count <int-arg> file <filename-arg>

Execute a upgrade step


None
start upgrade-bundle <bundle-name-arg> step <step-name-arg> args <step-args-arg>

List all available commands and scripts in the bundle


None
get upgrade-bundle <bundle-name-arg> commands

Execute a upgrade step without args


None
start upgrade-bundle <bundle-name-arg> step <step-name-arg>

Execute rollback of node upgrade after failed upgrade


Roll back an upgrade with the specified upgrade bundle.
rollback upgrade-bundle <bundle-name-arg>

Execute rollback of node upgrade after successful upgrade


None
rollback node-upgrade

Debug command to swap OS and config partitions


None
swap partitions

Set the Local Controller service component logging level


Set the Local Controller service component logging level
set service local-controller component <local-controller-logging-component-arg> logging-level <edge-service-logging-level-arg>

Set the Dataplane service component logging level


Set the Dataplane service component logging level
set service dataplane component <dataplane-logging-component-arg> logging-level <edge-service-logging-level-arg>

Set the DHCP service component logging level


Set the DHCP service component logging level
set service dhcp component <dhcp-logging-component-arg> logging-level <edge-service-logging-level-arg>

Set IKE service component logging level


Set IKE service component logging level
set service ike component <ike-logging-component-arg> logging-level <edge-service-logging-level-arg>

Set maintenance mode


Enable or disable maintenance mode. Maintenance mode can be used during upgrade and debugging. When an Edge is in maintenance mode only management traffic will be passed; data traffic will be dropped.
set maintenance-mode <enabled-arg>

Set maintenance mode


Enable or disable maintenance mode. Maintenance mode can be used during upgrade and debugging. When an Edge is in maintenance mode only management traffic will be passed; data traffic will be dropped.
set maintenance-mode <enabled-arg> force

Display verbose information of all logical routers


Display verbose information of all logical routers.
get logical-routers verbose

Display Global Replication Mode status


Display information about Global Replication Mode.
get routing-domain global-replication-mode

Display verbose information about logical switches


Display verbose information about all logical switches.
get logical-switches verbose

Display meta-data proxy arp table of logical switch


Display meta-data proxy arp table of logical switch.
get logical-switch md-proxy arp

Display verbose information about segments


Display verbose information about all segments.
get segments verbose

Display meta-data proxy arp table of segment


Display meta-data proxy arp table of segment.
get segment md-proxy arp

Dump Datapath Learning Slowpath Information


Dump Datapath Learning Slowpath Information
get dataplane learning

Shows the logical router's neighbor fib table


Shows the logical router's neighbor fib table
get dataplane logical-router <dpd-uuid-lrouter-arg> forwarding neighbor

Dump the full fib table of the logical router


Dump the full fib table of the logical router
get dataplane logical-router <dpd-uuid-lrouter-arg> forwarding all

Dump Datapath Neighbor Module Information


Dump Datapath Neighbor Module Information
get dataplane neighbor info

Dump Arp Announcement Table


Dump ArpAnnouncement Table
get dataplane announce

Get the route for a specific IP address


Get the route for a specific IP address
get dataplane logical-router <dpd-uuid-lrouter-arg> ip <ip-address>

Get the forwarding port for a specific MAC address


Get the forwarding port for a specific MAC address
get dataplane logical-switch <dpd-uuid-lswitch-arg> mac <hardware-address>

Set maximum number of arp per transport node


Set maximum number of arp per transport node
set dataplane neighbor max-arp-transport-node <max-number-arp-tn-arg>

Set maximum number of arp per logical router


Set maximum number of arp per logical router
set dataplane neighbor max-arp-logical-router <max-number-arp-lr-arg>

Set maximum number of packet held by arp per transport node


Set maximum number of packet held by arp per transport node
set dataplane neighbor max-packet-held-transport-node <max-number-packet-held-tn-arg>

Dump Datapath STT stats


Dump Datapath STT stats
get dataplane stt-stats

Clear Datapath STT stats


Clear Datapath STT stats
clear dataplane stt-stats

Dump Datapath Slowpath stats


Dump Datapath Slowpath stats
get dataplane slowpath-stats

Clear Datapath Slowpath stats


Clear Datapath Slowpath stats
clear dataplane slowpath-stats

Dump datapath flowcache contents to console


Dump datapath flowcache contents to console
get dataplane flow-cache

Dump datapath flowcache contents to file


Dump datapath flowcache contents to file
get dataplane flow-cache file

Shows datapath KNI interfaces and stats


Shows datapath KNI interfaces and stats
get dataplane kni stats

Shows datapath packet queue stats


Shows datappacket queue stats
get dataplane packet-queue stats

Set dataplane corelist


Set dataplane corelist
set dataplane corelist <lcore-list-arg>

Shows datapath interrupt stats per core


Shows datapath interrupt stats per core
get dataplane interrupt stats

Disable service core feature


Disable service core and re-generate config.json.
set dataplane service-core disabled

Enable service core feature


Enable service core feature.
set dataplane service-core enabled

Get IP RSS hash and queue id of a flow


Get IP RSS hash and queue id of a flow
get dataplane ip-rss rxq <num-rxq-arg> src-ip <ip-address> dst-ip <ip-address>

Get TCP/UDP RSS hash and queue id of a flow


Get TCP/UDP RSS hash and queue id of a flow
get dataplane l4-rss rxq <num-rxq-arg> src-ip <ip-address> dst-ip <ip-address> src-port <l4-port-arg> dst-port <l4-port-arg>

Get ESP RSS hash and queue id of a flow


Get ESP RSS hash and queue id of a flow
get dataplane esp-rss rxq <num-rxq-arg> src-ip <ip-address> dst-ip <ip-address> spi <spi-arg>

Shows the logical switches


Shows the logical switches
get logical-switches nsxa

Shows the logical switch with the specific UUID


Shows the logical switch with the specific UUID
get logical-switch <nsxa-uuid-lswitch-arg> nsxa

Shows the logical switch's mac table


Shows the logical switch's mac table
get logical-switch <nsxa-uuid-lswitch-arg> mac-address-table nsxa

Shows the logical switch's vtep table


Shows the logical switch's vtep table
get logical-switch <nsxa-uuid-lswitch-arg> vtep-table nsxa

Shows the logical switch's ports


Shows the logical switch's ports
get logical-switch <nsxa-uuid-lswitch-arg> ports nsxa

Shows the logical switch's tunnel ports


Shows the logical switch's tunnel ports
get logical-switch <nsxa-uuid-lswitch-arg> tunnel-ports nsxa

Shows logical routers


Shows logical routers
get logical-routers nsxa

Shows the logical router with the specific UUID


Shows the logical router with the specific UUID
get logical-router <nsxa-uuid-lrouter-arg> nsxa

Shows the logical router's ports


Shows the logical router's ports
get logical-router <nsxa-uuid-lrouter-arg> interfaces nsxa

Shows the logical router's fib table


Shows the logical router's fib table
get logical-router <nsxa-uuid-lrouter-arg> forwarding nsxa

Shows the logical router's rib table


Shows the logical router's rib table
get logical-router <nsxa-uuid-lrouter-arg> ip rib nsxa

Shows logical switch ports


Shows logical switch ports
get logical-switch ports nsxa

Shows the specific logical switch port


Shows the specific logical switch port
get logical-switch port <nsxa-uuid-lswitch-port-arg> nsxa

Shows tunnel ports


Shows tunnel ports
get tunnel-ports nsxa

Shows the specific tunnel port


Shows the specific tunnel port
get tunnel-port <nsxa-uuid-tunnel-port-arg> nsxa

Shows the logical router ports


Shows the logical router ports
get logical-router interfaces nsxa

Shows the specific logical router port


Shows the specific logical router port
get logical-router interface <nsxa-uuid-lrouter-port-arg> nsxa

Shows all vteps


Shows all vteps
get vteps nsxa

Display routing domain


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

Display a routing domain


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

Get local-controller service full state


Display the full state of the local controller service.
get service local-controller state dump

Get edge-client statistics


Get edge-client statistics
get edge-client stats

Show BGP keepalive miss debugging configuration


Show BGP keepalive miss debugging configuration
get routing debug keepalive-miss all

Disable BGP keepalive miss debugging configuration


Disable BGP keepalive miss debugging configuration
clear routing debug keepalive-miss all

Get the internal routing running configuration


Display the routing running configuration.
get service router running-config

Show engine config for the specified load balancer


Show engine config for the specified load balancer.
get load-balancer <uuid-string-arg> engine-config

Show session statistics for all load balancer services


Show session statistics for all load balancer services.
get load-balancers stats

Show verbose debugging statistics for all load balancer services


Show verbose debugging statistics for all load balancer services.
get load-balancers stats verbose

Show verbose debugging statistics for the specified load balancer service


Show verbose debugging statistics for the specified load balancer service.
get load-balancer <uuid-string-arg> stats verbose

List namespaces that contain load balancer services


List namespaces that contain load balancer services.
get namespaces

Show network config for namespaces containing load balancer services


Show network config for namespaces containing load balancer services.
get namespace <uuid-string-arg> network-config

Show processes for namespaces containing load balancer services


Show processes for namespaces containing load balancer services.
get namespace <uuid-string-arg> processes

Show interfaces for namespaces containing load balancer services


Show interfaces for namespaces containing load balancer services.
get namespace <uuid-string-arg> interfaces

Show interfaces stats for namespaces containing load balancer services


Show interfaces stats for namespaces containing load balancer services.
get namespace <uuid-string-arg> interfaces stats

Show network statistics for namespaces containing load balancer services


Show network statistics for namespaces containing load balancer services.
get namespace <uuid-string-arg> network-stats

Show routes for namespaces containing load balancer services


Show routes for namespaces containing load balancer services.
get namespace <uuid-string-arg> routes

Show arp entries for namespaces containing load balancer services


Show arp entries for namespaces containing load balancer services.
get namespace <uuid-string-arg> arp-table

Show sockets for namespaces containing load balancer services


Show sockets for namespaces containing load balancer services.
get namespace <uuid-string-arg> sockets

Show load balancer shared memory


Display a specific load balancer shared memory.
get load-balancer <lb-uuid-arg> shared-memory

Show load balancer members' state


Display a specific load balancer members' state.
get load-balancer <lb-uuid-arg> pool <pool-uuid-arg> members-state

Display IKE service status


Display IKE service status.
get ipsecvpn service state

Start ACL counters


Start all the ACL counters.
start dataplane acl-counter

Stop ACL counters


Stop all the ACL counters.
stop dataplane acl-counter

Get ACL counter stats


Get the stats of all the ACL counters.
get dataplane acl-counter stats

Get ACL counter stats of logical router port


Get the stats of the ACL counters of specific logical router port
get dataplane acl-counter stats interface <dpd-uuid-lrouter-port-arg>

Get ACL counter stats of logical switch port


Get the stats of the ACL counters of specific logical switch port
get dataplane acl-counter stats port <dpd-uuid-lswitch-port-arg>

Get ACL counter stats of tunnel port


Get the stats of the ACL counters of specific tunnel port
get dataplane acl-counter stats tunnel <dpd-uuid-tunnel-port-arg>

Get ACL counter IPv4 stats


Get the stats of an IPv4 rule for the ACL counters.
get dataplane acl-counter stats ipv4 proto <ip-proto> src-ip <ipv4-addr> dst-ip <ipv4-addr>

Get ACL counter IPv6 stats


Get the stats of an IPv6 rule for the ACL counters.
get dataplane acl-counter stats ipv6 proto <ip-proto> src-ip <ipv6-addr> dst-ip <ipv6-addr>

Get ACL counter IPv4 interval stats


Get the stats of an IPv4 rule for the ACL counters within a certain interval.
get dataplane acl-counter stats ipv4 proto <ip-proto> src-ip <ipv4-addr> dst-ip <ipv4-addr> from <iso-8601> until <iso-8601>

Get ACL counter IPv6 interval stats


Get the stats of an IPv6 rule for the ACL counters within a certain interval.
get dataplane acl-counter stats ipv6 proto <ip-proto> src-ip <ipv6-addr> dst-ip <ipv6-addr> from <iso-8601> until <iso-8601>

Get ACL counter rules


Get the rules of all the ACL counters.
get dataplane acl-counter rules

Set ACL counter IPv4 rules


Set an IPv4 rule for the ACL counters.
set dataplane acl-counter rules ipv4 proto <ip-proto> src-ip <ipv4-addr> dst-ip <ipv4-addr>

Set ACL counter IPv4 rules


Set an IPv4 rule for the ACL counters.
set dataplane acl-counter rules ipv4 proto <ip-proto> src-ip <ipv4-addr> dst-ip <ipv4-addr> src-port <l4-port-any>

Set ACL counter IPv4 rules


Set an IPv4 rule for the ACL counters.
set dataplane acl-counter rules ipv4 proto <ip-proto> src-ip <ipv4-addr> dst-ip <ipv4-addr> dst-port <l4-port-any>

Set ACL counter IPv4 rules


Set an IPv4 rule for the ACL counters.
set dataplane acl-counter rules ipv4 proto <ip-proto> src-ip <ipv4-addr> dst-ip <ipv4-addr> src-port <l4-port-any> dst-port <l4-port-any>

Set ACL counter IPv6 rules


Set an IPv6 rule for the ACL counters.
set dataplane acl-counter rules ipv6 proto <ip-proto> src-ip <ipv6-addr> dst-ip <ipv6-addr>

Set ACL counter IPv6 rules


Set an IPv6 rule for the ACL counters.
set dataplane acl-counter rules ipv6 proto <ip-proto> src-ip <ipv6-addr> dst-ip <ipv6-addr> src-port <l4-port-any>

Set ACL counter IPv6 rules


Set an IPv6 rule for the ACL counters.
set dataplane acl-counter rules ipv6 proto <ip-proto> src-ip <ipv6-addr> dst-ip <ipv6-addr> dst-port <l4-port-any>

Set ACL counter IPv6 rules


Set an IPv6 rule for the ACL counters.
set dataplane acl-counter rules ipv6 proto <ip-proto> src-ip <ipv6-addr> dst-ip <ipv6-addr> src-port <l4-port-any> dst-port <l4-port-any>

Delete ACL counter IPv4 rules


Delete an IPv4 rule for the ACL counters.
del dataplane acl-counter rules ipv4 proto <ip-proto> src-ip <ipv4-addr> dst-ip <ipv4-addr>

Delete ACL counter IPv4 rules


Delete an IPv4 rule for the ACL counters.
del dataplane acl-counter rules ipv4 proto <ip-proto> src-ip <ipv4-addr> dst-ip <ipv4-addr> src-port <l4-port-any>

Delete ACL counter IPv4 rules


Delete an IPv4 rule for the ACL counters.
del dataplane acl-counter rules ipv4 proto <ip-proto> src-ip <ipv4-addr> dst-ip <ipv4-addr> dst-port <l4-port-any>

Delete ACL counter IPv4 rules


Delete an IPv4 rule for the ACL counters.
del dataplane acl-counter rules ipv4 proto <ip-proto> src-ip <ipv4-addr> dst-ip <ipv4-addr> src-port <l4-port-any> dst-port <l4-port-any>

Delete ACL counter IPv6 rules


Delete an IPv6 rule for the ACL counters.
del dataplane acl-counter rules ipv6 proto <ip-proto> src-ip <ipv6-addr> dst-ip <ipv6-addr>

Delete ACL counter IPv6 rules


Delete an IPv6 rule for the ACL counters.
del dataplane acl-counter rules ipv6 proto <ip-proto> src-ip <ipv6-addr> dst-ip <ipv6-addr> src-port <l4-port-any>

Delete ACL counter IPv6 rules


Delete an IPv6 rule for the ACL counters.
del dataplane acl-counter rules ipv6 proto <ip-proto> src-ip <ipv6-addr> dst-ip <ipv6-addr> dst-port <l4-port-any>

Delete ACL counter IPv6 rules


Delete an IPv6 rule for the ACL counters.
del dataplane acl-counter rules ipv6 proto <ip-proto> src-ip <ipv6-addr> dst-ip <ipv6-addr> src-port <l4-port-any> dst-port <l4-port-any>

Clear ACL counter rules


Clear the rules for the ACL counters.
clear dataplane acl-counter rules

Set statistics update interval


Set the interval between statistics updates. The old stats will be deleted.
set dataplane stats interval <stats-interval>

Get service opsagent workflow stats


Get service opsagent workflow stats.
get service nsx-opsagent lib-wft stats

Reload controller list in host


Reload the controller list from configuration file in the host.
set nsx-proxy controllers file <controller-config-file>

Delete transport node and clear remote config data in nestdb


Delete transport node and clear remote config data in nestdb.
del transport-node

Get routing domain remote vtep


Get routing domain remote vtep.
get routing-domain remote vtep-cache <routing-id>

Get routing domain local vtep


Get routing domain local vtep.
get routing-domain local vtep-cache <routing-id>

Get service netopa collector addr config


Get service netopa collector addr config.
get service nsx-netopa collector

Set multiple addr config for netopa with format "ip1:port1,ip2:port2..."


Set multiple addr config for netopa.
set service nsx-netopa collector <netopa-collector-addr-config-list-arg>

Clear service netopa collector addr config


Clear service netopa collector addr config.
clear service nsx-netopa collector

Get service netopa fsm status


Get service netopa fsm status.
get service nsx-netopa fsm status

Get service netopa maximum fragment size config


Get service netopa maximum fragment size config.
get service nsx-netopa fragment

Set service netopa maximum fragment size config


Set service netopa maximum fragment size config.
set service nsx-netopa fragment <netopa-max-fragment-config-arg>

Get service netopa collector poll-interval config


Get service netopa collector poll-interval config.
get service nsx-netopa poll-interval

Set service netopa collector poll-interval config


Set service netopa collector poll-interval config.
set service nsx-netopa poll-interval <netopa-collector-interval-config-config-arg>

Display verbose information of all gateways


Display verbose information of all gateways.
get gateway verbose

Display the stats of all ifaces in the path


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

Display routes for BGP VPN per address family


Display routes for BGP VPN per address family.
get bgp vpn <ip-version>

Turn on all routing debug options


Turn on all routing debug options.
set routing debug all

Turn off all routing debug options


Turn off all routing debug options.
clear routing debug all

Turn on BGP debug options


Turn on BGP debug options.
set routing debug bgp <edge-routing-bgp-debug-arg>

Turn off BGP debug options


Turn off BGP debug options.
clear routing debug bgp <edge-routing-bgp-debug-arg>

Turn on all BGP debug options


Turn on all BGP debug options.
set routing debug bgp all

Turn off all BGP debug options


Turn off all BGP debug options.
clear routing debug bgp all

Turn on MRoute debug option


Turn on MRoute debug option.
set routing debug mroute

Turn off MRoute debug option


Turn off MRoute debug option.
clear routing debug mroute

Turn on OSPF debug option


Turn on OSPF debug option.
set routing debug ospf

Turn off OSPF debug option


Turn off OSPF debug option.
clear routing debug ospf

Turn on PIM debug options


Turn on PIM debug options.
set routing debug pim <edge-routing-pim-debug-arg>

Turn off PIM debug options


Turn off PIM debug options.
clear routing debug pim <edge-routing-pim-debug-arg>

Turn on IGMP debug options


Turn on IGMP debug options.
set routing debug igmp <edge-routing-igmp-debug-arg>

Turn off IGMP debug options


Turn off IGMP debug options.
clear routing debug igmp <edge-routing-igmp-debug-arg>

Turn on route map debug option


Turn on route map debug option.
set routing debug route-map

Turn off route map debug option


Turn off route map debug option.
clear routing debug route-map

Turn on Zebra debug options


Turn on Zebra debug options.
set routing debug zebra <edge-routing-zebra-debug-arg>

Turn off Zebra debug options


Turn off Zebra debug options.
clear routing debug zebra <edge-routing-zebra-debug-arg>

Show BGP debugging


Show BGP debugging.
get routing debug bgp

Show OSPF debugging


Show OSPF debugging.
get routing debug ospf

Rescan interfaces from all Tier0 vrfs


Rescan interfaces from all Tier0 vrfs
start rescan interfaces

Enable BGP neighbor session diagnostics


Enable BGP neighbor session diagnostics
set routing debug session-diagnostics neighbor <ip46-address>

Disable BGP neighbor session diagnostics


Disable BGP neighbor session diagnostics
del routing debug session-diagnostics neighbor <ip46-address>

Enable BGP keepalive miss debugging on all neighbors configured in the vrf


Enable BGP keepalive miss debugging on all neighbors configured in the vrf
set routing debug keepalive-miss all trigger <trigger-arg>

Enable BGP keepalive miss debugging on specific neighbor


Enable BGP keepalive miss debugging on specific neighbor
set routing debug keepalive-miss neighbor <ip46-address> trigger <trigger-arg>

Disable BGP keepalive miss debugging on all neighbors configured in the vrf


Disable BGP keepalive miss debugging on all neighbors configured in the vrf
del routing debug keepalive-miss all

Disable BGP keepalive miss debugging on specific neighbor


Disable BGP keepalive miss debugging on specific neighbor
del routing debug keepalive-miss neighbor <ip46-address>

Show BGP keepalive miss debugging configuration in the vrf


Show BGP keepalive miss debugging configuration in the vrf
get routing debug keepalive-miss vrf

Get routing state history


Get the routing state history.
get routing state history

Get routing state information


Get the routing state information.
get routing state

Show routing global config


Display Routing Global config from nestdb.
get routing-config routing-global

Show BGP config


Display BGP config from nestdb.
get routing-config bgp

Show all BGP neighbors config


Display all BGP neighbors config from nestdb.
get routing-config bgp-neighbor

Show specific BGP neighbor config


Display a specific BGP neighbor config from nestdb.
get routing-config bgp-neighbor <uuid-string-arg>

Show all static route config


Display all static route config from nestdb.
get routing-config static-route

Show specific static route config


Display specific static route config from nestdb.
get routing-config static-route <uuid-string-arg>

Show all route-map config


Display all route-maps config from nestdb.
get routing-config route-map

Show specific route-map config


Display specific route-map config from nestdb.
get routing-config route-map <uuid-string-arg>

Show all prefix-lists config


Display all prefix-lists config from nestdb.
get routing-config prefix-list

Show specific prefix-list config


Display specific prefix-list config from nestdb.
get routing-config prefix-list <uuid-string-arg>

Show Redistribution config


Display redistribution config from nestdb.
get routing-config redistribution

Show all redistribution rule config


Display all redistribution rule config from nestdb.
get routing-config redistribution-rules

Show all mpls-vrf config


Display all mpls-vrf config from nestdb.
get routing-config mpls-vrf

Show msr-db runtime information


Display msr-db runtime information.
get routing-config msrdb

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

Display the current port or interface


Display information about the current interface.
get current

Display the parent of current port or interface


Display the parent of the current interface.
get parent

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

Move up the path


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

Move down the path


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

Move to the bottom of the path


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

Move to the top of the path


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

Display BGP VPN routes for a VRF and it's shadow VRF in internal debug context


Display BGP VPN routes for a VRF and it's shadow VRF in internal debug context.
get bgp vpn <ip-version> vrfid <vrf-id>

Display BGP VPN routes for a VRF and it's shadow VRF in internal debug context


Display BGP VPN routes for a VRF and it's shadow VRF in internal debug context.
get bgp vpn <ip-version> rd <rd-arg>

Dump all TransportNode connection event statuses into a file


Dump all TransportNode connection event statuses into a file.
get alarm tn-connection-event-status dump <filename-arg>

Dump all Group Alarm event statuses into a file


Dump all all Group Alarm event event statuses into a file.
get alarm group-alarm-event-status dump <filename-arg>

Dump all alarm event status into a file


Dump all alarm event status into a file
get alarm all-alarm-event-status dump <filename-arg>

Dump all unresolved alarm into a file


Get unresolved alarm
get unresolved alarm dump <filename-arg>

Get alarm master


Get alarm master
get alarm master

Dump adaptor ufo related info to a file


Dump adaptor ufo related info to a file.
get adaptor-ufo dump <filename-arg>

Force adaptor ufo to conduct a fullsync with the UFO Config Store


Force adaper ufo to conduct a fullsync with the UFO Config Store
get adaptor-ufo forcesync

Display the fullsync status of the ufo adaptor


Display the fullsync status of the ufo adaptor
get adaptor-ufo fullsync

Lookup an message received by the ufo-adaptor by id


Lookup an message received by the ufo-adaptor by id
get adaptor-ufo lookup <data-id-arg>

Display counts by message count in ufo adaptor


Display counts by message count in ufo adaptor
get adaptor-ufo count

Display Ufo transactions info


Display pending Ufo transactions count and latest Ufo transaction id.
get adaptor-ufo transactioninfo

Force to announce CCP info.


Force to write CCP info into UFO table ClusterNodeConfigModel.
set ccp-info

Force to announce custom ipv4 CCP address.


Force to announce user provided ipv4 CCP address into UFO table ClusterNodeConfigModel.
set custom-ccp-address-ipv4 <ip46-address>

Force to announce custom ipv6 CCP address.


Force to announce user provided ipv6 CCP address into UFO table ClusterNodeConfigModel.
set custom-ccp-address-ipv6 <ip46-address>

Dump info for an individual handler to a file


Dump info for an individual handler to a file. Note that this may be too much information to be used for support bundles, but useful for debugging a live setup.
get adaptor-ufo-postprocessor <postprocessor-handler> dump <filename-arg>

Dump info for an individual handler to a file


Dump info for an individual handler to a file. Note that this may be too much information to be used for support bundles, but useful for debugging a live setup.
get adaptor-ufo-preprocessor <preprocessor-handler> dump <filename-arg>

Get debug data for an element by id


Display information about the specified object in the data layer, including information about its mediator lookup, domain object, span, nestdb span, and pigeon span.
get debug-data <uuid-arg>

Get debug data for an element by id plus tn status


Display information about the specified object in the data layer, including information about its mediator lookup, domain object, span, nestdb span, and pigeon span. In addition to this information, either the current status of the specified transport node will be returned or a message stating that the transport node is not within the span of the specified object.
get debug-data <uuid-arg> transport-node <uuid-arg>

Show all existing data in evaluator


Display all groups and inventory data in evaluator.
get cgroups group-evaluator <filename-arg>

Show all cache entry data in rooster


Display all groups and inventory data in evaluator.
get cgroups rooster <filename-arg>

Lookup dynamic group evaluator results


Display dynamic group evaluator members.
get cgroups group-evaluator lookup <group-id>

Show the container translation in the container cache


Display the translations in the container cache for the specified Container/LogicalSwitch/LogicalSwitchPort/FilterSpan.
get cgroup <entity-id> translated

Show the container translation summary from the container cache


Display the translations summary in the container cache for the specified Container/LogicalSwitch/LogicalSwitchPort/FilterSpan.
get cgroup <entity-id> translated summary

Show the group statistics


Display the group statistics.
get groups stats

Get all DAD status


Display information about all DAD status
get dad-status all

Get DAD status for a logical router port


Display information about DAD status for a logical router port.
get dad-status <uuid-arg>

Dump DAD status related info to a file


Dump DAD status related info to a file.
get dad-status dump <filename-arg>

Get information about the controller with master IPAM service


Display information about the controller with master IPAM service
get dhcp ipam master

Show configurations for a DHCP server/subnet


Display IDs of configuration entities associated with the DHCP server/subnet
get dhcp server <dhcp-uuid-arg>

Show all client ports under a DHCP server/subnet


Display all client ports under a DHCP server/subnet including its status, allocated IP, etc.
get dhcp ports <dhcp-uuid-arg>

Show a client port under a DHCP server/subnet


Display a client port under a DHCP server/subnet including its status, allocated IP, consumed IP, etc.
get dhcp port <dhcp-uuid-arg>

Show all dynamically assigned IPs under a DHCP server/subnet


Display all dynamically assigned IPs under a DHCP server/subnet
get dhcp dynamic-ips <dhcp-uuid-arg>

Show all IP bindings that do not belong under an existing DHCP server/subnet


Display all IP bindings that do not belong under an existing DHCP server/subnet
get dhcp orphan-ips

Write data dump of DHCP data


Display all DHCP LS, LSP, and IP binding data
get dhcp dump <filename-arg>

Get IP discovery effective profile for a logical switch port


Display IP discovery effective profile ID for a logical switch port.
get ip-discovery effective-profile <uuid-arg>

Get IP discovery Profile details info and Precedence Per Applied To for profile id.


Display IP discovery Profile details info and Precedence Per Applied To for profile id.
get ip-discovery profile-and-pat <uuid-arg>

Get detailed effective profile info given a lsp id


Get detailed effective profile info given a lsp id.
get ip-discovery effective-profile-verbose <uuid-arg>

Dump IP discovery effective profile for all logical switch ports to a file


Dump IP discovery effective profile for all logical switch ports to a file.
get ip-discovery effective-profile dump <filename-arg>

Dump persisted bindings for all logical switch ports to a file


Dump persisted bindings for all logical switch ports to a file.
get ip-discovery all-persisted-bindings dump <filename-arg>

Dump log switch port bindings for all logical switch ports to a file


Dump log switch port bindings for all logical switch ports to a file.
get ip-discovery all-log-switch-port-bindings dump <filename-arg>

Display internal routes info on the specified logical router


Display internal routes info on the specified logical router.
get logical-router <logical-router-id> routes-info

Get the service routers in the cluster


Get the service routers in the cluster.
get srcluster <uuid-arg> routers

Get the service routers in all clusters


Get the service routers in all cluster.
get srclusters routers

Get the routing config for sr routers in the cluster


Get the routing config for sr routers in the cluster.
get srcluster <uuid-arg> routing-config

Display statistics information about the specified logical switch over time


Display statistics information about the specified logical switch over time.
get logical-switch <vni-or-uuid-arg> stats-sample

Display a summary of all logical switch statistics over time


Display a summary of all logical switch statistics over time.
get logical-switches stats-sample

Dump lsp bindings to a file


Dump lsp bindings to a file.
get lsp-bindings-persistence dump <filename-arg>

Get LSP bindings for a given LSP ID


Get LSP bindings for a given LSP ID
get lsp-bindings-for-lsp <uuid-arg>

Get LSP bindings for a given LS ID


Get LSP bindings for a given LS ID
get lsp-bindings-for-ls <uuid-arg>

Enable wavefront


Enable wavefront for given proxy host, port and source name combination.
set wavefront on <host-name> <port-num> <source-name>

Disable wavefront


Disable wavefront.
set wavefront off

Get UUID of the master controller for the provided logical entity


Display information about the master controller for the specified object
get master <uuid-arg>

Dump the master controller details for all TNs into a file


Dump the master controller details for all TNs into a file
get master all-transport-nodes dump <filename-arg>

Get UUID and IP of the current controller node


Display information about the current controller
get controller-info

Get CCP node maintenance mode status


Display information about CCP nodes maintenance mode status
get ccp maintenance-mode status

Force ccp cluster to start a sharding change


Force ccp cluster to start a sharding change, testing purpose only
set cluster sharding-change

Lookup data summary for the receiver


Display data summary for the specified receiver.
get data summary with receiver <uuid-arg>

Show the datum ID(s) and detailed message(s) for the message ID


Display the datum ID(s) and detailed message(s) for the specified message ID.
get data <data-id-arg> verbose

Dump nestdb-pigeon datum(s) to a file


Dump nestdb-pigeon datum(s) to a file.
get all data <filename-arg>

Dump nestdb-pigeon datum(s) for a receiver to a file


Dump nestdb-pigeon datum(s) for a receiver to a file.
get data dump with receiver <uuid-arg> <filename-arg>

Get all connected receivers and synchronization status


Display all connected receivers and synchronization status.
get receivers verbose

Get LogRouterPortDadStateMsg reported by a transport node


Get LogRouterPortDadStateMsg reported by a transport node.
get lrp-dad-state <uuid-arg>

Show all LogRouterPortDadStateMsg from replication service into a file


Show all LogRouterPortDadStateMsg from replication service into a file.
get all lrp-dad-state <filename-arg>

Show all realization status information to a file


Show all realization status information to a file.
get all realization-status <filename-arg>

Enable controller profiler


Enable controller profiler.
set service controller profiler enabled

Disable controller profiler


Disable controller profiler.
set service controller profiler disabled

Get the status (Enabled/Disabled) of controller profiler


Get the status (Enabled/Disabled) of controller profiler.
get service controller profiler status

Enable profiler memory allocation recording


Enable profiler memory allocation recording.
set service controller profiler memory-profiling enabled

Disable profiler memory allocation recording


Disable profiler memory allocation recording.
clear service controller profiler memory-profiling enabled

Enable profiler cpu sampling recording


Enable profiler cpu sampling recording.
set service controller profiler cpu-profiling enabled

Disable profiler cpu sampling recording


Disable profiler cpu sampling recording.
clear service controller profiler cpu-profiling enabled

Start recording snapshots periodically


Start recording snapshots periodically.
get service controller profiler snapshot <number-iteration> <frequency-in-seconds>

Get profiler config status


Get profiler config status.
get service controller profiler config status

Take memory detail included snapshot


Take memory detail included snapshot.
get service controller profiler memory-dump-snapshot

Dump DDLog snapshot of routing domain module


Dump DDLog snapshot of routing domain module
get routing-domain ddlog-snapshot <filename-arg>

Get all service chains


Display information about all service chains
get all service-chains

Get all service paths


Display information about all service paths.
get all service-paths

Get service paths for a service chain


Display information about service paths for a service chain.
get service-paths with service-chain <uuid-arg>

Get service paths for a service vm


Display information about service paths for a service vm.
get service-paths with service-vm <uuid-arg>

Get all service VMs


Display information about all service VMs.
get all service-vms

Dump service insertion related info a file


Dump service insertion related info a file.
get service-insertion dump <filename-arg>

Show if the site proxy has enabled.


Display Enabled if site-proxy has been enabled, else Disabled.
get site-replicator site-proxy status

Dump remote site data present in the local sites TX and RX table.


Dump remote site data present in the TX and RX tables of the local site.
get site-replicator site-data site <uuid-arg> <local-filename-arg> <remote-filename-arg>

Dump out all data in local sites RX store.


Dump out all data present in the local sites RX store.
get site-replicator replicated-site-info <filename-arg>

Request a force sync of message identified by specified object id and type to the specified remote site.


Request a force sync of message identified by specified object id and type to the specified remote site.
start site-replicator force-sync <uuid-arg> <object-type> <string-arg>

Get detailed remote site status.


Get all remote site status for all the known sites.
get site-replicator remote-sites debug

Reset timestamp of a given remote record.


Reset timestamp of a given remote record.
set timestamp site <uuid-arg> record-address <record-address-arg> with-current-time <boolean-arg>

Reset timestamp of all records for a given logical switch.


Reset timestamp of all records for a given logical switch.
set timestamp site <uuid-arg> logical-switch <uuid-arg> with-current-time <boolean-arg>

Display span info of config app


Display span information about the specified entity of config app
get config-span span <entity-id>

Display adjacent nodes in directed graph based span computer


Display adjacent nodes about the specified entity of config app
get config-span adjacent-nodes <entity-id>

Display topology in directed graph based span computer


Display topology information about config span graph from specified entity
get config-span topology <entity-id> <max-distance> <find-ancestors> <find-descendants>

Dump config span graph and related span table into file


Dump config span graph and related span table into file
get config-span dump <filename-arg>

Dump dependency span graphs


Dump dependency span graphs
get dag-span-graph dump <filename-arg>

Dump DDLog snapshot of span computer(s)


Dump DDLog snapshot of span computer(s)
get span ddlog-snapshot <filename-arg>

Get span of domain object by id


Display the span of a domain object
get span <entity-id>

Given a logical router uuid and Vif id, find the possible path between them


print path and relationship between logical router and vif
get path <logical-router-id-arg> <vif-id>

Display external IP and internal IP of LSP


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

Display external IP and internal IP of existing LSPs


Display external IP and internal IP of existing LSPs.
get lsp-eip-bindings dump <filename-arg>

Display all existing DTGW DR UUIDs


Display all existing DTGW DR UUIDs.
get dtgw-drs

Display all LS UUIDs under DTGW DR


Display all LS UUIDs under DTGW DR.
get dtgw-dr-ls <dtgw-dr-uuid>

Display NAT config detail of DTGW DR


Display NAT config detail of DTGW DR.
get dtgw-dr-nat-config <dtgw-dr-uuid>

Dump DTGW NAT configuration details of existing DTGW DRs to a file


Dump DTGW NAT configuration details of existing DTGW DRs to a file.
get dtgw-dr-nat-configs dump <filename-arg>

Display all existing TGW Container UUIDs based on type


Display all existing TGW Container UUIDs based on type.
get tgw-containers

Display the TGW Container IP members and TGW Container type


Display the TGW Container IP members and TGW Container type.
get tgw-container <tgw-container-uuid> ip members

Display IP members of the LSP used by the TGW Container


Display IP members of the LSP used by the TGW Container. If TGW Container is public IP Container, the external IP is used. If TGW Container is Internal IP Container, the internal IP is used.
get tgw-container <tgw-container-uuid> ip member details

Dump tgw-container details of existing tgw-containers


Dump tgw-container details of existing tgw-containers.
get tgw-containers dump <filename-arg>

Dump Lcp Daemon Monitor data to a file


Dump Lcp Daemon Monitor data to a file.
get lcpdaemons dump <filename-arg>

Reset timestamps for all data reported by a transport node


Reset timestamps for all data reported by a transport node.
reset transport-node-data timestamp <transport-node-id> with-current-time <boolean-arg>

Reset timestamps for logical entity data reported by a transport node


Reset timestamps for logical entity data reported by a transport node.
reset logical-entity-data timestamp <transport-node-id> <logical-entity-id> with-current-time <boolean-arg>

Display current handshake state for the specified transport node.


Display current handshake state for the specified transport node.
get transport-node <uuid-arg> handshake state

Dump current handshake state for all transport nodes.


Dump current handshake state for all transport nodes in a specified file.
get transport-nodes handshake state dump <filename-arg>

Get current handshake state for all transport nodes.


Get current handshake state for all transport nodes.
get transport-nodes handshake state

Setting transaction log turned on or off


None
set transaction-log <onoffknob> <transactionlog>

Dump Falcon registry to file


Dump Falcon registry to file
get falcon dump <filename-arg> <max-output-level>

Get Falcon child relations for a specified ID.


Get Falcon child relations upto a maximum depth of 3 for a specified ID.
get falcon children <domain-object-id> <max-output-level>

Display Falcon transactions info


Display pending falcon transactions count and latest falcon transaction id.
get falcon transactioninfo

Get DR-related VmTag info with the given external Id


Get DR-related VmTag info with the given external Id.
get federation-srm vm-tag <string-arg>

Get DR policy info with the given DrPolicy UUID


Get DR policy info with the given DrPolicy UUID.
get federation-srm dr-policy <uuid-arg>

Dump all DR-related VmTag info into a file


Dump all DR-related VmTag info into a file.
get federation-srm vm-tag dump <filename-arg>

show keep alive on/off status


Shows whether keep alive mechanism is turned on or off.
get transport-channel keep-alive-status

show inactivity timeout in seconds


Shows the current value of inactivity timeout in seconds.
get transport-channel inactivity-timeout

show keep alive response timeout in seconds


Shows the current value of keep alive response timeout in seconds.
get transport-channel keep-alive-response-timeout

set keep alive on/off status


Turns keep alive mechanism on or off.
set transport-channel keep-alive-status <onoffknob>

set inactivity timeout value in seconds


Sets the inactivity timeout value.
set transport-channel inactivity-timeout <channel-timeout>

set the keep alive response timeout value in seconds


Sets the keep alive response timeout value.
set transport-channel keep-alive-response-timeout <channel-timeout>

Dumps transport-channel rpc dump into a file


Dumps transport-channel rpc data in the given file path
get transport-channel rpc-dump <filename-arg>

Dump all TransportNode data from replication service into a file


Dump all TransportNode data from replication service into a file.
get replication all-transport-node-data dump <filename-arg>

Get TransportNode data from replication service with UUID


Get TransportNode data from replication service with UUID.
get replication transport-node-data <transport-node-id>

Set TransportNode disconnect mac data timeout by days


Set TransportNode disconnect mac data timeout by days.
set mac-table timeout <timeout-value> day

Set TransportNode disconnect vtep data timeout by days


Set TransportNode disconnect vtep data timeout by days.
set vtep-table timeout <timeout-value> day

Get TransportNode disconnect mac data timeout in days


Get TransportNode disconnect mac data timeout in days.
get mac-table timeout

Get TransportNode disconnect vtep data timeout in days


Get TransportNode disconnect vtep data timeout in days.
get vtep-table timeout

Dump all tn disconnect timeout value from replication service into a file


Dump all tn disconnect timeout value from replication service into a file.
get all-timeout-value dump

Set TransportNode disconnect mac data timeout by hours


Set TransportNode disconnect mac data timeout by hours.
set mac-table timeout <timeout-value> hour

Set TransportNode disconnect vtep data timeout by hours


Set TransportNode disconnect vtep data timeout by hours.
set vtep-table timeout <timeout-value> hour

Display statistics information about the specified segment over time


Display statistics information about the specified segment over time.
get segment <vni-or-uuid-arg> stats-sample

Display a summary of all segment statistics over time


Display a summary of all segment statistics over time.
get segments stats-sample

Show the group translation in the group cache


Display the translations in the container cache for the specified Container/Segment/SegmentPort/FilterSpan.
get group <entity-id> translated

Show the group translation summary from the group cache


Display the translations summary in the container cache for the specified Container/LogicalSwitch/LogicalSwitchPort/FilterSpan.
get group <entity-id> translated summary

Debug manager connection


Issue a debug manager connection with reachability and port check.
debug manager <hostname-or-ip-address>

Get edge support bundles parsed


Get edge support bundles parsed
get edges

Set edge to be used by the offline cli backend tool


Set edge to be used by the offline cli backend tool
set edge <uuid-arg>

Enter support bundle 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 on an edgenode. You can get edge nodes using get edges. You can set an edge using set edge uuid. You can get a list of logical router interfaces with the get logical-router interfaces command. Then you can run offlinepath node_id lrport ip

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.

offlinepath <uuid-arg> <uuid-arg> <ip46-address>

Enter the inter-SR VRF context


Enter the inter-SR VRF context.
vrf internal

Set packet type statistics mode


Enable or disable packet type statistics.
set dataplane packet-type-stats-mode <enabled-arg>

Get packet type statistics mode


Get packet type statistics mode.
get dataplane packet-type-stats-mode

Set maintenance mode


Enable or disable maintenance mode. Maintenance mode can be used during upgrade and debugging. When an TN is in maintenance mode only management traffic will be passed; data traffic will be dropped.
set maintenance-mode <nsxproxy-maintenance-mode-arg>

Get service cfgagent workflow stats


Get service cfgagent workflow stats.
get service nsx-cfgagent lib-wft stats

Set service cfgagent simulate out of sync


Set service cfgagent simulate out of sync.
set service nsx-cfgagent simulate out-of-sync <cfgagent-vertical-name-arg>

Display firewall vsipioctl info


Display firewall vsipioctl info.
get firewall vsipioctl <vsip_commands> [<vsip_param>]

Display firewall ipfix VIF mapping


Display firewall ipfix VIF mapping.
get firewall ipfix-vifmap

Enable NSX DPI Debug


Enable NSX DPI Debug.
set dpi debug enable

Disable NSX DPI Debug


Disable NSX DPI Debug.
set dpi debug disable

Clear NSX VM Agent State


Clear NSX VM Agent State
clear nsx-vm-agent state

Start the VM agent upgrade from a local install bundle


Start the VM agent upgrade from a local install bundle
start upgrade <version-number> file <filename-arg>

Start the VM agent upgrade using the bundle from the Public Cloud Gateway


Start the VM agent upgrade using the bundle from the Public Cloud Gateway
start upgrade <version-number>

Dump full sync status


Dump full sync status
get gateway full-sync status

Get troubleshoot properties from the firewall


Get troubleshoot properties from the firewall.
get firewall troubleshoot-properties

Display hosts upgrade status


Display the list of hosts
rollback get-hosts

Host Rollback


Perform a rollback of the specified host machines. You need to specify the id of the NSX host to rollback.

Get the host id by running the rollback get-hosts command.

rollback host <host-uuid> username <host-username>

Host Rollback


Perform a rollback of the specified host machines. You need to specify the id of the NSX host to rollback.

Get the host id by running the rollback get-hosts command.

rollback host <host-uuid> username <host-username> password <host-password>

Host Rollback


Perform a rollback of the specified host machines. You need to specify the id of the NSX host to rollback.

Get the host id by running the rollback get-hosts command.

rollback hosts username <host-username> password <host-password>

Host Rollback


Perform a rollback of the specified host machines. You need to specify the id of the NSX host to rollback.

Get the host id by running the rollback get-hosts command.

rollback hosts username <host-username>

Perform Backup Operations using SSH File


Perform Backup Operations using SSH File
debug backup-restore verify backup operations host-ip <hostname-or-ip-address> [port <port-number-arg>] username <backup-server-username> directory-path <directory-path> [verbose <verbose-arg>] [ssh-file <ssh-key-file-path>]

Retrieve Backup Config Detail


Retrieve Backup Config Detail
debug backup-restore get backup config

Retrieve Backup Status


Retrieve Backup Status
debug backup-restore get backup status

Retrieve Backup Server Fingerprint


Retrieve Backup Server Fingerprint
debug backup-restore get backup server fingerprint host-ip <hostname-or-ip-address> port <port-number-arg>

Extract rollback scripts and start rollback


Extract the specified rollback scripts and start rollback.
node-rollback run-step step1_start_rollback allow-override-prechecks

Execute a rollback step


None
node-rollback run-step step2_restore_data allow-override-prechecks

Execute a rollback step


None
node-rollback run-step step3_exit_rollback allow-override-prechecks

Resume a paused rollback step


None
node-rollback resume-step
Total commands: 361