User guide

14 ExtremeWarePx1 1.2 Command Reference Guide
Command Reference Overview
Understanding Command Syntax
In describing command syntax, this manual uses symbols as described in Table 3. These symbols
explain how to enter the command, and you do not type them as part of the command itself.
Using the Command-Line Interface
The command-line interface displays a command prompt when it is ready to accept a command input.
To issue a command:
1 Enter the command name at the command prompt. You can use abbreviated syntax; see
ÒAbbreviated SyntaxÓ on page 16.
2 If the command includes parameters, enter each parameter name and its value, in the appropriate
order.
A parameterÕs value speciÞes how you want the parameter to be set. Values can be numbers, strings,
or addresses, depending on the parameter.
3 After entering the complete command, press [Return] or [Enter].
Table 3: Command Syntax Symbols
Symbol
Description
angle brackets < >
Enclose a variable or value. You must specify the variable or value. Do not type the angle
brackets. For example, in the syntax
configure vlan <name> ipaddress <IP address>
you must supply a VLAN name for <name> and an address for <IP address> when
entering the command.
vertical bar | Separates mutually exclusive items in a list, only one of which may be entered. Do not type
the vertical bar. The alternatives are generally enclosed in parentheses, square brackets, or
braces, as described below. For example, in the syntax
configure snmp community [read-only | read-write] <string>
you must specify either the read or write community string in the command.
parentheses ( ) Used to group items into a single element (often used with the vertical bar | ). Do not type
the parentheses. For example, in the syntax
reboot {(<date> <time>) | cancel}
you can optionally specify either a particular date and time combination, or the keyword
cancel to cancel a previously scheduled reboot. If you do not specify a parameter, the
command will prompt asking if you want to reboot the switch now.
square brackets [ ] Enclose a required value or list of required parameters. One or more values or parameters
can be specified. Do not type the square brackets. For example, in the syntax
use image [primary | secondary]
you must specify either the primary or secondary image when entering the command.
braces { } Enclose an optional value or a list of optional parameters. Do not type the braces. One or
more values or parameters can be specified. For example, in the syntax
reboot {(<date> <time>) | cancel}
you can optionally specify either a particular date and time combination, or the keyword
cancel to cancel a previously scheduled reboot. If you do not specify a parameter, the
command will prompt asking if you want to reboot the switch now.