3Com OfficeConnect 3C100XF Cli User's Manual - page 28
1-10
C
HAPTER
1: U
SING
THE
C
OMMAND
L
INE
I
NTERFACE
(CLI)
The login user name and password for the OfficeConnect Gateway is case
sensitive.
Many commands are position-independent, multi-tiered, and have
keywords
Multi-tiered commands let you type the base command (e.g.:
set interface
) and
implement associated parameters (
filter_access, input_filter
, 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.
You can abbreviate commands
You can shorten most commands and command options by typing the first few
letters that distinguish that command from any other. For example, while the full
command is
list tcp connections
, type only type
li tc
to invoke it.
An error message displays if you type an ambiguous abbreviated command.
Double quotations distinguish text strings
You can add white space or special characters to a string by wrapping it in double
quotes.
Command syntax and CLI rules
This following CLI command syntax conventions are used in this document:
Keywords are in
bold
text. For example:
ping
Values following keywords are in
brackets
. For example:
[
interval
].
Inside the
brackets, if you see a:
|
(vertical bar) you may select only
one
from the
key list
: [first | second |
third]
,
(comma) you can select
one or more
of the displayed
bitmasks
:
[first,second,third,...]
Values that are position dependent and do not have keywords are in
carets
. For
example:
Some of these parameters are required and some are
not. Required values are displayed in the CLI when querying a command
(typing a question mark) or upon issuing a command where required values
were omitted.
{
…
}
parameters enclosed by
curly braces
are optional, and are provided with
default
values. You do not need to specify these parameters unless you wish to
override the default.
Position independent
arguments display vertically after the command, e.g.:
set dns
domain_name
number_retries
timeout
5-125 seconds>
A
vertical
character between parameters indicates a choice of options, e.g.: