Table Of Contents
CLI Overview
Introducing the CLI
Character Case Sensitivity in the CLI
Command Modes
Command Prompt
Reserved Words
Show CLI Command
Special Keys
Starting a CLI Management Session
CLI Usage Tips
Command Documentation
CLI Overview
Note
This reference does not describe the command line interface for the SN 5420 Storage Router. For information on the SN 5420 Storage Router command line interface, see the Cisco SN 5420 Storage Router Software Configuration Guide, Release 2.1.
The Cisco SN 5400 series of storage routers provide three interfaces for operation, configuration, administration, maintenance, and support tasks: command line interface (CLI), web-based GUI, and SNMP.
This book documents the storage router CLI for the SN 5428 and the SN 5428-2. For help on the web-based GUI, point your browser to the storage router's management interface IP address. After logging on, click the Help link to access the online help system.
This chapter contains the following sections:
•
Introducing the CLI
•
CLI Usage Tips
•
Command Documentation
Introducing the CLI
The CLI is available via a Telnet or Secure Shell (SSH) session to the management interface. It is also available via a direct EIA/TIA-232 connection on the console interface. The CLI provides commands to perform all necessary storage router management functions, including software upgrades and maintenance.
All CLI commands are capable of prompting for further information as the user types.
•
Pressing the Tab key completes the current command word at any point after it is unique.
•
Pressing the question mark (?) key lists all of the options available at that point in the command syntax.
•
Each command or keyword can be truncated at any point after it is unique.
Character Case Sensitivity in the CLI
CLI commands, keywords, and reserved words are not case-sensitive. Commands and keywords can be entered in upper and lower case.
User-defined text strings are case-sensitive and can be defined in both upper and lower case (including mixed cases). Case for user-defined text strings is preserved in the configuration.
Command Modes
The storage router management interface is password protected. You must enter passwords when accessing the storage router via Telnet or SSH (for the CLI) or web-based GUI.
There are two levels of authority:
•
Monitor mode—Allows view-only access to the storage router status and system configuration information.
•
Administrator mode—Allows the user to configure and actively manage the storage router, its access lists and SCSI routing instances, FCIP instances, and the storage router cluster.
The factory default password for both modes is cisco.
Passwords for Monitor and Administrator mode can be initially configured through the setup configuration wizard. See the Storage Router Software Configuration Guide for details.
Note
Passwords are shared cluster-wide, and when configured on the first storage router in the cluster, will be shared with any other storage router that joins the cluster.
Command Prompt
The CLI command prompt includes the storage router system name. An asterisk ( * ) appears at the beginning of the prompt if the system configuration has been modified but not saved.
Reserved Words
Reserved words cannot be used as user-defined values or names in CLI commands. Words that are used as commands or as keywords in commands are reserved words.
The following are additional reserved words in the CLI.
•
acl
•
canonical
•
iprouter
•
iptan
•
loglevel
Show CLI Command
Use the show cli command to display the complete CLI command syntax tree, along with helpful information about command parameters and arguments. Only valid commands will display for the current storage router deployment option and command mode of your storage router management session.
You can limit the display to specific command families by specifying the desired command words as parameters to the show cli command. For example, show cli aaa debug scsirouter displays the syntax tree for all aaa commands, all debug commands, and all scsirouter commands.
Special Keys
The CLI supports the use of special keyboard keys. Table 1-1 lists the special keys and describes their function.
Table 1-1 Special Keys
Key
|
Function
|
?
|
List choices
|
Backspace
|
Delete character backwards
|
Tab
|
Command word completion
|
Ctrl-A
|
Go to the beginning of the line
|
Ctrl-B or Left Arrow
|
Go backwards one character
|
Ctrl-D
|
Delete current character
|
Ctrl-E
|
Go to the end of the line
|
Ctrl-F or Right Arrow
|
Go forward one character
|
Ctrl-K
|
Delete from current position to the end of the line
|
Ctrl-N or Down Arrow
|
Go to the next line in the history buffer
|
Ctrl-P or Up Arrow
|
Go to the previous line in the history buffer
|
Ctrl-T
|
Transpose the current and previous character
|
Ctrl-U
|
Delete the line
|
Ctrl-W
|
Delete the previous word
|
Starting a CLI Management Session
Follow these steps to start a CLI management session via a Telnet connection to the storage router.
Step 1
Establish a Telnet session to the storage router.
Step 2
Enter the appropriate password at the logon prompt.
Step 3
(Optional) Enter enable to change to Administrator mode.
Note
If you need to make changes to the configuration of the storage router, you need to enable the Administrator mode.
Step 4
(Optional) Enter the Administrator password at the prompt.
Step 5
Issue the appropriate CLI commands to complete the desired task.
CLI Usage Tips
•
Commands and keywords can be truncated at any point after they are unique.
•
Use the Tab key to complete the current word.
•
Use the question mark ( ? ) key to list all of the options available at that point in the command line.
•
CLI commands and keywords are not case-sensitive. Commands and keywords can be entered in any case (including mixed case).
•
User-defined strings are case-sensitive. User-defined strings must be entered in the appropriate case (including mixed case). Case for user-defined strings is preserved in the configuration.
•
An asterisk ( * ) at the beginning of the CLI command prompt indicates that the system configuration has been changed but not saved.
Command Documentation
Each chapter in this book documents storage router commands in alphabetical order alphabetical order regardless of command mode. The no form of any command is shown with the primary command entry. Command information includes syntax, defaults, mode, history, usage guidelines, examples, and related commands.
For more information about using CLI commands, refer to the appropriate Cisco Storage Router Software Configuration Guide for your storage router model.