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:
<ip_address>.
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
<name>
number_retries
<1-5>
timeout <
5-125 seconds>
A
vertical
character between parameters indicates a choice of options, e.g.:
Summary of Contents for OfficeConnect 3C100XF
Page 1: ...http www 3com com OfficeConnect Gateway CLI User s Guide Release 1 0 Part No 10042302 Rev AA ...
Page 14: ...xiv ...
Page 18: ...iv ABOUT THIS GUIDE ...
Page 30: ...1 12 CHAPTER 1 USING THE COMMAND LINE INTERFACE CLI ...
Page 50: ...3 14 CHAPTER 3 ADMINISTRATIVE CLI COMMANDS ...
Page 58: ...4 8 CHAPTER 4 CONFIGURING AND MANAGING USERS ...
Page 70: ...6 8 CHAPTER 6 BRIDGING COMMANDS ...
Page 78: ...8 4 CHAPTER 8 INTERFACE COMMANDS ...
Page 82: ...9 4 CHAPTER 9 ARP COMMANDS ...
Page 88: ...11 4 CHAPTER 11 DHCP COMMANDS ...
Page 124: ...12 36 CHAPTER 12 IP ROUTING COMMANDS ...
Page 134: ...13 10 CHAPTER 13 DNS COMMANDS ...
Page 142: ...15 6 CHAPTER 15 MULTICASTING AND IGMP COMMANDS ...
Page 160: ...17 8 CHAPTER 17 PPP COMMANDS ...
Page 182: ...21 6 CHAPTER 21 ADDRESS TRANSLATION COMMANDS ...
Page 186: ...22 4 CHAPTER 22 IPSEC COMMANDS ...
Page 188: ...23 2 CHAPTER 23 SECURITY ASSOCIATION SA COMMANDS ...
Page 192: ...24 4 CHAPTER 24 TCP COMMANDS ...
Page 204: ...25 12 CHAPTER 25 SNMP COMMANDS ...
Page 210: ...26 6 CHAPTER 26 IP FILTERS COMMANDS ...
Page 238: ...29 6 CHAPTER 29 TRACEROUTE COMMANDS ...
Page 255: ...xv RFC 1483 16 3 RFC 1483 MER 16 4 ...
Page 256: ...xvi ...
Page 260: ......