4. COMMAND STRUCTURE
The Command Line Interface (CLI) syntax, conventions and terminology are described in this section.
Each CLI command is illustrated using the structure outlined below.
4.1 Format
Commands are followed by values, parameters, or both.
Example 1
network parms <ipaddr> <netmask> [<gateway>]
▫
network parms
is the command name.
▫
<ipaddr> <netmask>
are the required values for the command.
▫
[<gateway>]
is the optional value for the command
Example 2
snmp-server location <loc>
▫
snmp-server location
is the command name.
▫
<loc>
is the required parameter for the command.
Example 3
clear vlan
▫
clear vlan
is the command name.
4.1.1 Command
The text in bold, non-italic font must be typed exactly as shown.
4.1.2 Parameters
Parameters are order dependent.
The text in bold italics should be replaced with a name or number. To use spaces as part of a name
parameter, enclose it in double quotes like this: "System Name with Spaces".
Parameters may be mandatory values, optional values, choices, or a combination.
▫
<parameter>
. The <> angle brackets indicate that a mandatory parameter must be entered
in place of the brackets and text inside them.
▫
[parameter]
. The [] square brackets indicate that an optional parameter may be entered in
place of the brackets and text inside them.
▫
choice1 | choice2
. The | indicates that only one of the parameters should be entered.
▫
The
{}
curly braces indicate that a parameter must be chosen from the list of choices.