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