NSX CLI Guide

Associated Commands:

CLI Description	Command
Clear http service redirect host Clear the HTTP service redirect host.	clear service http redirect-host
Clear install-upgrade service enabled property Clear the install-upgrade service's enabled property.	clear service install-upgrade enabled
Clear manager service logging levels Clear the log levels of the manager service.	clear service manager logging-level
Clear NTP service start on boot Configure the NTP service to not start on boot.	clear service ntp start-on-boot
Clear snmp service start on boot Configure the snmp service to not start on boot.	clear service snmp start-on-boot
Clear SSH service start on boot Configure the SSH service to not start on boot.	clear service ssh start-on-boot
Clear SSH Root login property Disable SSH Root login property	clear ssh root-login
Delete SNMP v2 Trap Targets Delete SNMP v2 Trap Targets.	del snmp v2-targets <hostname-or-ip-address-optional-port-arg>
Delete SNMP v3 Trap Targets Delete SNMP v3 Trap Targets.	del snmp v3-targets <hostname-or-ip-address-optional-port-arg>
Delete SNMP v3 Users Delete SNMP v3 Users.	del snmp v3-users <user-id-arg>
List docker containers in the system List all the docker containers in the system (equivalent of 'docker ps -a').	get docker-containers
List docker images in the system List docker images in the system (equivalent of 'docker images').	get docker-images
Display service properties Display information about the specified service.	get service <service-name-arg>
Display global logging configuration Display global logging configuration.	get service controller logging-config
Display configuration for logger with given log level Display the logging configuration for components that have the specified log level.	get service controller logging-config logging-level <controller-logging-level-arg>
Display configuration for given logger Display the logging configuration for the specified component.	get service controller logging-config name <string-arg-controller>
Display configuration for loggers matching to given regex Display the logging configuration for components that match the specified pattern. The pattern can be a regular expression.	get service controller logging-config pattern <string-arg-controller>
Display the controller service logging level Display the log level for the controller service.	get service controller logging-level
Get the dataplane service logging level Display the log level of the dataplane service.	get service dataplane logging-level
Get the dhcp service logging level Display the log level of the dhcp service.	get service dhcp logging-level
Display DHCP pool monitor configuration Display DHCP pool monitor configuration	get service dhcp pool-monitor
Display IKE per tunnel debugging configuration Display IKE per tunnel debugging configuration	get service ike debug-tunnel
Get the IKE service logging level Display the log level of the IKE service.	get service ike logging-level
Get the local-controller service logging level Display the log level of the local-controller service.	get service local-controller logging-level
Get local-controller service state Display the state of the local controller service.	get service local-controller state
Get Node Management service logging level Get the log level of the Node Management service.	get service node-mgmt logging-level
Get the log level of nsd Get nsd logging level.	get service nsd logging-level
Get the log level of NSX Agent service. Get service nsx-agent logging level.	get service nsx-agent logging-level
Get the whole cfgagent cache table Display the whole cache table in cfgagent. Optionally specify arguments to display only the local configuration, remote configuration, local L2, or remote L2 information, and remote L3 information.	get service nsx-cfgagent cache-table [{config \| l2 \| l3} {local \| remote \| logical-switch \| logical-switch-port \| logical-switch-port-list \| transport-node \| bridge-cluster \| group-relation \| mirror \| ipfix \| profile \| container}]
Get HyperBus vmknics Display the status for HyperBus vmknic ports on this hypervisor host.	get service nsx-cfgagent hyperbus vmknic
Get service cfgagent hyperbus logging level Get service cfgagent hyperbus logging level.	get service nsx-cfgagent lib-hyperbus logging-level
Get service cfgagent metrics logging level Get service cfgagent metrics logging level	get service nsx-cfgagent lib-metrics logging-level
Get service cfgagent nestdb logging level Get service cfgagent nestdb logging level	get service nsx-cfgagent lib-nestdb logging-level
Get service cfgagent net logging level Get service cfgagent net logging level	get service nsx-cfgagent lib-net logging-level
Get service cfgagent rpc logging level Get service cfgagent rpc logging level	get service nsx-cfgagent lib-rpc logging-level
Get service cfgagent SHA client logging level Get service cfgagent SHA client logging level.	get service nsx-cfgagent lib-sha logging-level
Get service cfgagent upm logging level Get service cfgagent upm logging level.	get service nsx-cfgagent lib-upm logging-level
Get service cfgagent workflow logging level Get service cfgagent workflow logging level.	get service nsx-cfgagent lib-wft logging-level
Get service cfgagent workflow trace level Get service cfgagent workflow trace level.	get service nsx-cfgagent lib-wft trace-level
Get service cfgagent logging level Get service cfgagent logging level.	get service nsx-cfgagent logging-level
Get LS's attachment config Display the attachment config logical switch on this hypervisor host.	get service nsx-cfgagent logical-switch attachment-config
Get LS's extra config Display the extra config list for logical switch on this hypervisor host.	get service nsx-cfgagent logical-switch extra-config
Get LSP's extra config Display the extra config list for logical switch port on this hypervisor host.	get service nsx-cfgagent logical-switch-port extra-config
Get nsx-context-mux feature status Get nsx-context-mux feature status.	get service nsx-context-mux feature <context-mux-feature-type-arg> status
Get the log level of context-mux Get service daemon log level for context-mux.	get service nsx-context-mux logging-level
Get current status of IDFW on host Get current status of IDFW on host	get service nsx-ctxteng idfw status
Get current status of IDS on host Get current status of IDS on host	get service nsx-ctxteng ids status
Get context engine protocol enable in the order TCP UDP ICMP Get context engine protocol enable in the order TCP UDP ICMP	get service nsx-ctxteng protocol
Get service exporter SmartNIC demux logging level Get service exporter SmartNIC demux logging level.	get service nsx-exporter lib-sndemux logging-level
Get the log level of the exporter service Get exporter service logging level.	get service nsx-exporter logging-level
Display service properties for nsx-lastline-rapid Display information about the nsx-lastline-rapid service.	get service nsx-lastline-rapid
Get the log level of nsx-lastline-rapid Get nsx-lastline-rapid log level	get service nsx-lastline-rapid logging-level
Get service netopa logging level Get service netopa logging level.	get service nsx-netopa logging-level
Get service opsagent SHA client logging level Get service opsagent SHA client logging level.	get service nsx-opsagent lib-sha logging-level
Get service opsagent SmartNIC demux logging level Get service opsagent SmartNIC demux logging level.	get service nsx-opsagent lib-sndemux logging-level
Get service opsagent workflow logging level Get service opsagent workflow logging level.	get service nsx-opsagent lib-wft logging-level
Get service opsagent workflow trace level Get service opsagent workflow trace level.	get service nsx-opsagent lib-wft trace-level
Get service OpsAgent logging level Get service OpsAgent logging level.	get service nsx-opsagent logging-level
Get service nsx-proxy central logging level Get service nsx-proxy central logging level.	get service nsx-proxy central logging-level
Get service nsx-proxy metrics logging level Get service nsx-proxy metrics logging level.	get service nsx-proxy lib-metrics logging-level
Get service nsx-proxy nestdb logging level Get service nsx-proxy nestdb logging level.	get service nsx-proxy lib-nestdb logging-level
Get service nsx-proxy net logging level Get service nsx-proxy net logging level.	get service nsx-proxy lib-net logging-level
Get service nsx-proxy rpc logging level Get service nsx-proxy rpc logging level.	get service nsx-proxy lib-rpc logging-level
Get service nsx-proxy logging level Get service nsx-proxy logging level.	get service nsx-proxy logging-level
Get service nsx-snproxy central logging level Get service nsx-snproxy central logging level.	get service nsx-snproxy central logging-level
Get service nsx-snproxy connection info Get service nsx-snproxy connection info	get service nsx-snproxy conn-info
Get service nsx-snproxy net logging level Get service nsx-snproxy net logging level.	get service nsx-snproxy lib-net logging-level
Get service nsx-snproxy rpc logging level Get service nsx-snproxy rpc logging level.	get service nsx-snproxy lib-rpc logging-level
Get service nsx-snproxy logging level Get service nsx-snproxy logging level.	get service nsx-snproxy logging-level
Display service properties for Security Hub Display information about the SecurityHub service.	get service security-hub
Get the log level of EPSEC Library Get EPSEC Library log level	get service security-hub epsec logging-level
Get configured SecurityHub feature details Get configured SecurityHub feature details	get service security-hub feature
Get the log level of security-hub Get security-hub log level	get service security-hub logging-level
Display service properties Display information about all services.	get services
Show the remote site(s) and their sync status Display the remote sites along with their sync status.	get site-replicator remote-sites
Get SNMP v2 configured status Indicates whether the local SNMP agent is configured with community string(s).	get snmp v2-configured
Get SNMP v2 Trap Targets Get SNMP v2 Trap Targets.	get snmp v2-targets
Get SNMP v3 configured status Indicates whether the local SNMP agent is configured with v3 user(s).	get snmp v3-configured
Get SNMP v3 Engine ID Get SNMP v3 Engine ID.	get snmp v3-engine-id
Get SNMP v3 Protocols Get SNMP v3 Protocols auth_protocol and priv_protocol.	get snmp v3-protocols
Get SNMP v3 Trap Targets Get SNMP v3 Trap Targets.	get snmp v3-targets
Get SNMP v3 User IDs Get SNMP v3 User IDs.	get snmp v3-users
Restart service Restart the specified service.	restart service <service-name-arg>
Restart service nsx-lastline-rapid Restart the nsx-lastline-rapid service.	restart service nsx-lastline-rapid
Restart service Security Hub Restart the Security Hub service.	restart service security-hub
Set repository state properties Set current node's IP address as repository IP. This command will restart the install-upgrade service.	set repository-ip
Set async replicator service logging level Set the log level of the async replicator service.	set service async_replicator logging-level <async-replicator-level-arg>
Set Auth service logging level Set the log level of the Auth service.	set service auth logging-level <auth-level-arg>
Set the controller service logging level Set the log level for the controller service.	set service controller logging-level <controller-logging-level-arg>
Set log level for given logger Set the log level for the specified component.	set service controller logging-level name <string-arg-controller> <controller-logging-level-arg>
Set log level for loggers matching regex Set the log level for components that match the specified pattern. The pattern can be a regular expression.	set service controller logging-level pattern <string-arg-controller> <controller-logging-level-arg>
Set the DHCP service logging level Set the log level of the DHCP service.	set service dhcp logging-level <edge-service-logging-level-arg>
Enable/Disable DHCP pool monitor and set monitor interval in seconds Enable or disable DHCP pool monitor and set monitor interval in seconds	set service dhcp pool-monitor <monitor-flag-arg> monitor-interval <monitor-interval-arg>
Enable or disable basic authentication in API calls. Enable or disable basic authentication in API calls.	set service http basic-authentication <enabled-arg>
Set http API per-client concurrency limit, 0 to disable Set the HTTP API per-client concurrency limit value.	set service http client-api-concurrency-limit <http-client-api-concurrency-limit-arg>
Set http per-client API rate limit, 0 to disable Set the HTTP API per-client rate limit value.	set service http client-api-rate-limit <http-client-api-rate-limit-arg>
Set http service connection timeout, 0 to disable Set the HTTP service connection timeout value.	set service http connection-timeout <http-conn-timeout-arg>
Enable or disable cookie-based authentication in API calls. Enable or disable cookie-based authentication in API calls.	set service http cookie-based-authentication <enabled-arg>
Set http API global concurrency limit, 0 to disable Set the HTTP API global concurrency limit value.	set service http global-api-concurrency-limit <http-global-api-concurrency-limit-arg>
Set HTTP service logging level Set the log level of the HTTP service.	set service http logging-level <http-level-arg>
Set http service redirect host Set the HTTP service redirect host.	set service http redirect-host <hostname-or-ip-address>
Set http service session timeout, 0 to disable Set the HTTP service session timeout value.	set service http session-timeout <http-timeout-arg>
Enable/Disable IKE per tunnel debugging Enable or disable ike per tunnel debug mode	set service ike debug-tunnel local-ip <ip46-address> remote-ip <ip46-address> debug-level <debug-level-arg>
Enable/Disable IKE per tunnel debugging Enable or disable ike per tunnel debug mode	set service ike debug-tunnel local-ip <ip46-address> remote-ip <ip46-address> debug-level <debug-level-arg> follow
Set the IKE service logging level Set the log level of the IKE service.	set service ike logging-level <edge-service-logging-level-arg>
Set install-upgrade service enabled property Set the install-upgrade service's enabled property.	set service install-upgrade enabled
Set the Local Controller service logging level Set the log level of the Local Controller service.	set service local-controller logging-level <edge-service-logging-level-arg>
Set manager service logging level Set the log level of the manager service.	set service manager logging-level <manager-level-arg>
Set manager service package logging level Set the log level of the specified package in manager service.	set service manager logging-level <manager-level-arg> package <manager-package-name-arg>
Set Monitoring service logging level Set the log level of the Monitoring service.	set service monitoring logging-level <monitoring-level-arg>
Set Node Management service logging level Set the log level of the Node Management service.	set service node-mgmt logging-level <node-mgmt-level-arg>
Set the log level of nsd. Dynamically set nsd log level.	set service nsd logging-level <level>
Set the log level of NSX Agent service. Dynamically set service daemon log level.	set service nsx-agent logging-level <nsx-agent-logging-level-arg>
Set service cfgagent hyperbus logging level Set service cfgagent hyperbus logging level.	set service nsx-cfgagent lib-hyperbus logging-level <cfgagent-logging-level-arg>
Set service cfgagent metrics logging level Set service cfgagent metrics logging level	set service nsx-cfgagent lib-metrics logging-level <cfgagent-logging-level-arg>
Set service cfgagent nestdb logging level Set service cfgagent nestdb logging level	set service nsx-cfgagent lib-nestdb logging-level <cfgagent-logging-level-arg>
Set service cfgagent net logging level Set service cfgagent net logging level	set service nsx-cfgagent lib-net logging-level <cfgagent-logging-level-arg>
Set service cfgagent rpc logging level Set service cfgagent rpc logging level	set service nsx-cfgagent lib-rpc logging-level <cfgagent-logging-level-arg>
Set service cfgagent SHA client logging level Set service cfgagent SHA client logging level.	set service nsx-cfgagent lib-sha logging-level <cfgagent-logging-level-arg>
Set service cfgagent upm logging level Set service cfgagent upm logging level.	set service nsx-cfgagent lib-upm logging-level <cfgagent-logging-level-arg>
Set service cfgagent workflow logging level Set service cfgagent workflow logging level.	set service nsx-cfgagent lib-wft logging-level <cfgagent-logging-level-arg>
Set service cfgagent workflow trace level Set service cfgagent workflow trace level.	set service nsx-cfgagent lib-wft trace-level <cfgagent-workflowtrace-level-arg>
Set service cfgagent logging level Set service cfgagent logging level.	set service nsx-cfgagent logging-level <cfgagent-logging-level-arg>
Enable/Disable ContextMux feature Enable/Disable ContextMux feature	set service nsx-context-mux feature <context-mux-feature-type-arg> <context-mux-feature-operation-arg>
Set the log level of nsx-context-mux Dynamically set service daemon log level.	set service nsx-context-mux logging-level <context-mux-logging-level-arg>
Enable/disable TCP UDP ICMP events Enable/disable TCP UDP ICMP events	set service nsx-ctxteng protocol <idfw-protocol> <idfw-enable>
Set service exporter SmartNIC demux logging level Set service exporter SmartNIC demux logging level.	set service nsx-exporter lib-sndemux logging-level <exporter-sndemux-loglevel-arg>
Set the log level of exporter service. Dynamically set service daemon log level.	set service nsx-exporter logging-level <level>
Set the log level of nsx-lastline-rapid Dynamically set nsx-lastline-rapid log level	set service nsx-lastline-rapid logging-level <rapid-logging-level-arg>
Set service netopa logging level Set service netopa logging level.	set service nsx-netopa logging-level <netopa-logging-level-arg>
Set service opsagent SHA client logging level Set service opsagent SHA client logging level.	set service nsx-opsagent lib-sha logging-level <opsagent-logging-level-arg>
Set service opsagent SmartNIC demux logging level Set service opsagent SmartNIC demux logging level.	set service nsx-opsagent lib-sndemux logging-level <opsagent-logging-level-arg>
Set service opsagent workflow logging level Set service opsagent workflow logging level.	set service nsx-opsagent lib-wft logging-level <opsagent-logging-level-arg>
Set service opsagent workflow trace level Set service opsagent workflow trace level.	set service nsx-opsagent lib-wft trace-level <opsagent-workflowtrace-level-arg>
Set service OpsAgent logging level Set service OpsAgent logging level.	set service nsx-opsagent logging-level <opsagent-logging-level-arg>
Set the log level of platform client service. Dynamically set service daemon log level.	set service nsx-platform-client logging-level <platform-client-logging-level-arg>
Set service nsx-proxy central logging level Set service nsx-proxy central logging level	set service nsx-proxy central logging-level <nsxproxy-logging-level-arg>
Set service nsx-proxy metrics logging level Set service nsx-proxy metrics logging level.	set service nsx-proxy lib-metrics logging-level <nsxproxy-logging-level-arg>
Set service nsx-proxy nestdb logging level Set service nsx-proxy nestdb logging level.	set service nsx-proxy lib-nestdb logging-level <nsxproxy-logging-level-arg>
Set service nsx-proxy net logging level Set service nsx-proxy net logging level.	set service nsx-proxy lib-net logging-level <nsxproxy-logging-level-arg>
Set service nsx-proxy rpc logging level Set service nsx-proxy rpc logging level.	set service nsx-proxy lib-rpc logging-level <nsxproxy-logging-level-arg>
Set service nsx-proxy logging level Set service nsx-proxy logging level.	set service nsx-proxy logging-level <nsxproxy-logging-level-arg>
Set service nsx-snproxy central logging level Set service nsx-snproxy central logging level	set service nsx-snproxy central logging-level <nsx-snproxy-logging-level-arg>
Set service nsx-snproxy net logging level Set service nsx-snproxy net logging level.	set service nsx-snproxy lib-net logging-level <nsx-snproxy-logging-level-arg>
Set service nsx-snproxy rpc logging level Set service nsx-snproxy rpc logging level.	set service nsx-snproxy lib-rpc logging-level <nsx-snproxy-logging-level-arg>
Set service nsx-snproxy logging level Set service nsx-snproxy logging level.	set service nsx-snproxy logging-level <nsx-snproxy-logging-level-arg>
Set NTP service start on boot Configure the NTP service to start on boot.	set service ntp start-on-boot
Set log level for routing service Set the log level of the FRR service.	set service router logging-level <edge-routing-service-logging-destination-arg> <edge-routing-service-logging-level-arg>
Set log level for routing platform service Set the log level of the routing platform and config services.	set service routing-platform logging-level <edge-routing-platform-service-logging-level-arg>
Set the log level of EPSEC Library Dynamically set EPSEC Library log level	set service security-hub epsec logging-level <epsec-lib-logging-level-arg>
Enable/Disable SecurityHub Fileless feature and sub-features Enable/Disable SecurityHub Fileless feature and sub-features	set service security-hub fileless <fileless-feature-subtype-arg> <feature-operation-arg> vms <feature-target-arg>
Set the log level of security-hub Dynamically set security-hub log level	set service security-hub logging-level <security-hub-logging-level-arg>
Set snmp service start on boot Configure the snmp service to start on boot.	set service snmp start-on-boot
Set SSH service start on boot Configure the SSH service to start on boot.	set service ssh start-on-boot
Set Telemetry service logging level Set the log level of the Telemetry service.	set service telemetry logging-level <telemetry-level-arg>
Set SNMP service v1/v2c community string Set the SNMP service v1/v2c community string in ciper text. This must be set before MIBs can be queried. Choose a string that is difficult to guess.	set snmp community
Set SNMP service v1/v2c community string Set the SNMP service v1/v2c community string. This must be set before MIBs can be queried. Choose a string that is difficult to guess.	set snmp community <snmp-community-arg>
Set SNMP v2 Trap Targets Set SNMP v2 Trap Targets.	set snmp v2-targets <hostname-or-ip-address-optional-port-arg> community <snmp-community-arg>
Set SNMP v3 Engine ID Set SNMP v3 Engine ID.	set snmp v3-engine-id <v3-engine-id-arg>
Set SNMP v3 Protocols Set SNMP v3 Protocols auth_protocol and priv_protocol.	set snmp v3-protocols auth-protocol <v3-auth-protocol-arg> priv-protocol <v3-priv-protocol-arg>
Set SNMP v3 Trap Targets Set SNMP v3 Trap Targets.	set snmp v3-targets <hostname-or-ip-address-optional-port-arg> user <user-id-arg>
Set SNMP v3 users Set SNMP v3 users,auth-password,priv-password in cipher text.	set snmp v3-users <user-id-arg>
Set SNMP v3 users Set SNMP v3 users auth-password,priv-password in plain text.	set snmp v3-users <user-id-arg> auth-password <auth-password-arg> priv-password <priv-password-arg>
Set SSH Root login property Enable SSH Root login property	set ssh root-login
Start service Start the specified service.	start service <service-name-arg>
Start service nsx-lastline-rapid Start the nsx-lastline-rapid service.	start service nsx-lastline-rapid
Start service Security Hub Start the Security Hub service.	start service security-hub
Stop service Stop the specified service.	stop service <service name> [force]
Stop service nsx-lastline-rapid Stop the nsx-lastline-rapid service.	stop service nsx-lastline-rapid
Stop service Security Hub Stop the Security Hub service.	stop service security-hub