Notational Conventions

The following notational conventions are used in this document:

Understanding Command Syntax

<variable> Variables are described with a short description enclosed within a ‘<‘ and a ‘>' pair.

For example, the command,

nx9500-6C8809>show interface ge 1

is documented as:

show interface ge <1-2>

where:

  • show – is the command – displays information
  • interface – is the keyword – represents the interface type
  • <1-2> – is the variable – represents the ge interface index value
    Note: Since this output is from an NX 9500 service platform, which supports only two (2) GE interfaces, the index value is shown as <1-2>. This value will vary depending on the platform type.
| The pipe symbol. This is used to separate the variables/keywords in a list.

For example, the command,

nx9500-6C8809> show .....

is documented as:

show [adoption|bluetooth|bonjour|boot|...........

where:

  • show – is the command – displays information
  • [adoption|bluetooth|bonjour|boot|.........] – indicates the different keywords that can be combined with the show command. However, only one of the above option can be used at a time.
show adoption ...
show bluetooth ...
show bonjour ...
[]

Of the different keywords and variables listed inside a ‘[‘ & ‘]' pair, only one can be used. Each choice in the list is separated with a ‘|' (pipe) symbol.

For example, the command,

nx9500-6C8809# clear ...

is documented as:

clear [arp-cache|bonjour|cdp|counters|crypto|
event-history|firewall|gre|ip|ipv6|l2tpv3-stats|lacp|
license|lldp|logging|mac-addresstable|mint|role|rtls|
spanning-tree|traffic-shape|vrrp]

where:

  • clear – is the command
  • [arp-cache|bonjour|cdp|counters|crypto| ….….…....|vrrp] – indicates that these keywords are available for this command. However, only one can be used at a time.
{ } Any command/keyword/variable or a combination of them inside a ‘{‘ &‘}' pair is optional. All optional commands follow the same conventions as listed above. However, they are displayed italicized.

For example, the command,

nx9500-6C8809> show adoption ....

is documented as:

show adoption info {on <DEVICE-NAME>}

here:

  • show adoption info – is the command. This command can also be used as:
show adoption info

The command can also be extended as:

show adoption info {on <DEVICE-NAME>}

here:

  • {on <DEVICE-NAME>} – is the optional keyword.
command / keyword The first word is always a command. Keywords are words that must be entered as is. Commands and keywords are mandatory.

For example, the command,

nx9500-6C8809>show wireless

is documented as:

show wireless

where:

  • show – is the command
  • wireless – is the keyword
() Any command/keyword/variable or a combination of them inside a ‘(‘ & ‘)' pair are recursive. All recursive commands can be listed in any order and can be used once along with the rest of the commands.

For example, the command,

crypto pki export request generate-rsa-key test autogen-subject-name ...

is documented as:

nx9500-6C8809#crypto pki export request generate-rsa-key test 
autogen-subject-name (<URL>,email <EMAIL>,fqdn <FQDN>,ip-address <IP>)

here:

  • crypto pki export request generate-rsa-key <RSA-KEYPAIR-NAME> auto-gen-subject-name – is the command
  • <RSA-KEYPAIR-NAME> – is the RSA keypair name (in this example, the keypair name is ‘test')
  • (<URL>,email <EMAIL>,fqdn <FQDN>,ip-address <IP>) – is the set of recursive parameters (separated by commas) that can be used in any order.
9037762-01 Rev AA