Understanding The Command Syntax - Extreme Networks ExtremeWare Command Reference Manual

Understanding the Command Syntax

When entering a command at the prompt, ensure that you have the appropriate privilege level. Most
configuration commands require you to have the administrator privilege level.
You may see a variety of symbols shown as part of the command syntax. These symbols explain how to
enter the command, and you do not type them as part of the command itself. Table 3 summarizes
command syntax symbols.
Table 3: Command Syntax Symbols
Symbol
angle brackets < >
square brackets [ ]
vertical bar |
braces { }
Command Completion with Syntax Helper
The CLI has a built-in syntax helper. If you are unsure of the complete syntax for a particular command,
enter as much of the command as possible and press [Tab]. The syntax helper provides a list of options
for the remainder of the command, and places the cursor at the end of the command you have entered
so far, ready for the next option.
If the command is one where the next option is a named component, such as a VLAN, access profile, or
route map, the syntax helper will also list any currently configured names that might be used as the
next option. In situations where this list might be very long, the syntax helper will list only one line of
names, followed by an ellipses to indicate that there are more names than can be displayed.
The syntax helper also provides assistance if you have entered an incorrect command.
ExtremeWare Software 7.0.0 Command Reference Guide
Description
Enclose a variable or value. You must specify the variable or value. For
example, in the syntax
config vlan <vlan name> ipaddress <ip_address>
you must supply a VLAN name for <vlan name> and an address for
<ip_address> when entering the command. Do not type the angle
brackets.
Enclose a required value or list of required arguments. One or more
values or arguments can be specified. For example, in the syntax
use image [primary | secondary]
you must specify either the primary or secondary image when entering
the command. Do not type the square brackets.
Separates mutually exclusive items in a list, one of which must be
entered. For example, in the syntax
config snmp community [read-only | read-write]
<string>
you must specify either the read or write community string in the
command. Do not type the vertical bar.
Enclose an optional value or a list of optional arguments. One or more
values or arguments can be specified. For example, in the syntax
reboot {<date> <time> | cancel}
you can specify either a particular date and time combination, or the
keyword cancel to cancel a previously scheduled reboot. If you do not
specify an argument, the command will prompt asking if you want to
reboot the switch now. Do not type the braces.
Understanding the Command Syntax
45