PLANET WGS3-24000 - Manual (Page 310)

310
5. 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.
5.1 Format
Commands are followed by values, parameters, or both.
Example 1
network parms []
▫ network parms is the command name.
▫ are the required values for the command.
▫ [] is the optional value for the command
Example 2
snmp-server location
▫ snmp-server location is the command name.
▫ is the required parameter for the command.
Example 3
clear vlan
▫ clear vlan is the command name.
5.1.1 Command
The text in bold, non-italic font must be typed exactly as shown.
5.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.
▫ . 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.
5.1.3 Values
ipaddr This parameter is a valid IP address, made up of four decimal bytes ranging from 0 to 255. The default for all IP
parameters consists of zeros (that is, 0.0.0.1). The interface IP address of 0.0.0.0 is invalid. In some cases, the IP address can