ATM Command-Line Interface

You can configure and maintain the Catalyst 5000 series ATM module by entering commands from the ATM module CLI. The ATM module CLI uses a subset of the Cisco IOS software commands. Generally, the Cisco IOS software works the same on the ATM module as it does on routers.

To configure other Catalyst 5000 series modules, you must use the switch CLI. For more information about the switch CLI, refer to the "Switch Command-Line Interface" chapter.

Accessing the ATM Module CLI

You can open a session with the ATM module on a Catalyst 5000 series switch by using the session mod_num command from the switch CLI Console> prompt. After you enter this command, the switch responds with the Enter Password prompt. Enter atm as the default password. At this point, you are at the ATM> prompt, and you have direct access only to the ATM module with which you have established a session.

The following example shows how to establish a session with the ATM module (in this case, module 5):

Console> (enable) session 5
Trying ATM-5...
Connected to ATM-5.
Escape character is '^]'.
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.

Accessing the Command Modes

This section describes how to access and list the commands available in each of the command modes available in the Cisco IOS user interface, and explains the primary uses for each command mode.

Command Mode Overview

The Cisco IOS software provides two levels of access to commands: user and privileged. The user mode is called user EXEC mode. The privileged mode is called privileged EXEC mode. The default password to access the privileged EXEC mode on the ATM module is atm. The commands available in user EXEC mode are a subset of those available in privileged EXEC mode.

Most configuration commands have a standard form and a no form. Use the standard form of a command to enable a feature that is disabled by default or to reenable a disabled feature. Use the no form to disable a feature or function.

Entering a question mark (?) at the system prompt displays commands available for each command mode. For the complete syntax of standard and no forms of the ATM module commands, refer to the "General ATM Commands" chapter and the "ATM show Commands" chapter.

Table 10-1 lists the ATM module command modes, how to access each mode, the prompts you see in each mode, and the methods used to exit each mode. The prompts assume the default name ATM.

User EXEC Mode

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

The user EXEC mode prompt is as follows:

ATM>

To list the user EXEC commands, complete this task:

The following example shows how to list the commands available in user EXEC mode:

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>

Privileged EXEC Mode

Because many of the privileged commands set operating parameters, privileged access is password-protected to prevent unauthorized use. The privileged command set includes all of the commands available in user EXEC mode, as well as the debug commands and the configure command, which is used to access the other configuration command modes.

The privileged EXEC mode prompt is as follows:

ATM#

To access privileged EXEC mode and list the available commands, perform these steps:

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

The following example shows how to list the privileged EXEC commands:

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#

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

To return to user EXEC mode from privileged EXEC mode, perform this task:

Global Configuration Mode

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

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

You can then specify the terminal or NVRAM as the source of configuration commands (for more information, see the "Image and Configuration File Load Commands" chapter in the Cisco IOS Configuration Fundamentals Command Reference publication). The default is to enter commands from the terminal console. Pressing Return begins this configuration method.

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

The following 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:

Interface Configuration Mode

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

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

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
  help           Description of the interactive help system
  lane           Modify LANE parameters
  load-interval  Specify interval for load calculation for an interface
  loopback       Configure internal loopback on an interface
  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
ATM(config-if)#

You can exit to global configuration mode or privileged EXEC mode from interface configuration mode. To exit interface configuration mode, perform one of the following tasks:

Line Configuration Mode

Line configuration commands modify the operation of a virtual terminal line. Line configuration commands always follow a line global configuration command, which identifies the 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:

The following example shows how to enter line configuration mode for virtual terminal line 3 and list the line configuration commands:

ATM(config)#line 3
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
  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)#

You can exit to global configuration mode or privileged EXEC mode from line configuration mode. To exit line configuration mode, perform one of the following tasks:

Performing ATM Module Functions

This section describes how to perform the following tasks on the Catalyst 5000 series ATM module:

• Getting Context-Sensitive Help

• Checking Command Syntax

• Using the Command History Features

• Using the Editing Features

• Ending a Session

Getting Context-Sensitive Help

Entering a question mark (?) at the system prompt displays a list of commands available for each command mode. You can also use ? to see a list of the keywords and arguments associated with a command.

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

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 backup 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?'.)
ATM#

As described in the help command output, you can enter a partial command name and a question mark (?) to obtain a list of commands beginning with a particular character set. For more detail, see the section "Completing a Partial Command Name" later in this chapter.

The following example shows how to use the context-sensitive help to access global configuration mode:

ATM#co?
configure  copy
ATM#co
ATM# configure ?
  memory    Configure from NV memory
  network   Configure from a TFTP network host
  terminal  Configure from the terminal
  
ATM#configure

Checking Command Syntax

The user interface provides error isolation with an error indicator (^). The ^ 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 the following example, suppose you want to clear an interface. 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 interface keyword is required. Next, check the syntax for specifying the type of interface:

ATM#clear interface ?
  ATM       ATM interface
  Ethernet  IEEE 802.3
  Null      Null interface
ATM#clear interface

Enter the type of interface:

ATM#clear interface atm
% Incomplete command.
ATM#

The system indicates that you need to provide additional arguments to complete the command. Press Ctrl-P to automatically repeat the previous command entry (for more information, see the section "Using the Command History Features" later in this chapter) and then complete the command entry:

ATM#clear interface atm 1
                        ^
% Invalid input detected at '^' marker.
ATM#

The ^ symbol indicates an error at the character "1." To list the correct syntax, enter the command up to the point where the error occurred and then enter a question mark (?):

ATM#clear interface atm ?
  <0-0>  ATM interface number
ATM#clear interface atm

Now enter the correct interface number and press Return to execute the command:

ATM#clear interface atm 0
ATM#

Using the Command History Features

The ATM module CLI provides a history or record of commands you have entered. This feature is particularly useful for recalling long or complex commands or entries. This section describes how to perform the following tasks:

• Setting the Command History Buffer Size

• Recalling Commands

• Disabling the Command History Feature

Setting the Command History Buffer Size

By default, the system records ten command lines in its history buffer. To alter the behavior of the command history feature, perform one of these tasks:

Recalling Commands

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

Disabling the Command History Feature

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

To disable the command history feature on a specific line, complete this task in line configuration mode:

Using the Editing Features

The enhanced command editing mode provides 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 form a unique abbreviation.

You can abbreviate commands and keywords by using enough characters to form a unique abbreviation. For example, you can abbreviate the show command to sh because show is the only command that begins with "sh."

This section describes how to perform the following tasks:

• Enabling Enhanced Editing Mode

• Moving Around on the Command Line

• Completing a Partial Command Name

• Pasting in Buffer Entries

• Editing Command Lines That Wrap

• Deleting Entries

• Scrolling Down a Line or a Screen

• Redisplaying the Current Command Line

• Transposing Mistyped Characters

• Controlling Capitalization

• Designating a Keystroke As a Command Entry

Enabling Enhanced Editing Mode

The enhanced editing mode is automatically enabled, but you can disable it using the no editing command.

To reenable the enhanced editing mode for the current terminal session, complete this task in EXEC mode:

To reconfigure a specific line to have enhanced editing mode, complete this task in line configuration mode:

Moving Around on the Command Line

Use the following keystrokes to move the cursor around on the command line to make corrections or changes:

Completing a Partial Command Name

If you cannot remember a complete command name, perform this task to allow the system to complete a partial entry:

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
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, there are three commands in privileged mode that start with co. To see what they are, type co? at the privileged EXEC prompt:

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 performing these steps:

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

Editing Command Lines That Wrap

The editing command set has a wraparound feature. When the cursor reaches the right margin, the command line shifts 10 spaces to the left. You cannot see the first 10 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:

In the following example, the lane config-atm-address command entry extends beyond one line. When the cursor first reaches the end of the line, the line is shifted ten spaces to the left and redisplayed. The dollar sign ($) indicates that the line has been scrolled to the left. Each time the cursor reaches the end of the line, the line is again shifted 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 have completed the entry, press Ctrl-A to check the complete syntax, then press the Return key to execute the command. The dollar sign ($) appears at the end of the line to indicate that the line has been scrolled to the right:

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

The system assumes you have a terminal screen that is 80 columns wide. If you have a width other than that, use the terminal width command to set the correct width of your terminal.

Use line wrapping with the command history feature to recall and modify previous complex command entries. See the section "Using the Command History Features" earlier in this chapter 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:

Scrolling Down a Line or a Screen

When you use help 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, complete these tasks:

Redisplaying the Current Command Line

If you are entering a command and the system suddenly sends a message to your screen (such as the output of a debug command), you can easily recall your current command line entry. To do so, perform this task:

Transposing Mistyped Characters

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

Controlling Capitalization

You can capitalize or lowercase words or capitalize a set of letters by performing these tasks:

Designating a Keystroke As a Command Entry

Sometimes you might want to use a particular keystroke as an executable command. Complete this task to insert a system code for this purpose:

Ending a Session

After entering configuration commands or performing other tasks, exit the ATM module and quit the session by performing this task: