About This Manual

This section defines the audience and scope of this manual and briefly describes the contents of each chapter. Icons and conventions are also described.

This document is for networking professionals configuring Catalyst 1900 series or Catalyst 2820 series switch through the command-line interface (CLI). These CLI commands are a supported feature of the Cisco Catalyst 1900 and 2820 Enterprise Edition Software. We assume that you have some experience working from a CLI and that you are familiar with the terminology and concepts of Ethernet and local area networking.

The document is designed to provide comprehensive reference information about the CLI commands these switches support.

Organization

This guide is organized into the following sections:

"Overview" explains the syntax of the CLI commands, provides time-saving shortcuts, and lists the various command modes, error-message types, and command restrictions.

"Command Descriptions" is an alphabetized description of each command used in the Catalyst 2820 series and Catalyst 1900 series switches.

"Command Lists" is a list of available CLI commands listed by password level and command mode.

Conventions

This publication uses the following conventions to convey instructions and information:

Command descriptions use these conventions:

Commands and keywords are in boldface.

Note

show

(cdp neighbors)

Arguments for which you supply values are in italic.
Required options are grouped in braces ( { } ) and separated by vertical bars ( | ).
Elements in square brackets ( [ ] ) are optional and separated by vertical bars ( | ).
Nonprinting characters, such as passwords, are in angle brackets (< >).
A string is defined as a nonquoted set of characters (except where quotes are indicated as necessary).

Examples use these conventions:

Terminal sessions and system displays are in screen font.
Information you enter is in boldface screen font.

Notes use the following convention:

Note Means reader take note. Notes contain helpful suggestions or references to materials not contained in this manual.

Related Publications

The following documents provide related information about the Catalyst 1900 series and Catalyst 2820 series switches:

Quick Start Guide: Catalyst 1900 Series Ethernet Switches provides instructions for connecting the switch to network devices, assigning an IP address and password to the switch, and displaying the web-based Catalyst 1900 Switch Manager.

Catalyst 1900 Series Installation and Configuration Guide describes the Catalyst 1900 switch hardware features, its physical and performance characteristics, and how to troubleshoot the installation.

Catalyst 1900 Switch Manager online help provides detailed procedures for using the web-based Catalyst 1900 Switch Manager to change configuration settings and to display switch information. O nline help also provides detailed information about the fields on each Catalyst 1900 Switch Manager page.
Catalyst 1900 Series and Catalyst 2820 Series Enterprise Edition Software Configuration Guide describes the features and configuration procedures for the Cisco Catalyst 1900/2820 Enterprise Edition Software.
Quick Start Guide: Catalyst 2820 Series Ethernet Switches provides instructions for connecting the switch to network devices, assigning an IP address and password to the switch, and displaying the web-based Catalyst 2820 Switch Manager.
Catalyst 2820 Series Installation and Configuration Guide describes the Catalyst 2820 switch hardware features, its physical and performance characteristics, and how to troubleshoot the installation.
Catalyst 2820 Switch Manager online help provides detailed procedures for using the web-based Catalyst 2820 Switch Manager to change configuration settings and to display switch information. O nline help also provides detailed information about the fields on each Catalyst 2820 Switch Manager page.
Catalyst 2820 Modules User Guide describes the Catalyst 2820 100BaseT switch modules, 100BaseT repeater modules, and FDDI modules and provides instructions for installing the modules in the switch.
Catalyst 2820 ATM Modules Installation and Configuration Guide describes the Catalyst 2820 ATM modules and provides instructions for installing the modules in the switch.
Cisco IOS Desktop Switch Software Configuration Guide, Catalyst 2900 Series XL and Catalyst 3500 Series XL Cisco IOS Release 12.0(5)XP describes switch cluster management and membership.

Cisco CLI Command Reference Format

Cisco Connection Online

Cisco Connection Online (CCO) is Cisco Systems' primary, real-time support channel. Maintenance customers and partners can self-register on CCO to obtain additional information and services.

Available 24 hours a day, 7 days a week, CCO provides a wealth of standard and value-added services to Cisco's customers and business partners. CCO services include product information, product documentation, software updates, release notes, technical tips, the Bug Navigator, configuration notes, brochures, descriptions of service offerings, and download access to public and authorized files.

CCO serves a wide variety of users through two interfaces that are updated and enhanced simultaneously: a character-based version and a multimedia version that resides on the World Wide Web (WWW). The character-based CCO supports Zmodem, Kermit, Xmodem, FTP, and Internet e-mail, and it is excellent for quick access to information over lower bandwidths. The WWW version of CCO provides richly formatted documents with photographs, figures, graphics, and video, as well as hyperlinks to related information.

You can access CCO in the following ways:

WWW: http://www.cisco.com
WWW: http://www-europe.cisco.com
WWW: http://www-china.cisco.com
Telnet: cco.cisco.com
Modem: From North America, 408 526-8070; from Europe, 33 1 64 46 40 82. Use the following terminal settings: VT100 emulation; databits: 8; parity: none; stop bits: 1; and connection rates up to 28.8 kbps.

For a copy of CCO's Frequently Asked Questions (FAQ), contact cco-help@cisco.com. For additional information, contact cco-team@cisco.com.

Note If you are a network administrator and need personal technical assistance with a Cisco product that is under warranty or covered by a maintenance contract, contact Cisco's Technical Assistance Center (TAC) at 800 553-2447, 408 526-7209, or tac@cisco.com. To obtain general information about Cisco Systems, Cisco products, or upgrades, contact 800 553-6387, 408 526-7208, or cs-rep@cisco.com.

Documentation CD-ROM

Cisco documentation and additional literature are available in a CD-ROM package, which ships with your product. The Documentation CD-ROM, a member of the Cisco Connection Family, is updated monthly. Therefore, it might be more current than printed documentation. To order additional copies of the Documentation CD-ROM, contact your local sales representative or call customer service. The CD-ROM package is available as a single package or as an annual subscription. You can also access Cisco documentation on the World Wide Web at http://www.cisco.com, http://www-china.cisco.com, or http://www-europe.cisco.com.

If you are reading Cisco product documentation on the World Wide Web, you can submit comments electronically. Click Feedback in the toolbar and select Documentation. After you complete the form, click Submit to send it to Cisco. We appreciate your comments.

Table of Contents

About This Manual