Using the Command-Line Interface
11
ProSafe Managed Switch
[gateway] is an optional parameter, so you are not required to enter a value in place of
the parameter.
The New Template User Manual lists each command by the command name and provides a
brief description of the command. Each command reference also contains the following
information:
Format shows the command keywords and the required and optional parameters.
Mode identifies the command mode you must be in to access the command.
Default shows the default value, if any, of a configurable setting on the device.
The show commands also contain a description of the information that the command shows.
Command Conventions
In this document, the command name is in bold font. Parameters are in italic font. You
must replace the parameter name with an appropriate value, which might be a name or
number. Parameters are order dependent.
The parameters for a command might include mandatory values, optional values, or keyword
choices. Table 1 describes the conventions this document uses to distinguish between value
types.
Table 1. Parameter Conventions
<value>
[value]
{choice1 |
choice2}
choice1 | choice2
[{choice1 |
choice2}]
Common Parameter Values
Parameter values might be names (strings) or numbers. To use spaces as part of a name
parameter, enclose the name value in double quotes. For example, the expression “System
Symbol Example Description
<> angle brackets Indicates that you must enter a value in place of the
brackets and text inside them.
[] square brackets Indicates an optional parameter that you can enter in
place of the brackets and text inside them.
{} curly braces Indicates that you must select a parameter from the list of
choices.
| Vertical bars Separates the mutually exclusive choices.
[{}] Braces within
square brackets Indicates a choice within an optional element.