|
|
This chapter contains the following sections:
This document provides a brief description of the Catalyst 5000 series switch products, and describes the Cisco Systems private, or local, Workgroup Management Information Base (MIB) for Cisco Internetwork Operating System (Cisco IOS) Release 2.2. The Cisco Workgroup MIBs are provided with all Cisco software releases and with CiscoWorks router management software. The MIB file contains variables that can be set or read to provide information on network devices and interfaces.
This document is intended for network management system (NMS) managers.
The Cisco Workgroup MIB is a set of variables that are private extensions to the Internet standard MIB II and many other Internet standard MIBs. MIB II is documented in RFC 1213, Management Information Base for Network Management of TCP/IP-based Internets: MIB-II.
This section contains a brief description and list of features for Catalyst 5000 series switches. The Catalyst 5000 series switches include the Catalyst 5002, the Catalyst 5000, and the Catalyst 5500. Throughout this guide and all Catalyst 5000 series switch documents, "Catalyst 5000 series switches" refers to all of the Catalyst 5000 switches unless otherwise noted. For additional information regarding any of these products, refer to the appropriate publication.
Catalyst 5000 series switches include an expanding line of modular LAN switches that provide the flexibility needed to meet the most challenging networking requirements. Table 1-1 lists and describes the Catalyst 5000 series switch models.
| Switch Model | Description | Features |
|---|---|---|
| Catalyst 5002 | 2-slot switch | |
|
Catalyst 5000 | 5-slot switch |
|
|
Catalyst 5500 | 13-slot switch |
|
Catalyst 5000 series switches support the interfaces listed below. Default configurations and quick configuration tables are provided for each interface. For detailed configuration information, refer to the Catalyst 5000 Series Advanced Software Configuration Guide.
Catalyst 5000 series switches support the software features listed below. A quick configuration table is provided for each feature. For detailed configuration information, refer to the publication, Catalyst 5000 Series Advanced Software Configuration Guide.
Catalyst 5002 and Catalyst 5000 switches feature a single, integrated 1.2-Gbps switching backplane. Catalyst 5500 switches feature a 3.6-Gbps switching backplane. All Catalyst 5000 series switches support switched 10/100-Mbps Ethernet/Fast Ethernet and Ethernet repeater connections, with backbone connections to Fast Ethernet, Asynchronous Transfer Mode (ATM), Fiber Distributed Data Interface (FDDI), Copper Distributed Data Interface (CDDI), and Token Ring. Slot 1 in all Catalyst 5000 series switches is dedicated to the supervisor engine module. The Catalyst 5500 switch supports a redundant supervisor engine module and LightStream 1010 ATM switch modules. The Catalyst 5500 switch supports ATM Port Adapter Modules (PAMs).
Catalyst 5000 series switches support all standard traps defined in the standard MIBs listed in the "Catalyst 5000 Series Switch Overview." Cisco-proprietary traps used by the Catalyst 5000 series switches are documented in the CISCO-STACK-MIB.my file.
Three methods are available for accessing and downloading a copy of the CISCO-STACK-MIB.my file:
These methods are described in the following sections.
To download the CISCO-STACK-MIB.my MIB file using FTP, perform the following steps:
Step 1 From a UNIX server, enter the following command at the system prompt:
% ftp ftp.cisco.com
The system displays a login prompt.
Step 2 Log in with the username anonymous, as follows:
Name (ftp.cisco.com:user): anonymous
The system displays a password prompt.
Step 3 Enter your full e-mail address in the following format:
Password: user@domain_name
For example:
Password: jdoe@cisco.com
The system displays an ftp> prompt.
Step 4 Change directories to pub/mibs, as follows:
ftp> cd pub/mibs
Step 5 Change to the directory containing the CISCO-STACK-MIB.my file, as follows:
ftp> cd v1
Step 6 Use the get command to download a copy of the CISCO-STACK-MIB.my file, as follows:
ftp> get CISCO-STACK-MIB.my
The get command downloads the CISCO-STACK-MIB.my file to your directory.
Step 7 Exit FTP by entering quit at the ftp> prompt, as follows:
ftp> quit
To access the Catalyst 5000 MIBs using a multimedia WWW browser, perform the following steps:
Step 1 Go to the following WWW location to reach the Catalyst 5000 MIB support list page:
http://www.cisco.com/public/mibs/supportlists/wsc5000/supportlist.html
Step 2 Select CISCO-STACK-MIB.my. The browser displays the first page of the CISCO-STACK-MIB.my file.
Step 3 Save the CISCO-STACK-MIB.my file as text using the Save as... command from the File pulldown menu of your browser. You can also send the file to yourself using the Mail Document... command from the File pulldown menu of your browser.
You can also use the Cisco Connection Online (CCO) World Wide Web (WWW) site to download the CISCO-STACK-MIB.my MIB file. You can access CCO through either a character-based interface or a multimedia browser interface. The character-based interface, called CCO Classic, allows people without direct Internet access to use virtually all of the CCO features. CCO Classic supports Xmodem, Ymodem, Zmodem, Kermit, FTP, Internet e-mail, and fax download options, and can be accessed using the Telnet protocol. The multimedia browser interface provides richly formatted documents with photographs, figures, graphics, and video. Both methods also provide hyperlinks to related information.
Table 1-2 shows the modem settings that you should use to access CCO.
| Modem Setting | Value |
|---|---|
| Terminal emulation: | VT100 |
| Data bits: | 8 |
| Parity: | None |
| Stop bits: | 1 |
| Baud rate: | Up to 14.4 kbps |
To access CCO from North America, dial 408 526-8070; from Europe, dial 33 1 6446 40 82.
To access CCO using a character-based WWW interface, perform the following steps:
Step 1 From a system capable of running the Telnet protocol, enter the following command:
% telnet cco.cisco.com
The system displays a login prompt.
Step 2 Log in cco as follows:
login: cco
The system displays messages similar to the following and prompts you to specify a terminal type:
Last login: Tue Dec 17 17:14:51 from dynaserv-noc-use
Welcome to CCO Classic....
Enter terminal type (return=vt100):
Step 3 Press the Return key to select VT100 terminal emulation.
The system displays messages similar to the following:
_______________________________________________________________ Cisco Systems, Incorporated - Cisco Connection Online (CCO)
[Enhanced for Lynx!]
_________________________________________________________________
* Enter CCO as a Registered User
* Enter CCO as a Guest User (public information)
* Perform an Online Registration (Maintenance Contract required)
* Help
_________________________________________________________________
Step 4 Select Enter CCO as a Guest User (public information) and press the Return key.
The system displays the Welcome to Cisco Connection Online screen.
Step 5 Select Software Image Library and press the Return key.
The system displays the Software Images Library (p1 of 6) screen.
Step 6 Select MIB Files and press the Return key.
The system displays the Index of /public/mibs screen.
Step 7 Select v1 and press the Return key.
The system displays the Index of /public/mibs/v1 screen.
Step 8 Select CISCO-STACK-MIB.my and press the Return key.
The system displays the first page of the CISCO-STACK-MIB.my file.
Step 9 Enter P.
The system displays the Printing Options (CCOLynx Version 2.5) screen.
Step 10 Select the Mail the file option and press the Return key.
The system prompts you for a valid Internet mail address.
Step 11 Enter your e-mail address at the prompt, as follows:
Please enter a valid internet mail address: user@domain_name
The CCO Classic interface sends the CISCO-STACK-MIB.my file to the specified e-mail address.
Although this guide deals primarily with the CISCO-STACK-MIB, information for accessing other MIBs supported by Catalyst 5000 series switches is provided for your convenience. Two methods are described in this section for accessing and downloading MIB files:
To access the Catalyst 5000 MIBs using a multimedia WWW browser, perform the following steps:
Step 1 Go to the following WWW location to reach the Catalyst 5000 MIB support list page:
http://www.cisco.com/public/mibs/supportlists/wsc5000/supportlist.html
Step 2 Select a MIB file to view. The browser displays the first page of the selected MIB file.
Step 3 Save the MIB file as text using the Save as... command from the File pulldown menu of your browser. You can also send the file to yourself using the Mail Document... command from the File pulldown menu of your browser.
The following MIBs are available through ftp.cisco.com in the following locations:
To access the information that certain MIB variables support, you must enter either an Interface Index (IF-INDEX) or Bridge Identifier (BridgeID) value as an instance identifier. The following sections describe how to access these types of values for use with MIBs mentioned previously:
To find the module number and port number to which an IF-INDEX is mapped, read the IfName in the MIB object of the Interface Extension MIB (RFC 1573). Use this method to find the IF-INDEX when you are accessing any of the variables in the CDP MIB that require an IF-INDEX for a variable instance identifier (such as "CDP neighbors").
The Catalyst 5000 Series Group Switching Ethernet module has 12 ports in each of its four switched, repeated segments. To gather statistical information about one of these segments using the Interface Extension MIB (RFC 1573) or CDP MIB, use the IF-INDEX of the first port of the segment (port 1, 13, 25, or 37) as the variable instance identifier.
Standard remote monitoring (RMON, RFC 1757) supports nine types of monitoring groups. The Catalyst 5000 supports four of these groups: statistics, history, alarms, and events. Any RMON-compliant manager can obtain and display information from these groups. For example, the Cisco TrafficDirector application provides a simple, point-and-click method of obtaining the information. Refer to the TrafficDirector Windows User Guide or TrafficDirector UNIX User Guide for details about TrafficDirector.
Collecting remote monitoring (RMON) information requires you to create TrafficDirector software agents. These agents consist of a Catalyst 5000 IP address and an Interface Index (IF-INDEX) for the port about which information is to be collected. For instructions about how to display the IF-INDEX and the port number to which it is mapped, refer to the sections in this document "Displaying the IF-INDEX Using SunNet Manager" and "Displaying the IF-INDEX Using HP Openview." To gather statistical information using the Interface Extension MIB (RFC 1573) or CDP MIB, use the IF-INDEX of the first port of the segment (port 1, 13, 25, or 37) as the variable instance identifier.
The Bridge MIB (RFC 1493) contains a bridge port number for each Catalyst 5000 Series Group Switching Ethernet module segment. Query the portCrossIndex.mod_num.port_num MIB object in the CISCO-STACK-MIB to find the BridgeID. The mod_num is the module number in the Catalyst 5000, and the port_num is the first port in each Group Switching Ethernet module segment (that is, port 1, 13, 25, or 37).
To display Bridge MIB information for different VLANs, change the SNMP community string to append @vlan_num to the configured SNMP community string. The vlan_num is the VLAN number.
To access the different segments of the Group Switching Ethernet module using the SNMP-REPEATER-MIB (RFC 1516), change the SNMP community string of your SNMP application that references the Catalyst 5000 to the following syntax:
community_string@mod_num/port_num
The community_string represents the name of the SNMP community (the defaults are Public for Read-Only permission, private for Read-Write permission, and secret for Read-Write-All permission). The mod_num is the module number in the Catalyst 5000 and the port_num is the first port of each segment. For segment one, use port 1; for segment two, use port 13; for segment three, use port 25; and for segment four, use port 37.
To display the IF-INDEX and port number of a Catalyst 5000 using SunNet Manager, perform the following steps:
Step 1 Download the following files from ftp.cisco.com:
/pub/mibs/schema/IF-MIB.schema
/pub/mibs/oid/IF-MIB.oid.
Step 2 Copy these files to your SNMP agents directory, which is typically located in $SNMHOME/agents.
Step 3 Reinitialize SunNet Manager using the following command:
$SNMHOME/bin/snm -i
Step 4 If an icon of the Catalyst 5000 you are interested in monitoring is present in your network application topology map, highlight it and select IF-MIB from the properties sheet list. If the Catalyst 5000 icon is not present, create a new object to represent the switch in your network before highlighting its icon and selecting IF-MIB from the properties sheet list.
Step 5 On the device-specific menu, select the following commands:
Quick Dump, IF-MIB, and ifXTable.
Output similar to the following will be displayed. The IF-INDEX is listed under the column heading "KEY" in the first column of the output.
Apr 12 13:48:39 1996 [ 172.20.24.188 ] : Quick Dump: IF-MIB.ifXTable
KEY ifName ifInMulticastPkts ifInBroadcastPkts...
1 sc0 0 0
2 sl0 0 0
3 1/1 0 0
4 1/2 0 0
5 2/1 0 0
6 2/2 0 0
7 2/3 0 0
8 2/4 0 0
9 2/5 0 0
10 2/6 0 0
11 2/7 0 0
12 2/8 0 0
13 2/9 0 0
14 2/10 0 0
15 2/11 0 0
16 2/12 0 0
Step 6 Choose the key that corresponds to the module or port to monitor.
To display the IF-INDEX and port number of the Catalyst 5000 using HP Openview, perform the following steps:
Step 1 Download the following file from ftp.cisco.com:
/ftp/pub/mibs/V2/IF-MIB.my
Step 2 Copy this MIB file to your OpenView MIBs directory, which is typically located in the directory path:
/usr/OV/snmp_mibs
Step 3 Rename the file rfc1573.mib to "rfc1573-INTERFACES".
Step 4 From the HP Openview main menu, select the following commands:
Options, Load/Unload MIBs:SNMP.
Step 5 Click on Load. Choose the file name rfc1573-INTERFACES, and click on OK.
Step 6 From the HP Openview main menu, select the following commands:
Monitor, MIB Values, Browse MIB:SNMP
Step 7 Type a device name or IP address into the form and then click MIB Object ID.
From the perspective of a network manager, network management takes place between two major types of systems: those in control, called managing systems, and those observed and controlled, called managed systems. The most common managing system is called a network management system (NMS). Managed systems can include hosts, servers, or network components such as routers or intelligent repeaters.
To promote interoperability, cooperating systems must adhere to a common framework and a common language, called a protocol. In the Internet Network Management Framework, that protocol is the Simple Network Management Protocol (SNMP).
The exchange of information between managed network devices and a robust NMS is essential for reliable performance of a managed network. Because some devices have a limited ability to run management software, most of the computer processing burden is assumed by the NMS. The NMS runs the network management applications, such as CiscoWorks or CiscoView, that present management information to network managers and other users.
In a managed device, specialized low-impact software modules, called agents, access information about the device and make it available to the NMS. Managed devices maintain values for a number of variables and report those, as required, to the NMS. For example, an agent might report such data as the number of bytes and packets in and out of the device, or the number of broadcast messages sent and received. In the Internet Network Management Framework, each of these variables is referred to as a managed object. A managed object is anything that an agent can access and report back to the NMS. All managed objects are contained in the Management Information Base (MIB), a database of the managed objects.
An NMS can control a managed device by sending a message to an agent of that managed device requiring the device to change the value of one or more of its variables. The managed devices can respond to commands such as set or get commands. The set commands are used by the NMS to control the device. The get commands are used by the NMS to monitor the device.
The Cisco Workgroup MIB variables are accessible via the Simple Network Management Protocol (SNMP), an application-layer protocol designed to facilitate the exchange of management information between network devices. The SNMP system consists of three parts: SNMP manager, SNMP agent, and MIB.
Instead of defining a large set of commands, SNMP places all operations in a get-request, get-next-request, and set-request format. For example, an SNMP manager can get a value from an SNMP agent or store a value in that SNMP agent. The SNMP manager can be part of a network management system (NMS), and the SNMP agent can reside on a networking device such as a router. You can compile the Cisco Workgroup MIB with your network management software. If SNMP is configured on a router, the SNMP agent can respond to MIB-related queries being sent by the NMS.
CiscoWorks network management software is an example of an NMS. CiscoWorks uses the Cisco Workgroup MIB variables to set device variables and to poll devices on the internetwork for specific information. The results of a poll can be graphed and analyzed to help you troubleshoot internetwork problems, increase network performance, verify the configuration of devices, and monitor traffic loads.
As shown in Figure 1-1, the SNMP agent gathers data from the MIB, which is the repository for information about device parameters and network data. The agent also sends traps, or notifications of certain events, to the manager. The Cisco trap file, mib.traps, which documents the format of the Cisco traps, is available on the Cisco host ftp.cisco.com. The Cisco traps are also summarized in the section, "Summary of Supported MIBs," later in this chapter.

The SNMP manager uses information in the MIB to perform the operations described in Table 1-3.
| Operation | Description |
|---|---|
| get-request | Retrieve a value from a specific variable. |
| get-next-request | Retrieve the value following the named variable. Often used to retrieve variables from within a table1. |
| get-response | The reply to a get-request, get-next-request, and set-request sent by an NMS. |
| set-request | Store a value in a specific variable. |
| trap | An unsolicited message sent by an SNMP agent to an SNMP manager indicating that some event has occurred. |
The MIB structure is logically represented by a tree hierarchy. (See Figure 1-2.) The root of the tree is unnamed and splits into three main branches: International Telecommunication Union Telecommunication Standardization Sector (ITU-T), International Organization for Standardization (ISO), and joint ISO/ITU-T.
These branches and those that fall below each category have short text strings and integers to identify them. Text strings describe object names, while integers allow computer software to create compact, encoded representations of the names. For example, the Cisco Workgroup MIB variable authAddr is an object name and is denoted by number 5, which is listed at the end of its object identifier number 1.3.6.1.4.1.9.2.1.5.
In the Internet MIB hierarchy, the object identifier is the sequence of numeric labels on the nodes along a path from the root to the object. The Internet standard MIB is represented by the object identifier 1.3.6.1.2.1. It also can be expressed as iso.org.dod.internet.mgmt.mib. (See Figure 1-2.)

The object identifier 1.3.6.1.4.1.9, or iso.org.dod.internet.private.enterprise.cisco represents the Cisco Workgroup MIB. The Cisco Workgroup MIB splits into two main areas: Workgroup Products (5) and Cisco Management (1).
In Figure 1-3, the Stack MIB group is identified by 1; its subgroup, called tftp grp, is identified by 5. Therefore, a variable in the subgroup tftp grp has an object identifier (OID) of 1.3.6.1.4.1.9.5.1.5.n, where n equals the variable number.
For information regarding the Workgroup MIBs, refer to Chapter 2 "Catalyst 5000 Series Switch Workgroup MIBs." For information regarding the Cisco Management MIBs, as well as other MIBs supported by the Catalyst 5000 series switches, refer to the publication "Cisco Management Information Base (MIB) User Quick Reference."

Each MIB variable is assigned an object identifier. For example, the MIB variable tftpHost is indicated by the number 1. The object identifier for tftpHost is iso.org.dod.internet.private.enterprise.cisco.workgroup products.stack group.tftp group.tftpHost variable or 1.3.6.1.4.1.9.5.1.5.1. Figure 1-4 provides a visual of this variable. The last value is the number of the MIB variable tftpHost.

Figures 1-5 through 1-17 provide a visual overview of the Catalyst 5000 series switch Workgroup MIB variables along with the object identifier numbers for each MIB variable. The MIB variables are arranged alphabetically within each figure.













When network management protocols use names of MIB variables in messages, each name has a suffix appended. This suffix is called an instance identifier. For simple variables, the instance identifier 0 refers to the instance of the variable with that name. A MIB also can contain tables of related variables.
An excerpt of the information on the local IP routing table (known as lipRoutingTable) from the associated MIB file follows:
lipRoutingTable OBJECT-TYPESYNTAX SEQUENCE OF lipRouteEntryACCESS not-accessibleSTATUS mandatoryDESCRIPTION"A list of IP routing entries."::= { lip 2 }lipRouteEntry OBJECT-TYPESYNTAX lipRouteEntryACCESS not-accessibleSTATUS mandatoryDESCRIPTION"A collection of additional objects in thecisco IP routing implementation." INDEX { ipRouteDest } ::= { lipRoutingTable 1 }lipRouteEntry ::=SEQUENCE {locRtMasklIpAddress,locRtCountINTEGER,}
The local IP routing table, lipRoutingTable, is described in Table 1-4. The lipRoutingTable contains two variables: locRtMask and locRtCount. The index for this table is the destination address of the IP route, or ipRouteDest. With n number of routes available to a device, n rows are available in the IP routing table.
In Table 1-4, the route with the destination IP address of 131.104.111.1 has an IP routing table network mask of 255.255.255.0. Three parallel routes are available within the routing table.
| lipRouteDest | locRtMask | locRtCount |
|---|---|---|
| 131.104.111.1 | 255.255.255.0 | 3 |
| 133.45.244.245 | 255.255.255.0 | 1 |
Typically, an instance identifier might be a unique interface number or a 0, as described earlier. An instance identifier can also be an IP address. For example, to find the network mask for the route with a destination address of 131.104.211.243, use the variable locRtMask (locate route mask) with an instance identifier of 131.104.211.243. The format is locRtMask.131.104.211.243.
In this document, when variables belong to a table, they are listed in the section describing the table. The following tag is used to indicate the end of a table; all variables before this tag are part of the table:
This section contains the following information:
For detailed information regarding the CISCO-STACK-MIB traps, refer to the section "Traps," in Chapter 2, "Catalyst 5000 Series Switch Workgroup MIBs." For detailed information regarding the other traps, refer to the publication Cisco Management Information Base (MIB) User Quick Reference.
This list includes the standard MIBs:
This list includes the Cisco MIBs:
This list includes the Catalyst 5000 series switches MIB:
This list includes the CISCO-STACK-MIB traps:
This list includes the Cisco traps:
|
|