Cli Command Conventions And Terminology; Command Structure; Format; Parameters - 3Com OfficeConnect Remote 812 Cli User's Manual

2
Command
Structure

Format

CLI C
OMMAND
TERMINOLOGY
This chapter describes the command syntax, conventions and terminology used
within the Command Line Interface. Reviewing and understanding this chapter is
essential for you to understand subsequent chapters.
Commands can be followed by values and/or parameters and values. For example:
a dd ip network <network_name>
address [ip_addr]
{ interface [eth:1] }
add ip network is the command


<network_name> is the (required) value for the command


address is a required parameter


[ip_addr] is the value for the IP address parameter which you must provide


interface is only required if you want to override the default value, which is


eth:1

Parameters

are order independent


{ ... } 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.

Values

< ... > required values for a command or parameter are enclosed by arrows.


[ ... ] range of values following parameters are enclosed in brackets. Inside the


brackets, if you see a:
| (vertical bar) you may select only one of the displayed choices:


[FIRST | SECOND | THIRD]
, (comma) you can select one or more of the displayed choices:


[FIRST,SECOND,THIRD,...]
C
ONVENTIONS AND