beautypg.com

Chapter 2, Command syntax conventions in this software, Reference – Allied Telesis AlliedWare Plus Operating System Version 5.4.4C (x310-26FT,x310-26FP,x310-50FT,x310-50FP) User Manual

Page 63

background image

Software Reference for x310 Series Switches

C613-50046-01 REV A

AlliedWare Plus

TM

Operating System - Version 5.4.4C

2.1

Chapter 2:

Command Syntax Conventions in

this Software Reference

The following table describes how command line interface syntax is shown in this Software Reference.

Syntax element

Example

What to enter in the command
line

Keywords are shown in
lowercase fixed-width font or
bold variable-width font.

show spanning-tree mst

or

show ip route

Some keywords are required, and
others are optional parameters.
Type keywords exactly as they
appear in the command syntax.

Number ranges are enclosed in
angle-brackets < > and
separated by a hyphen.

<0-255>

Enter a number from the range. Do
not enter the angle brackets.

Placeholders are shown in
lowercase italics within angle-
brackets < >, or in uppercase
italics.

<port-list>

or

ip dhcp pool NAME

Replace the placeholder with the
value you require. The placeholder
may be an IP address, a text string,
or some other value. See the
parameter table for the command
for information about the type of
value to enter.
Do not enter the angle-brackets.

Repeats are shown with ellipsis.

param1...

Enter the parameter one or more
times.

Optional elements are shown in
brackets: [ ]

vlan <vid> [name name>]

If you need the optional parameter,
enter it. Do not enter the brackets.

Required choices are enclosed
in braces and separated by a
vertical bar (pipe) : {|}.

spanning-tree {mstp|rstp|
stp} enable

Enter one only of the options.
Do not enter the braces or vertical
bar.

Optional choices are enclosed in
or brackets and separated by a
vertical bar (pipe): [|]

[param1|param2]

If needed, enter one only of the
options.
Do not enter the brackets or
vertical bar.

Inclusive options are enclosed
in braces, and separated by
brackets: {[ ] [ ]}.

{[param1] [param2]
[param3]}

Enter one or more of the options
and separate them with a space.
Do not enter the braces or brackets.