Table Of Contents
Command Reference
CLI Command Modes
User EXEC Mode
Privileged EXEC Mode
Global Configuration Mode
Interface Configuration Mode
Line Configuration Mode
ATM Module Commands
atm bind
atm pvc
show atm vlan
Supported Cisco IOS Commands
Command Reference
This appendix provides a reference to the Cisco IOS commands used by the ATM modules.
A detailed description of the commands specific to the ATM modules is provided in the "ATM Module Commands" section. Core commands the ATM module uses are listed in in the "Supported Cisco IOS Commands" section.
A description of the command-line interface (CLI) command modes is also included.
CLI Command Modes
This section describes the CLI command mode structure. Command modes support specific Cisco IOS commands. For example, the interface type_number command works only when entered in global configuration mode. The Cisco IOS command modes are as follows:
•
User EXEC mode
•
Privileged EXEC mode
•
Global configuration mode
•
Interface configuration mode
•
Line configuration mode
lists the command modes, how to access each mode, the prompt you will see in that mode, and how to exit that mode. The prompts listed assume the default name ATM.
Table B-1 Command Modes Summary
Command Mode
|
Access Method
|
Prompt
|
Exit Method
|
User EXEC
|
Begin a session with the ATM module.
|
|
Enter the logout command.
|
Privileged EXEC
|
From user EXEC mode, enter the enable EXEC command.
|
|
To exit to user EXEC mode, enter the disable command.
To enter global configuration mode, enter the configure command.
|
Global configuration
|
From privileged EXEC mode, enter the configure privileged EXEC command.
|
|
To exit to privileged EXEC mode, enter the exit or end command, or press Ctrl-Z.
To enter interface configuration mode, enter the interface configuration command.
|
Interface configuration
|
From global configuration mode, specify an interface by entering the interface command.
|
|
To exit to global configuration mode, enter the end command.
To exit to privileged EXEC mode, enter the exit command, or press Ctrl-Z.
To enter subinterface configuration mode, specify a subinterface with the interface command. On the ATM module, the LANE client is considered a subinterface.
|
Line configuration
|
From global configuration mode, specify a line by entering the line command.
|
|
To exit to global configuration mode, enter the exit command.
To return to privileged EXEC mode, enter the end command, or press Ctrl-Z.
|
User EXEC Mode
After you access 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 at the privileged level. In general, the user EXEC commands allow you to change terminal settings temporarily, perform basic tests, and list system information.
The list of user EXEC commands displayed in the following example is a subset of the supported commands. The supported commands can vary, depending on the version of IOS Software in use. To view a comprehensive list of commands, enter a question mark (?) at the prompt.
disable Turn off privileged commands
enable Turn on privileged commands
help Description of the interactive help system
login Log in as a particular user
logout Exit from the EXEC
show Show running system information
terminal Set terminal line parameters
Privileged EXEC Mode
Because many of the privileged commands configure operating parameters, privileged access should be password-protected to prevent unauthorized use. The privileged command set includes those commands contained in user EXEC mode, as well as the configure command through which you access the remaining command modes.
If your system administrator has set a password, you are prompted to enter it before being granted access to privileged EXEC mode. The password is not displayed on the screen and is case sensitive.
The privileged EXEC mode prompt is as follows:
Enter the enable command to access privileged EXEC mode:
The list of privileged EXEC commands displayed in the following example is a subset of the supported commands. The supported commands can vary, depending on the version of IOS software in use. To view a comprehensive list of commands, enter a question mark (?) at the prompt.
configure Enter configuration mode
debug Debugging functions (see also 'undebug')
disable Turn off privileged commands
enable Turn on privileged commands
help Description of the interactive help system
login Log in as a particular user
logout Exit from the EXEC
reload Halt and perform a cold restart
show Show running system information
terminal Set terminal line parameters
write Write running configuration to memory, network, or
To return from privileged EXEC mode to user EXEC mode, enter the disable command.
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. The default is to enter commands from the management console.
When you enter the configure command, the console prompts you for the source of the configuration commands:
Configuring from terminal, memory, or network [terminal]?
You can specify either the terminal or NVRAM as the source of configuration commands.
The following example shows you how to access global configuration mode:
Enter configuration commands, one per line. End with CNTL/Z.
The list of global configuration commands displayed in the following example is a subset of the supported commands. The supported commands can vary depending on the version of IOS software in use. To view a comprehensive list of commands, enter a question mark (?) at the prompt.
alias Create command alias
default Set a command to its defaults
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
line Configure a terminal line
no Negate a command or set its defaults
privilege Command privilege parameters
username Establish User Name Authentication
To exit global configuration command mode and return to privileged EXEC mode, enter the end or exit command, or press Ctrl-Z.
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.
Use the interface type_number.subif command to access interface configuration mode. In the following example, ATM interface 1 is about to be configured. The new prompt, ATM(config-if)#, indicates interface configuration mode.
Note
One (1) is the interface number for Slot A, and 2 is the interface number for Slot B.
The following example shows you how to access interface configuration mode:
ATM(config)# int atm1.1 multipoint
The list of interface configuration commands displayed in the following example is a subset of the supported commands. The supported commands can vary, depending on the version of IOS software in use. To view a comprehensive list of commands, enter a question mark (?) at the prompt.
Interface configuration commands:
atm Modify ATM parameters
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 the exit command. To exit interface configuration mode and return to privileged EXEC mode, enter the end command, or press Ctrl-Z.
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 are used to change terminal parameter settings line-by-line or a range of lines.
Use the line vty line_number [ending_line_number] command to enter line configuration mode. The new prompt, ATM(config-line)#, indicates line configuration mode. The following example shows how to enter line configuration mode for virtual terminal line 7:
ATM(config)# line vty 0 7
The list of line configuration commands displayed in the following example is a subset of the supported commands. The supported commands can vary, depending on the version of IOS software in use. To view a comprehensive list of commands, enter a question mark (?) at the prompt.
Line configuration commands:
autocommand Automatically execute an EXEC command
editing Enable command line editing
escape-character Change the current line's escape character
exec-banner Enable the display of the EXEC banner
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 historyfunction
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 concurrentsessions
padding Set padding for a specified output character
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
To exit line configuration mode and return to global configuration mode, use the exit command. To exit line configuration mode and return to privileged EXEC mode, enter the end command, or press Ctrl-Z.
ATM Module Commands
The Cisco IOS software commands in this section are specific to the ATM module.
atm bind
Use the atm bind interface configuration command to bind a PVC to a VLAN. Use the no form of this command to remove the bind.
atm bind pvc vlan vc_no vlan_id
no atm bind pvc vlan vc_no vlan_id
Syntax Description
vc_no
|
Virtual circuit descriptor, a unique number for each switch that identifies which virtual path identifier/virtual channel identifier (VPI/VCI) to use for a particular packet.
|
vlan_id
|
Number of the VLAN.
|
Default
None
Command Mode
Interface configuration
Usage Guideline
You can bind any number of PVCs to the same VLAN. To prevent loops, ensure that each PVC uniquely connects a VLAN group between two Catalyst 2900 series switches.
Example
The following example shows how to bind PVC 10 to VLAN 5 and PVC 11 to VLAN 5:
ATM(config-if)# atm bind pvc vlan 10 5
ATM(config-if)# atm bind pvc vlan 11 5
Related Commands
show atm vlan
show atm vc
atm pvc
Use the atm pvc interface configuration command to enable the new encapsulation type, AAL5 SNAP, to support RFC-1483. You can specify the traffic-shaping parameters (such as peak rate in kbps, average rate in kbps, and burst-in cell rates) on a permanent virtual circuit (PVC). If you do not specify the traffic-shaping parameters, the default parameters are used. The default value for the peak bandwidth and average bandwidth is the line rate (155 Mbps), and burst cell rate is 4. Use the no form of this command to remove PVCs.
atm pvc vc_no vpi vci encaps [Peak Average [Burst]][OAM time_in_seconds]
no atm pvc vc_no vpi vci encaps [Peak Average [Burst]][OAM time_in_seconds]
Syntax Description
vc_no
|
Number of the virtual channel descriptor (VCD).
|
vpi
|
ATM network virtual path identifier (VPI) of this PVC. This value must be 0.
The VPI is an 8-bit field in the header of the ATM cell. The VPI value is unique only on a single link, not throughout the ATM network (it has local significance only). The vpi value must match that of the switch.
|
vci
|
ATM network virtual channel identifier (VCI) of this PVC, ranging from 1 to 1023. The VCI is a 16-bit field in the header of the ATM cell. The VCI value is unique only on a single link, not throughout the ATM network (it has local significance only).
|
encaps
|
ATM adaptation layer (AAL) and encapsulation type. Possible values are as follows:
• aal5snap—Logical Link Control/Subnetwork Access Protocol (LLC/SNAP) precedes the protocol datagram. This is the only encapsulation supported for RFC-1483 LLC encapsulation.
• ilmi—Used to set up communication with the ILMI; the associated vpi and vci values are ordinarily 0 and 16, respectively.
• qsaal—A signaling-type PVC used for setting up or tearing down SVCs; the associated vpi and vci values are ordinarily 0 and 5, respectively.
|
Peak
|
Maximum rate (in kbps) at which this virtual circuit can transmit. Valid values range from 130 kbps to 155,000 kbps. If you set this value, you must also specify the average (burst is optional) value.
|
Average
|
Average rate (in kbps) at which this virtual circuit transmits. Valid values are 130 kbps to 155,000 kbps. If you set this value, you must also specify the peak (burst is optional) value.
|
Burst
|
Value that relates to the maximum number of ATM cells the virtual circuit can transmit to the network at the peak rate of the PVC. On the ATM module, burst can range from 1 to 32 cells.
|
OAM
|
Specifies how often to generate an OAM F5 loopback cell from this virtual circuit.
|
time_in_seconds
|
The OAM value. The default value is 10 seconds.
|
Default
If peak and average rates are omitted, the PVC defaults to the highest bandwidth rate queue available. Peak and average rates are then equal. By default, the virtual circuit is configured to run as fast as possible.
If the OAM keyword is omitted, OAM cells are not generated. If the OAM keyword is present but the time-in seconds value is omitted, the default value is 10 seconds.
Command Mode
Interface configuration
Examples
The following example creates a PVC with VPI 0 and VC 100. The PVC uses RFC-1483 LLC encapsulation.
ATM(config-if)# atm pvc 100 0 100 aa5snap
The following example creates a PVC to be used for ATM signaling for an SVC. It specifies VPI 0 and VCI 5.
ATM(config-if)# atm pvc 1 0 5 qsaal
Related Commands
show atm interface atm
show atm vc
show atm vlan
Use the show atm vlan priviledged EXEC command to show the relationship between the VLAN and the PVCs.
show atm vlan vlan_id
Syntax Description
vlan_id
|
(Optional) Specifies the VLAN number.
|
Default
None
Command Mode
Privileged EXEC
Usage Guideline
If vlan_id is not specified, all active VLAN-to-PVC bindings are displayed.
Example
After entering the show atm vlan command, you see the following display:
The display shows the VCD of the VC and the VLAN-ID of the VLAN to which the VC belongs.
Related Commands
show atm ilmi-config
show atm ilmi-status
show atm interface
show atm map
show atm signalling
show atm traffic
show atm vc
Supported Cisco IOS Commands
The Cisco IOS commands listed in are supported by the ATM module. Each command in is in one of the following categories:
•
ATM module CLI commands
Use these commands to enter and exit CLI command modes. For details about CLI command modes, see the "CLI Command Modes" section.
•
Configuration commands
Use these commands to configure Flash memory on the ATM module.
•
ATM commands
Use these commands to configure an ATM interface.
•
LANE commands
Use these commands to configure a LAN client on the ATM interface for LANE.
For detailed descriptions of these commands, refer to your Cisco IOS documentation.
Table B-2 Supported Cisco IOS Commands
Command
|
Description
|
|
|
alias
|
Creates a shorthand alias.
|
IOS/ATM
|
GC
|
atm idle-timeout
|
Changes the idle timer for SVCs on an interface.
|
IOS/ATM
|
IC
|
atm ilmi-keepalive
|
Enables ILMI keepalives.
|
IOS/ATM
|
IC
|
atm nsap-address
|
Enables point-to-multipoint signaling to the ATM switch.
|
IOS/ATM
|
IC
|
atm sonet
|
Sets the mode of operation and control type of an ATM cell.
|
IOS/ATM
|
EXEC
|
atm uni-version
|
Specifies the UNI version 3.0 or 3.1 the router should use when ILMI link autodetermination is unsuccessful or ILMI is disabled.
|
IOS/ATM
|
IC
|
banner
|
Defines a login banner.
|
IOS/ATM
|
EXEC
|
clear atm vc
|
Clears a specified SVC.
|
IOS/ATM
|
IC
|
clear counters
|
Clears Media Access Control (MAC) and port counters.
|
IOS/ATM
|
EXEC
|
clear interface
|
Resets the hardware logic on an interface.
|
IOS/ATM
|
EXEC
|
clear lane le-arp
|
Clears the dynamic LANE Address Resolution Protocol (LE_ARP) table or a single LE_ ARP entry of the LANE client.
|
IOS/LAN
|
EXEC
|
clear line
|
Returns a terminal to idle state.
|
IOS/ATM
|
EXEC
|
configure
|
Enters global configuration mode.
|
IOS/ATM
|
EXEC
|
description
|
Adds a description to an interface configuration.
|
IOS/ATM
|
IC
|
debug atm
|
Displays ATM errors.
|
IOS/ATM
|
EXEC
|
debug lane
|
Displays ATM events.
|
IOS/ATM
|
EXEC
|
debug packet
|
Displays information on packets that the network cannot classify.
|
IOS/ATM
|
EXEC
|
debug sscop
|
Enables debugging for the Service Specific Connection Oriented Protocol (SSCOP).
|
IOS/ATM
|
EXEC
|
disable
|
Returns the management console interface to user EXEC mode.
|
IOS/ATM
|
EXEC
|
editing
|
Enables enhanced editing mode for a particular line.
|
IOS/ATM
|
LC
|
enable
|
Enters privileged EXEC mode.
|
IOS/ATM
|
EXEC
|
enable password
|
Sets a local password to control access to various privilege levels.
|
IOS/ATM
|
GC
|
end
|
Exits to configuration mode.
|
IOS/ATM
|
GC
|
full-help
|
Retrieves help for the full set of user-level commands.
|
IOS/ATM
|
All ATM
|
help
|
Displays a brief description of the help system.
|
Switch
|
N, P
|
history
|
Displays the command history.
|
IOS/ATM
|
Line
|
hostname
|
Modifies the host name for the network server.
|
IOS/ATM
|
GC
|
interface
|
Configures an interface type and enters interface configuration mode.
|
IOS/ATM
|
GC
|
lane bus-atm-address
|
Specifies an ATM address—and overrides the automatic ATM address assignment—or the broadcast-and-unknown server on the specified subinterface.
|
IOS/LAN
|
IC
|
lane client
|
Activates a LANE client on the specified subinterface.
|
IOS/LAN
|
IC
|
lane client-atm-address
|
Specifies an ATM address—and overrides the automatic ATM address assignment—for the LANE client on the specified subinterface.
|
IOS/LAN
|
IC
|
lane config-atm-address
|
Specifies a configuration server ATM address explicitly.
|
IOS/LAN
|
IC
|
lane le-arp
|
Adds a static entry to the LE_ARP table of the LANE client configured on the specified subinterface.
|
IOS/LAN
|
IC
|
lane server-atm-address
|
Specifies an ATM address—and overrides the automatic ATM address assignment—for the LANE server on the specified subinterface.
|
IOS/LAN
|
IC
|
login
|
Enables password checking at login.
|
IOS/ATM
|
LC
|
logout
|
Warns users of a forced timeout.
|
IOS/ATM
|
LC
|
no
|
Uses the command defaults.
|
IOS/ATM
|
LC
|
privilege
|
Sets the privilege level for a command.
|
IOS/ATM
|
GC
|
reload
|
Reloads the operating system.
|
IOS/Conf
|
EXEC
|
show
|
Displays running system information.
|
IOS/ATM
|
EXEC
|
show aliases
|
Displays all alias commands or the alias commands in a specified mode.
|
Switch
|
N, P
|
show atm ilmi
|
Displays ILMI information.
|
IOS/ATM
|
EXEC
|
show atm interface atm
|
Displays ATM-specific information about an ATM interface.
|
IOS/ATM
|
EXEC
|
show atm traffic
|
Displays current global ATM traffic to and from all ATM networks connected to the switch.
|
IOS/ATM
|
EXEC
|
show atm vc
|
Displays all active ATM virtual connections (PVCs and SVCs) and traffic information.
|
IOS/ATM
|
EXEC
|
show buffers
|
Displays statistics for the buffer pools on the network server.
|
IOS/ATM
|
EXEC
|
show configuration
|
Displays contents of nonvolatile memory.
|
IOS/ATM
|
EXEC
|
show controllers
|
Displays the interface controller status.
|
IOS/ATM
|
EXEC
|
show controller address-table
|
Shows the address table entries.
|
IOS/ATM
|
EXEC
|
show controller atm
|
Shows the ATM segmentation and reassembly (SAR) counters.
|
IOS/ATM
|
EXEC
|
show controller eth
|
Displays the MAC counters.
|
IOS/ATM
|
EXEC
|
show controller mem
|
Displays the memory buffer pools.
|
IOS/ATM
|
EXEC
|
show controller relay
|
Displays the Ethernet-to-ATM and ATM-to-Ethernet relay counters.
|
IOS/ATM
|
EXEC
|
show controller rfc
|
Displays the RFC-1483 counters.
|
IOS/ATM
|
EXEC
|
show controller sonet
|
Displays the SONET counters.
|
IOS/ATM
|
EXEC
|
show controller switch-port
|
Displays the switch port information.
|
IOS/ATM
|
EXEC
|
show debugging
|
Displays information about the types of Cisco Discovery Protocol (CDP) debugging that are enabled for your module.
|
IOS/ATM
|
EXEC
|
show history
|
Lists the commands you have entered in the current EXEC session.
|
IOS/ATM
|
EXEC
|
show interface
|
Displays information about the ATM interface.
|
IOS/ATM
|
EXEC
|
show lane
|
Displays detailed information for all the LANE components configured on an interface or on an emulated LAN.
|
IOS/LAN
|
EXEC
|
show lane brief
|
Bypasses individual connection client information.
|
IOS/LAN
|
EXEC
|
show lane client
|
Displays detailed LANE information for all the LANE clients configured on an interface or on an emulated LAN.
|
IOS/LAN
|
EXEC
|
show lane default-atm-addresses
|
Displays the automatically assigned ATM address of each LANE component on a specified interface.
|
IOS/LAN
|
EXEC
|
show lane interface
|
Identifies the interface.
|
IOS/LAN
|
EXEC
|
show lane le-arp
|
Displays the LANE ARP table of the LANE client configured on an interface or on an emulated LAN.
|
IOS/LAN
|
EXEC
|
show lane name
|
Identifies the ELAN name.
|
IOS/ATM
|
EXEC
|
show line
|
Displays connection information for a line running in asychronous mode.
|
IOS/ATM
|
EXEC
|
show location
|
Displays the system location.
|
IOS/ATM
|
EXEC
|
show logging
|
Displays the state of logging (syslog).
|
Switch
|
P
|
show memory
|
Shows statistics about memory, including memory-free pool statistics.
|
IOS/ATM
|
EXEC
|
show privilege
|
Displays your current privilege level.
|
IOS/ATM
|
EXEC
|
show processes
|
Displays information about the active processes.
|
IOS/ATM
|
EXEC
|
show registry
|
Displays function registry information.
|
IOS/ATM
|
EXEC
|
show reload
|
Displays the reload status of the module.
|
IOS/ATM
|
EXEC
|
show running-config
|
Displays the configuration information currently running on the terminal.
|
IOS/ATM
|
EXEC
|
show sscop
|
Shows Service-Specific Connection Oriented Protocol (SSCOP) details for all ATM interfaces.
|
IOS/ATM
|
EXEC
|
show stacks
|
Monitors the stack utilization of processes and interrupt routines.
|
IOS/ATM
|
EXEC
|
show startup-config
|
Displays the contents of NVRAM, if present and valid, or shows the configuration file pointed to by the config_file environment variable.
|
IOS/ATM
|
EXEC
|
show tech-support
|
Displays general system information about the module.
|
IOS/ATM
|
EXEC
|
show terminal
|
Displays terminal configuration parameters.
|
IOS/ATM
|
EXEC
|
show users
|
Displays information about terminal lines.
|
IOS/ATM
|
EXEC
|
show version
|
Displays the configuration of the system hardware, the software version, the names and sources of configuration files, and the boot images.
|
IOS/Conf
|
IC
|
shutdown
|
Disables the interface.
|
IOS/Conf
|
IC
|
sscop keepalive-time
|
Changes the keepalive timer.
|
IOS/ATM
|
IC
|
sscop max-cc
|
Changes the retry count of connection control.
|
IOS/ATM
|
IC
|
sscop max-stat
|
Identifies the maximum number of retries for connection control operations.
|
IOS/ATM
|
IC
|
sscop poll-timer
|
Changes the poll timer.
|
IOS/ATM
|
IC
|
sscop receive-window
|
Changes the receiving window.
|
IOS/ATM
|
IC
|
sscop send-window
|
Changes the transmitter window.
|
IOS/ATM
|
IC
|
terminal editing
|
Enables enhanced editing mode on the local line.
|
IOS/ATM
|
EXEC
|
terminal history
|
Enables the command history feature for the current terminal session or changes the size of the command history buffer for the current terminal session.
|
IOS/ATM
|
EXEC
|
terminal length
|
Sets number of lines on a screen.
|
IOS/ATM
|
EXEC
|
terminal monitor
|
Copies debug output to the current terminal line.
|
IOS/ATM
|
EXEC
|
terminal terminal-type
|
Sets the terminal type.
|
IOS/ATM
|
EXEC
|
terminal width
|
Sets width of the display terminal.
|
IOS/ATM
|
EXEC
|
undebug
|
Disables debugging functions.
|
IOS/ATM
|
EXEC
|
write erase
|
Erases the configuration information in NVRAM.
|
IOS/Conf
|
EXEC
|
write memory
|
Restarts the configuration information stored in NVRAM.
|
IOS/Conf
|
EXEC
|
write terminal
|
See show running_config command.
|
IOS/Conf
|
EXEC
|