Installation and User Manual
EtherHaul
1200™
Page 166
EH-INST-02, Issue 4.0
11.2.2 Common Syntax Rules
This document uses the following notation conventions when presenting CLI usage
examples. These syntax conventions are found in commands, index names, objects and
attributes.
Syntax
Meaning
{a | b | c}
One of the specified values must be entered in the command line
<name>
The name of a required attribute, explained in an accompanying or
referenced section.
[name]
The name of an optional attribute, explained in an accompanying or
referenced section.
n…m
Represents a number or integer series from n to m.
11.2.3 Repeatedly Used Identifiers
This document uses the following identifying conventions when presenting CLI usage
examples. These syntax conventions are used primarily to represent various types of
objects and lists that are to be specified on the command line.
For more information on using identifiers in the EtherHaul CLI, refer to
Designating
Named Objects
on page 171.
Convention
Meaning
<comp-id>
A single component ID (one of c1, c2, c3, c4, c4, s1)
<bridge-port>
A single port name (one of host, eth0, eth1, eth2, c1, c2, c3, c4, c4, s1)
<fdb-id>
A single FID (number from 1 to 64)
<vid>
A single VID (number from 1 to 4094)
<mac-addr>
A MAC address in the form NN-NN-NN-NN-NN-NN, where N is a
hexadecimal number (
e.g.
, 00-AF-DD-1E-2D-A3).
<ip-addr>
A standard dotted notation IP address (
e.g
., 10.0.15.74)
<ip-mask>
The IP address mask,
i.e.
, the number of bits that constitute the IP network
address prefix.
<comp-id-list>
A comma-separated list of the component IDs,
e.g.
, c1, c2, c3, c4, c4, s1. Any
combination of the component IDs can be included in the list. For details,
refer to
Designating Named Objects
on page 171.
<c-comp-id-list>
A comma-separated list of the C-component IDs,
e.g.,
c1, c2, c3, c4, c4. Any
combination of the component IDs can be included in the list. For details,
refer to
Designating Named Objects
on page 171.
<bridge-port-list>
A comma-separated list of port names,
e.g.
, host, eth0, eth1, eth2, c1, c2, c3,
c4, c4, s1. Any combination of the names can be included in the list. For
details, refer to
Designating Named Objects
on page 171.
<eth-list>
A comma-separated list of external port names,
e.g.
, host, eth0, eth1, eth2.
Any combination of the names can be included in the list. For details, refer
to
Designating Named Objects
on page 171.
