HP Mellanox SX1018 Mellanox MLNX-OS User Manual for SX1018HP Ethernet Managed - Page 26

Syntax Conventions, Getting Help

Page 26 highlights

Rev 1.6.2 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 < > Angled brackets [ ] Square brackets { } Braces | Vertical bars Description Example Indicate a value/variable that must be replaced. or 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 | destination-mac] Enclose alternatives or variables that are required for the parameter in square brackets. [mode {active | on | passive}] Identify mutually exclusive choices. active | on | passive 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. 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 enable exit help no show Configure CLI shell options Enter enable mode Log out of the CLI View description of the interactive help system Negate or clear certain configuration options Display system configuration or statistics Mellanox Technologies 26

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77

Rev 1.6.2
Mellanox Technologies
26
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 |
destination-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
show
Display system configuration or statistics
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.