User manual

CLI Reference Guide 21
Introduction
This section describes some basic concepts of the CLI. It explains the syntax
used throughout this document and the structure of the command language as
an aid to understanding how commands are structured.
Command Format
Many commands are
position independent
,
multi-tiered
and use
keywords
.
Multi-tiered commands let you type the base command (e.g.:
set interface
)
and implement many more parameters (
host_type, host_address
, etc).
Position independence does not require all parameters to be specified at once,
nor in sequence, to work. But typing a keyword in the base command such as
network
in
set ip network
is mandatory to enable the command. Command
syntax is described in the example below:
add appletalk network <
network_name
>
address_range [
appletalk_range
]
{ interface [
eth:1
] }
add appletalk network
is the command
<network_name>
is the (required) value for the command
address_range
is a required parameter
[appletalk_range]
is the value for the address_range
parameter which you must provide
interface
is only required if you want to override the default
value, which is
eth:1
Parameters
• {
…
}
parameters enclosed by
curly braces
are required, and are provided
with
default
values. You do not need to specify these parameters unless
you wish to override the default.
• <
…
>
required values for a command or parameter which are position
dependent and do not have keywords are enclosed by
arrows
.
• [
…
]
range of values following keywords are enclosed in
brackets
.
Inside the brackets, if you see a:
♦
|
(vertical bar) you may select only
one
from the
key list
:
[FIRST | SECOND | THIRD]