Command-Line Interfaces

This chapter describes the Catalyst 5000 series switch command-line interface (CLI), the ATM module CLI, and the Route Switch Module (RSM) CLI. For descriptions of all switch, ATM, and RSM CLI commands, refer to the Catalyst 5000 Series Command Reference publication. For additional information on Cisco IOS commands, refer to the Configuration Fundamentals Command Reference publication.

Switch Command-Line Interface

The Catalyst 5000 series switch CLI is a basic command-line interpreter, similar to the UNIX C shell.

Accessing the Switch CLI

You can access the CLI from a console terminal connected to an EIA/TIA-232 port or through Telnet. Telnet automatically disconnects after remaining idle for a configurable time period.

Note EIA/TIA-232 was known as recommended standard RS-232 before its acceptance as a standard by the Electronic Industries Association (EIA) and Telecommunications Industry Association (TIA).

Accessing the CLI through the EIA/TIA-232 Port

To access the switch through the EIA/TIA-232 port, complete these steps:

Task	Command
Step 1 From the Catalyst 5000 series switch console prompt, press Return.
Step 2 At the prompt, enter the system password. The Console> prompt appears, indicating that you have accessed the CLI in normal mode.
Step 3 Enter the necessary commands to complete your desired tasks.	Appropriate commands
Step 4 When finished, exit the session.	quit

After accessing the switch through the console port (EIA/TIA-232), you see this display:

Cisco Systems Console
Enter password:
Console>

Accessing the CLI through Telnet

To use Telnet, you must set the IP address for the switch. See "Configuring the Supervisor Software," for information about setting the IP address. You can conduct multiple sessions through Telnet.

To access the switch from a remote host with Telnet, complete these steps:

Task	Command
Step 1 From the remote host, enter the telnet command and the name or IP address of the switch you want to access.	telnet {hostname \| ip_addr}
Step 2 At the prompt, enter the password for the CLI. If no password has been configured, press Return.	<password>
Step 3 Enter the necessary commands to complete your desired tasks.	Appropriate commands
Step 4 When finished, exit the Telnet session.	quit

After connecting through Telnet, you see this display:

% telnet catalyst1
Trying 123.236.273.11...
Connected to catalyst1.
Escape character is '^]'.
Cisco Systems Console
Enter password: <password>
Console>

Operating the Switch CLI

There are two modes of operation, both password protected: normal and privileged. Enter normal-mode commands for everyday system monitoring. Enter privileged commands for system configuration and basic troubleshooting.

After you log in, the system automatically enters normal mode, which gives you access to normal-mode commands only. You can enter privileged mode by entering the enable command followed by a second password. To return to normal mode, enter the disable command at the prompt.

This sample session shows how to enable privileged mode:

Console>
Console> enable
Enter Password:
Console> (enable)

Performing Command Line Processing

Switch commands are not case sensitive. You can abbreviate commands and parameters as long as they contain enough letters to be different from any other currently available commands or parameters. Table 2-1 lists the keyboard shortcuts that can be used when entering switch commands.

**Table 2-1: Keyboard Shortcuts**
Command	Function
Ctrl-W	Deletes last word typed.
Ctrl-U	Deletes entire line.
Ctrl-C	Escapes and terminates prompts and lengthy tasks.
Delete key or Backspace key	Erases mistake when entering a command; reenter command after using this key.

Performing History Substitution

Commands that you enter during each terminal session are stored in a history buffer. The history buffer stores the last 20 commands entered during a terminal session. History substitution allows you to access these commands without retyping them, by using special abbreviated commands. Table 2-2 lists the history substitution commands.

Table 2-2: History Substitution Commands

Command	Function
Repeating recent commands:
!!	Repeat the most recent command.
!-nn	Repeat the nnth most recent command.
!n	Repeat command n.
!aaa	Repeat the command beginning with string aaa.
!?aaa	Repeat the command containing the string aaa.
To modify and repeat the most recent command:
^aaa^bbb	Replace the string aaa with the string bbb in the most recent command.
To add a string to the end of a previous command and repeat it:
!!aaa	Add string aaa to the end of the most recent command.
!n aaa	Add string aaa to the end of command n.
!aaa bbb	Add string bbb to the end of the command beginning with string aaa.
!?aaa bbb	Add string bbb to the end of the command containing the string aaa.

Accessing Command Help

Enter help or ? in normal or privileged mode to see a listing of the commands available in those modes. On selected commands, entering help or ? after a command provides additional information. Command usage, the help menu, and when appropriate, parameter ranges are provided if you enter a command using the wrong number of arguments or inappropriate arguments. Additionally, appending help or ? to a command category displays a list of commands in that category.

Displaying Top-Level Commands and Command Categories

In normal mode, use the ? command to display a list of top-level commands and command categories. The example below displays the top-level commands and categories when your system is equipped with a Supervisor Engine I or II module:

Console> ?
Commands:
----------------------------------------------------------------------
enable              Enable privileged mode
help                Show this message
history             Show contents of history substitution buffer
ping                Send echo packets to hosts
quit                Exit from the Admin session
session             Tunnel to ATM or Router module
set                 Set, use 'set help' for more info
show                Show, use 'show help' for more info
wait                Wait for x seconds
Console>

This example displays the top-level commands and categories when your system is equipped with a Supervisor Engine III module running the applicable software image, for example, cat5000-sup3.4-1-1.bin:

Console> ?
Commands:
----------------------------------------------------------------------
cd                  Set default flash device
dir                 Show list of files on flash device
enable              Enable privileged mode
help                Show this message
history             Show contents of history substitution buffer
ping                Send echo packets to hosts
pwd                 Show default flash device
quit                Exit from the Admin session
session             Tunnel to ATM or Router module
set                 Set, use 'set help' for more info
show                Show, use 'show help' for more info
traceroute          Trace the route to a host
verify              Verify checksum of file on flash device
wait                Wait for x seconds
whichboot           Which file booted
Console>

In privileged mode, enter the ? command to display a list of top-level commands and command categories. This example displays the top-level commands and categories when your system is equipped with a Supervisor Engine I or II module:

Console> (enable) ?
Commands:
----------------------------------------------------------------------
clear               Clear, use 'clear help' for more info
configure           Configure system from terminal/network
disable             Disable privileged mode
disconnect          Disconnect user session
download            Download code to a processor
enable              Enable privileged mode
help                Show this message
history             Show contents of history substitution buffer
ping                Send echo packets to hosts
quit                Exit from the Admin session
reconfirm           Reconfirm VMPS
reset               Reset system or module
session             Tunnel to ATM or Router module
set                 Set, use 'set help' for more info
show                Show, use 'show help' for more info
slip                Attach/detach Serial Line IP interface
switch              Switch to standby <clock|supervisor>
telnet              Telnet to a remote host
test                Test, use 'test help' for more info
upload              Upload code from a processor
wait                Wait for x seconds
write               Write system configuration to terminal/network
Console> (enable)

This example displays the privileged mode top-level commands and categories available when your system is equipped with a Supervisor Engine III module running the applicable software image, for example, cat5000-sup3.4-1-1.bin:

Console> (enable) ?
Commands:
----------------------------------------------------------------------
cd                  Set default flash device
clear               Clear, use 'clear help' for more info
configure           Configure system from network
copy                Copy files between TFTP/module/flash devices
delete              Delete a file on flash device
dir                 Show list of files on flash device
disable             Disable privileged mode
disconnect          Disconnect user session
download            Download code to a processor
enable              Enable privileged mode
format              Format a flash device
help                Show this message
history             Show contents of history substitution buffer
ping                Send echo packets to hosts
pwd                 Show default flash device
quit                Exit from the Admin session
reconfirm           Reconfirm VMPS
reload              Force software reload to linecard
reset               Reset system or module
session             Tunnel to ATM or Router module
set                 Set, use 'set help' for more info
show                Show, use 'show help' for more info
slip                Attach/detach Serial Line IP interface
squeeze             Reclaim space used by deleted files
switch              Switch to standby <clock|supervisor>
telnet              Telnet to a remote host
test                Test, use 'test help' for more info
traceroute          Trace the route to a host
undelete            Undelete a file on flash device
upload              Upload code from a processor
verify              Verify checksum of file on flash device
wait                Wait for x seconds
whichboot           Which file booted
write               Write system configuration to terminal/network
Console> (enable)

Following Additional Usage Guidelines

The Catalyst 5000 series switch is a multimodule system. Commands you enter from the CLI can apply to the entire system or to a specific module, port, or VLAN.

Catalyst 5000 series module slots, ports, and VLANs are numbered starting with 1. The supervisor engine module is module 1, residing in the top slot. If your Catalyst 5505 or 5500 switch has a redundant supervisor engine, the supervisor modules reside in slots 1 and 2. On each module, port 1 is the left-most port. To reference a specific port on a specific module, the command syntax is mod_num/port_num. For example, 3/1 denotes module 3, port 1. In some commands, such as set trunk, set cam, and set vlan commands, you can enter lists of ports and VLANs.

Designating Ports

To designate ports, enter the module and port number pairs, separated by commas. To specify a range of ports, use a hyphen (-) between the module number and port number pairs. Hyphens take precedence over commas. The following examples show several ways of designating ports:

Example 1. 2/1,2/3 denotes module 2, port 1 and module 2, port 3.

Example 2. 2/1-12 denotes module 2, ports 1 through 12.

Example 3. 2/1-2/12 is the same as Example 2.

Each VLAN is designated by a single number. You specify lists of VLANs the same way you do for ports. Individual VLANs are separated by commas (,); ranges are separated by hyphens (-). In the following example, VLANs 1 through 10 and VLAN 1000 are specified:

1-10,1000

Designating MAC Addresses, IP Addresses, and IP Aliases

Some commands require a Media Access Control (MAC) address, IP address, or IP alias, which must be designated in a standard format. The MAC address format must be six hexadecimal numbers separated by hyphens, as shown in the following example:

00-00-0c-24-d2-fe

The IP address format is 32 bits, written as 4 octets separated by periods (dotted decimal format) that are made up of a network section, an optional subnet section, and a host section, as shown in the following example:

126.2.54.1

If the IP alias table is configured, you can use IP aliases in place of the dotted decimal IP address. This is true for most commands that use an IP address, except for commands that define the IP address or IP alias. For more information about the set interface and set ip alias commands, refer to the Catalyst 5000 Series Command Reference publication.

ATM Module Command-Line Interface

The ATM module uses a subset of the Cisco IOS software. The Cisco IOS user interface provides access to several different command modes. Each command mode provides a group of related commands.

Cisco IOS software provides two command access modes: user EXEC and privileged EXEC. The user EXEC mode does not require a password, and allows you direct access only to the ATM module with which you have established a session. The commands available in user EXEC mode are a subset of the commands available in privileged EXEC mode.

The privileged EXEC mode requires a password (the default password is atm). From the privileged level, you can access the six configuration modes: user EXEC, privileged EXEC, global configuration, interface configuration, line configuration, and LAN Emulation (LANE) database configuration. Entering a question mark (?) at the system prompt displays a list of commands available for each command mode.

Almost every configuration command has a no form. The no form disables a feature or function. Enter the command without the keyword no to reenable a disabled feature or to enable a feature that is disabled by default. Refer to the Catalyst 5000 Series Command Reference publication for more information about the ATM module commands.

The user interface also provides context-sensitive help on command syntax. The section "Getting Context-Sensitive Help" (later in this chapter) describes how to use the help system. It also describes the command editing and command history features that enable you to recall previous command entries and easily edit command entries.

Accessing the ATM Module

To access an ATM module installed in a Catalyst 5000 series switch, enter the session mod_num command at the Console> prompt. The switch responds with the Enter Password prompt. Enter atm as the default password. The ATM module responds with the ATM> prompt. At this point, you are in user EXEC command mode, and you have direct access only to the ATM module with which you have established a session.

This example shows how to open a session on an ATM module:

Console> session mod_num 
Console> Enter Password: atm
ATM>

Operating the ATM Module CLI

This section describes the command modes and functions that allow you to access and operate the ATM module CLI. Table 2-3 lists the command modes, how to access each mode, the prompt you see while you are in that mode, the main uses for each configuration mode, and the method to exit that mode. The prompts listed assume the default name ATM.

Table 2-3: ATM Module Command Mode Summary

Command Mode	Access Method	Prompt	Exit Method
User EXEC	Use the session command in the switch CLI.	ATM>	Enter the logout command.
Privileged EXEC	From user EXEC mode, enter the enable EXEC command. Enter the enable password at the prompt (default is atm).	ATM#	Enter the disable command.
Global configuration	From privileged EXEC mode, enter the configure privileged EXEC command.	ATM(config)#	Enter the exit or end command or press Ctrl-Z.
Interface configuration	From global configuration mode, enter the interface interface_num command.	ATM (config-if)#	To exit to global configuration mode, enter the end command. To exit to privileged EXEC mode, enter the exit command or press Ctrl-Z.
Subinterface configuration	From interface configuration mode, enter the interface sub_interface_num command.	ATM (config-subif)#	To exit to global configuration mode, enter the end command. To exit to privileged EXEC mode, enter the exit command or press Ctrl-Z.
Line configuration	From global configuration mode, enter the line line_number command.	ATM (config-line)#	To exit to global configuration mode, enter the exit command. To exit to privileged EXEC mode, enter the end command or press Ctrl-Z.
LANE database configuration	From global configuration mode, enter the lane database command.	ATM (config-if)#	To exit to global configuration mode, enter the exit command. To exit to privileged EXEC mode, enter the end command or press Ctrl-Z.

Accessing User EXEC Mode

After you log in to the ATM module, you are automatically in user EXEC command mode. The user EXEC commands are a subset of the privileged EXEC commands. The user EXEC commands allow you to change terminal settings on a temporary basis, perform basic tests, and list system information.

To list the user EXEC commands, enter this command:

Task	Command
List the user EXEC commands.	?

The user-level prompt is as follows:

ATM>

To list the commands available in user EXEC mode, enter a question mark (?) at the ATM> prompt, as shown in this example:

ATM>?
Exec commands:
  <1-99>    Session number to resume
  atmsig    Execute Atm Signalling Commands
  clear     Reset functions
  disable   Turn off privileged commands
  enable    Turn on privileged commands
  exit      Exit from the EXEC
  help      Description of the interactive help system
  login     Log in as a particular user
  logout    Exit from the EXEC
  show      Show running system information
  systat    Display information about terminal lines
  terminal  Set terminal line parameters
ATM>

Accessing Privileged EXEC Mode

Because many privileged commands set operating parameters, use password protection to restrict access to privileged EXEC mode. The privileged EXEC command set includes those commands in user EXEC mode, as well as the configure command through which you can access the remaining command modes. Privileged EXEC mode also includes high-level testing commands, such as debug.

To access and list the privileged EXEC commands, complete these steps:

Task	Command
Step 1 Enter privileged EXEC mode.	enable password
Step 2 List privileged EXEC commands.	?

If the system administrator has set a password, you are prompted to enter it before you are allowed access to privileged EXEC mode. The password is not displayed on the screen and is case sensitive. If an enable password has not been set, you can only access privileged EXEC mode from the console. The default password for the ATM module is atm.

This example shows how to access privileged EXEC mode and list privileged EXEC commands:

ATM> enable
Password: 
ATM# ?
Exec commands:
  <1-99>     Session number to resume
  atmsig     Execute Atm Signalling Commands
  clear      Reset functions
  clock      Manage the system clock
  configure  Enter configuration mode
  copy       Copy configuration or image data
  debug      Debugging functions (see also 'undebug')
  disable    Turn off privileged commands
  enable     Turn on privileged commands
  exit       Exit from the EXEC
  help       Description of the interactive help system
  login      Log in as a particular user
  logout     Exit from the EXEC
  no         Disable debugging functions
  reload     Halt and perform a cold restart
  rsh        Execute a remote command
  show       Show running system information
  systat     Display information about terminal lines
  terminal   Set terminal line parameters
  test       Test subsystems, memory, and interfaces
  undebug    Disable debugging functions (see also 'debug')
  write      Write running configuration to memory, network, or terminal
ATM#

Note Only the write memory and write terminal commands are supported. The write network command is not supported.

From privileged EXEC mode, you can access global configuration mode. For instructions, see the section "Accessing Global Configuration Mode."

To return from privileged EXEC mode to user EXEC mode, enter this command:

Task	Command
Go from privileged EXEC mode to user EXEC mode.	disable

Accessing Global Configuration Mode

Global configuration commands apply to features that affect the ATM module as a whole. To enter global configuration mode, enter the configure privileged EXEC command. When you enter this command, the privileged EXEC mode prompts you for the source of the configuration commands, as follows:

Configuring from terminal, memory, or network [terminal]?

You can specify either the terminal, nonvolatile random-access memory (NVRAM), or a file stored on a network server as the source of configuration commands (see the "System Image, Microcode Image, and Configuration File Load Commands" chapter in the Router Products Command Reference publication). The default is to enter commands from the console terminal. Pressing Return begins this configuration method.

To access and list the global configuration commands, complete these steps:

Task	Command
Step 1 At the console terminal, from privileged EXEC mode, enter global configuration mode.	configure
Step 2 List the global configuration commands.	?

This example shows how to access global configuration mode and list global configuration commands:

ATM#configure terminal
Enter configuration commands, one per line.  End with CNTL/Z.
ATM(config)#?
Configure commands:
  alias                       Create command alias
  banner                      Define a login banner
  buffers                     Adjust system buffer pool parameters
  clock                       Configure time-of-day clock
  default                     Set a command to its defaults
  downward-compatible-config  Generate a configuration compatible with older
                              software
  enable                      Modify enable password parameters
  end                         Exit from configure mode
  exit                        Exit from configure mode
  help                        Description of the interactive help system
  hostname                    Set system's network name
  interface                   Select an interface to configure
  lane                        Configure LAN Emulation
  line                        Configure a terminal line
  logging                     Modify message logging facilities
  no                          Negate a command or set its defaults
  privilege                   Command privilege parameters
  service                     Modify use of network based services
  tftp-server                 Provide TFTP service for netload requests
  vtp                         VLAN Trunk Protocol
ATM(config)#

To exit global configuration command mode and return to privileged EXEC mode, use one of the following commands:

Task	Command
Exit global configuration mode.	exit end Ctrl-Z

Accessing Interface Configuration Mode

Interface configuration commands modify the operation of the ATM interface. Interface configuration commands always follow an interface global configuration command, which defines the interface type.

To access and list the interface configuration commands, complete these steps:

Task	Command
Step 1 From global configuration mode, enter interface configuration mode.	interface atm0¹
Step 2 List the interface configuration commands.	?
Step 3 From interface configuration mode, enter subinterface configuration mode.	interface atm0.sub_interface_num mul
Step 4 List the subinterface configuration commands.	?

¹ Always specify ATM interface 0 for the Catalyst 5000 series ATM module.

The following example shows how to access interface configuration mode and list the interface configuration commands:

ATM(config)#interface atm0
ATM(config-if)#?
Interface configuration commands:
  atm            Modify ATM parameters
  bandwidth      Set bandwidth informational parameter
  carrier-delay  Specify delay for interface transitions
  default        Set a command to its defaults
  description    Interface specific description
  exit           Exit from interface configuration mode
  fair-queue     Enable Fair Queuing on an Interface
  help           Description of the interactive help system
  lane           Modify LANE parameters
  load-interval  Specify interval for load calculation for an interface
  logging        Configure logging for interface
  loopback       Configure internal loopback on an interface
  mac-address    Manually set interface MAC address
  mtu            Set the interface Maximum Transmission Unit (MTU)
  no             Negate a command or set its defaults
  shutdown       Shutdown the selected interface
  snmp           Modify SNMP interface parameters
  sscop          SSCOP Interface Subcommands
  traffic-shape  Enable Traffic Shaping on an Interface or Sub-Interface
ATM(config-if)#

The following example shows how to access subinterface configuration mode and list the subinterface configuration commands:

ATM(config-if)#interface atm0.1
ATM(config-subif)#?
Interface configuration commands:
  atm            Modify ATM parameters
  bandwidth      Set bandwidth informational parameter
  carrier-delay  Specify delay for interface transitions
  default        Set a command to its defaults
  description    Interface specific description
  exit           Exit from interface configuration mode
  lane           Modify LANE parameters
  mtu            Set the interface Maximum Transmission Unit (MTU)
  no             Negate a command or set its defaults
  shutdown       Shutdown the selected interface

To exit interface configuration mode and return to global configuration mode, enter this command:

Task	Command
Exit interface configuration mode.	exit

To exit global configuration mode and return to privileged EXEC mode, enter one of these commands:

Task	Command
Exit global configuration mode.	end Ctrl-Z

Accessing Line Configuration Mode

Line configuration commands modify the operation of a terminal line. Line configuration commands always follow a line command, which defines a line number. These commands change terminal parameter settings either on a line-by-line basis or for a range of lines.

To access and list the virtual terminal line configuration commands, complete these steps:

Task	Command
Step 1 From global configuration mode, configure a virtual terminal line.	line [vty] line-number [ending-line-number]¹
Step 2 List the line configuration commands.	?

¹ This command is documented in the "Terminal Lines and Modem Support Commands" chapter in the Router Products Command Reference publication.

This example shows how to enter line configuration mode for virtual terminal line 4 and list the line configuration commands. The ATM (config-line)# prompt indicates line configuration mode:

ATM(config)# line 0 4
ATM(config-line)# ?
Line configuration commands:
  default              Set a command to its defaults
  domain-lookup        Enable domain lookups in show commands
  editing              Enable command line editing
  escape-character     Change the current line's escape character
  exec                 Start an EXEC process
  exec-banner          Enable the display of the EXEC banner
  exec-character-bits  Size of characters to the command exec
  exec-timeout         Set the EXEC timeout
  exit                 Exit from line configuration mode
  full-help            Provide help to unprivileged user
  help                 Description of the interactive help system
  history              Enable and control the command history function
  length               Set number of lines on a screen
  location             Enter terminal location description
  logging              Modify message logging facilities
  login                Enable password checking
  monitor              Copy debug output to the current terminal line
  motd-banner          Enable the display of the MOTD banner
  no                   Negate a command or set its defaults
  notify               Inform users of output from concurrent sessions
  password             Set a password
  privilege            Change privilege level for line
  refuse-message       Define a refuse banner
  session-timeout      Set interval for closing connection when there is no
                       input traffic
  terminal-type        Set the terminal type
  vacant-message       Define a vacant banner
  width                Set width of the display terminal
ATM(config-line)#

To exit line configuration mode and return to global configuration mode, enter this command:

Task	Command
Exit line configuration mode.	exit

To exit global configuration mode and return to privileged EXEC mode, enter one of these commands:

Task	Command
Exit global configuration mode.	end Ctrl-Z

Performing ATM Module Functions

This section describes how to perform the following functions:

Getting Context-Sensitive Help

You can also get a list of any command's associated keywords and arguments with the context-sensitive help feature.

To get help specific to a command mode, a command, a keyword, or arguments, enter one of these commands:

Task	Command
Obtain a brief description of the help system in any command mode.	help
Configure a line or lines to receive help for the full set of user-level commands when you enter ?.	full-help
Configure a line to receive help for the full set of user-level commands for this EXEC session.	terminal full-help¹
Obtain a list of commands that begin with a particular character string.	abbreviated-command-entry?
Complete a partial command name.	abbreviated-command-entry<Tab>
List all commands available for a particular command mode.	?
List a command's associated keywords.	command ?
List a keyword's associated arguments.	command keyword ?

¹ This command is documented in the Cisco Access Connection Guide.

When using context-sensitive help, the space (or lack of a space) before the question mark (?) is significant.

To obtain a list of commands that begin with a particular character sequence, enter word help by entering characters immediately followed by the question mark (?). Do not include a space. This form of help completes the word for you.

To list keywords or arguments, enter command syntax help by entering a question mark (?) in place of a keyword or argument. Include a space before the ?. This form of help reminds you which keywords or arguments are applicable based on the command, keywords, and arguments you have already entered.

You can abbreviate commands and keywords by using a number of characters that allow a unique abbreviation. For example, you can abbreviate the show command to sh.

Enter the help command (which is available in any command mode) for a brief description of the help system:

ATM# help
Help may be requested at any point in a command by entering
a question mark '?'. If nothing matches, the help list will
be empty and you must back up until entering a '?' shows the
available options.
Two styles of help are provided:
1. Full help is available when you are ready to enter a
   command argument (e.g. 'show ?') and describes each possible
   argument.
2. Partial help is provided when an abbreviated argument is entered
   and you want to know what arguments match the input
   (e.g. 'show pr?'.)

You can enter a partial command name and a question mark (?) to obtain a list of commands beginning with a particular character set. See the section "Completing a Partial Command Name" for more details.

This example illustrates how context-sensitive help enables you to create an access list from configuration mode. Enter co at the system prompt followed by a question mark (?). Do not leave a space between the last letter and the question mark (?). The system provides the commands that begin with co.

ATM# co?
configure  connect  copy

Enter the configure command followed by a space and a question mark (?) to list the command's keywords and a brief explanation:

ATM# configure ?
  memory    Configure from NV memory
  network   Configure from a TFTP network host
  terminal  Configure from the terminal
  <cr>

Checking Command Syntax

An error indicator (^) symbol appears at the point in the command string where you have entered an incorrect command, keyword, or argument. The error location indicator and interactive help system allow you to easily find and correct syntax errors.

In this example, suppose you want to clear a virtual circuit. First, use context-sensitive help to check the syntax for the command:

ATM# clear ?
counters   Clear counters on one or all interfaces
  interface  Clear the hardware logic on an interface
  lane       lane
  line       Reset a terminal line
  logging    Clear logging buffer
  tcp        Clear a TCP connection or statistics
ATM# clear

The help output shows that the atm-vc keyword is required. Next, check the syntax for specifying the type of virtual circuit:

ATM# clear atm-vc ?
ATM  ATM interface

Enter the type of virtual circuit:

ATM# clear atm-vc atm 0
% Incomplete command.

The system indicates that you need to provide additional arguments to complete the command. Press Ctrl-P (see the next section, "Using the Command History Features") to automatically repeat the previous command entry. Then add a space and question mark (?) to reveal the additional arguments:

ATM# clear atm-vc atm 0 ?
  <1-4095>  Virtual Circuit Number (VCD)

Now you can complete the command entry:

ATM# clear atm-vc atm 0 4096
                          ^
% Invalid input detected at '^' marker.

The caret symbol (^) and help response indicate an error at 4096. To list the correct syntax, enter the command up to the point where the error occurred, and then enter a question mark (?):

ATM# clear atm-vc atm 0 ?
  <1-4095>  Virtual Circuit Number (VCD)

Enter the year using the correct syntax, and press Return to execute the command:

ATM# clear atm-vc atm 0 11

Using the Command History Features

The command history feature keeps a record of commands you have entered and allows you to recall these commands. The functions of the command history feature are as follows:

Setting the Command History Buffer Size

By default, the system records ten command lines in its history buffer. To set the number of command lines the system records during the current terminal session, enter this command in user EXEC mode:

Task	Command
Enable the command history feature for the current terminal session.	terminal history [size number-of-lines]¹

¹ This command is documented in the Cisco Access Connection Guide.

The terminal no history size command resets the number of lines saved by history to the default of ten lines.

To configure the number of command lines the system records, enter this command in line configuration mode:

Task	Command
Enable the command history feature.	history [size number-of-lines]¹

¹ The no history command turns off command history for the line.

Recalling Commands

To recall commands from the history buffer, perform one of these tasks:

Task	Key Sequence/Command
Recall commands in the history buffer, beginning with the most recent command. Repeat the key sequence to recall successively older commands.	Press Ctrl-P or the up arrow key.¹
Return to more recent commands in the history buffer after recalling commands with Ctrl-P or the up arrow key. Repeat the key sequence to recall successively more recent commands.	Press Ctrl-N or the down arrow key.1
In EXEC mode, list the last several commands you have just entered.	show history

¹ The arrow keys function only on ANSI-compatible terminals such as VT100s.

Disabling the Command History Feature

The command history feature is automatically enabled. To disable it during the current terminal session, enter this command in user EXEC mode:

Task	Command
Disable the command history feature for the current session.	terminal no history¹

¹ This command is documented in the Cisco Access Connection Guide.

To configure a specific line so that the command history feature is disabled, enter this command in line configuration mode:

Task	Command
Configure the line so that the command history feature is disabled.	no history

Using the Editing Features

Catalyst 5000 series software release 2.3 and above includes an enhanced editing mode that provides a set of editing key functions similar to those of the Emacs editor. You can enter commands in uppercase, lowercase, or a mix of both. Only passwords are case sensitive. You can abbreviate commands and keywords to the number of characters that allow a unique abbreviation.

For example, you can abbreviate the show command to sh. After entering the command at the system prompt, press Return to execute the command. The editing features are as follows:

Enabling Enhanced Editing Mode

Although enhanced editing mode is automatically enabled with this software release, you can disable it and revert to the editing mode of previous software releases. See the section "Ending a Session" later in this chapter.

To reenable the enhanced editing mode for the current terminal session, enter this command in user EXEC mode:

Task	Command
Enable the enhanced editing features for the current terminal session.	terminal editing¹

¹ This command is documented in the Cisco Access Connection Guide.

To reconfigure a specific line in enhanced editing mode, enter this command in line configuration mode:

Task	Command
Enable the enhanced editing features.	editing

Moving Around on the Command Line

Perform these tasks to move the cursor around on the command line for corrections or changes:

Task	Keystrokes
Move the cursor back one character.	Press Ctrl-B or press the left arrow key.¹
Move the cursor forward one character.	Press Ctrl-F or press the right arrow key.1
Move the cursor to the beginning of the command line.	Press Ctrl-A.
Move the cursor to the end of the command line.	Press Ctrl-E.
Move the cursor back one word.	Press Esc B.
Move the cursor forward one word.	Press Esc F.

¹ The arrow keys function only on ANSI-compatible terminals such as VT100s.

Completing a Partial Command Name

If you cannot remember a complete command name, press the Tab key to allow the system to complete a partial entry. To do so, perform this task:

Task	Keystrokes
Complete a command name.	Enter the first few letters and press the Tab key.

If your keyboard does not have a Tab key, press Ctrl-I instead.

In the following example, when you enter the letters conf and press the Tab key, the system provides the complete command:

ATM# conf<Tab>
ATM# configure

If you enter a set of characters that could indicate more than one command, the system beeps to indicate an error. Enter a question mark (?) to obtain a list of commands that begin with that set of characters. Do not leave a space between the last letter and the question mark (?). For example, three commands in privileged mode start with co. To see what they are, enter co? at the privileged EXEC prompt. The system displays all commands that begin with co, as follows:

ATM# co?
configure  connect  copy

Pasting in Buffer Entries

The system provides a buffer that contains the last ten items you deleted. You can recall these items and paste them in the command line by completing these steps:

Task	Keystrokes
Step 1 Recall the most recent entry in the buffer.	Press Ctrl-Y.
Step 2 Recall the next buffer entry.	Press Esc Y.

The buffer contains only the last ten items you have deleted or cut. If you press Esc Y more than ten times, you cycle back to the first buffer entry.

Editing Command Lines That Wrap

The new editing command set provides a wraparound feature for commands that extend beyond a single line on the screen. When the cursor reaches the right margin, the command line shifts ten spaces to the left. You cannot see the first ten characters of the line, but you can scroll back and check the syntax at the beginning of the command. To scroll back, perform this task:

Task	Keystrokes
Return to the beginning of a command line to verify that you have entered a lengthy command correctly.	Press Ctrl-B or the left arrow key repeatedly until you scroll back to the beginning of the command entry, or press Ctrl-A to return directly to the beginning of the line.¹

¹ The arrow keys function only on ANSI-compatible terminals such as VT100s.

In this example, the lane config-atm-address command entry extends beyond one line. When the cursor reaches the end of the line, the line shifts ten spaces to the left and is redisplayed. The dollar sign ($) indicates that the line scrolled to the left. Each time the cursor reaches the end of the line, the line shifts ten spaces to the left.

ATM(config-subif)# lane config-atm-address 39.000000000000014155551211.080020
ATM(config-subif)#$ -atm-address 39.000000000000014155551211.0800200c1001.00

When you complete the entry, press Ctrl-A to check the complete syntax, and then press Return to execute the command. The dollar sign ($) appears at the end of the line to indicate that the line scrolled to the right:

ATM(config-subif)# lane config-atm-address 39.000000000000014155551211.080020 $

The system assumes your terminal screen is 80 columns wide. If your screen has a different width, enter the terminal width command to tell the router the correct width of your screen.

Use line wrapping with the command history feature to recall and modify previous complex command entries. See the section "Recalling Commands" for information about recalling previous command entries.

Deleting Entries

Perform any of these tasks to delete command entries if you make a mistake or change your mind:

Task	Keystrokes
Erase the character to the left of the cursor.	Press the Delete or Backspace key.
Delete the character at the cursor.	Press Ctrl-D.
Delete from the cursor to the end of the command line.	Press Ctrl-K.
Delete from the cursor to the beginning of the command line.	Press Ctrl-U or Ctrl-X.
Delete the word to the left of the cursor.	Press Ctrl-W.
Delete from the cursor to the end of the word.	Press Esc D.

Scrolling Down a Line or a Screen

When you use the help facility to list the commands in a particular mode, the list is often longer than the terminal screen can display. In such cases, a ---More--- prompt is displayed at the bottom of the screen. To view the next line or screen, perform these tasks:

Task	Keystrokes
Scroll down one line.	Press the Return key.
Scroll down one screen.	Press the Spacebar.

Note The ---More--- prompt is used for any output that has more lines than can be displayed on the terminal screen, including show command output.

Redisplaying the Current Command Line

If you enter a command and the system suddenly sends a message to your screen, you can recall your current command line entry. To do so, perform this task:

Task	Keystrokes
Redisplay the current command line.	Press Ctrl-L or Ctrl-R.

Transposing Mistyped Characters

If you mistype a command entry, you can transpose the mistyped characters by performing this task:

Task	Keystrokes
Transpose the character to the left of the cursor with the character located at the cursor.	Press Ctrl-T.

Controlling Capitalization

You can change words to uppercase or lowercase, or capitalize a set of letters, with simple keystroke sequences:

Task	Keystrokes
Capitalize at the cursor.	Press Esc C.
Change the word at the cursor to lowercase.	Press Esc L.
Capitalize letters from the cursor to the end of the word.	Press Esc U.

Designating a Keystroke as a Command Entry

You can use a particular keystroke as an executable command. Perform this task:

Task	Keystrokes
Insert a code to indicate to the system that the keystroke immediately following should be treated as a command entry, not an editing key.	Press Ctrl-V or Esc Q.

Ending a Session

After entering the setup command or other configuration commands, exit the ATM module and quit the session.

To end a session, enter this command:

Task	Command
Enter the quit EXEC command.	quit

RSM Command-Line Interface

The RSM is a fully-functional router running Cisco IOS software. The Cisco IOS user interface allows you to access several different command modes. Each command mode provides a group of related commands.

Cisco IOS software has two levels of access to commands: user and privileged. The unprivileged user mode is the user EXEC mode. The privileged mode is the privileged EXEC mode and requires a password. The commands available in user EXEC mode are a subset of the commands available in privileged EXEC mode.

From the privileged EXEC level, you can access global configuration mode and six specific configuration modes: interface, subinterface, line, router, ipx-router, and route-map configuration. Entering a question mark (?) at the system prompt displays a list of commands available for each command mode.

Almost every configuration command has a no form. In general, enter the no form to disable a feature or function. Enter the command without the keyword no to reenable a disabled feature or to enable a feature that is disabled by default. Refer to the Catalyst 5000 Series Route Switch Module Installation and Configuration Note, Catalyst 5000 Series Command Reference, and the Cisco IOS Configuration Fundamental Command Reference publications for more information about the RSM commands.

The user interface provides context-sensitive help on command syntax, and describes the command editing and command history features that enable you to recall previous command entries and easily edit command entries.

Accessing the RSM

To access an RSM installed in a Catalyst 5000 series switch, enter the session mod_num command at the Console> prompt. The switch responds with the Enter Password prompt. Enter the password for the RSM. The RSM responds with the Router> prompt. At this point, you are in user EXEC command mode, and you have direct access only to the RSM with which you have established a session.

The following example shows how to open a session on an RSM:

Console> session mod_num 
Console> Enter Password:
Router>

Accessing the VIP2 Port Adapters

When you use the RSM with the Catalyst VIP2, the combination is a double-wide module that occupies two consecutive Catalyst 5505, Catalyst 5000, or Catalyst 5500 slots. The Catalyst VIP2 data and control interface is provided through two ribbon cables. Power to the Catalyst VIP2 is provided through the Catalyst VIP2 backplane connector.

For more information, refer to the Route Switch Module Catalyst VIP2-15 and VIP2-40 Installation and Configuration Note.

Note You can install the RSM/VIP2 combination in Catalyst 5505, Catalyst 5000, and Catalyst 5500 switches; you can use the standalone RSM in the Catalyst 5002 switch.

Operating the RSM CLI

Refer to the Configuration Fundamentals Command Reference publication for router commands and instructions on how to configure the IOS Router CLI.

ROM Monitor Command-Line Interface

The ROM monitor is a ROM-based program that executes upon platform power-up, reset, or when a fatal exception occurs. The system enters ROM monitor mode if the switch does not find a valid system image, if the NVRAM configuration is corrupted, or if the configuration register is set to enter ROM monitor mode. From the ROM monitor mode, you can manually load a system image from Flash memory, from a network server file, or from bootflash.

You can also enter ROM monitor mode by restarting the switch and then pressing the Break key during the first 60 seconds of startup.

Note The Break key is always enabled for 60 seconds after rebooting the system, regardless of whether the Break key is configured to be off by configuration register settings.

For connection through a terminal server, you can escape to the Telnet prompt and enter the send break command to break back to ROM monitor mode.

Once you are in ROM monitor mode, the prompt changes to rommon#>.

Table of Contents

Command-Line Interfaces