Basics – CLI Command Conventions

The following table describes the command syntax conventions.

[ ]In a command line, square brackets indicates an optional entry
{ }In a command line, curly brackets indicate a selection of compulsory parameters separated by the | character. One option must be selected. For example: flowcontrol {auto|on|off} means that for the flowcontrol command either auto, on or off must be selected.
Italic fontIndicates a parameter.
<Enter>Any individual key on the keyboard. For example click <Enter>
Ctrl+F4Any combination keys pressed simultaneously on the keyboard
Screen DisplayIndicates system messages and prompts appearing on the console
allWhen a parameter is required to define a range of ports or parameters and all is an option, the default for the command is all when no parameters are defined. For example, the command interface range port-channel has the option of either entering a range of channels, or selecting all. When the command is entered without a parameter, it automatically defaults to all
interface-idThis indicates a port, VLAN or LAG. The syntax for interface_id is as follows: {port_type}port-number |{vlan} vlan-id | {port-channel} LAG-number

Was this article helpful?

Related Articles

Leave A Comment?