About This Manual

This chapter describes the objectives, audience, organization, and conventions of the Catalyst 5000 Series Command Reference publication.

Cisco documentation and additional literature are available in a CD-ROM package that ships with your product. The Documentation CD-ROM, a member of the Cisco Connection Family, is updated monthly. Therefore, it might be more up to date 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.

Document Objectives

The Catalyst 5000 Series Command Reference publication is designed as a reference document. It provides complete descriptions of all the software commands used to configure and maintain Catalyst 5000 series switches.

For quick software configuration procedures for the Catalyst 5000 series switches, refer to the Catalyst 5000 Series Quick Installation and Software Configuration guide. For detailed software configuration information and procedures, refer to the Catalyst 5000 Series Advanced Software Configuration Guide.

If you are using Catalyst 5000 series switches in an emulated LAN environment, you should use this manual with the Cisco IOS Release 11.0 documentation set for routers and the LightStream 100 User Guide (3.1). If you are using a LightStream 1010 Asynchronous Transfer Mode (ATM) switch in the Catalyst 5500 series switch, refer to the LightStream 1010 ATM Switch Hardware Installation Guide and the LightStream 1010 ATM Switch Command Reference publications for detailed information regarding installation and configuration, respectively.

If you are using the Route Switch Module (RSM), refer to the Catalyst 5000 Series Switch Route Switch Module Installation and Configuration Note. If you need additional information on IOS commands, refer to the Configuration Fundamentals Command Reference.

Audience

This publication is for experienced network administrators who are responsible for configuring and maintaining Catalyst 5000 series switches.

Document Organization

This publication is organized as follows:

• Part 1, Switch Commands

  • "Switch Command Quick Reference"--A quick command reference that lists all switch command-line interface (CLI) commands, their syntax, and a brief description of their function.

  • "Switch Command-Line Interface"--Describes how to access and use the Catalyst 5000 series switch CLI.

  • "General Switch Commands"--Complete information on the switch CLI command set (except for the clear, set, and show commands).

  • "Switch clear Commands"--Complete information on the switch CLI clear command set.

  • "Switch set Commands"--Complete information on the switch CLI set command set.

  • "Switch show Commands"--Complete information on the switch CLI show command set.

• Part 2, ATM Commands

  • "ATM Command Quick Reference"--A quick command reference that lists all ATM CLI commands, their syntax, and a brief description of their function.

  • "ATM Command-Line Interface"--Describes how to access and use the Catalyst 5000 series switch command-line interface (CLI).

  • "General ATM Commands"--Complete information on the ATM CLI command set (except for the clear, set, and show commands).

  • "ATM show Commands"--Complete information on the ATM CLI show command set.

Document Conventions

The manual uses the following conventions:

• The symbol ^ represents the key labeled Control. For example, the key combinations ^D and Ctrl-D mean hold down the Control key while you press the D key. Keys are indicated in capital letters, but are not case sensitive.

• A string is defined as a nonquoted set of characters. For example, when setting a Simple Network Management Protocol (SNMP) community string to "public," do not use quotation marks around the string, or the string will include the quotation marks.

• Command descriptions use these conventions:

  • Commands and keywords are in boldface font.

  • Arguments for which you supply values are in italic font.

  • Optional elements are shown in square brackets ([ ]); alternative optional elements are separated by vertical bars ( | ).

  • Alternative but required elements are grouped in braces ({ }) and separated by vertical bars ( | ).

• Examples use these conventions:

  • Examples that contain system prompts denote interactive sessions, indicating that the user enters commands at the prompt. The system prompt indicates the current command mode. For example, Console <enable> indicates privileged mode.

  • Terminal sessions and information the system displays are in screen font.

  • Information you enter is in boldface screen font.

  • Nonprinting characters, such as passwords, are in angle brackets (< >).

  • Default responses to system prompts are in square brackets ([ ]).

  • Exclamation points (!) and pound signs (#) at the beginning of a line indicate a comment line. They are also displayed by the switch for certain processes.

• Throughout this manual, the word port refers to both ports and interfaces.

---

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

---

Caution Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of data.

The following illustration explains the fields on a typical command reference page: