Kontron AT8402 CLI - Manual (Page 25)

AT8402 Using the Command-Line Interface
Page 1 - 3 AT8402 CLI Reference Manual
The parameters for a command might include mandatory values, optional values, or
keyword choices. Table 4.1 describes the conventions this document uses to
distinguish between value types.
1.2.1 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 Name with Spaces” forces the system to accept the spaces. Empty strings (““)
are not valid user-defined strings. Table 4.2 describes common parameter values and
value formatting.
Table 4.1. Parameter Conventions
Symbol Example Description
<> angle brackets <value> Indicates that you must enter a value
in place of the brackets and text
inside them.
[] square brackets [value] Indicates an optional parameter that
you can enter in place of the brackets
and text inside them.
{} curly braces {choice1 | choice2} Indicates that you must select a
parameter from the list of choices.
| Vertical bars choice1 | choice2 Separates the mutually exclusive
choices.
[{}] Braces within
square brackets [{choice1 | choice2}] Indicates a choice within an optional
element.
Table 4.2. Parameter Descriptions
Parameter Description
ipaddr This parameter is a valid IP address. You can enter the IP address in the
following formats:
a (32 bits)
a.b (8.24 bits)
a.b.c (8.8.16 bits)
a.b.c.d (8.8.8.8)
In addition to these formats, the CLI accepts decimal, hexidecimal and
octal formats through the following input formats (where n is any valid
hexidecimal, octal or decimal number):
0xn (CLI assumes hexidecimal format)
0n (CLI assumes octal format with leading zeros)
n (CLI assumes decimal format)
areaid Enter area IDs in dotted-decimal notation (for example, 0.0.0.1). An
area ID of 0.0.0.0 is reserved for the backbone. Area IDs have the same
format as IP addresses but are distinct from IP addresses. You can use
the IP network number of the sub-netted network for the area ID.
routerid Enter the value of <routerid> in dotted-decimal notation, such as
0.0.0.1. A router ID of 0.0.0.0 is invalid.