Command Structure; Format - Hirschmann PowerMICE Reference Manual

1.0 Command Structure

The Command Line Interface (CLI) syntax, conventions and terminology are described in this
section. Each CLI command referenced in this document is illustrated using the structure
outlined below.

1.1 Format

Some commands, such as
network parms
positional — you must type the values in the correct order. Optional parameters will follow
required parameters. For example:
Example 1
Example 2
Example 3
1.1.1 Command
The following conventions apply to the command name:
The command name is displayed in this document in bold font and must be typed exactly as shown.
Once you have entered enough letters of a command name to uniquely identify the command,
pressing the
Entering Ctrl-Z will return you to the root level command prompt.
1.1.2 Parameters
Parameters are displayed in this document in
number.
Command Structure
© 2001- 2006 Hirschmann Automation and Control GmbH. All Rights Reserved.
clear vlan,
, have parameters for which you must supply a value. Parameters are
network parms
<ipaddr> <netmask> [gateway]
is the command name.
network parms
<ipaddr> <netmask>
is the optional value for the command.
[gateway]
snmp-server location
snmp-server location
is the required parameter for the command.
<loc>
clear vlan
is the command name.
clear vlan
or
<Space bar>
Parameters are order dependent.
do not require parameters. Other commands, such as
are the required values for the command.
<loc>
is the command name.
will cause the system to complete the word.
<Tab key>
italic font
, which must be replaced with a name or
4