3 common parameter values, 3 common parameter values - 3, At8404 using the command-line interface – Kontron AT8404 CLI User Manual
Page 29

AT8404
Using the Command-Line Interface
Page 1 - 3
AT8404 CLI Reference Manual
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.
1.3
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 2
describes common parameter values and
value formatting.
Table 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 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)
ipv6-address
FE80:0000:0000:0000:020F:24FF:FEBF:DBCB, or
FE80:0:0:0:20F:24FF:FEBF:DBCB, or
FE80::20F24FF:FEBF:DBCB, or
FE80:0:0:0:20F:24FF:128:141:49:32
For additional information, refer to RFC 3513.
Interface or
slot/port
Valid slot and port number separated by a forward slash. For example, 0/1 represents
slot number 0 and port number 1.
Logical Interface
Represents a logical slot and port number. This is applicable in the case of a port-
channel (LAG). You can use the logical slot/port to configure the port-channel.
Character strings
Use double quotation marks to identify character strings, for example, “System Name
with Spaces”. An empty string (“”) is not valid.