NSX CLI Guide

Associated Commands:

CLI Description Command

Clear statistics of a specified pool


Clear the statistics for a specific load balancer and pool. In rare cases some of the counters may not be cleared and when that happens please try issuing the command again.
clear load-balancer <dlb-uuid-arg> pool <pool-arg> stats

Clear statistics of all pools


Clear the statistics for all pools of a specific load balancer. In rare cases some of the counters may not be cleared and when that happens please try issuing the command again.
clear load-balancer <dlb-uuid-arg> pools stats

Clear load balancer statistics


Clear the statistics for a specific load balancer.
clear load-balancer <dlb-uuid-arg> stats

Clear statistics of a specified virtual server


Clear the statistics for a specific load balancer and virtual server. In rare cases some of the counters may not be cleared and when that happens please try issuing the command again.
clear load-balancer <dlb-uuid-arg> virtual-server <vs-arg> stats

Clear statistics of all virtual servers


Clear the statistics for all virtual servers of a specific load balancer. In rare cases some of the counters may not be cleared and when that happens please try issuing the command again.
clear load-balancer <dlb-uuid-arg> virtual-servers stats

Clear statistics of a specified pool


Clear the statistics for a specific load balancer and pool. In rare cases some of the counters may not be cleared and when that happens please try issuing the command again.
clear load-balancer <lb-uuid-arg> pool <pool-uuid-arg> stats

Clear statistics of all pools


Clear the statistics for all pools of a specific load balancer. In rare cases some of the counters may not be cleared and when that happens please try issuing the command again.
clear load-balancer <lb-uuid-arg> pools stats

Clear load balancer statistics


Clear the statistics for a specific load balancer.
clear load-balancer <lb-uuid-arg> stats

Clear statistics of a specified virtual server


Clear the statistics for a specific load balancer and virtual server. In rare cases some of the counters may not be cleared and when that happens please try issuing the command again.
clear load-balancer <lb-uuid-arg> virtual-server <vs-uuid-arg> stats

Clear statistics of all virtual servers


Clear the statistics for all virtual servers of a specific load balancer. In rare cases some of the counters may not be cleared and when that happens please try issuing the command again.
clear load-balancer <lb-uuid-arg> virtual-servers stats

Clear load balancer performance profile settings


Clear load balancer performance profile parameter settings from edge.
clear load-balancer perf-profile

Show dhcp ip pool


Display a specific DHCP IP pool.
get dhcp ip-pool <uuid-string-arg>

Show all dhcp ip pool


Display all DHCP IP pools.
get dhcp ip-pools

Show dhcp ip pools matched server uuid


Display DHCP IP pools which matched a specific server UUID.
get dhcp ip-pools server-uuid <uuid-string-arg>

Show DHCPv6 IP pool


Display a specific DHCPv6 IP pool.
get dhcp ipv6-ip-pool <uuid-string-arg>

Show all DHCPv6 IP pools


Display all DHCPv6 IP pools.
get dhcp ipv6-ip-pools

Show DHCPv6 IP pools matching server uuid


Display DHCPv6 IP pools which match a specific server UUID.
get dhcp ipv6-ip-pools server-uuid <uuid-string-arg>

Show all non-released DHCPv6 leases by search string


Display all non-released DHCPv6 leases by search string.
get dhcp ipv6-lease <string-arg>

Show all DHCPv6 leases by search string


Display all DHCPv6 leases(both released and non-released) by search string.
get dhcp ipv6-lease <string-arg> all

Show all non-released DHCPv6 leases


Display all non-released DHCPv6 leases.
get dhcp ipv6-leases

Show all DHCPv6 leases


Display all DHCPv6 leases.
get dhcp ipv6-leases all

Show DHCPv6 static binding


Display a specific DHCPv6 static binding.
get dhcp ipv6-static-binding <uuid-string-arg>

Show all DHCPv6 static bindings


Display all DHCPv6 static bindings.
get dhcp ipv6-static-bindings

Show DHCPv6 static bindings matching server uuid


Display DHCPv6 static bindings which match a specific server UUID.
get dhcp ipv6-static-bindings server-uuid <uuid-string-arg>

Show non-released DHCP lease


Display a specific DHCP lease. You can specify a DHCP server's UUID, or a MAC address, or an IP address.
get dhcp lease <string-arg>

Show DHCP lease


Display a specific DHCP lease. You can specify a DHCP server's UUID, or a MAC address, or an IP address.
get dhcp lease <string-arg> all

Show all non-released dhcp leases


Display all non-released DHCP leases.
get dhcp leases

Show all dhcp leases


Display all DHCP leases.
get dhcp leases all

Display DHCP Server IPv6 Stats Entries


Display the DHCP Server IPv6 Stats Entries.
get dhcp server <uuid-string-arg> ipv6-stats

Display DHCP Server IPv4 Stats Entries


Display the DHCP Server IPv4 Stats Entries.
get dhcp server <uuid-string-arg> stats

Show logical dhcp server


Display a specific DHCP server. Optionally specify an argument to display only the status or the synchronization information.
get dhcp server <uuid> [status | sync]

Show all logical DHCP server


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

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

Show dhcp static binding


Display a specific DHCP static binding.
get dhcp static-binding <uuid-string-arg>

Show all dhcp static binding


Display all DHCP static bindings.
get dhcp static-bindings

Show dhcp static bindings matched server uuid


Display a specific DHCP static bindings which matched a specific server UUID.
get dhcp static-bindings server-uuid <uuid-string-arg>

Display DNS Forwarder Cache Entries


Display the DNS Forwarder Cache Entries.
get dns-forwarder <uuid-string-arg> cache

Display DNS Forwarder Config


Display the DNS Forwarder Config.
get dns-forwarder <uuid-string-arg> config

Display DNS Forwarder Stats Entries


Display the DNS Forwarder Stats Entries.
get dns-forwarder <uuid-string-arg> stats

Display DNS Forwarder Status


Display DNS Forwarder Status
get dns-forwarder <uuid-string-arg> status

Display DNS Forwarder Entries


Display the DNS Forwarder Entries.
get dns-forwarder <uuid-string-arg> table

Live debugging DNS Forwarder


Live debugging the DNS Forwarder
get dns-forwarder <uuid> live-debug [server-ip <ip-address>] [lookup <hostname-or-ip-address>]

Display DNS Forwarder Cache Entries Per SR


Display the DNS Forwarder Cache Entries Per SR.
get dns-forwarder cache

Live debugging DNS forwarder


Live debugging the DNS Forwarder
get dns-forwarder live-debug [server-ip <ip-address>] [lookup <hostname-or-ip-address>]

Display DNS Forwarder Stats Entries Per SR


Display the DNS Forwarder Stats Entries Per SR.
get dns-forwarder stats

Display DNS Forwarder Status Per SR


Display the DNS Forwarder Entries Per SR.
get dns-forwarder status

Display DNS Forwarder Entries Per SR


Display the DNS Forwarder Entries Per SR.
get dns-forwarder table

Display DNS Forwarders Config


Display the DNS Forwarders Config.
get dns-forwarders config

Display DNS Forwarders Status


Display DNS Forwarder Status
get dns-forwarders status

Show load balancer


Display a specific load balancer.
get load-balancer <dlb-uuid-arg>

Show the error log for the specified load balancer


Display the error log file for a specific load balancer.
get load-balancer <dlb-uuid-arg> error-log

Show persistence tables of a specific load balancer


Display the persistence tables of a specific load balancer.
get load-balancer <dlb-uuid-arg> persistence-tables

Show statistics of the specified load balancer and pool


Display the statistics for a specific load balancer and pool.
get load-balancer <dlb-uuid-arg> pool <pool-arg> stats

Show load balancer pools.


Display the pools of a specific load balancer.
get load-balancer <dlb-uuid-arg> pools

Show statistics of all pools of the specified load balancer


Display the statistics for all the pools of a specific load balancer.
get load-balancer <dlb-uuid-arg> pools stats

Show load balancer sessions


Display sessions of load balancer.
get load-balancer <dlb-uuid-arg> sessions

Show load balancer verbose


Display stats for load balancer.
get load-balancer <dlb-uuid-arg> stats

Show load balancer verbose stats


Display verbose stats for load balancer.
get load-balancer <dlb-uuid-arg> stats verbose

Show status for the specified load balancer


Display the status of a specific load balancer.
get load-balancer <dlb-uuid-arg> status

Get hash selected backend server for the specified source IP traffic


Display the backend server IP address for the specified source IP traffic..
get load-balancer <dlb-uuid-arg> virtual-server <vs-arg> hash <ip46-address>

Show statistics of the specified load balancer and virtual server


Display the statistics for a specific load balancer and virtual server.
get load-balancer <dlb-uuid-arg> virtual-server <vs-arg> stats

Show verbose statistics of the specified load balancer and virtual server


Display verbose statistics for a specific load balancer and virtual server.
get load-balancer <dlb-uuid-arg> virtual-server <vs-arg> stats verbose

Show load balancer virtual servers


Display the virtual servers of a specific load balancer.
get load-balancer <dlb-uuid-arg> virtual-servers

Show statistics of all virtual servers of the specified load balancer


Display the statistics for all virtual servers of a specific load balancer.
get load-balancer <dlb-uuid-arg> virtual-servers stats

Show load balancer


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

Show load balancer diagnosis information


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

Show the error log for the specified load balancer


Display the error log file for a specific load balancer.
get load-balancer <lb-uuid-arg> error-log

Follow the error log for the specified load balancer


Display the last 10 lines of the error log file for a specific load balancer and all new messages that are written to the log file.
get load-balancer <lb-uuid-arg> error-log follow

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


Display error log messages containing strings that match the given regular expression pattern for a specific load balancer.
get load-balancer <lb-uuid-arg> error-log reg-filter <regex>

Show health check table of a specific load balancer


Display the health check table of a specific load balancer.
get load-balancer <lb-uuid-arg> health-check-table

Show HA state of a specific load balancer


Display the HA state of a specific load balancer.
get load-balancer <lb-uuid-arg> high-availability-state

Show a load balancer monitor


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

Show a load balancer monitor status.


Show the health check table of a load balancer monitor.
get load-balancer <lb-uuid-arg> monitor <monitor-uuid-arg> status

Show load balancer monitors


Display the monitors for a specific load balancer.
get load-balancer <lb-uuid-arg> monitors

Show persistence tables of a specific load balancer


Display the persistence tables of a specific load balancer.
get load-balancer <lb-uuid-arg> persistence-tables

Show a load balancer pool


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

Display information about an LB pool


Display information about an LB pool.
get load-balancer <lb-uuid-arg> pool <pool-uuid-arg> snat-pools

Show statistics of the specified load balancer and pool


Display the statistics for a specific load balancer and pool.
get load-balancer <lb-uuid-arg> pool <pool-uuid-arg> stats

Show status for the given pool


Display the status of a specific load balancer and pool.
get load-balancer <lb-uuid-arg> pool <pool-uuid-arg> status

Show load balancer pools


Display the pools of a specific load balancer.
get load-balancer <lb-uuid-arg> pools

Show statistics of all pools of the specified load balancer


Display the statistics for all the pools of a specific load balancer.
get load-balancer <lb-uuid-arg> pools stats

Show status for all pools of the given load balancer


Display the status of all the pools of a specific load balancer.
get load-balancer <lb-uuid-arg> pools status

Show sessions of a specific load balancer


Display the sessions of a specific load balancer.
get load-balancer <lb-uuid-arg> session-tables

Get load balancer L4 session table


Get the load balancer L4 session table with the expiration time.
get load-balancer <lb-uuid-arg> session-tables l4

Get load balancer L7 session table


Get the load balancer L7 session table with the expiration time.
get load-balancer <lb-uuid-arg> session-tables l7

Get LB pool information, especially port usage


Get load-balancer snat pools' information.
get load-balancer <lb-uuid-arg> snat-pools

Show statistics for the specified load balancer


Display the statistics for a specific load balancer.
get load-balancer <lb-uuid-arg> stats

Show status for the specified load balancer


Display the status of a specific load balancer.
get load-balancer <lb-uuid-arg> status

Show a load balancer virtual server


Display a specific load balancer virtual server.
get load-balancer <lb-uuid-arg> virtual-server <vs-uuid-arg>

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


Display the access log file for a specific load balancer and virtual server.
get load-balancer <lb-uuid-arg> virtual-server <vs-uuid-arg> access-log

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


Display the last 10 lines of the access log file for a specific virtual server of load balancer and all new messages that are written to the log file.
get load-balancer <lb-uuid-arg> virtual-server <vs-uuid-arg> access-log follow

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


Display access log messages containing strings that match the given regular expression pattern for a specific load balancer.
get load-balancer <lb-uuid-arg> virtual-server <vs-uuid-arg> access-log reg-filter <regex>

Show load balancer rules


Display the load balancer rules for a specific load balancer and virtual server.
get load-balancer <lb-uuid-arg> virtual-server <vs-uuid-arg> lbrules

Show statistics of the specified load balancer and virtual server


Display the statistics for a specific load balancer and virtual server.
get load-balancer <lb-uuid-arg> virtual-server <vs-uuid-arg> stats

Show status for the given virtual server


Display the status of a specific load balancer virtual server.
get load-balancer <lb-uuid-arg> virtual-server <vs-uuid-arg> status

Show load balancer virtual servers


Display the virtual servers of a specific load balancer.
get load-balancer <lb-uuid-arg> virtual-servers

Show statistics of all virtual servers of the specified load balancer


Display the statistics for all virtual servers of a specific load balancer.
get load-balancer <lb-uuid-arg> virtual-servers stats

Show status for all virtual servers of the given load balancer


Display the status of all virtual servers of a specific load balancer.
get load-balancer <lb-uuid-arg> virtual-servers status

Show load balancer global verbose stats


Display global verbose stats for load balancer.
get load-balancer global stats

Get load balancer performance config


Get edge parameters configured by load balancer for performance.
get load-balancer perf-profile config

Show pool.


Display the information for pool.
get load-balancer pool <pool-arg>

Show a load balancer virtual server


Display a specific load balancer virtual server.
get load-balancer virtual-server <vs-arg>

Show the access log for the specified virtual server


Display the access log for the virtual server.
get load-balancer virtual-server <vs-arg> access-log

Show all load balancers


Display all load balancers.
get load-balancers

Show status for all load balancers


Display the status of all load balancers.
get load-balancers status

Display Nslookup DNS Forwarder result


Display Nslookup DNS Forwarder result.
nslookup dns-forwarder <hostname-or-ip-address> [[server-ip <ip-address>] [source-ip <ip-address>]]

Display Nslookup DNS Forwarder result


Display Nslookup DNS Forwarder result.
nslookup dns-forwarder <uuid> <hostname-or-ip-address> [server-ip <ip-address>] [source-ip <ip-address>]

Reset DHCP Server IPv6 Stats Entries


Reset the DHCP Server IPv6 Stats Entries.
reset dhcp server <uuid-string-arg> ipv6-stats

Reset DHCP Server IPv4 Stats Entries


Reset the DHCP Server IPv4 Stats Entries.
reset dhcp server <uuid-string-arg> stats

Clear DNS Forwarder cache


Clear the DNS Forwarder cache
reset dns-forwarder <uuid-string-arg> cache

Reset DNS Forwarder Stats and Display the Latest Entries


Reset the DNS Forwarder Stats Entries.
reset dns-forwarder <uuid-string-arg> stats

Clear DNS Forwarder Cache Per SR


Clear the DNS Forwarder Cache Per SR.
reset dns-forwarder cache

Reset DNS Forwarder Stats and Display Entries Per SR


Reset the DNS Forwarder Stats Entries Per SR.
reset dns-forwarder stats

Enable/disable rule log


Enable or disable rule log for a specific load balancer.
set load-balancer <lb-uuid-arg> rule-log <enabled-arg>

Enable/disable rule log


Enable or disable rule log for a specific pool.
set load-balancer <lb-uuid-arg> rule-log pool <pool-uuid-arg> <enabled-arg>

Enable/disable rule log


Enable or disable rule log for a specific virtual server.
set load-balancer <lb-uuid-arg> rule-log virtual-server <vs-uuid-arg> <enabled-arg>

Set load balancer performance profile


Apply edge parameters to accelerate load balancer performance.
set load-balancer perf-profile <perf-profile-type-arg>

Total commands: 116