About This Document

This section discusses the objectives, intended audience, and organization of the Catalyst 5000 Series Switch Workgroup MIB User Quick Reference, and defines the conventions used to convey instructions and information.

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 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

This document describes the Management Information Base (MIB) for Catalyst 5000 series switches. It provides you with MIB descriptions, available integers, and access levels.

Audience

This document provides information specific to those who configure the software and administer the network. To use this document, you should be familiar with Cisco IOS software. For descriptions and examples of software configuration commands and the procedures for implementing them, refer to the Catalyst 5000 Series Advanced Software Configuration Guide and the Catalyst 5000 Series Command Reference publication.

Document Organization

This publication contains the following information:

Chapter 1,"Introduction to Catalyst 5000 Series Switch Workgroup MIBs," describes MIBs and how to access them.
Chapter 2, "Catalyst 5000 Series Switch Workgroup MIBs," contains descriptions of the groups and variables used within the Catalyst 5000 series switch CISCO-STACK-MIB.
Chapter 3, "Catalyst 5000 Series Switch Cisco Management MIBs," contains descriptions of the groups and variables used within the following Cisco Management MIBs:
Chapter 4, "Catalyst 5000 Series Switch Traps," contains descriptions of the Catalyst 5000 series switch traps, and includes the following sections:

Document Conventions

This document uses the conventions described below.

All descriptions, procedures, examples, and explanations given in this document apply to the Catalyst 5002 switch, Catalyst 5000 switch, and Catalyst 5500 switch unless specifically stated otherwise.
Each variable description uses these conventions:
- The variable is written in boldface font, with the object identifier in parentheses ( ).
- The syntax provides the available variables.
- Default settings are provided where available.
A string is defined as a nonquoted set of characters. For example, when setting an 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 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 (< >).

How to Use This Document

The Catalyst 5000 Series Switch Workgroup MIB User Quick Reference publication lists the Workgroup MIB variables that are proprietary to Cisco devices, as well as Cisco Management MIBs. However, many other Internet-standard MIBs are supported by Cisco agents. These standard MIBs are defined in documents called Requests for Comments (RFCs). (For information on the RFC MIBs supported by Cisco, refer to the section "Summary of Supported MIBs" in Chapter 1, "Introduction to Catalyst 5000 Series Switch Workgroup MIBs.") To find specific MIB information, you must examine the Cisco proprietary MIB structure and the standard RFC MIBs supported by Cisco.

If your network management system (NMS) is unable to get requested information from a managed device such as a Cisco router, the MIB that allows that specific data collection might be missing. Typically, if an NMS cannot retrieve a particular MIB variable, either the NMS does not recognize the MIB variable, or the agent does not support the MIB variable. If the NMS does not recognize a specified MIB variable, you might need to load the MIB into the NMS, usually by means of a MIB compiler. For example, you might need to load the Cisco Workgroup MIB or the supported RFC MIB into the NMS to execute a specified data collection. If the agent does not support a specified MIB variable, you must find out what version of Cisco IOS or system software you are running. Different MIBs are supported in different software releases.

Use this document to determine whether your version of software supports the specified MIB variable, or to see what variables are available for a given software release. As you use this document, read the descriptions of the variables to learn what they are and what they do. Check the Access or Max-Access type to learn what operations, such as reading get commands or writing set commands, can be performed on a particular MIB variable. Check the Syntax type to determine the data type for the MIB variable. Some variables provide textual information (for example, syntax of DisplayString), while others provide numeric information (for example, syntax of integers or counters). Once you identify a needed MIB variable, you can easily load the MIB file into your NMS. To learn how to access a Cisco Workgroup or Management MIB file, refer to the section "Downloading the Cisco Workgroup MIB File" in Chapter 1, "Introduction to Catalyst 5000 Series Switch Workgroup MIBs."

This document lists the default values, whenever they are available.

Table of Contents