Mellanox MLNX-OS User Manual for SX1018HP Ethernet Managed Blade Switch

Rev 2.10
Mellanox Technologies
29
Mellanox Technologies Confidential
3.1.2 Syntax Conventions
To help you identify the parts of a CLI command, this section explains conventions of presenting
the syntax of commands.
Table 12 - Syntax Conventions
Syntax Convention Description Example
< > Angled brackets Indicate a value/variable that
must be replaced.
<1...65535> or <switch inter-
face>
[ ] Square brackets Enclose optional parameters.
However, only one parameter out
of
the list of parameters listed can
be used. The user cannot have a
combination of the parameters
unless stated otherwise.
[destination-ip | destination-port |
desti
n
ation-mac]
{ } Braces Enclose alternatives or
variables
that are required for the parameter
in square brackets.
[mode {active | on | passive}]
| Vertical bars Identify mutually exclusive
choices.
active | on | passive
3.1.3 Getting Help
You may request context-sensitive help at any time by pressing “?” on the command line. This
will show a list of choices for the word you are on, or a list of top-level commands if you have
not typed anything yet.
For example, if you are in Standard mode and you type “?”
at the command line, then you will
get the following list of available commands.
switch > ?
cli Configure CLI shell options
enable Enter enable mode
exit Log out of the CLI
help View description of the interactive help system
no Negate or clear certain configuration options
Do not type the angled or square brackets, vertical bar, or braces in command lines. This
guide uses these symbols only to show the types of entries.
CLI commands and options are in lowercase and are case-sensitive.
For example, when you enter the
enable command, enter it all in lowercase. It cannot
be ENABLE or Enable. Text entries you create are also case-sensitive.