Introduction Command Syntax Conventions
Software Reference for SwitchBlade x3100 Series Switches (Setting Up the Switch)
1-10
1.4 CLI Introduction
1.4.1 Command Syntax Conventions
The syntax rules for a Command and its parameters use the following conventions throughout this document:
All upper case = Key Word
| = Option (OR)
[] = Optional
{ = Choice of until }
1.4.2 Entering Commands
The SBx3112 supports line editing, line recall, and abbreviations, so that command line input and editing can be
done very quickly once command syntax and the line editing commands are learned.
Ta b l e 1- 3 lists the terminal editing and keystroke functions most commonly used.
The SBx3112 also allows the following methods to make entering commands more efficient:
• Commands and parameters can be in lower case.
• Commands and parameters can be abbreviated (such as en for ENABLE, sh for SHOW, etc.)
• The equal sign (=) is not needed as long as a parameter is paired with a space and then a value.
Note: Throughout this document, all syntax will try to use complete words, with verbs and parameters in
upper case and the pairing of parameters and values with equal signs.
TABLE 1-3 Terminal Editing Functions and Keystrokes
Action Key Sequence
Move cursor within command line left and right arrow
Delete character to left of cursor [Delete] or [Backspace]
Clear command line [Ctrl/U]
Recall previous command in command history CTRL/P or up arrow
Recall next command in command history CTRL/N or down arrow
Automatically complete a partially entered command keyword [Tab] or [Ctrl/I]