NSX-T Command-Line Interface Reference
Copyright © 2014-2022 VMware, Inc. All rights reserved. Copyright and trademark information.
EN-002526-00
NSX-T Command-Line Interface Reference
NSX-T Data Center 4.0.0
Table of Contents
About This Book
Intended Audience
VMware Technical Publications Glossary
Document Feedback
Introduction to the NSX-T CLI
Logging In and Out of the CLI
set service ssh start-on-boot command to enable
the SSH service.
CLI Command Modes
Important Note
NSX-T CLI Commands
If you do not provide a passphrase on the command line, you will be prompted to enter one. The passphrase is used to encrypt the backup. If you forget the passphrase, you will not be able to restore the backup.
Important: This backup command is one part of the backup process. You must complete all backup and restore tasks in the correct order. See the NSX-T Administration Guide for information and instructions about performing backups and restores.
| Option | Description |
|---|---|
| <filename> | Filename argument Allowed pattern: ^[^/ *;&|]+$ |
| <passphrase> | Backup passphrase |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
get gateway command to get a list of gateways and their types.| Option | Description |
|---|---|
| <uuid> | UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <service-id> | Service id (0-65535) |
| Option | Description |
|---|---|
| <interface-name> | Configurable network interface argument |
| Option | Description |
|---|---|
| <interface-name> | Configurable network interface argument |
| Option | Description |
|---|---|
| <interface-name> | Configurable network interface argument |
| Option | Description |
|---|---|
| <interface-name> | LLDP interface argument |
| Option | Description |
|---|---|
| <interface-name> | LLDP interface argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <pool-uuid> | Pool UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <pool-uuid> | Pool UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
get logical-routers command to get a list of logical routers and their router types.| Option | Description |
|---|---|
| <uuid> | UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <physical-port-name> | Datapath String argument |
| Option | Description |
|---|---|
| <cached-certificate-id> | Certificate id string argument Allowed pattern: ^([0-9a-f]*)$ |
| Option | Description |
|---|---|
| <username> | Username of user |
| Option | Description |
|---|---|
| <username> | Username of user |
| Option | Description |
|---|---|
| <filepath> | Path of generated core dump file |
| <url> | Remote file url (e.g. scp://username@ip_address/filepath/filename) |
| Option | Description |
|---|---|
| <filename> | Existing file argument |
| <url> | Remote file url (e.g. scp://username@ip_address/filepath/filename) |
file argument to specify a different destination file name.To specify IPv6 remote addresses, url server should be enclosed between square brackets.
| Option | Description |
|---|---|
| <url> | Remote file url (e.g. scp://username@ip_address/filepath/filename) |
| <filename> | Filename argument Allowed pattern: ^[^/ *;&|]+$ |
| Option | Description |
|---|---|
| <url> | Remote file url (e.g. scp://username@ip_address/filepath/filename) |
| <thumbprint> | Remote host thumbprint |
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
| <port-uuid-name> | Datapath String argument |
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
| <interface-name> | Network interface argument |
| Option | Description |
|---|---|
| <esx-session-id-arg> | Packet Capture session id parameter |
| Option | Description |
|---|---|
| <session-id-arg> | Packet capture session id parameter |
| Option | Description |
|---|---|
| <filepath> | Path of generated core dump file |
| Option | Description |
|---|---|
| <filepattern> | Existing file or pattern argument |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <vm-id> | VM ID |
| Option | Description |
|---|---|
| <image-name> | Edge service container image name |
| <image-version> | Edge service container image version |
get logging-servers command to display the current logging server configuration.| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | A hostname or IPv4 or IPv6 address with optional port delimited by a colon |
| <proto> | Logging server protocol Allowed values: tcp, udp, tls, li, li-tls |
| <level> | Level of log entries to export Allowed values: emerg, alert, crit, err, warning, notice, info, debug |
| <facility> | Comma delimited list of facilities of log entries to export |
| <messageid> | Comma delimited list of MSGIDs of log entries to export |
| <structured-data> | Structured data of log entries to export Allowed pattern: ^(alarmId|alarmState|audit|comp|depr|entId|eReqId|errorCode|eventFeatureName|eventId|eventSev|eventState|eventType|euser|level|method|nodeId|path|security|subcomp|s2comp|splitId|splitIndex|tenantId|tid|tname|update|username)=.+$ |
| Option | Description |
|---|---|
| <ip-address> | Name server IP v4 or v6 address argument |
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
| Option | Description |
|---|---|
| <prefix> | CIDR notation argument |
| <ip-route-metric> | IP route metric argument Allowed pattern: ^[0-9]+$ |
| <gateway-ip> | Gateway IP address argument |
| <interface-name> | Configurable network interface argument |
| Option | Description |
|---|---|
| <prefix-ipv46> | CIDR notation argument for IPv4/IPv6 address |
| <ip-route-metric> | IP route metric argument Allowed pattern: ^[0-9]+$ |
| <gateway-ipv46> | Gateway IPv4/IPv6 address argument |
| <interface-name> | Configurable network interface argument |
| Option | Description |
|---|---|
| <domain> | Search domain argument |
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | A hostname or IPv4 or IPv6 address with optional port delimited by a colon |
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | A hostname or IPv4 or IPv6 address with optional port delimited by a colon |
| Option | Description |
|---|---|
| <v3-user> | SNMP v3 user Allowed pattern: ^[\S]{1,32}$ |
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | A hostname or IPv4 or IPv6 address with optional port delimited by a colon |
| Option | Description |
|---|---|
| <username> | Username of user |
| <key-label> | Unique label for SSH key |
| <password> | Password of user |
Use the API username and password for the specified NSX Manager. If you do not provide a password on the command line, you will be prompted to enter one.
Get the NSX Manager thumbprint by running the get certificate api thumbprint command on the specified NSX Manager.
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | Hostname or IPv4 or IPv6 address of an NSX Manager and optional port |
| <username> | Manager API username |
| <thumbprint> | Manager API thumbprint |
| <password> | Manager API password |
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | Hostname or IPv4 or IPv6 address of an NSX Manager and optional port |
| <username> | Manager API username |
| <thumbprint> | Manager API thumbprint |
| <password> | Manager API password |
Use the API username and password for the specified NSX Manager. If you do not provide a password on the command line, you will be prompted to enter one.
Get the NSX Manager thumbprint by running the get certificate api thumbprint command on the specified NSX Manager.
| Option | Description |
|---|---|
| <ip-address[:port]> | IPv4 or IPv6 address of an NSX Manager and optional port |
| <username> | Manager API username |
| <thumbprint> | Manager API thumbprint |
| <password> | Manager API password |
| Option | Description |
|---|---|
| <node-id> | Node ID of cluster node to detach Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <node-id> | Node ID of cluster node to detach Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <session-id-arg> | Packet capture session id parameter |
| Option | Description |
|---|---|
| <session-id-arg> | Packet capture session id parameter |
| <arguments> | Packet capture option parameter |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <bgp-community> | BGP community argument, either NO_EXPORT, NO_ADVERTISE, NO_EXPORT_SUBCONFED or community in AA:NN format |
| Option | Description |
|---|---|
| <bgp-large-community> | BGP large-community argument in AA:BB:CC format |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <address-family> | BGP address family argument Allowed values: ipv4, ipv6, evpn |
stats argument to display the statistics for the interface.| Option | Description |
|---|---|
| <bond-name> | Datapath device name argument |
stats argument to display the statistics for the interfaces.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <bridge-lswitch-name-arg> | Attached logical switch name or regex |
| Option | Description |
|---|---|
| <vlan-id-arg> | VLAN Id (0-4094, all) |
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
| Option | Description |
|---|---|
| <esx-session-id-arg> | Packet Capture session id parameter |
| Option | Description |
|---|---|
| <session-id-arg> | Packet capture session id parameter |
start capture interface <interface-name> command.
start capture interface <interface-name> command.
| Option | Description |
|---|---|
| <uuid> | Cgroup identifier |
| <translation-type> | Translation type Allowed values: logical-objects, ips, vifs, macs, tns, vms, excluded-ips |
| Option | Description |
|---|---|
| <uuid> | Group identifier |
| <translation-type> | Translation type Allowed values: logical-objects, ips, vifs, macs, tns, vms, excluded-ips |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <hardware-address> | Network hardware address argument |
| Option | Description |
|---|---|
| <vif> | VIF ID |
Show status to display ESXio node data in ESXi host command output.
Applicable only when ESXio nodes are registered with ESXi host.
To show all command history set size to 0.
Note:Outputs command history from version 3.2.0 and above.
| Option | Description |
|---|---|
| <data-id> | ID of the datum Allowed pattern: ^.*$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <lcore-list-all> | Specify a list of lcore ids or "all" Allowed pattern: ^([0-9]+,)*([0-9]+)$|(all)$ |
| Option | Description |
|---|---|
| <interval> | Specify sample interval |
| Option | Description |
|---|---|
| <time> | Time measurement in seconds Allowed pattern: [1-9][0-9]*$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
| Option | Description |
|---|---|
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
| Option | Description |
|---|---|
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
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.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <log-num> | Specify number of log entries Allowed pattern: ^([0-9]+)$ |
| Option | Description |
|---|---|
| <log-num> | Specify number of log entries Allowed pattern: ^([0-9]+)$ |
| <context-line-num> | Specify the numbers of context logs before and after the error log Allowed pattern: ^([0-9]+)$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <ip-address> | Network IP address argument |
| <hostname-or-ip-address> | A hostname or IP address |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| <hostname-or-ip-address> | A hostname or IP address |
| Option | Description |
|---|---|
| <uuid> | Domain object identifier |
| Option | Description |
|---|---|
| <domain_object_type> | Domain object type Allowed values: ArpTableConfig, Container, ContextProfile, Cif, DhcpIpPool, DhcpStaticBinding, DirectoryGroup, DistinguishedNameObject, EdgeNode, Hypervisor, EdgeClusterConfig, EvpnService, EvpnTunnelEndpoint, FQDNAnalysisConfig, SiRedirectionPolicy, IpfixCollectorConfiguration, IpfixDfwConfiguration, IpReputationChunkParent, IPReputationFeedConfig, LogicalDhcpServer, LogicalMDProxyServer, LogicalSwitch, LogicalSwitchPort, LogicalSwitchPortBindings, LogicalRouter, LogicalRouterPort, MacAddress, PublicCloudGatewayNode, RemoteSiteContainer, Rule, RuleSection, UfoContainer, UrlCategorizationConfig, Vif, ServicePath, ServiceChain, ServiceVM, ServiceVmStatus, EwSiRedirectionPolicy, NsSiRedirectionPolicy, ServiceProfile, SiService, ComputedDadState, LogicalRouterPortDadState, VifTnBindingExpiration |
| Option | Description |
|---|---|
| <objects_type_with_component_name> | Object type with component name Allowed values: rule, rulesection |
| <component-name> | Component name Allowed values: dfw |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| Option | Description |
|---|---|
| <vni> | vni Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <esi> | Ethernet Segment Identifier (ESI) |
| Option | Description |
|---|---|
| <vni> | vni Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <filename> | Existing file argument |
| Option | Description |
|---|---|
| <filename> | Existing file argument |
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| <rule-id> | Rule ID Allowed pattern: ^[1-9][0-9]*$ |
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| Option | Description |
|---|---|
| <vifuuid> | UUID argument |
| Option | Description |
|---|---|
| <vifuuid> | UUID argument |
| Option | Description |
|---|---|
| <vifuuid> | UUID argument |
| Option | Description |
|---|---|
| <vifuuid> | UUID argument |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <context-profile-id> | Context profile ID argument Allowed pattern: ^[0-9a-zA-Z-]+$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <lines> | Line count, up to 80 |
| Option | Description |
|---|---|
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Gateway identifier Allowed pattern: ^[0-9]+$|^0x[0-9a-fA-F]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | Gateway identifier Allowed pattern: ^[0-9]+$|^0x[0-9a-fA-F]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <route> | Logical Router route description Allowed values: route |
| Option | Description |
|---|---|
| <uuid> | Gateway identifier Allowed pattern: ^[0-9]+$|^0x[0-9a-fA-F]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <route> | Logical Router route description Allowed values: route |
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <uuid> | Gateway identifier Allowed pattern: ^[0-9]+$|^0x[0-9a-fA-F]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <interface-id> | Gateway interface id Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | Gateway identifier Allowed pattern: ^[0-9]+$|^0x[0-9a-fA-F]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | Gateway identifier Allowed pattern: ^[0-9]+$|^0x[0-9a-fA-F]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
get gateway command to get a list of logical routers and their router types.| Option | Description |
|---|---|
| <uuid> | UUID argument |
get gateway command to get a list of gateways and their router types.| Option | Description |
|---|---|
| <uuid> | UUID argument |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <ip-version> | Internet Protocol Version (IPV4 or IPV6) Allowed values: ipv4, ipv6 |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <ip-or-mac-address> | IP or MAC address |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <ip-or-mac-address> | IP or MAC address |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <policy-table-id> | Proximity routing policy table identifier UUID or ID |
| Option | Description |
|---|---|
| <dvs-name> | DVS name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <hardware-address> | Network hardware address argument |
| Option | Description |
|---|---|
| <vif> | VIF ID |
| Option | Description |
|---|---|
| <vm-id> | VM ID |
| Option | Description |
|---|---|
| <vm-id> | VM ID |
| Option | Description |
|---|---|
| <vm-id> | VM ID |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <service-id> | Service id (0-65535) |
| Option | Description |
|---|---|
| <service-id> | Service id (0-65535) |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <service-type> | Service type argument is one of {service-router} Allowed values: service-router, l2-bridge |
| Option | Description |
|---|---|
| <service-type> | Service type argument is one of {service-router} Allowed values: service-router, l2-bridge |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <service-type> | Service type argument is one of {service-router} Allowed values: service-router, l2-bridge |
| Option | Description |
|---|---|
| <service-type> | Service type argument is one of {service-router} Allowed values: service-router, l2-bridge |
| Option | Description |
|---|---|
| <service-type> | Service type argument is one of {service-router} Allowed values: service-router, l2-bridge |
| Option | Description |
|---|---|
| <service-type> | Service type argument is one of {service-router} Allowed values: service-router, l2-bridge |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <bfd-cmd-type> | BFD command type Allowed values: tunnels, evpn-bfds, tunnel, evpn-bfd |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <bfd-cmd-type> | BFD command type Allowed values: tunnels, evpn-bfds, tunnel, evpn-bfd |
| <local_ip> | Local IP |
| <remote_ip> | Remote IP |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| <entry-mode> | Mode of a mcast filter entry Allowed values: igmp, mld |
| <entry-group> | Group address of a mcast filter entry Allowed pattern: ^([A-Fa-f0-9.:]+)$ |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <mirror-session-id> | Mirror session identifier UUID Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <uplink> | Uplink identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <uplink> | Uplink identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| Option | Description |
|---|---|
| <string> | Application ID Allowed pattern: ^.*$ |
| Option | Description |
|---|---|
| <logical-switch-port-ID> | Logical switch port ID Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vif-ID> | VIF ID Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vif-ID> | VIF ID Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <ids-sig-id-arg> | Integer IDPS signature id Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <profileid> | Profile ID UUID argument |
| Option | Description |
|---|---|
| <ruleid> | Rule ID Integer argument |
| <profileid> | Profile ID UUID argument |
| <signid> | Signature ID Integer argument Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <ids-sig-id-arg> | Integer IDPS signature id Allowed pattern: ^[0-9]+$ |
| <context-profile-id> | Context profile ID argument Allowed pattern: ^[0-9a-zA-Z-]+$ |
| Option | Description |
|---|---|
| <ids-sig-id-arg> | Integer IDPS signature id Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <multicast-ip-address> | Multicast IP address argument |
| Option | Description |
|---|---|
| <image-name> | Edge service container image name |
| Option | Description |
|---|---|
| <image-name> | Edge service container image name |
| Option | Description |
|---|---|
| <interface-name> | Network interface argument |
| Option | Description |
|---|---|
| <interface-name> | Network interface argument |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
| <ip-version> | Internet Protocol Version (IPV4 or IPV6) Allowed values: ipv4, ipv6 |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
| <ip-version> | Internet Protocol Version (IPV4 or IPV6) Allowed values: ipv4, ipv6 |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <session-id> | IKE Session ID |
| Option | Description |
|---|---|
| <session-id> | IKE Session ID |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <session-id> | IKE Session ID |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <session-id> | IKE Session ID |
| Option | Description |
|---|---|
| <session-id> | IKE Session ID |
| Option | Description |
|---|---|
| <session-id> | IKE Session ID |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <rule-id> | Rule ID |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <session-id> | IKE Session ID |
| Option | Description |
|---|---|
| <rule-id> | Rule ID |
| Option | Description |
|---|---|
| <session-id> | IKE Session ID |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <session-id> | IKE Session ID |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <session-id> | IKE Session ID |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <session-id> | IKE Session ID |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <session-id> | IKE Session ID |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <session-id> | IKE Session ID |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <session-id> | IKE Session ID |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <session-id> | IKE Session ID |
| Option | Description |
|---|---|
| <session-id> | IKE Session ID |
| Option | Description |
|---|---|
| <session-id> | IKE Session ID |
| Option | Description |
|---|---|
| <session-id> | IKE Session ID |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <keypolicy-id> | Keypolicy ID for the rule Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <interface-name> | LLDP interface argument |
| Option | Description |
|---|---|
| <interface-name> | LLDP interface argument |
| Option | Description |
|---|---|
| <interface-name> | LLDP interface argument |
| Option | Description |
|---|---|
| <interface-name> | LLDP interface argument |
| Option | Description |
|---|---|
| <interface-name> | LLDP interface argument |
| Option | Description |
|---|---|
| <interface-name> | LLDP interface argument |
| Option | Description |
|---|---|
| <interface-name> | LLDP interface argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <pool-uuid> | Pool UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <regex> | Regular expression |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <monitor-uuid> | Monitor UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <monitor-uuid> | Monitor UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <pool-uuid> | Pool UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <pool-uuid> | Pool UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <pool-uuid> | Pool UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <pool-uuid> | Pool UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
| <regex> | Regular expression |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| Option | Description |
|---|---|
| <pool-uuid> | Pool UUID argument |
| Option | Description |
|---|---|
| <vs-uuid> | Virtual server UUID argument |
| Option | Description |
|---|---|
| <vs-uuid> | Virtual server UUID argument |
| Option | Description |
|---|---|
| <filename> | Log file name |
| Option | Description |
|---|---|
| <filename> | Log file name |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <bgp-community> | BGP community argument, either NO_EXPORT, NO_ADVERTISE, NO_EXPORT_SUBCONFED or community in AA:NN format |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <bgp-large-community> | BGP large-community argument in AA:BB:CC format |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <esi> | Ethernet Segment Identifier (ESI) |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <multicast-ip-address> | Multicast IP address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <multicast-ip-address> | Multicast IP address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <multicast-ip-address> | Multicast IP address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Logical Router identifier Allowed pattern: ^[0-9]+$|^0x[0-9a-fA-F]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | Logical Router identifier Allowed pattern: ^[0-9]+$|^0x[0-9a-fA-F]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <route> | Logical Router route description Allowed values: route |
| Option | Description |
|---|---|
| <uuid> | Logical Router identifier Allowed pattern: ^[0-9]+$|^0x[0-9a-fA-F]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <route> | Logical Router route description Allowed values: route |
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <uuid> | Logical Router identifier Allowed pattern: ^[0-9]+$|^0x[0-9a-fA-F]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <interface-id> | Logical Router interface id Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | Logical Router identifier Allowed pattern: ^[0-9]+$|^0x[0-9a-fA-F]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | Logical Router identifier Allowed pattern: ^[0-9]+$|^0x[0-9a-fA-F]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
get logical-routers command to get a list of logical routers and their router types.| Option | Description |
|---|---|
| <uuid> | UUID argument |
get logical-routers command to get a list of logical routers and their router types.| Option | Description |
|---|---|
| <uuid> | UUID argument |
| Option | Description |
|---|---|
| <uuid> | UUID argument |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <ip-version> | Internet Protocol Version (IPV4 or IPV6) Allowed values: ipv4, ipv6 |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <ip-or-mac-address> | IP or MAC address |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <ip-or-mac-address> | IP or MAC address |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <address-family> | BGP address family argument Allowed values: ipv4, ipv6, evpn |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
get logical-routers command to get a
list of logical routers and their router types.
Optionally specify a prefix or IPv6 address to display only the route used for that network.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <prefix> | IPv6 Prefix or IPv6 address with optional prefix length |
get logical-routers command to get a
list of logical routers and their router types.
Optionally specify a prefix or IPv4 address to display only the route used for that network.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <prefix> | Prefix or IP address with optional prefix length |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <prefix> | Network Address argument |
get logical-router command
also displays Tier 0 NAT, Tier 1 NAT, Tier 1 connected,
Load balancer routes along with Tier 0 & Tier 1 static routes
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <policy-table-id> | Proximity routing policy table identifier UUID or ID |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
| <multicast-ip-address> | Multicast IP address argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <rtep-group-id> | RTEP Group ID |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <logical-switch-id> | Logical switch identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <uuid> | UUID argument |
| Option | Description |
|---|---|
| <uuid> | UUID argument |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
get logical-switches command to get a list of all logical switches. You can use the VNI or UUID to specify the logical switch.| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
get logical-switches command to get a list of all logical switches. You can use the VNI or UUID to specify the logical switch.| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <vni> | vni Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <vni> | vni Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <multicast-ip-address> | Multicast IP address argument |
| Option | Description |
|---|---|
| <mirror-session-id> | Mirror session identifier UUID |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <multicast-ip-address> | Multicast IP address argument |
| Option | Description |
|---|---|
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
get current, will display information about the selected interface.
| Option | Description |
|---|---|
| <physical-port-name> | Datapath String argument |
| Option | Description |
|---|---|
| <physical-port-name> | Datapath String argument |
| Option | Description |
|---|---|
| <physical-port-name> | Datapath String argument |
| Option | Description |
|---|---|
| <physical-port-name> | Datapath String argument |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <prefix> | Prefix or IP address with optional prefix length |
| Option | Description |
|---|---|
| <prefix> | IPv6 Prefix or IPv6 address with optional prefix length |
| Option | Description |
|---|---|
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <prefix> | CIDR notation argument |
| Option | Description |
|---|---|
| <prefix-ipv46> | CIDR notation argument for IPv4/IPv6 address |
get route static command also displays
Tier 0 NAT, Tier 1 NAT, Tier 1 connected, Load balancer routes
along with Tier 0 & Tier 1 static routes
| Option | Description |
|---|---|
| <prefix> | Network Address argument |
| Option | Description |
|---|---|
| <ip-address-type> | IP address type argument Allowed values: ipv4, ipv6 |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <rtep-group-id> | RTEP Group ID |
| Option | Description |
|---|---|
| <rtep-group-id> | RTEP Group ID |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <rtep-group-id> | RTEP Group ID |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | UUID argument |
| Option | Description |
|---|---|
| <uuid> | UUID argument |
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <segment-id> | Segment identifier UUID, VNI or vlan:VLAN-ID |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
get segmentss command to get a list of all segments. You can use the VNI or UUID to specify the logical switch.| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
get segments command to get a list of all segmentss. You can use the VNI or UUID to specify the segment.| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <vni-or-uuid> | VNI or UUID argument Allowed pattern: ^[0-9]+$|^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <service-name> | Node service argument |
| Option | Description |
|---|---|
| <level> | The controller service logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <string> | String argument Allowed pattern: ^.*$ |
| Option | Description |
|---|---|
| <string> | String argument Allowed pattern: ^.*$ |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
| Option | Description |
|---|---|
| <uuid> | Cgroup identifier |
| <translation-type> | Translation type Allowed values: logical-objects, ips, vifs, macs, tns, vms, excluded-ips |
| Option | Description |
|---|---|
| <uuid> | Group identifier |
| <translation-type> | Translation type Allowed values: logical-objects, ips, vifs, macs, tns, vms, excluded-ips |
file argument to save the bundle to a file with the specified file name in the file store. This support bundle does not contain core or audit log files. To include those files, specify the all argument. Core files contain system information and all information stored in memory at the time of the dump (this may include confidential, sensitive or personal information such as passwords and encryption keys, if they are being processed in memory at that time). If you choose to send the support bundle to VMware, it will be processed in accordance with VMware’s standard processes and policies, to provide you with support, fix problems and improve the product and services.
| Option | Description |
|---|---|
| <filename> | Name of file to generate, for example support-bundle.tgz Allowed pattern: ^[^/ *;&|]+$ |
| Option | Description |
|---|---|
| <filename> | Name of file to generate, for example support-bundle.tgz Allowed pattern: ^[^/ *;&|]+$ |
| Option | Description |
|---|---|
| <logical-switch-port-id> | Logical switch port UUID |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <dvport-id> | DVPort identifier Allowed pattern: ^([A-Za-z0-9_:-]+)$ |
| Option | Description |
|---|---|
| <logical-port> | Log port ID argument |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <cached-certificate-id> | Certificate id string argument Allowed pattern: ^([0-9a-f]*)$ |
| Option | Description |
|---|---|
| <certificate-uuid> | TLS Certificate UUID |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <string> | Generic string argument Allowed pattern: ^([A-Za-z0-9_:.-]+)$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <rule-id> | Rule ID Allowed pattern: ^[1-9][0-9]*$ |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <rule-id> | Rule ID Allowed pattern: ^[1-9][0-9]*$ |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| Option | Description |
|---|---|
| <bundle-name> | Name of NSX upgrade bundle in the file store |
| <playbook-file> | Name of Playbook file to use |
| Option | Description |
|---|---|
| <url-string-arg> | URL string, e.g. www.vmware.com Allowed pattern: ^([a-z]+://)?(www.)?[-a-zA-Z0-9@:%._+~#=]{2,256}.[a-z]{2,6}(/([-a-zA-Z0-9@:%_+.~#?&/=]*))?$ |
| Option | Description |
|---|---|
| <username> | Username of user |
| Option | Description |
|---|---|
| <username> | Username of user |
| Option | Description |
|---|---|
| <username> | Username of user |
get transport-node <uuid> vif command or the get logical-switch <uuid> ports command (see Child-UUID where Child-EntityType is VIF).| Option | Description |
|---|---|
| <vif> | VIF ID |
| Option | Description |
|---|---|
| <service-chain-id> | Service Chain Id |
| Option | Description |
|---|---|
| <service-chain-id> | Service Chain Id |
| Option | Description |
|---|---|
| <service-chain-id> | Service Chain Id |
| Option | Description |
|---|---|
| <service-chain-id> | Service Chain Id |
| Option | Description |
|---|---|
| <service-chain-id> | Service Chain Id |
| Option | Description |
|---|---|
| <number> | Datapath service chain ID argument Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <int> | Integer Allowed pattern: ^([0-9]+)$ |
| Option | Description |
|---|---|
| <vtep-group-id> | VTEP Group ID |
| Option | Description |
|---|---|
| <dvs-name> | DVS name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
| Option | Description |
|---|---|
| <image-name> | Edge service container image name |
| <image-version> | Edge service container image version |
get cluster config command to get the cluster ID, and run the get certificate api thumbprint command to get the thumbprint. If you do not provide a password on the command line, you will be prompted to enter one.| Option | Description |
|---|---|
| <ip-address[:port]> | IPv4 or IPv6 address of an NSX Manager and optional port |
| <cluster-id> | Cluster ID of existing cluster to join Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <username> | Manager API username |
| <password> | Manager API password |
| <thumbprint> | Manager API thumbprint |
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | Hostname or IPv4 or IPv6 address of an NSX Manager and optional port |
| <thumbprint> | Manager API thumbprint |
| <token> | Manager API token Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Use the API username and password for the specified NSX Manager. If you do not provide a password on the command line, you will be prompted to enter one.
Get the NSX Manager thumbprint by running the
get certificate api thumbprint command on the
specified NSX Manager.
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | Hostname or IPv4 or IPv6 address of an NSX Manager and optional port |
| <username> | Manager API username |
| <thumbprint> | Manager API thumbprint |
| <password> | Manager API password |
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | Hostname or IPv4 or IPv6 address of an NSX Manager and optional port |
| <username> | Manager API username |
| <thumbprint> | Manager API thumbprint |
| <password> | Manager API password |
| <uuid> | UUID argument Allowed pattern: ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
Use the API username and password for the specified NSX Manager. If you do not provide a password on the command line, you will be prompted to enter one.
Get the NSX Manager thumbprint by running the get certificate api thumbprint command on the specified NSX Manager.
Specify the network interface name used for hypervisors to request keys.
| Option | Description |
|---|---|
| <ip-address[:port]> | IPv4 or IPv6 address of an NSX Manager and optional port |
| <username> | Manager API username |
| <thumbprint> | Manager API thumbprint |
| <password> | Manager API password |
| <interface-name> | Network interface argument |
| Option | Description |
|---|---|
| <action-type> | Livetrace action. Allowed values: counter, follow |
| <port-uuid-name> | Datapath String argument |
| <proto-num> | IP protocol number. Allowed values: TCP, UDP, ICMP, ICMP6, ESP, ALL |
| <prefix> | Network Address argument |
| <l4-port-range> | TCP/UDP port range (0-65535:0-65535) |
| <time-out> | Time measurement in milliseconds Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <action-type> | Livetrace action. Allowed values: counter, follow |
| <port-uuid-name> | Datapath String argument |
| <proto-num> | IP protocol number. Allowed values: TCP, UDP, ICMP, ICMP6, ESP, ALL |
| <prefix> | Network Address argument |
| <time-out> | Time measurement in milliseconds Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <action-type> | Livetrace action. Allowed values: counter, follow |
| <port-uuid-name> | Datapath String argument |
| <proto-num> | IP protocol number. Allowed values: TCP, UDP, ICMP, ICMP6, ESP, ALL |
| <spi-value> | SPI value Allowed pattern: ^0x[a-f0-9]+$ |
| <time-out> | Time measurement in milliseconds Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <action-type> | Livetrace action. Allowed values: counter, follow |
| <port-uuid-name> | Datapath String argument |
| <proto-num> | IP protocol number. Allowed values: TCP, UDP, ICMP, ICMP6, ESP, ALL |
| <time-out> | Time measurement in milliseconds Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <hostname> | System hostname argument |
Note that when run on an NSX Manager, the responding server is reported as 127.0.0.1 instead of the configured name server.
| Option | Description |
|---|---|
| <hostname> | System hostname argument |
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| <hostname-or-ip-address> | A hostname or IP address |
| <ip-address> | Network IP address argument |
You can get a list of logical router interfaces with the get logical-router interfaces command.
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.
| Option | Description |
|---|---|
| <uuid> | Datapath UUID argument |
| <ip-address> | Network IP address argument |
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
repeat argument to specify how many packets to transmit.| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
repeat argument specifies how many ping
packets to transmit.
The size argument specifies the size of the ping
packet. The dfbit argument specifies whether to
set the "don't fragment" bit in the ping packet. If enabled, the
packet will not be fragmented.
The source argument specifies which IP
address to ping from. This may be required in some circumstances
for ping to work as expected. For example, if there is overlap
in IP addresses used in the tier 0 and tier 1 router transit
subnets, pings from the tier 0 VRF will not reach virtual
machines on networks routed by the tier 1 router.
If you use the source argument to specify a unique
IP used by that VRF (in this case, the
tier 0 uplink IP) the pings will reach the virtual machines.
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <dfbit-state> | Enable the DF bit Allowed values: enable |
repeat argument specifies how many ping
packets to transmit. The vrf argument
specifies which VRF to send the pings from. You can get a list of
available VRFs with the get logical-routers command.
The size argument specifies the size of the ping
packet. The dfbit argument specifies whether to
set the "don't fragment" bit in the ping packet. If enabled, the
packet will not be fragmented.
The source argument specifies which IP
address to ping from. This may be required in some circumstances
for ping to work as expected. For example, if there is overlap
in IP addresses used in the tier 0 and tier 1 router transit
subnets, pings from the tier 0 VRF will not reach virtual
machines on networks routed by the tier 1 router.
If you use the source argument to specify a unique
IP used by that VRF (in this case, the
tier 0 uplink IP) the pings will reach the virtual machines.
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <dfbit-state> | Enable the DF bit Allowed values: enable |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <uuid> | Datapath UUID argument |
The repeat argument specifies how many ping packets to transmit.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.
The repeat argument specifies how many ping packets to transmit.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
The size argument specifies the size of the ping packet.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
The size argument specifies the size of the ping packet.
The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
The repeat argument specifies how many ping packets to transmit.
The size argument specifies the size of the ping packet.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
The size argument specifies the size of the ping packet.
The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.
The repeat argument specifies how many ping packets to transmit.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address
The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <uuid> | Datapath UUID argument |
The repeat argument specifies how many ping packets to transmit.
The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address
The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.
The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.
The size argument specifies the size of the ping packet.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
The size argument specifies the size of the ping packet.
The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.
The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.
The size argument specifies the size of the ping packet.
The repeat argument specifies how many ping packets to transmit.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
The repeat argument specifies how many ping packets to transmit.
The size argument specifies the size of the ping packet.
The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.
The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.
The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.
The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.
The repeat argument specifies how many ping packets to transmit.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
The repeat argument specifies how many ping packets to transmit.
The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.
The size argument specifies the size of the ping packet.
The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.
The size argument specifies the size of the ping packet.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.
The size argument specifies the size of the ping packet.
The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
The repeat argument specifies how many ping packets to transmit.
The size argument specifies the size of the ping packet.
The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
The repeat argument specifies how many ping packets to transmit.
The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.
The size argument specifies the size of the ping packet.
The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.
The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.
The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.
The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.
The repeat argument specifies how many ping packets to transmit.
The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.
The size argument specifies the size of the ping packet.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
The repeat argument specifies how many ping packets to transmit.
The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.
The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.
The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.
The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.
The size argument specifies the size of the ping packet.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.
The size argument specifies the size of the ping packet.
The egress argument specifies the egress interface to send the IPv6 ping packets. This is usually required when you ping to a link local IPv6 address.
The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
The repeat argument specifies how many ping packets to transmit.
The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.
The size argument specifies the size of the ping packet.
The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
The repeat argument specifies how many ping packets to transmit.
The vrf argument specifies which VRF to send the pings from. You can get a list of available VRFs with the get logical-routers command.
The size argument specifies the size of the ping packet.
The source argument specifies which IP address to ping from. This may be required in some circumstances for ping to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, pings from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the pings will reach the virtual machines.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <uuid> | Datapath UUID argument |
Use the API username and password for the specified NSX Manager. If you do not provide a password on the command line, you will be prompted to enter one.
Get the NSX Manager thumbprint by running the get certificate api thumbprint command on the specified NSX Manager.
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | Hostname or IPv4 or IPv6 address of an NSX Manager and optional port |
| <username> | Manager API username |
| <thumbprint> | Manager API thumbprint |
force argument, the system will reboot immediately without prompting for confirmation.
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
| Option | Description |
|---|---|
| <uuid> | Generic UUID string argument Allowed pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$ |
Use the API username and password for the specified NSX Manager. If you do not provide a password on the command line, you will be prompted to enter one.
Get the NSX Manager thumbprint by running the get certificate api thumbprint command on the specified NSX Manager.
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | Hostname or IPv4 or IPv6 address of an NSX Manager and optional port |
| <username> | Manager API username |
| <thumbprint> | Manager API thumbprint |
| <password> | Manager API password |
| Option | Description |
|---|---|
| <service-name> | Node restartable service argument |
If you do not provide a passphrase on the command line, you will be prompted to enter one. If you cannot remember the passphrase used to create the backup, you will not be able to restore the backup.
Important: This restore request is one part of the restore process. You must complete all backup and restore tasks in the correct order. See the NSX-T Administration Guide for information and instructions about performing backups and restores.
| Option | Description |
|---|---|
| <filename> | Existing file argument |
| <passphrase> | Backup passphrase |
start upgrade-bundle <bundle-name> playbook <playbook-file> and the system was rebooted.| Option | Description |
|---|---|
| <bundle-name> | Name of NSX upgrade bundle in the file store |
| Option | Description |
|---|---|
| <lockout-period> | Lockout period in seconds |
| Option | Description |
|---|---|
| <lockout-reset-period> | Lockout reset period in seconds |
| Option | Description |
|---|---|
| <auth-failures> | Number of authentication failures to trigger lockout |
| Option | Description |
|---|---|
| <lockout-period> | Lockout period in seconds |
| Option | Description |
|---|---|
| <auth-failures> | Number of authentication failures to trigger lockout |
| Option | Description |
|---|---|
| <password-length> | Password length argument |
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
| <thumbprint> | The thumbprint of the vidm host |
| <vidm-client-id> | vIDM client id parameter Allowed pattern: .* |
| <vidm-client-secret> | vIDM client secret parameter Allowed pattern: .* |
| Option | Description |
|---|---|
| <uuid> | UUID argument |
set capture session <session-number> interface <port-uuid-name> direction <direction> command in basic mode, or with the set capture session <session-number> direction <direction> command in path mode. Use the get capture sessions command in basic mode to see all configured capture sessions.
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
set capture session <session-number> interface <port-uuid-name> direction <direction> command in basic mode, or with the set capture session <session-number> direction <direction> command in path mode. Use the get capture sessions command in basic mode to see all configured capture sessions.
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
Start the packet capture with the set capture session
<session-number> command in either basic or path
mode, or with the set capture session
<session-number> [file <filename> [count
<packet-count> [expression <expression>
command in basic mode.
Use the get capture sesssions command in basic mode
to see all configured capture sessions.
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
To run the packet capture using this configuration, use the
set capture session <session-number>
[file <filename>] [count <packet-count>]
[expression <expression>] command.
If you need to capture packets from only one interface, you
can configure and run the packet capture with a single command:
start capture interface <interface-name>
[file <filename>] [count <packet-count>]
[expression <expression>].
Use the get capture sessions command
to see all configured capture sessions.
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
| <interface-name> | Network interface argument |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
set capture session
<session-number> interface <port-uuid-name>
direction <direction> command.
If you don't specify a file, the output displays on the terminal.
Type Control-C to end the packet capture.
You can filter the capture using tcpdump expressions. The expression must be the last argument of the command.
Use the get capture sessions command
to see all configured capture sessions.
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
| <filename> | Capture file name Allowed pattern: ^[^/ *;&|]+$ |
| <packet-count> | Packet count value greater than or equal to 1 |
| <expression> | Packet capture expression Allowed pattern: ^.*$ |
set capture session
<session-number> interface <port-uuid-name>
direction <direction> command.
If you don't specify a file, the output displays on the terminal.
If file is specified, the file count can be specified to enable rotating capture files, where each file will be of size 100MB. Multiple files will be bundled into single tarfile.
Type Control-C to end the packet capture.
You can filter the capture using tcpdump expressions. The expression must be the last argument of the command.
Use the get capture sessions command
to see all configured capture sessions.
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
| <filename> | Capture file name Allowed pattern: ^[^/ *;&|]+$ |
| <packet-count> | Packet count value greater than or equal to 1 |
| <expression> | Packet capture expression Allowed pattern: ^.*$ |
To run the packet capture using this configuration, use the
set capture session <session-number>
[file <filename>] [count <packet-count>]
[expression <expression>] command.
If you need to capture packets from only one interface, you
can configure and run the packet capture with a single command:
start capture interface <interface-name>
[direction <direction>] [file <filename>]
[count <packet-count>] [expression <expression>].
Use the get capture sessions command
to see all configured capture sessions.
| Option | Description |
|---|---|
| <session-number> | Session ID argument in numbers |
| <port-uuid-name> | Datapath String argument |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <core-id> | Core id for packet capture session Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <datetime-arg> | DateTime stamp status argument Allowed values: disable, enable |
Set NSX-CLI state on ESXi host to include or exclude data from ESXio node for issued commands.
Default state is set to be enabled when ESXi host is registered with ESXio nodes and is set to disabled when no ESXio nodes found.
| Option | Description |
|---|---|
| <esxio-cli-state> | ESXio CLI output state argument Allowed values: disable, enable |
| Option | Description |
|---|---|
| <timeout> | Number of seconds before timeout or 0 to disable timeout |
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
| Option | Description |
|---|---|
| <api-service-client-api-concurrency-limit> | Cluster API service API per-client concurrency limit value in the range of 0 - 9223372036854775807 |
| Option | Description |
|---|---|
| <api-service-client-api-rate-limit> | Cluster API service API per-client rate limit in calls per second |
| Option | Description |
|---|---|
| <api-service-conn-timeout> | Cluster API service connection timeout in seconds |
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
| Option | Description |
|---|---|
| <api-service-global-api-concurrency-limit> | Cluster API service API global concurrency limit value in the range of 0 - 9223372036854775807 |
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
| Option | Description |
|---|---|
| <api-service-session-timeout> | Cluster API service session timeout in seconds |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
Note, disabling config may consume higher disk space and can cause disk outage.
| Option | Description |
|---|---|
| <core-dump-limit> | Core dump numeric argument |
Note, disabling config may consume higher disk space and can cause disk outage.
| Option | Description |
|---|---|
| <core-dump-limit> | Core dump numeric argument |
Note, disabling config may consume higher disk space and can cause disk outage.
| Option | Description |
|---|---|
| <process-name> | Core dump process name |
| <core-dump-limit> | Core dump numeric argument |
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
| Option | Description |
|---|---|
| <pci-address-arg> | PCI address |
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
| Option | Description |
|---|---|
| <flow-cache-size> | Flow cache size of a core (8 minimum, must be power of two) |
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
| Option | Description |
|---|---|
| <jumbo-mbuf-pool-size> | Size of jumbo mbuf pool (1024 minimum, 4096 by defualt) |
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
| Option | Description |
|---|---|
| <number> | Max number of packets queued by each core |
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
| Option | Description |
|---|---|
| <queue-num-per-port-per-core-arg> | The number of queues Dataplane allocates per port per core |
| Option | Description |
|---|---|
| <ring-size> | Ring size (128 - 4096) |
| Option | Description |
|---|---|
| <ring-size> | Ring size (128 - 4096) |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <ens-lc-mode> | ENS lcore assignment mode name Allowed values: vNIC-count, cpu-usage |
This command should be used for advanced configuration or troubleshooting only.
If you manually configure the active/standby peer on an edge node, you must also configure its peer.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| <ip-address> | Network IP address argument |
| <uuid> | UUID argument |
This command should be used for advanced configuration or troubleshooting only.
If you manually configure the active/standby sync, you must correctly configure both edge nodes in the active/standby configuration. One node must be configured as primary and one as secondary. One node must be configured as active, and one as passive.
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| <sync-rank> | One of {primary|secondary} Allowed values: primary, secondary |
| <sync-mode> | One of {active|passive} Allowed values: active, passive |
| Option | Description |
|---|---|
| <boolean-arg> | Boolean enum value Allowed values: true, false |
| <dvs-name> | DVS name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
| Option | Description |
|---|---|
| <grub-menu-timeout> | GRUB menu timeout in seconds |
| Option | Description |
|---|---|
| <grub-username> | Username of GRUB user |
| <grub-password> | Password for the GRUB user |
| Option | Description |
|---|---|
| <level> | The gw-controller service logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <enabled-clear> | One of {enabled|disabled|clear} Allowed values: enabled, disabled, clear |
| Option | Description |
|---|---|
| <enabled-clear> | One of {enabled|disabled|clear} Allowed values: enabled, disabled, clear |
| <vm-id> | VM ID |
| Option | Description |
|---|---|
| <history-size> | Integer value for history size or 0 to display all commands |
| Option | Description |
|---|---|
| <host-switch-name> | Host switch name |
| <mcast-filter-mode> | Mode of mcast filter Allowed values: legacy, snooping |
| Option | Description |
|---|---|
| <boolean-arg> | Boolean enum value Allowed values: true, false |
| Option | Description |
|---|---|
| <hostname> | System hostname argument |
| Option | Description |
|---|---|
| <hugepage-size> | Hugepage size in MB or GB Allowed pattern: ^[0-9]+([M|G]B)?$ |
| Option | Description |
|---|---|
| <idsengalertlog> | Engine Fast Log Allowed values: disable, enable |
| Option | Description |
|---|---|
| <ids-eng-fastlog-arg> | IDS Engine Fast Log setting Allowed values: disable, enable |
| Option | Description |
|---|---|
| <idsengloglevel> | Engine Log level Allowed values: off, emergency, alert, critical, error, warning, notice, info, perf, config, debug |
| Option | Description |
|---|---|
| <ids-logging-level-arg> | Edge IDS logging level Allowed values: debug, emer, error, info, verbose, warn |
| Option | Description |
|---|---|
| <idsloglevel> | Log level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <interface-name> | Configurable network interface argument |
| Option | Description |
|---|---|
| <interface-name> | Configurable network interface argument |
| <plane> | Interface plane argument Allowed values: mgmt, debug |
| <mode> | Bond mode (e.g. active-backup) Allowed values: active-backup |
| <members> | Bond member devices (e.g. eth0,eth1) |
| <primary> | Bond primary device (in active-backup mode, e.g. eth0) |
plane property of the interface and config the IP address. If plane is set to mgmt, it is reported as such to the management plane (MP) via MPA, and the slave devices are not consumed by dataplane for dataplane operations. You can configure the bond interface with a DHCP or static IP address. If you configure a static IP address, make sure an appropriate network route is also configured.
| Option | Description |
|---|---|
| <interface-name> | Configurable network interface argument |
| <prefix> | CIDR notation argument |
| <gateway-ip> | Gateway IP address argument |
| <plane> | Interface plane argument Allowed values: mgmt, debug |
| <mode> | Bond mode (e.g. active-backup) Allowed values: active-backup |
| <members> | Bond member devices (e.g. eth0,eth1) |
| <primary> | Bond primary device (in active-backup mode, e.g. eth0) |
interface. and the interface's plane property will be set to mgmt. Any existing configuration on the parent interface will be deleted. Users must use the newly created VLAN network interface for configuration.| Option | Description |
|---|---|
| <interface-name> | Configurable network interface argument |
| <vlan> | VLAN id <1-4094> Allowed pattern: ^([1-9]|[1-9][0-9]|[1-9][0-9]{2}|[1-3][0-9]{3}|40[0-9][0-4])$ |
plane property of the interface and optionally configure the IP address. By default, the plane property is not configured, the dataplane component takes control of the interface for the data path and the interface is not visible to the Linux kernel. If plane is set to mgmt, it is reported as such to the management plane (MP) via MPA, and the corresponding interface is not consumed by the dataplane for dataplane operations and is available for configuration from the CLI. If it is set to debug, the dataplane does not consume the interface for dataplane operations and the interface is available for configuration from the CLI. Optionally, you can configure the interface with a DHCP or static IP address. If you configure a static IP address, make sure an appropriate network route is also configured. You can use the optional gateway argument, or set a route using the set route command.
For NSX Manager or a controller, you cannot configure the plane property. You also cannot configure a DHCP or static IP address because both NSX Manager and a controller have a static IP address that is set at installation and cannot be changed.
| Option | Description |
|---|---|
| <interface-name> | Configurable network interface argument |
| <prefix> | CIDR notation argument |
| <gateway-ip> | Gateway IP address argument |
| <plane> | Interface plane argument Allowed values: mgmt, debug |
gateway argument, or set a route using the set route command. You cannot configure a static IP address for NSX Manager or a controller because their static IP address is set at installation and cannot be changed.
| Option | Description |
|---|---|
| <interface-name> | Configurable network interface argument |
| <prefix> | CIDR notation argument |
| <gateway-ip> | Gateway IP address argument |
| Option | Description |
|---|---|
| <interface-name> | Configurable network interface argument |
| <prefix-ipv6> | CIDR notation argument for IPv6 address |
ethX.vlan and the interface's plane property will be set to mgmt. Users must use the newly created in-band VLAN network interface for configuration.| Option | Description |
|---|---|
| <mac-address> | Configurable mac address argument |
| <vlan> | VLAN id <1-4094> Allowed pattern: ^([1-9]|[1-9][0-9]|[1-9][0-9]{2}|[1-3][0-9]{3}|40[0-9][0-4])$ |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <pool-uuid> | Pool UUID argument |
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
| Option | Description |
|---|---|
| <lb-uuid> | LoadBalancer UUID argument |
| <vs-uuid> | Virtual server UUID argument |
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
| Option | Description |
|---|---|
| <perf-profile-type> | Performance profile type argument Allowed values: http, https, l4 |
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | A hostname or IPv4 or IPv6 address with optional port delimited by a colon |
| <proto> | Logging server protocol Allowed values: tcp, udp, tls, li, li-tls |
| <level> | Level of log entries to export Allowed values: emerg, alert, crit, err, warning, notice, info, debug |
| <facility> | Comma delimited list of facilities of log entries to export |
| <messageid> | Comma delimited list of MSGIDs of log entries to export |
| <filename> | Existing file argument |
| <structured-data> | Structured data of log entries to export Allowed pattern: ^(alarmId|alarmState|audit|comp|depr|entId|eReqId|errorCode|eventFeatureName|eventId|eventSev|eventState|eventType|euser|level|method|nodeId|path|security|subcomp|s2comp|splitId|splitIndex|tenantId|tid|tname|update|username)=.+$ |
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | A hostname or IPv4 or IPv6 address with optional port delimited by a colon |
| <proto> | Logging server protocol Allowed values: tcp, udp, tls, li, li-tls |
| <level> | Level of log entries to export Allowed values: emerg, alert, crit, err, warning, notice, info, debug |
| <facility> | Comma delimited list of facilities of log entries to export |
| <messageid> | Comma delimited list of MSGIDs of log entries to export |
| <filename> | Existing file argument |
| <structured-data> | Structured data of log entries to export Allowed pattern: ^(alarmId|alarmState|audit|comp|depr|entId|eReqId|errorCode|eventFeatureName|eventId|eventSev|eventState|eventType|euser|level|method|nodeId|path|security|subcomp|s2comp|splitId|splitIndex|tenantId|tid|tname|update|username)=.+$ |
| Option | Description |
|---|---|
| <nsxproxy-maintenance-mode> | One of {enabled|disabled} Allowed values: enabled, disabled |
| Option | Description |
|---|---|
| <ip-address> | Name server IP v4 or v6 address argument |
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
- Minimum number of characters expected in password; user can not set their password of length lesser than this parameter. Default: 12, Minimum: 8, Maximum: 128
- Maximum number of characters allowed in password; user can not set their password of length greater than this parameter. Default: 128, Minimum: 8, Maximum: 128
- Number of lower case characters (a..z) expected in user password.
N > 0, to set maximum credit for having lower case letters in the new password, i.e. this is the maximum number of lower case characaters that are allowed for a new password.
N < 0, to set minimum credit for having lower case letters in the new password, i.e. this is the minimum number of lower case characters that must be met for a new password.
N = 0, to disable the policy check.
Default: -1, Minimum: -128, Maximum: 128- Number of upper case characters (A..Z) expected in user password.
N > 0, to set maximum credit for having upper case letters in the new password, i.e. this is the maximum number of upper case characters that are allowed for a new password.
N < 0, to set minimum credit for having upper case letters in the new password, i.e. this is the minimum number of lower case characters that must be met for a new password.
N = 0, to disable the policy check.
Default: -1, Minimum: -128, Maximum: 128- Number of digits (0..9) expected in user password.
N > 0, to set maximum credit for having digits in the new password, i.e. this is the maximum number of digits that are allowed for a new password.
N < 0, to set minimum credit for having digits in the new password, i.e. this is the minimum number of digits that must be met for a new password.
N = 0, to disable the policy check.
Default: -1, Minimum: -128, Maximum: 128- Number of special characters (!@#$&*..) expected in user password.
N > 0, to set maximum credit for having special letters in the new password, i.e. this is the maximum number of sepcial characters that are allowed for a new password.
N < 0, to set minimum credit for having special letters in the new password, i.e. this is the minimum number of sepcial characters that must be met for a new password.
N = 0, to disable the policy check.
Default: -1, Minimum: -128, Maximum: 128- Number of character changes in the new password that differentiate it from the old password. To disable the check, value should be set to 0. Default: 0, Minimum: 0, Maximum: 128
- Reject passwords which contain more than N same consecutive characters. To disable the check, value should be set to 0. Default: 0, Minimum: 0, Maximum: 128
- Reject passwords which contain more than N monotonic character sequences. Monotonic sequences can be '12345' or 'fedcb'. To disable the check, value should be set to 0. Default: 0, Minimum: 0, Maximum: 128
- Sets hash/cryptographic algorithm type for new passwords. Default: sha512. Enum: [ sha512, sha256 ]
- Limit using a password that was used in past; users can not set the same password within the N generations. To disable the check, value should be set to 0. Default: 0, Minimum: 0
| Option | Description |
|---|---|
| <physical-port-name> | Datapath String argument |
| dpd-physical-port-mtu-arg | MTU for a physical port (1500-9000) |
| Option | Description |
|---|---|
| <physical-port-name> | Datapath String argument |
| <physical-port-state> | One of {up|down} Allowed values: up, down |
prefix value of 0.0.0.0/0.| Option | Description |
|---|---|
| <prefix> | CIDR notation argument |
| <ip-route-metric> | IP route metric argument Allowed pattern: ^[0-9]+$ |
| <gateway-ip> | Gateway IP address argument |
| <interface-name> | Configurable network interface argument |
prefix value of 0.0.0.0/0 for Ipv4 and ::/0 for Ipv6. Default value for the IPv6 route metric is 1024.| Option | Description |
|---|---|
| <prefix-ipv46> | CIDR notation argument for IPv4/IPv6 address |
| <ip-route-metric> | IP route metric argument Allowed pattern: ^[0-9]+$ |
| <gateway-ipv46> | Gateway IPv4/IPv6 address argument |
| <interface-name> | Configurable network interface argument |
| Option | Description |
|---|---|
| <domain> | Search domain argument |
| Option | Description |
|---|---|
| <async-replicator-level> | Async replicator logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <auth-level> | Auth logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | The controller service logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <string> | String argument Allowed pattern: ^.*$ |
| <level> | The controller service logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <string> | String argument Allowed pattern: ^.*$ |
| <level> | The controller service logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | Edge service logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | Edge service logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <mode> | DHCP Pool Monitor Enable/Disable Flag Allowed values: on, off |
| <number> | DHCP Pool Monitor Interval |
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
| Option | Description |
|---|---|
| <http-client-api-concurrency-limit> | HTTP API per-client concurrency limit value in the range of 0 - 9223372036854775807 |
| Option | Description |
|---|---|
| <http-client-api-rate-limit> | HTTP API per-client rate limit in calls per second |
| Option | Description |
|---|---|
| <http-conn-timeout> | HTTP connection timeout in seconds |
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
| Option | Description |
|---|---|
| <http-global-api-concurrency-limit> | HTTP API global concurrency limit value in the range of 0 - 9223372036854775807 |
| Option | Description |
|---|---|
| <http-level> | HTTP logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
| Option | Description |
|---|---|
| <http-session-timeout> | HTTP session timeout in seconds |
| Option | Description |
|---|---|
| <ipv4-addr> | IPv4 Address |
| <debug-level-arg> | IKE Debug level Allowed values: off, fail, highok, highstart, uncommon, midok, midstart, lowok, lowstart |
| Option | Description |
|---|---|
| <ipv4-addr> | IPv4 Address |
| <debug-level-arg> | IKE Debug level Allowed values: off, fail, highok, highstart, uncommon, midok, midstart, lowok, lowstart |
| Option | Description |
|---|---|
| <level> | Edge service logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | Keymanager logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | Edge service logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | Manager logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | Manager logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
| <manager-package-name> | Manager package name argument |
| Option | Description |
|---|---|
| <level> | NSX Agent service logging level argument Allowed values: fatal, error, warn, info, debug, trace, off |
| Option | Description |
|---|---|
| <level> | Cfgagent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | Cfgagent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | Cfgagent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | Cfgagent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | Cfgagent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | Cfgagent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | Cfgagent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | Cfgagent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | Cfgagent trace level Allowed values: off, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | Cfgagent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | Context mux logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <protocol> | Context Engine event protocol Allowed values: tcp, udp, icmp |
| <enable> | Context Engine event protocol enable Allowed values: off, on |
| Option | Description |
|---|---|
| <level> | Exporter service logging level argument Allowed values: fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | Exporter service logging level argument Allowed values: fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | Netopa logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | OpsAgent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | OpsAgent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | OpsAgent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | OpsAgent trace level Allowed values: off, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | OpsAgent logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | Platform client service logging level argument Allowed values: fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | NsxProxy logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | NsxProxy logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | NsxProxy logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | NsxProxy logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | NsxProxy logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | NsxProxy logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | NsxSNProxy logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | NsxSNProxy logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | NsxSNProxy logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | NsxSNProxy logging level Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <destination> | Edge Routing service logging destination argument Allowed values: file, syslog |
| <level> | Edge Routing service logging level argument Allowed values: off, error, warning, notification, informational, debug |
| Option | Description |
|---|---|
| <level> | Edge Routing Platform service logging level argument Allowed values: off, fatal, error, warn, info, debug |
| Option | Description |
|---|---|
| <telemetry-level> | Telemetry logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <community-string> | SNMP community string Allowed pattern: ^[\S]{1,64}$ |
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | A hostname or IPv4 or IPv6 address with optional port delimited by a colon |
| <community-string> | SNMP community string Allowed pattern: ^[\S]{1,64}$ |
| Option | Description |
|---|---|
| <v3-engine-id> | SNMP v3 Engine ID Allowed pattern: ^[0-9a-fA-F]{10,64}$ |
| Option | Description |
|---|---|
| <v3-auth-protocol> | SNMP v3 Auth Protocol Allowed pattern: SHA1 |
| <v3-priv-protocol> | SNMP v3 Priv Protocol Allowed pattern: AES128 |
| Option | Description |
|---|---|
| <hostname-or-ip-address[:port]> | A hostname or IPv4 or IPv6 address with optional port delimited by a colon |
| <v3-user> | SNMP v3 user Allowed pattern: ^[\S]{1,32}$ |
| Option | Description |
|---|---|
| <v3-user> | SNMP v3 user Allowed pattern: ^[\S]{1,32}$ |
| Option | Description |
|---|---|
| <v3-user> | SNMP v3 user Allowed pattern: ^[\S]{1,32}$ |
| <auth-password> | SNMP v3 User Auth Password |
| <priv-password> | SNMP v3 user Priv Password |
| Option | Description |
|---|---|
| <timezone> | Timezone (e.g. UTC, America/New_York, Asia/Tokyo, Europe/Zurich) |
| Option | Description |
|---|---|
| <level> | Edge service logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
| Option | Description |
|---|---|
| <level> | Edge service logging level argument Allowed values: off, fatal, error, warn, info, debug, trace |
| <dest> | TLS Inspection logging destination argument Allowed values: syslog, console |
| Option | Description |
|---|---|
| <username> | Username of user |
| <password-expiration-days> | Number of days password valid after change (1 - 9999) |
| Option | Description |
|---|---|
| <username> | Username of user |
| <password-expiration-warn-days> | Number of days password warn messages before change (1 - 9999) |
| Option | Description |
|---|---|
| <username> | Username of user |
| <new-username> | Username of user |
| Option | Description |
|---|---|
| <username> | Username of user |
| <password> | Password of user |
| <old-password> | Current password of user |
| Option | Description |
|---|---|
| <username> | Username of user |
| <key-label> | Unique label for SSH key |
| <key-type> | SSH key type Allowed values: ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, ecdsa-sha2-nistp521, ssh-dss, ssh-ed25519, ssh-rsa |
| <key-value> | SSH key value |
| <password> | Password of user |
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
| Option | Description |
|---|---|
| <enabled> | One of {enabled|disabled} Allowed values: enabled, disabled |
| Option | Description |
|---|---|
| <option-name> | Runtime option name Allowed values: IGMPQueries, IGMPQueryInterval, IGMPRouterIP, IGMPV3MaxSrcIPNum, IGMPVersion, MLDRouterIP, MLDV2MaxSrcIPNum, MLDVersion, MaxRARPsPerInterval, RARPAdvertisementDuration, TeamPolicyUpDelay |
| <option-value> | Runtime option value Allowed pattern: ^(([0-9]+)|(((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9]).){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9]))|(([A-Za-z0-9]{0,4}:){5}[A-Za-z0-9]{0,4}))$ |
| Option | Description |
|---|---|
| <boolean-arg> | Boolean enum value Allowed values: true, false |
| <dvs-name> | DVS name Allowed pattern: ^([A-Za-z0-9_:.-]|\s)+$ |
force argument, the system will shut down immediately without prompting for confirmation.
start capture dvfilter followed by a space and the Tab key.| Option | Description |
|---|---|
| <esx-dvfilter-name> | dvfilter name argument |
| Option | Description |
|---|---|
| <interface-name> | Network interface argument |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <capture-snaplen> | Packet capture snapshot length |
| <filename> | Capture file name Allowed pattern: ^[^/ *;&|]+$ |
| <file-count> | File count for rotating capture (1-25) |
| <expression> | Packet capture expression Allowed pattern: ^.*$ |
| Keyword | Value |
| ethtype | Ethernet type in HEX format. 0x<ETHTYPE> |
| mac | Source or destination MAC address |
| srcmac | Source MAC address |
| dstmac | Destination MAC address |
| ipproto | IP protocol in HEX format. 0x<PROTO> |
| ip | Source or destination IPv4 address |
| srcip | Source IPv4 address |
| dstip | Destination IPv4 address |
| port | Source or destination TCP port |
| srcport | Source TCP port |
| dstport | Destination TCP port |
| vni | VNI of the flow |
| vlan | VLAN ID |
| Option | Description |
|---|---|
| <interface-name> | Network interface argument |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <filename> | Capture file name Allowed pattern: ^[^/ *;&|]+$ |
| <packet-count> | Packet count value greater than or equal to 1 |
| <expression> | Packet capture expression Allowed pattern: ^.*$ |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <fcport-id> | Packet capture fcport id parameter Allowed pattern: ^[0-9]+$ |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <fcport-id> | Packet capture fcport id parameter Allowed pattern: ^[0-9]+$ |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <arguments> | Packet capture option parameter |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <fcport-id> | Packet capture fcport id parameter Allowed pattern: ^[0-9]+$ |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <fcport-id> | Packet capture fcport id parameter Allowed pattern: ^[0-9]+$ |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| <arguments> | Packet capture option parameter |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <filter-name> | Packet capture filter name parameter |
| <stage-type> | Packet capture filter stage parameter Allowed values: pre, post |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <filter-name> | Packet capture filter name parameter |
| <stage-type> | Packet capture filter stage parameter Allowed values: pre, post |
| <arguments> | Packet capture option parameter |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <filter-name> | Packet capture filter name parameter |
| <stage-type> | Packet capture filter stage parameter Allowed values: pre, post |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <filter-name> | Packet capture filter name parameter |
| <stage-type> | Packet capture filter stage parameter Allowed values: pre, post |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| <arguments> | Packet capture option parameter |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <cap-interface-id> | Interface id Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <cap-interface-id> | Interface id Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <arguments> | Packet capture option parameter |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <cap-interface-id> | Interface id Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <cap-interface-id> | Interface id Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| <arguments> | Packet capture option parameter |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <pnic-value> | Packet capture pnic value parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <pnic-value> | Packet capture pnic value parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <arguments> | Packet capture option parameter |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <pnic-value> | Packet capture pnic value parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <pnic-value> | Packet capture pnic value parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| <arguments> | Packet capture option parameter |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vdrport-id> | Vdrport id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vdrport-id> | Vdrport id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <arguments> | Packet capture option parameter |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vdrport-id> | Vdrport id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vdrport-id> | Vdrport id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| <arguments> | Packet capture option parameter |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vif> | VIF ID |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vif> | VIF ID |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <arguments> | Packet capture option parameter |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vif> | VIF ID |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vif> | VIF ID |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| <arguments> | Packet capture option parameter |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vmknic-id> | Vmknic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vmknic-id> | Vmknic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <arguments> | Packet capture option parameter |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vmknic-id> | Vmknic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vmknic-id> | Vmknic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| <arguments> | Packet capture option parameter |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vmnic-id> | Vmnic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vmnic-id> | Vmnic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <arguments> | Packet capture option parameter |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vmnic-id> | Vmnic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vmnic-id> | Vmnic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| <arguments> | Packet capture option parameter |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vnic-id> | Vnic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vnic-id> | Vnic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <arguments> | Packet capture option parameter |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vnic-id> | Vnic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <cap-node-id> | Capture node id parameter Allowed pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ |
| <vnic-id> | Vnic id parameter |
| <capture-direction> | Packet capture direction parameter Allowed values: input, output, dual |
| <receiver_address> | Packet capture address parameter |
| <port-id> | Packet capture port parameter Allowed pattern: ^[0-9]+$ |
| <arguments> | Packet capture option parameter |
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| Option | Description |
|---|---|
| <core-id> | Core id for packet capture session Allowed pattern: ^[0-9]+$ |
| <time> | Time measurement in seconds Allowed pattern: [1-9][0-9]*$ |
| Option | Description |
|---|---|
| <search-scope> | Search scope argument Allowed values: manager, policy, csm, global-manager, inventory, idps-reporting, telemetry, all |
| Option | Description |
|---|---|
| <service-name> | Node startable and stoppable service argument |
| Option | Description |
|---|---|
| <bundle-name> | Name of NSX upgrade bundle in the file store |
| <playbook-file> | Name of Playbook file to use |
| Option | Description |
|---|---|
| <session-id-arg> | Packet capture session id parameter |
| Option | Description |
|---|---|
| <uuid> | Firewall logical interface UUID argument |
| Option | Description |
|---|---|
| <service-name> | Node startable and stoppable service argument |
| Option | Description |
|---|---|
| <port-uuid-name> | Datapath String argument |
| <base64-string> | Datapath Base64 Encoded String argument |
| Option | Description |
|---|---|
| <hostname-or-ip-address> | A hostname or IP address |
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
The maxttl specifies the maximum time-to-live, or
maximum number of routers the traceroute packet will traverse.
The source argument specifies which source IP
address to use for traceroute. This may be required in some
circumstances for traceroute to work as expected. For example,
if there is overlap in IP addresses used in the tier 0 and
tier 1 router transit subnets, traceroute packets from the
tier 0 VRF will not reach virtual machines on networks routed
by the tier 1 router. If you use the source argument
to specify a unique IP used by that VRF (in this case, the tier 0
uplink IP) the traceroute packets will reach the virtual machines.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
maxttl specifies the maximum time-to-live, or
maximum number of routers the traceroute packet will traverse.
The vrfid argument
specifies which VRF to send the traceroute packets from. You can
get a list of available VRFs with the
get logical-routers command.
The source argument specifies which source IP
address to use for traceroute. This may be required in some
circumstances for traceroute to work as expected. For example,
if there is overlap in IP addresses used in the tier 0 and
tier 1 router transit subnets, traceroute packets from the
tier 0 VRF will not reach virtual machines on networks routed
by the tier 1 router. If you use the source argument
to specify a unique IP used by that VRF (in this case, the tier 0
uplink IP) the traceroute packets will reach the virtual machines.
| Option | Description |
|---|---|
| <ip-address> | Network IP address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
maxttl specifies the maximum time-to-live, or maximum number of routers the traceroute packet will traverse.| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
The source argument specifies which source IP address to use for traceroute. This may be required in some circumstances for traceroute to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, traceroute packets from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the traceroute packets will reach the virtual machines.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
The maxttl specifies the maximum time-to-live, or maximum number of routers the traceroute packet will traverse.
The source argument specifies which source IP address to use for traceroute. This may be required in some circumstances for traceroute to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, traceroute packets from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the traceroute packets will reach the virtual machines.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
The vrfid argument specifies which VRF to send the traceroute packets from. You can get a list of available VRFs with the get logical-routers command.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
maxttl specifies the maximum time-to-live, or maximum number of routers the traceroute packet will traverse. The vrfid argument specifies which VRF to send the traceroute packets from. You can get a list of available VRFs with the get logical-routers command.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
The vrfid argument specifies which VRF to send the traceroute packets from. You can get a list of available VRFs with the get logical-routers command.
The source argument specifies which source IP address to use for traceroute. This may be required in some circumstances for traceroute to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, traceroute packets from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the traceroute packets will reach the virtual machines.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
The maxttl specifies the maximum time-to-live, or maximum number of routers the traceroute packet will traverse.
The vrfid argument specifies which VRF to send the traceroute packets from. You can get a list of available VRFs with the get logical-routers command.
The source argument specifies which source IP address to use for traceroute. This may be required in some circumstances for traceroute to work as expected. For example, if there is overlap in IP addresses used in the tier 0 and tier 1 router transit subnets, traceroute packets from the tier 0 VRF will not reach virtual machines on networks routed by the tier 1 router. If you use the source argument to specify a unique IP used by that VRF (in this case, the tier 0 uplink IP) the traceroute packets will reach the virtual machines.
| Option | Description |
|---|---|
| <ip-address> | Network IPv6 address argument |
| <vrf-id> | VRF ID argument Allowed pattern: ^[0-9]+$ |
| <number> | Number argument Allowed pattern: ^[0-9]+$ |
| Option | Description |
|---|---|
| <cluster-id> | ESXi Cluster ID |
| <timeout> | Timeout for ESX enter maintenance mode in minutes. Allowed pattern: ^([0-9]+)$ |
| Option | Description |
|---|---|
| <cluster-name> | ESXi Cluster Name |
| <timeout> | Timeout for ESX enter maintenance mode in minutes. Allowed pattern: ^([0-9]+)$ |
| Option | Description |
|---|---|
| <configfile> | Transport node list file |
| <timeout> | Timeout for ESX enter maintenance mode in minutes. Allowed pattern: ^([0-9]+)$ |
| Option | Description |
|---|---|
| <image-filename> | Edge service container image filename |
| Option | Description |
|---|---|
| <bundle-name> | Name of NSX upgrade bundle in the file store |
get logical-routers command.| Option | Description |
|---|---|
| <uuid-vrfid> | Datapath UUID or VRF ID argument |