Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service ProvidersFor Cisco Unified Contact Center Express Release 7.0(1)
Americas HeadquartersCisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706 USAhttp://www.cisco.comTel: 408 526-4000
800 553-NETS (6387)Fax: 408 527-0883
Text Part Number: OL-19788-01
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
CCDE, CCENT, Cisco Eos, Cisco Lumin, Cisco Nexus, Cisco StadiumVision, Cisco TelePresence, Cisco WebEx, the Cisco logo, DCE, and Welcome to the Human Network are trademarks; Changing the Way We Work, Live, Play, and Learn and Cisco Store are service marks; and Access Registrar, Aironet, AsyncOS, Bringing the Meeting To You, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, CCVP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Collaboration Without Limitation, EtherFast, EtherSwitch, Event Center, Fast Step, Follow Me Browsing, FormShare, GigaDrive, HomeLink, Internet Quotient, IOS, iPhone, iQuick Study, IronPort, the IronPort logo, LightStream, Linksys, MediaTone, MeetingPlace, MeetingPlace Chime Sound, MGX, Networkers, Networking Academy, Network Registrar, PCNow, PIX, PowerPanels, ProConnect, ScriptShare, SenderBase, SMARTnet, Spectrum Expert, StackWise, The Fastest Way to Increase Your Internet Quotient, TransPath, WebEx, and the WebEx logo are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.
All other trademarks mentioned in this document or website are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (0809R)
Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.
Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers © 2009 Cisco Systems, Inc. All rights reserved.
Cisco Unified CoOL-19788-01
Contents
Purpose iii
Audience iii
Organization iv
Related Documentation iv
Conventions iv
Obtaining Documentation and Submitting a Service Request v
Cisco Product Security Overview vi
Overview
Cisco Unified Communications Contact Center Express 1-1
About Cisco Unified CCX Architecture 1-3
Cisco Unified CCX Management Architecture 1-4
Cisco Unity Architecture Overview 1-4
Process Walkthroughs 1-24
Simple Network Management Protocol 1-43
Management Information Base 1-48
Managing and Monitoring Cisco Unified CCX and Cisco Unity
Cisco Unity Reporting 2-1
UCCX and Cisco Unity MIBs
UCCX Base Level MIB Support 3-1
UCCX Monitoring and Fault Management 3-107
Faults (Events / Alarms) 3-119
Setting Traces In UCCX 3-120
Cisco Unity MIBs 3-121
Cisco UCCX and Cisco Unity PerfMon and Alerts
Unity PerfMon Counters 4-1
THE UNITY DATA OBJECT MODEL 4-8
UnityDB 4-22
UnityReports 4-33
immunications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
Contents
iiCisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Preface
This chapter describes the purpose, audience, and organization of this document and describes the conventions that convey instructions and other information. It contains the following sections:
• Purpose, page v
• Audience, page v
• Organization, page vi
• Related Documentation, page vi
• Conventions, page vi
• Obtaining Documentation and Submitting a Service Request, page vii
• Cisco Product Security Overview, page vii
PurposeThis document provides information for managing Cisco Unified Communications products, specifically Unified Communications Contact Center Express. This includes information for the products Management Information Base (MIB), and it also explains syslogs, alerts and alarms for the managed services that Service Providers implement in their networks. This document outlines basic concepts including Simple Network Management Protocol (SNMP) and the features of the management tools available for these products.
AudienceThis document is for system and network administrators who install, upgrade, and maintain the Service Provider network.
You must have an understanding of Cisco Unified Communications Manager and the functionality of the related Cisco Unified Communications products included in this guide. See the “Related Documentation” section on page vi for Cisco Unified Commuications documents and other related technologies.
vCisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Preface
OrganizationThe following table provides an outline of the chapters in this document.
Related DocumentationThis section lists documents that provide information on Cisco Unified Contact Center Express.
• Cisco Unified Communications Contact Center Express Release 7.x—Go to http://www.cisco.com/en/US/products/sw/custcosw/ps1846/tsd_products_support_series_home.html for a complete set of user documentation for UCCX.
ConventionsThis document uses the following conventions:
Chapter Description
Chapter 1, “Overview” Describes an overview of UCCX and Cisco Unity. Covers concepts with which you need to be familiar to implement SNMP, MIBs, and serviceability features.
Chapter 2, “Managing and Monitoring Cisco Unified CCX”
Describes the management tools for managing UCCX and Cisco Unity. Provides information on product architecture
Chapter 3, “Cisco Unified CCX MIBs” Describes the function of all the MIBs in the UCCX and Cisco Unity products.
Chapter 4, “Cisco UCCX PerfMon and Alerts”
Lists the perfmon counters and alerts for UCCX and Cisco Unity.
Convention Description
boldface font Commands and keywords are in boldface.
italic font Arguments for which you supply values are in italics.
[ ] Elements in square brackets are optional.
{ x | y | z } Alternative keywords are grouped in braces and separated by vertical bars.
[ x | y | z ] Optional alternative keywords are grouped in brackets and separated by vertical bars.
string A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks.
screen font Terminal sessions and information the system displays are in screen font.
boldface
screen fontInformation you must enter is in boldface screen font.
viCisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Preface
Notes use the following conventions:
Note Means reader take note. Notes contain helpful suggestions or references to material not covered in the publication.
Timesavers use the following conventions:
Timesaver Means the described action saves time. You can save time by performing the action described in the paragraph.
Tips use the following conventions:
Tip Means the following are useful tips.
Obtaining Documentation and Submitting a Service RequestFor information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What’s New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
Subscribe to the What’s New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS Version 2.0.
Cisco Product Security Overview This product contains cryptographic features and is subject to United States and local country laws governing import, export, transfer and use. Delivery of Cisco cryptographic products does not imply third-party authority to import, export, distribute or use encryption. Importers, exporters, distributors and users are responsible for compliance with U.S. and local country laws. By using this product you agree to comply with applicable laws and regulations. If you are unable to comply with U.S. and local laws, return this product immediately.
italic screen font
Arguments for which you supply values are in italic screen font.
→ This pointer highlights an important line of text in an example.
^ The symbol ̂ represents the key labeled Control—for example, the key combination ^D in a screen display means hold down the Control key while you press the D key.
< > Nonprinting characters, such as passwords are in angle brackets.
Convention Description
viiCisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Preface
A summary of U.S. laws governing Cisco cryptographic products may be found at—http://www.cisco.com/wwl/export/crypto/tool/stqrg.html.
If you require further assistance please contact us by sending email to [email protected].
viiiCisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Cisco Unified Communications MIBs, SyslogsOL-19788-01
C H A P T E R 1
OverviewThis chapter gives a conceptual overview of Cisco Unified Communications Contact Center Express and Cisco Unity. It also includes some basic information about Simple Network Management Protocol (SNMP) including traps, Management Information Bases (MIBs), syslogs, and alerts/alarms. It contains the following sections:
• Cisco Unified Communications Contact Center Express, page 1-1
• About Cisco Unified CCX Architecture, page 1-2
• Cisco Unified CCX Management Architecture, page 1-3
• Simple Network Management Protocol, page 1-4
Cisco Unified Communications Contact Center ExpressA Cisco Unified CCX system contains the following components:
• Unified Gateway—Connects the Cisco Unified Communications family of products to the Public Switched Telephone Network (PSTN) and to other private telephone systems such as PBX.
• Unified CM Server—The Cisco Unified Communications Manager (Unified CM) provides the features required to implement IP phones, manage gateways, provide failover and redundancy service for the telephony system, and direct Voice over IP (VoIP) traffic to the Cisco Unified CCX system.
Note Cisco Unified Communications Manager was previously known as Cisco Unified CallManager. This guide uses Cisco Unified Communications Manager at the first occurrence and Unified CM for later occurrences.
• Unified CME interoperability—The Cisco Unified Communications Manager Express (Unified CME) provides interoperability between Unified CCX and Unified CME, call routing using SIP-based route point, keep alive session management, Support of Cisco Agent Desktop for use with Unified CME, and the ability to store the users locally in the Cisco Unified CCX database.
Note Cisco Unified Communications Manager Express was previously known as Cisco Unified CallManager Express. This guide uses Cisco Unified Communications Manager Express at the first occurrence and Unified CME for later occurrences.
1-1, and Alerts/Alarms for Managed Service Providers
Chapter 1 Overview About Cisco Unified CCX Architecture
• Cisco Unified CCX Configuration Datastore (CDS)—Manages configuration, component, and application information within the Cisco Unified CCX cluster and communicates with Unified CM (see About the Cisco Unified CCX Datastore, page 12-2).
• Cisco Unified CCX Server—Contains the Cisco Unified CCX Engine that runs applications, including Cisco script applications, Unified CM user integration, Unified CME interoperability, Cisco Unified Intelligent Contact Management Enterprise (Unified ICME) translation-routing and post-routing applications, Busy applications, Ring No Answer applications, and VXML 2.0 applications. You can position your Cisco Unified CCX application server anywhere on the IP network and administer your applications from a web browser on any computer on the IP network. Because Cisco Unified CCX uses an open architecture that supports industry standards, you can integrate your applications with a wide variety of technologies and products such as Enterprise databases and Cisco Unified Contact Center (Unified CCX) Agent Desktop.
Note If you are using Microsoft Internet Explorer Version 7.0, verify that the popup blocker is disabled.
• Cisco Unified CCX Editor—Allows application developers to use a simple graphical user interface (GUI) to create, modify, and debug Cisco Unified CCX scripts for automating customer interactions. Each script consists of a series of steps, implemented as Java Beans.
• Cisco Unified CCX Administration web interface—Provides access through a web browser for administrators to configure and manage Cisco Unified CCX Datastores, Servers and Applications.
• Cisco IP Agent and Supervisor Desktops —Desktop programs that allow Unified CCX agents and supervisors to log into the system, change agent states, and monitor status.
• Media Resource Control Protocol (MRCP) Automatic Speech Recognition (ASR) server—(Optional.) Dedicated server that performs real-time speech recognition.
• MRCP Text-to-Speech (TTS) server—(Optional.) Dedicated server that converts text into speech and plays it back to the caller.
• Unified CCX Call Statistics, Recording, and Monitoring Server—Dedicated server that maintains Unified CCX call statistics. It additionally provides recording and call monitoring for the Unified CCX Enhanced package.
• Unified CCX Call Monitoring Servers—Additional dedicated servers that provide for call monitoring.
• Historical Reports Database Server—Dedicated server that stores Cisco Unified CCX database for the following datastores: Configuration Datastore (CDS), Historical Datastore (HDS), Repository Datastore (RDS), and Agent Datastore (ADS).
Note Support for High Availability, remote servers, and expansion servers is only available in multiple-server deployments.
• Historical Reporting Client—The Unified CCX and Cisco Unified IP IVR (Unified IP IVR) applications can generate a variety of historical reports that provide detailed CCDR records, application performance, and traffic analysis information.
About Cisco Unified CCX ArchitectureThe components constituting Unified CCX are identified in the diagram below.
1-2Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 1 Overview Cisco Unified CCX Management Architecture
Figure 1-1 Cisco UCCX Architecture
The three important server processes are
• Engine
• Node Manager
• Application Administrator (three color codes).
The UCCX Engine is entrusted with supporting the UCCX features of IVR and Call Routing. It is built around Managers and SubSystems and gets help from various libraries, the desktop (CAD) server components and the Jtapi Client.
The Node Manager is entrusted with the task of starting and monitoring the services, restarting then if they fail. It also provides the basic infrastructure for high availability since it communicated with the NM component on other nodes. High Avialability in Dactyl UCCX is based on two node architecture.
The Application Administrator provides the interface to configure the system and other essential health monitoring interface for all the other components. There are a few client components like the Editor to design the business logic for contact center and the Cisco Agent/Supervisor Desktop components, Real Time Reporting (RTR) and Historical Reporting (HRC).
Unified CCX will support multiple MIBs at the product specific level and also by virtue of the underlying platform. Network Management tools like Cisco Works can send SNMP queries or receive traps to monitor the system function.
Cisco Unified CCX Management ArchitectureUnified CCX usally acts as the end application that is not used by any other application. Because of this, there has not been any need to configure this externally, as is typically the case for applications like Cisco Unified CM.
Unified CCX Client
Unified CCX Server
CAD uiCAD ui
CAD uiEDITOR
RTRHRC
Syslog
NODE
MANAGER
ENGINE
ApplicationAdministrator
LIBRARIES JTAPI Client
MANAGERS
SUB SYSTEMS CAD server
WINDOWS
2520
33
1-3Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 1 Overview Simple Network Management Protocol
The central price for configuring, managing and monitoring the UCCX installation is the Application Administrator web utility along with the Real Time Monitoring utility which is part of Cisco Unified CM.
UCCX also uses SNMP-based monitoring in the form of traps and Alarm messages (in line with those used with Cisoc Unified CM).
Figure 1-2 UCCX Management Architecture
For monitoring the health of the system Alarm traces are sent which can be directed to Syslog or SNMP traps. All Alarm traces of level 1 (Catastrophic) to 6 (Informational) can be individually treated to be sent to one or more interfaces (syslog, Cisco Works etc.)
Here it must be noted that the SNMP based interface is the only external interface for monitoring. Application Administration is not exposed to be used by any other entity. It is very much a part of the UCCX installation.
Simple Network Management ProtocolSimple Network Management Protocol (SNMP) is an application layer protocol that facilitates the exchange of management information among network devices, such as nodes and routers. It is part of the TCP/IP protocol suite. System administrators can remotely manage network performance, find and solve network problems, and plan for network growth by using SNMP.
Syslog
2520
34
SNMPTraps
UCCX
Request
Response
Data Base
Web Service
1-4Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 1 Overview Simple Network Management Protocol
Instead of defining a large set of commands, SNMP places all operations in a get-request, get-next-request, get-bulk-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.
Cisco Management Information Base (MIB) variables are accessible by using SNMP which facilitates the exchange of management information between network devices. The SNMP system consists of three parts—SNMP manager, SNMP agent, and MIB. You can compile the Cisco MIB with your network management software.
The NMS uses the Cisco 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.
The SNMP agent gathers data from the MIB, which is the repository for information about device parameters and network data. The SNMP agent also can send traps (notifications) of certain events, to the SNMP manager. The Cisco trap file, mib.traps, which documents the format of Cisco traps, is available on the Cisco host //ftp.cisco.com.
The SNMP manager uses information in the MIB to perform the operations described in Table 1-1.
SNMP MIBs are ASCII text files and contain a list of data objects. Every device in the network must be defined by a MIB or it does not exist in the SNMP network.
When an SNMP device transmits a message, the device is identified with a number string called an object identifier (OID). The OID contains specific characteristics of the managed device and can have one or more object variables.
MIBs convert the OIDs into text which is readable by administrators. The OID gives the organization type and name and other valuable information about each device. MIBs are important because they define available alerts (notifications) and traps and assist in troubleshooting.
To view MIB dependencies including obsolete objects, across Cisco Unified Communications Manager releases, go to the following link—http://tools.cisco.com/Support/SNMP/do/BrowseMIB.do?local=en&step=2&mibName=CISCO-CCM-CAPABILITY
Table 1-1 SNMP Manager Operations
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 table. With this operation, an SNMP manager does not need to know the exact variable name. A sequential search is performed to find the needed variable from within the MIB.
get-response The reply to a get-request, get-next-request, get-bulk-request, and set-request sent by an NMS.
get-bulk-request Similar to get-next-request, but fills the get-response with up to max-repetition number of get-next interactions.
set-request Store a value in a specific variable.
traps An unsolicited message sent by an SNMP agent to an SNMP manager indicating that some event has occurred.
1-5Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 1 Overview Simple Network Management Protocol
This section contains information on the following topics:
• SNMP Basics, page 1-6
• SNMP version 1 Support, page 1-7
• SNMP version 2c Support, page 1-7
• SNMP version 3 Support, page 1-7
• SNMP Services, page 1-7
• SNMP Community Strings and Users, page 1-8
Note SNMP must also be enabled on network devices to allow network management applications such as Unified OM, Cisco Monitor Manager, and Cisco Monitor Director to get information on network devices at configured polling intervals and to receive alerts and faults via trap notification sent by the managed devices.
SNMP BasicsA network that uses SNMP requires three key components—managed devices, agents, and network management software (NMS).
• Managed device—Devices that contain SNMP agents and reside on a managed network. Managed devices collect and store management information and make it available by using SNMP.
The first node in the Cisco UCM cluster acts as the managed device. In Cisco UCMBE, the server on which Cisco UCM is installed acts as the managed device.
• Agent—Software modules that reside on managed devices. An agent contains local knowledge of management information and translates it into a form that is compatible with SNMP.
– Cisco Unified Communications Manager uses a master agent and subagent components to support SNMP. The master agent acts as the agent protocol engine and performs the authentication, authorization, access control, and privacy functions that relate to SNMP requests. It contains a few Management Information Base (MIB) variables that relate to MIB-II. The master agent also connects and disconnects subagents after the subagent completes necessary tasks.
The SNMP master agent listens on port 161 and forwards SNMP packets for vendor MIBs.
– The Cisco Unified Communications Manager subagent interacts with the local Cisco Unified Communications Manager only. The Cisco Unified Communications Manager subagents send trap and information messages to the SNMP Master Agent, and the SNMP Master Agent communicates with the SNMP trap receiver (notification destination).
• NMS—SNMP management application that runs on a PC and provides the bulk of the processing and memory resources that are required for network management. It executes applications that monitor and control managed devices. Cisco Unified Communications Manager works with the following NMS:
– CiscoWorks2000
– HP OpenView
– Third-party applications that support SNMP and Cisco Unified Communications Manager SNMP interfaces
1-6Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 1 Overview Simple Network Management Protocol
SNMP version 1 SupportSNMP version 1 (SNMPv1), the initial implementation of SNMP that functions within the specifications of the Structure of Management Information (SMI), operates over protocols, such as User Datagram Protocol (UDP) and IP.
The SNMPv1 SMI defines highly structured MIB tables that are used to group objects that contain multiple variables. Tables contain zero or more rows, which are indexed, so SNMP can retrieve or alter an entire row with a supported command.
With SNMPv1, the NMS issues a request, and managed devices return responses. Agents use the Trap operation to asynchronously inform the NMS of a significant event.
SNMP version 2c SupportAs with SNMPv1, SNMPv2c functions within the specifications of SMI. MIB modules contain definitions of interrelated managed objects. The operations that are used in SNMPv1 are similar to those that are used in SNMPv2. The SNMPv2 trap operation, for example, serves the same function as that used in SNMPv1, but it uses a different message format and replaces the SNMPv1 trap.
The Inform operation in SNMPv2c enables one NMS to send trap information to another NMS and to receive a response from the NMS.
SNMP version 3 SupportSNMP version 3 (SNMPv3) provides security features such as the following:
• Authentication—Verifying that the request comes from a genuine source.
• Privacy—Encrypting data.
• Authorization—Verifying that the user allows the requested operation.
• Access control—Verifying that the user has access to the objects requested.
SNMPv3 prevents packets from being exposed on the network. Instead of using community strings like SNMP v1 and v2, SNMP v3 uses SNMP users, as described in the “SNMP Community Strings and Users” section on page 1-8.
SNMP ServicesTo support SNMP, you must use the following services:
• Cisco UCM SNMP service
• SNMP Master Agent
• MIB2 Agent
• Host Resources Agent
• System Application Agent
• Native Agent Adaptor
• Cisco CDP Agent
• Cisco Syslog Agent
1-7Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 1 Overview Simple Network Management Protocol
For more information, refer to the Cisco Unified Serviceability Administration Guide, Release 7.0(1).
SNMP Community Strings and UsersAlthough SNMP community strings provide no security, the strings authenticate access to MIB objects and function as embedded passwords. You configure SNMP community strings for SNMP v1 and v2c only.
SNMP v3 does not use community strings. It uses SNMP users that serve the same purpose as community strings, but provide security because encryption or authentication is configured.
No default community string or user exists.
SNMP Traps and InformsAn SNMP agent sends notifications in the form of traps or informs to identify important system events. Traps do not receive acknowledgments from the destination whereas informs do receive acknowledgments.
Note Cisco Unified Communications Manager supports SNMP traps in Cisco Unified Communications Manager and Cisco Unified Communications Manager Business Edition systems. Cisco Unity Connection SNMP does not support traps.
For all notifications, the system sends traps immediately if the corresponding trap flags are enabled. In the case of the syslog agent, the Cisco UCM alarms and system level log messages get sent to syslog daemon for logging. Also, some standard third-party applications send the log messages to syslog daemon for logging. These log messages get logged locally in the syslog files and also get converted into SNMP traps/notifications.
The following list contains Cisco UCM SNMP trap and inform messages that are sent to a configured trap destination:
• Cisco UCM failed
• Phone failed
• Phones status update
• Gateway failed
• Media resource list exhausted
• Route list exhausted
• Gateway layer 2 change
• Quality report
• Malicious call
• Syslog message generated
1-8Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 1 Overview Management Information Base
Tip Before you configure notification destination, verify that the required SNMP services are activated and running. Also, make sure that you configured the privileges for the community string/user correctly. You configure the SNMP trap destination by choosing SNMP > V1/V2 > Notification Destination or SNMP > V3> Notification Destination in Cisco UCM, Serviceability Administration.
SNMP Trace ConfigurationFor Cisco CDP Agent and Cisco Syslog Agent, you use the CLI to change trace settings, as described in the Command Line Interface Reference Guide for Cisco Unified Solutions for Release 7.0(1).
Management Information BaseManagement Information Bases (MIBs) convert object identifiers (OIDs) that are numerical strings into an ASCII text file. The OIDs identify data objects in a hierarchy. The OID represents specific characteristics of a device or application and can have one or more object instances (variables). Managed objects, alarms, notifications, and other valuable information are identified by the OID and listed in the MIB.
The OID is logically represented in a tree hierarchy. The root of the tree is unnamed and splits into three main branches—Consultative Committee for International Telegraph and Telephone (CCITT), International Organization for Standardization (ISO), and joint ISO/CCITT.
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 MIB variable authAddr is an object name and is denoted by number 5, which is listed at the end of its OID of 1.3.6.1.4.1.9.2.1.5.
The OID in the Internet MIB hierarchy 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 OID 1.3.6.1.2.1. It also can be expressed as iso.org.dod.internet.mgmt.mib.
The Cisco MIB set is a collection 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.
Cisco Unified CCX and Cisco Unity support the following MIBs:
• CISCO-UNITY-MIB
• CISCO-CDP-MIB
• CISCO-SYSLOG-MIB
• HOST-RESOURCES-MIB
• MIB-II
• SYSAPPL-MIB
• Vendor-specific MIBs
For descriptions of the supported MIBs, see:
• Chapter 3, “Cisco Unified CCX MIBs”
1-9Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 1 Overview Management Information Base
1-10Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Cisco Unified Communications MIBs, SyslogsOL-19788-01
C H A P T E R 2
Managing and Monitoring Cisco Unified CCXThis chapter describes the tools available for managing and monitoring Cisco Unifed CCX and Cisco Unity. For Cisco Unifed CCX, montitoring is done primarily with the Windows performance monitoring tool.
For Cisco Unity, the following tools are available:
• Unity Advanced Settings Tool—This tool allows you to safely edit many of the “hidden registry settings” that commonly need to be modified. These are items that are not on the SA interface and require users to add/edit keys to the registry.
• Alternative Directory Handler Prompts—This is a zip file containing different wording on the prompts that outside callers hear when they go to find a subscriber by spelling their name in the directory handler.
• AudioStat utility—This tool allows audio driver statistics to be viewed in real time. The information provided by AudioStat can help isolate audio quality issues due to packet delay and codec-related problems.
Caution Cisco recommends using this tool only with Cisco TAC supervision.
• Bridge Analog Network And Node Analyzer (BANANA)—BANANA is a stand-alone application that runs on the Cisco Unity Bridge server. It is designed to assist with monitoring and troubleshooting of analog communication between the Bridge and other Octel nodes in the analog network. It also provides detail and summary information of call activity. BANANA contains an administration application called the BANANA admin that allows you to control how BANANA:
– Extracts information from the call traces on the Bridge server and presents different views of the data.
– Monitors the call logs for error conditions and logs warnings or errors to the Windows Event Viewer.
– Generates test calls to any of the Octel systems that are networked with the Bridge server.
With the BANANA admin, you can also install and configure the BANANA service to do any or all of the above tasks at configurable intervals.
• Cisco Unity Bridge Bulk Node Utility (CUBBNUT)—This utility allows a Cisco Bridge administrator to add, change or delete Unity and Octel nodes via a .csv file.
• BulkEdit Utility—The BulkEdit Utility is designed to allow you to select large numbers of call handlers or subscribers and make changes to them in bulk quickly and easily. Nearly every value you can see and edit via the SA is available to change en mass using BulkEdit as well as a few items not visible in the SA
2-1, and Alerts/Alarms for Managed Service Providers
REVIEW DRAFT—CISCO CONF IDENT IAL
Chapter 2 Managing and Monitoring Cisco Unified CCX Cisco Unity Reporting
• Bulk Subscriber Delete tool—This is a wizard tool that allows you to delete large numbers of subscribers from Unity. For example, installations at schools and universities where there is a large number of users that “turn over” at the end of the year. Removing subscribers from Unity one at a time through the SA is time consuming and tedious and it also leaves the user’s directory and messaging accounts in AD and Exchange which may or may not be desirable.
This tool give you the option of only removing the subscriber information from Unity or removing the directory and messaging accounts for selected users entirely. You can choose subscribers based on their Class of Service membership, extension range, switch association, mailstore association, location assignment (for remote users), node ID (for Bridge users) or you can import them from a custom CSV file.
• Directory Walker—This utility walks the directory and makes the checks on all call handler, subscriber, subscriber template, interview handler, locations and directory handler objects in the database. If there's a problem the string "(error)" will appear in red in the output HTML. Warning strings in yellow that start with "(warning) are also logged for items that you should check on but are not necessarily problems. If an item is automatically fixed, a string that starts with "(fixed) will be logged in green directly under the error to indicate what was done.
• Subscriber Information Dump utility—This utility allows you to quickly dump out specific information about the subscribers in their system to a file they can be viewed or imported into another application such as a database utility or Excel. The file generated automatically creates a header row that lists the data type found in that column of the output for ease of import into other programs. This tool includes both full subscribers (Exchange and Domino) as well as “remote subscribers” (AMIS, VPIM, Bridge, SMTP).
Cisco Unity ReportingThe following tools provide reporting capabilites for Cisco Unity
• Bridge Traffic Analyzer - The Bridge Traffic Analyzer is a tool that allows administrators to obtain traffic data on their Cisco Bridge units to determine:
– total size of messages sent
– number of messages sent
– which servers messages have come from or gone to
– how long it takes for messages to arrive at their destinations
– how many analog ports are in use for message transport
– · How many failures were there sending and receiving messages between various nodes
This tool allows you to generate the following reports:
– Port Availability Report
– Message Queue Activity Report
– Message Latency Report
– Node Message Traffic Report
– Non-delivery Notifications Report
Authentication validates the user ID and password that are submitted during log in. An alarm gets raised when an invalid user ID and/or the password gets used.
2-2Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
REVIEW DRAFT—CISCO CONF IDENT IAL
Chapter 2 Managing and Monitoring Cisco Unified CCX Cisco Unity Reporting
2-3Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
REVIEW DRAFT—CISCO CONF IDENT IAL
Chapter 2 Managing and Monitoring Cisco Unified CCX Cisco Unity Reporting
2-4Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Cisco Unified Communications MIBs, SyslogsOL-19788-01
C H A P T E R 3
Cisco Unified CCX MIBsThis chapter describes the Management Information Base (MIB) that are supported by Cisco Unified Contact Center Express. These MIBs are used with Simple Network Management Protocol (SNMP). It contains the following sections:
• UCCX Base Level MIB Support, page 3-1
• UCCX Monitoring and Fault Management, page 3-107
UCCX Base Level MIB SupportThis section contains the base level MIBs that apply to UCCX. Base level MIBs are those that are supported by all Unified Communication products in order to provide for a level of commonality among products. For each MIB listed in the subsections, it is important for the product teams to evaluate if the MIB is supported (all or partial). If the MIB is not currently supported, the product team needs to consider supporting it in a future release.
SNMP Master AgentThe SNMP Master Agent is an entity or process on a server that exchanges messages with a SNMP Management station such as Cisco’s Unified Operations Manager. It acts as a primary interface between the management station and the various subagents. Inbound requests are received by the Master Agent and forwarded to the appropriate subagent. It also generates the SNMP Trap on receiving a Trap Event from any subagent.
The Master Agent listens for polls on port 161 (gets/sets) and by default, sends traps to the Network Management Station on port 162. The trap port can be set to a different value while specifying the trap destination IP address via the serviceability web interface. These are all UDP by default, although, SNMP v2c and v3 can use TCP. It is important for all Unified Communication products to support SNMP v1, v2c, and v3.
Base Level SNMP SubagentsThe SNMP Subagents are processes that provide access to the application instrumentation within the server. The Subagents do not interact with the management station directly. Each Subagent responds to the ‘get’ and ‘set’ requests forwarded to them by the SNMP Master Agent.
3-1, and Alerts/Alarms for Managed Service Providers
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
Platform MIB SubagentPlatform MIB/Subagent is provided by the hardware vendor – in case of the Cisco MCS platform, HP or IBM. This subagent provides instrumentation for low-level attributes of the specific hardware.
For IBM hardware platforms, the following MIBs are supported:
IBM-SYSTEM-AGENT-MIB
IBM-SYSTEM-ASSETID-MIB
IBM-SYSTEM-HEALTH-MIB
IBM-SYSTEM-LMSENSOR-MIB
IBM-SYSTEM-MEMORY-MIB
IBM-SYSTEM-MIB
IBM-SYSTEM-NETWORK-MIB
IBM-SYSTEM-POWER-MIB
IBM-SYSTEM-PROCESSOR-MIB
IBM-SYSTEM-RAID-MIB
IBM-SYSTEM-TRAP-MIB
For HP hardware platforms, the following MIBs are supported:
CPQHLTH
CPQHOST
CPQNIC
CPQSINFO
CPQSTDEQ
CPQTHRSH
CPQSM2
CPQIDE
CPQIDA
CPQSTSYS
CPQSCSI
UCCX is built on Cisco bundled Windows. Hence all vendors specific MIBs are available due to the platform. UCCX code does not add to that.
All the above MIBs are supported by the respective hardware platforms (in conjunction with UCOS), hence these will be available by default. You can refer to platform documentation for better description of the MIBs and the extent of support.
3-2Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
Host Resources MIB SubagentThe Host Resources MIB is an implementation of RFC-2790. The Host Resources MIB is a standard MIB which instruments attributes common to all hosts, including but not limited to Linux-based servers. Thus, the attributes defined are independent of the operating system, network services or software applications. The instrumentation is focused on host memory, processor(s), storage devices, run-time system data, and software running on the host.
Host Resources MIB will be supported at the platform level. UCCX uses the Host-Resources MIB subagent implementation as provided by the platform without any modifications.
HOST-RESOURCES-MIB
HOST-RESOURCES-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY, OBJECT-TYPE, mib-2,
Integer32, Counter32, Gauge32, TimeTicks FROM SNMPv2-SMI
TEXTUAL-CONVENTION, DisplayString,
TruthValue, DateAndTime, AutonomousType FROM SNMPv2-TC
MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF
InterfaceIndexOrZero FROM IF-MIB;
hostResourcesMibModule MODULE-IDENTITY
LAST-UPDATED "200003060000Z" -- 6 March 2000
ORGANIZATION "IETF Host Resources MIB Working Group"
CONTACT-INFO
"Steve Waldbusser
Postal: Lucent Technologies, Inc.
1213 Innsbruck Dr.
Sunnyvale, CA 94089
USA
Phone: 650-318-1251
Fax: 650-318-1633
Email: [email protected]
In addition, the Host Resources MIB mailing list is
dedicated to discussion of this MIB. To join the
3-3Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
mailing list, send a request message to
[email protected]. The mailing list
address is [email protected]."
DESCRIPTION
"This MIB is for use in managing host systems. The term
`host' is construed to mean any computer that communicates
with other similar computers attached to the internet and
that is directly used by one or more human beings. Although
this MIB does not necessarily apply to devices whose primary
function is communications services (e.g., terminal servers,
routers, bridges, monitoring equipment), such relevance is
not explicitly precluded. This MIB instruments attributes
common to all internet hosts including, for example, both
personal computers and systems that run variants of Unix."
REVISION "200003060000Z" -- 6 March 2000
DESCRIPTION
"Clarifications and bug fixes based on implementation
experience. This revision was also reformatted in the SMIv2
format. The revisions made were:
New RFC document standards:
Added Copyright notice, updated introduction to SNMP
Framework, updated references section, added reference to
RFC 2119, and added a meaningful Security Considerations
section.
New IANA considerations section for registration of new types
Conversion to new SMIv2 syntax for the following types and
macros:
Counter32, Integer32, Gauge32, MODULE-IDENTITY,
OBJECT-TYPE, TEXTUAL-CONVENTION, OBJECT-IDENTITY,
MODULE-COMPLIANCE, OBJECT-GROUP
Used new Textual Conventions:
TruthValue, DateAndTime, AutonomousType,
InterfaceIndexOrZero
3-4Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
Fixed typo in hrPrinterStatus.
Added missing error bits to hrPrinterDetectedErrorState and
clarified confusion resulting from suggested mappings to
hrPrinterStatus.
Clarified that size of objects of type
InternationalDisplayString is number of octets, not number
of encoded symbols.
Clarified the use of the following objects based on
implementation experience:
hrSystemInitialLoadDevice, hrSystemInitialLoadParameters,
hrMemorySize, hrStorageSize, hrStorageAllocationFailures,
hrDeviceErrors, hrProcessorLoad, hrNetworkIfIndex,
hrDiskStorageCapacity, hrSWRunStatus, hrSWRunPerfCPU,
and hrSWInstalledDate.
Clarified implementation technique for hrSWInstalledTable.
Used new AUGMENTS clause for hrSWRunPerfTable.
Added Internationalization Considerations section.
This revision published as RFC2790."
REVISION "9910202200Z" -- 20 October, 1999
DESCRIPTION
"The original version of this MIB, published as
RFC1514."
::= { hrMIBAdminInfo 1 }
host OBJECT IDENTIFIER ::= { mib-2 25 }
hrSystem OBJECT IDENTIFIER ::= { host 1 }
hrStorage OBJECT IDENTIFIER ::= { host 2 }
hrDevice OBJECT IDENTIFIER ::= { host 3 }
3-5Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
hrSWRun OBJECT IDENTIFIER ::= { host 4 }
hrSWRunPerf OBJECT IDENTIFIER ::= { host 5 }
hrSWInstalled OBJECT IDENTIFIER ::= { host 6 }
hrMIBAdminInfo OBJECT IDENTIFIER ::= { host 7 }
-- textual conventions
KBytes ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Storage size, expressed in units of 1024 bytes."
SYNTAX Integer32 (0..2147483647)
ProductID ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This textual convention is intended to identify the
manufacturer, model, and version of a specific
hardware or software product. It is suggested that
these OBJECT IDENTIFIERs are allocated such that all
products from a particular manufacturer are registered
under a subtree distinct to that manufacturer. In
addition, all versions of a product should be
registered under a subtree distinct to that product.
With this strategy, a management station may uniquely
determine the manufacturer and/or model of a product
whose productID is unknown to the management station.
Objects of this type may be useful for inventory
purposes or for automatically detecting
incompatibilities or version mismatches between
various hardware and software components on a system.
For example, the product ID for the ACME 4860 66MHz
clock doubled processor might be:
enterprises.acme.acmeProcessors.a4860DX2.MHz66
A software product might be registered as:
3-6Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
enterprises.acme.acmeOperatingSystems.acmeDOS.six(6).one(1)
"
SYNTAX OBJECT IDENTIFIER
-- unknownProduct will be used for any unknown ProductID
-- unknownProduct OBJECT IDENTIFIER ::= { 0 0 }
InternationalDisplayString ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This data type is used to model textual information
in some character set. A network management station
should use a local algorithm to determine which
character set is in use and how it should be
displayed. Note that this character set may be
encoded with more than one octet per symbol, but will
most often be NVT ASCII. When a size clause is
specified for an object of this type, the size refers
to the length in octets, not the number of symbols."
SYNTAX OCTET STRING
-- The Host Resources System Group
hrSystemUptime OBJECT-TYPE
SYNTAX TimeTicks
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The amount of time since this host was last
initialized. Note that this is different from
sysUpTime in the SNMPv2-MIB [RFC1907] because
sysUpTime is the uptime of the network management
portion of the system."
::= { hrSystem 1 }
hrSystemDate OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-write
3-7Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
STATUS current
DESCRIPTION
"The host's notion of the local date and time of day."
::= { hrSystem 2 }
hrSystemInitialLoadDevice OBJECT-TYPE
SYNTAX Integer32 (1..2147483647)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The index of the hrDeviceEntry for the device from
which this host is configured to load its initial
operating system configuration (i.e., which operating
system code and/or boot parameters).
Note that writing to this object just changes the
configuration that will be used the next time the
operating system is loaded and does not actually cause
the reload to occur."
::= { hrSystem 3 }
hrSystemInitialLoadParameters OBJECT-TYPE
SYNTAX InternationalDisplayString (SIZE (0..128))
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object contains the parameters (e.g. a pathname
and parameter) supplied to the load device when
requesting the initial operating system configuration
from that device.
Note that writing to this object just changes the
configuration that will be used the next time the
operating system is loaded and does not actually cause
the reload to occur."
::= { hrSystem 4 }
hrSystemNumUsers OBJECT-TYPE
3-8Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
SYNTAX Gauge32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of user sessions for which this host is
storing state information. A session is a collection
of processes requiring a single act of user
authentication and possibly subject to collective job
control."
::= { hrSystem 5 }
hrSystemProcesses OBJECT-TYPE
SYNTAX Gauge32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of process contexts currently loaded or
running on this system."
::= { hrSystem 6 }
hrSystemMaxProcesses OBJECT-TYPE
SYNTAX Integer32 (0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The maximum number of process contexts this system
can support. If there is no fixed maximum, the value
should be zero. On systems that have a fixed maximum,
this object can help diagnose failures that occur when
this maximum is reached."
::= { hrSystem 7 }
-- The Host Resources Storage Group
-- Registration point for storage types, for use with hrStorageType.
-- These are defined in the HOST-RESOURCES-TYPES module.
hrStorageTypes OBJECT IDENTIFIER ::= { hrStorage 1 }
3-9Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
hrMemorySize OBJECT-TYPE
SYNTAX KBytes
UNITS "KBytes"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The amount of physical read-write main memory,
typically RAM, contained by the host."
::= { hrStorage 2 }
hrStorageTable OBJECT-TYPE
SYNTAX SEQUENCE OF HrStorageEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The (conceptual) table of logical storage areas on
the host.
An entry shall be placed in the storage table for each
logical area of storage that is allocated and has
fixed resource limits. The amount of storage
represented in an entity is the amount actually usable
by the requesting entity, and excludes loss due to
formatting or file system reference information.
These entries are associated with logical storage
areas, as might be seen by an application, rather than
physical storage entities which are typically seen by
an operating system. Storage such as tapes and
floppies without file systems on them are typically
not allocated in chunks by the operating system to
requesting applications, and therefore shouldn't
appear in this table. Examples of valid storage for
this table include disk partitions, file systems, ram
(for some architectures this is further segmented into
regular memory, extended memory, and so on), backing
store for virtual memory (`swap space').
3-10Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
This table is intended to be a useful diagnostic for
`out of memory' and `out of buffers' types of
failures. In addition, it can be a useful performance
monitoring tool for tracking memory, disk, or buffer
usage."
::= { hrStorage 3 }
hrStorageEntry OBJECT-TYPE
SYNTAX HrStorageEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A (conceptual) entry for one logical storage area on
the host. As an example, an instance of the
hrStorageType object might be named hrStorageType.3"
INDEX { hrStorageIndex }
::= { hrStorageTable 1 }
HrStorageEntry ::= SEQUENCE {
hrStorageIndex Integer32,
hrStorageType AutonomousType,
hrStorageDescr DisplayString,
hrStorageAllocationUnits Integer32,
hrStorageSize Integer32,
hrStorageUsed Integer32,
hrStorageAllocationFailures Counter32
}
hrStorageIndex OBJECT-TYPE
SYNTAX Integer32 (1..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A unique value for each logical storage area
contained by the host."
::= { hrStorageEntry 1 }
hrStorageType OBJECT-TYPE
3-11Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
SYNTAX AutonomousType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The type of storage represented by this entry."
::= { hrStorageEntry 2 }
hrStorageDescr OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A description of the type and instance of the storage
described by this entry."
::= { hrStorageEntry 3 }
hrStorageAllocationUnits OBJECT-TYPE
SYNTAX Integer32 (1..2147483647)
UNITS "Bytes"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The size, in bytes, of the data objects allocated
from this pool. If this entry is monitoring sectors,
blocks, buffers, or packets, for example, this number
will commonly be greater than one. Otherwise this
number will typically be one."
::= { hrStorageEntry 4 }
hrStorageSize OBJECT-TYPE
SYNTAX Integer32 (0..2147483647)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The size of the storage represented by this entry, in
units of hrStorageAllocationUnits. This object is
writable to allow remote configuration of the size of
the storage area in those cases where such an
3-12Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
operation makes sense and is possible on the
underlying system. For example, the amount of main
memory allocated to a buffer pool might be modified or
the amount of disk space allocated to virtual memory
might be modified."
::= { hrStorageEntry 5 }
hrStorageUsed OBJECT-TYPE
SYNTAX Integer32 (0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The amount of the storage represented by this entry
that is allocated, in units of
hrStorageAllocationUnits."
::= { hrStorageEntry 6 }
hrStorageAllocationFailures OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of requests for storage represented by
this entry that could not be honored due to not enough
storage. It should be noted that as this object has a
SYNTAX of Counter32, that it does not have a defined
initial value. However, it is recommended that this
object be initialized to zero, even though management
stations must not depend on such an initialization."
::= { hrStorageEntry 7 }
-- The Host Resources Device Group
--
-- The device group is useful for identifying and diagnosing the
-- devices on a system. The hrDeviceTable contains common
-- information for any type of device. In addition, some devices
-- have device-specific tables for more detailed information. More
-- such tables may be defined in the future for other device types.
3-13Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
-- Registration point for device types, for use with hrDeviceType.
-- These are defined in the HOST-RESOURCES-TYPES module.
hrDeviceTypes OBJECT IDENTIFIER ::= { hrDevice 1 }
hrDeviceTable OBJECT-TYPE
SYNTAX SEQUENCE OF HrDeviceEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The (conceptual) table of devices contained by the
host."
::= { hrDevice 2 }
hrDeviceEntry OBJECT-TYPE
SYNTAX HrDeviceEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A (conceptual) entry for one device contained by the
host. As an example, an instance of the hrDeviceType
object might be named hrDeviceType.3"
INDEX { hrDeviceIndex }
::= { hrDeviceTable 1 }
HrDeviceEntry ::= SEQUENCE {
hrDeviceIndex Integer32,
hrDeviceType AutonomousType,
hrDeviceDescr DisplayString,
hrDeviceID ProductID,
hrDeviceStatus INTEGER,
hrDeviceErrors Counter32
}
hrDeviceIndex OBJECT-TYPE
SYNTAX Integer32 (1..2147483647)
MAX-ACCESS read-only
3-14Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
STATUS current
DESCRIPTION
"A unique value for each device contained by the host.
The value for each device must remain constant at
least from one re-initialization of the agent to the
next re-initialization."
::= { hrDeviceEntry 1 }
hrDeviceType OBJECT-TYPE
SYNTAX AutonomousType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"An indication of the type of device.
If this value is
`hrDeviceProcessor { hrDeviceTypes 3 }' then an entry
exists in the hrProcessorTable which corresponds to
this device.
If this value is
`hrDeviceNetwork { hrDeviceTypes 4 }', then an entry
exists in the hrNetworkTable which corresponds to this
device.
If this value is
`hrDevicePrinter { hrDeviceTypes 5 }', then an entry
exists in the hrPrinterTable which corresponds to this
device.
If this value is
`hrDeviceDiskStorage { hrDeviceTypes 6 }', then an
entry exists in the hrDiskStorageTable which
corresponds to this device."
::= { hrDeviceEntry 2 }
hrDeviceDescr OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..64))
3-15Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A textual description of this device, including the
device's manufacturer and revision, and optionally,
its serial number."
::= { hrDeviceEntry 3 }
hrDeviceID OBJECT-TYPE
SYNTAX ProductID
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The product ID for this device."
::= { hrDeviceEntry 4 }
hrDeviceStatus OBJECT-TYPE
SYNTAX INTEGER {
unknown(1),
running(2),
warning(3),
testing(4),
down(5)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The current operational state of the device described
by this row of the table. A value unknown(1)
indicates that the current state of the device is
unknown. running(2) indicates that the device is up
and running and that no unusual error conditions are
known. The warning(3) state indicates that agent has
been informed of an unusual error condition by the
operational software (e.g., a disk device driver) but
that the device is still 'operational'. An example
would be a high number of soft errors on a disk. A
3-16Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
value of testing(4), indicates that the device is not
available for use because it is in the testing state.
The state of down(5) is used only when the agent has
been informed that the device is not available for any
use."
::= { hrDeviceEntry 5 }
hrDeviceErrors OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of errors detected on this device. It
should be noted that as this object has a SYNTAX of
Counter32, that it does not have a defined initial
value. However, it is recommended that this object be
initialized to zero, even though management stations
must not depend on such an initialization."
::= { hrDeviceEntry 6 }
hrProcessorTable OBJECT-TYPE
SYNTAX SEQUENCE OF HrProcessorEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The (conceptual) table of processors contained by the
host.
Note that this table is potentially sparse: a
(conceptual) entry exists only if the correspondent
value of the hrDeviceType object is
`hrDeviceProcessor'."
::= { hrDevice 3 }
hrProcessorEntry OBJECT-TYPE
SYNTAX HrProcessorEntry
MAX-ACCESS not-accessible
STATUS current
3-17Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
DESCRIPTION
"A (conceptual) entry for one processor contained by
the host. The hrDeviceIndex in the index represents
the entry in the hrDeviceTable that corresponds to the
hrProcessorEntry.
As an example of how objects in this table are named,
an instance of the hrProcessorFrwID object might be
named hrProcessorFrwID.3"
INDEX { hrDeviceIndex }
::= { hrProcessorTable 1 }
HrProcessorEntry ::= SEQUENCE {
hrProcessorFrwID ProductID,
hrProcessorLoad Integer32
}
hrProcessorFrwID OBJECT-TYPE
SYNTAX ProductID
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The product ID of the firmware associated with the
processor."
::= { hrProcessorEntry 1 }
hrProcessorLoad OBJECT-TYPE
SYNTAX Integer32 (0..100)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The average, over the last minute, of the percentage
of time that this processor was not idle.
Implementations may approximate this one minute
smoothing period if necessary."
::= { hrProcessorEntry 2 }
hrNetworkTable OBJECT-TYPE
3-18Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
SYNTAX SEQUENCE OF HrNetworkEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The (conceptual) table of network devices contained
by the host.
Note that this table is potentially sparse: a
(conceptual) entry exists only if the correspondent
value of the hrDeviceType object is
`hrDeviceNetwork'."
::= { hrDevice 4 }
hrNetworkEntry OBJECT-TYPE
SYNTAX HrNetworkEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A (conceptual) entry for one network device contained
by the host. The hrDeviceIndex in the index
represents the entry in the hrDeviceTable that
corresponds to the hrNetworkEntry.
As an example of how objects in this table are named,
an instance of the hrNetworkIfIndex object might be
named hrNetworkIfIndex.3"
INDEX { hrDeviceIndex }
::= { hrNetworkTable 1 }
HrNetworkEntry ::= SEQUENCE {
hrNetworkIfIndex InterfaceIndexOrZero
}
hrNetworkIfIndex OBJECT-TYPE
SYNTAX InterfaceIndexOrZero
MAX-ACCESS read-only
STATUS current
DESCRIPTION
3-19Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
"The value of ifIndex which corresponds to this
network device. If this device is not represented in
the ifTable, then this value shall be zero."
::= { hrNetworkEntry 1 }
hrPrinterTable OBJECT-TYPE
SYNTAX SEQUENCE OF HrPrinterEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The (conceptual) table of printers local to the host.
Note that this table is potentially sparse: a
(conceptual) entry exists only if the correspondent
value of the hrDeviceType object is
`hrDevicePrinter'."
::= { hrDevice 5 }
hrPrinterEntry OBJECT-TYPE
SYNTAX HrPrinterEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A (conceptual) entry for one printer local to the
host. The hrDeviceIndex in the index represents the
entry in the hrDeviceTable that corresponds to the
hrPrinterEntry.
As an example of how objects in this table are named,
an instance of the hrPrinterStatus object might be
named hrPrinterStatus.3"
INDEX { hrDeviceIndex }
::= { hrPrinterTable 1 }
HrPrinterEntry ::= SEQUENCE {
hrPrinterStatus INTEGER,
hrPrinterDetectedErrorState OCTET STRING
}
3-20Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
hrPrinterStatus OBJECT-TYPE
SYNTAX INTEGER {
other(1),
unknown(2),
idle(3),
printing(4),
warmup(5)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The current status of this printer device."
::= { hrPrinterEntry 1 }
hrPrinterDetectedErrorState OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object represents any error conditions detected
by the printer. The error conditions are encoded as
bits in an octet string, with the following
definitions:
Condition Bit #
lowPaper 0
noPaper 1
lowToner 2
noToner 3
doorOpen 4
jammed 5
offline 6
serviceRequested 7
inputTrayMissing 8
outputTrayMissing 9
3-21Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
markerSupplyMissing 10
outputNearFull 11
outputFull 12
inputTrayEmpty 13
overduePreventMaint 14
Bits are numbered starting with the most significant
bit of the first byte being bit 0, the least
significant bit of the first byte being bit 7, the
most significant bit of the second byte being bit 8,
and so on. A one bit encodes that the condition was
detected, while a zero bit encodes that the condition
was not detected.
This object is useful for alerting an operator to
specific warning or error conditions that may occur,
especially those requiring human intervention."
::= { hrPrinterEntry 2 }
hrDiskStorageTable OBJECT-TYPE
SYNTAX SEQUENCE OF HrDiskStorageEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The (conceptual) table of long-term storage devices
contained by the host. In particular, disk devices
accessed remotely over a network are not included
here.
Note that this table is potentially sparse: a
(conceptual) entry exists only if the correspondent
value of the hrDeviceType object is
`hrDeviceDiskStorage'."
::= { hrDevice 6 }
hrDiskStorageEntry OBJECT-TYPE
SYNTAX HrDiskStorageEntry
MAX-ACCESS not-accessible
3-22Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
STATUS current
DESCRIPTION
"A (conceptual) entry for one long-term storage device
contained by the host. The hrDeviceIndex in the index
represents the entry in the hrDeviceTable that
corresponds to the hrDiskStorageEntry. As an example,
an instance of the hrDiskStorageCapacity object might
be named hrDiskStorageCapacity.3"
INDEX { hrDeviceIndex }
::= { hrDiskStorageTable 1 }
HrDiskStorageEntry ::= SEQUENCE {
hrDiskStorageAccess INTEGER,
hrDiskStorageMedia INTEGER,
hrDiskStorageRemoveble TruthValue,
hrDiskStorageCapacity KBytes
}
hrDiskStorageAccess OBJECT-TYPE
SYNTAX INTEGER {
readWrite(1),
readOnly(2)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"An indication if this long-term storage device is
readable and writable or only readable. This should
reflect the media type, any write-protect mechanism,
and any device configuration that affects the entire
device."
::= { hrDiskStorageEntry 1 }
hrDiskStorageMedia OBJECT-TYPE
SYNTAX INTEGER {
other(1),
unknown(2),
hardDisk(3),
3-23Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
floppyDisk(4),
opticalDiskROM(5),
opticalDiskWORM(6), -- Write Once Read Many
opticalDiskRW(7),
ramDisk(8)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"An indication of the type of media used in this long-
term storage device."
::= { hrDiskStorageEntry 2 }
hrDiskStorageRemoveble OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Denotes whether or not the disk media may be removed
from the drive."
::= { hrDiskStorageEntry 3 }
hrDiskStorageCapacity OBJECT-TYPE
SYNTAX KBytes
UNITS "KBytes"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total size for this long-term storage device. If
the media is removable and is currently removed, this
value should be zero."
::= { hrDiskStorageEntry 4 }
hrPartitionTable OBJECT-TYPE
SYNTAX SEQUENCE OF HrPartitionEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
3-24Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
"The (conceptual) table of partitions for long-term
storage devices contained by the host. In particular,
partitions accessed remotely over a network are not
included here."
::= { hrDevice 7 }
hrPartitionEntry OBJECT-TYPE
SYNTAX HrPartitionEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A (conceptual) entry for one partition. The
hrDeviceIndex in the index represents the entry in the
hrDeviceTable that corresponds to the
hrPartitionEntry.
As an example of how objects in this table are named,
an instance of the hrPartitionSize object might be
named hrPartitionSize.3.1"
INDEX { hrDeviceIndex, hrPartitionIndex }
::= { hrPartitionTable 1 }
HrPartitionEntry ::= SEQUENCE {
hrPartitionIndex Integer32,
hrPartitionLabel InternationalDisplayString,
hrPartitionID OCTET STRING,
hrPartitionSize KBytes,
hrPartitionFSIndex Integer32
}
hrPartitionIndex OBJECT-TYPE
SYNTAX Integer32 (1..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A unique value for each partition on this long-term
storage device. The value for each long-term storage
device must remain constant at least from one re-
3-25Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
initialization of the agent to the next re-
initialization."
::= { hrPartitionEntry 1 }
hrPartitionLabel OBJECT-TYPE
SYNTAX InternationalDisplayString (SIZE (0..128))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A textual description of this partition."
::= { hrPartitionEntry 2 }
hrPartitionID OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A descriptor which uniquely represents this partition
to the responsible operating system. On some systems,
this might take on a binary representation."
::= { hrPartitionEntry 3 }
hrPartitionSize OBJECT-TYPE
SYNTAX KBytes
UNITS "KBytes"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The size of this partition."
::= { hrPartitionEntry 4 }
hrPartitionFSIndex OBJECT-TYPE
SYNTAX Integer32 (0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The index of the file system mounted on this
partition. If no file system is mounted on this
3-26Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
partition, then this value shall be zero. Note that
multiple partitions may point to one file system,
denoting that that file system resides on those
partitions. Multiple file systems may not reside on
one partition."
::= { hrPartitionEntry 5 }
-- The File System Table
-- Registration point for popular File System types,
-- for use with hrFSType. These are defined in the
-- HOST-RESOURCES-TYPES module.
hrFSTypes OBJECT IDENTIFIER ::= { hrDevice 9 }
hrFSTable OBJECT-TYPE
SYNTAX SEQUENCE OF HrFSEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The (conceptual) table of file systems local to this
host or remotely mounted from a file server. File
systems that are in only one user's environment on a
multi-user system will not be included in this table."
::= { hrDevice 8 }
hrFSEntry OBJECT-TYPE
SYNTAX HrFSEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A (conceptual) entry for one file system local to
this host or remotely mounted from a file server.
File systems that are in only one user's environment
on a multi-user system will not be included in this
table.
As an example of how objects in this table are named,
an instance of the hrFSMountPoint object might be
3-27Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
named hrFSMountPoint.3"
INDEX { hrFSIndex }
::= { hrFSTable 1 }
HrFSEntry ::= SEQUENCE {
hrFSIndex Integer32,
hrFSMountPoint InternationalDisplayString,
hrFSRemoteMountPoint InternationalDisplayString,
hrFSType AutonomousType,
hrFSAccess INTEGER,
hrFSBootable TruthValue,
hrFSStorageIndex Integer32,
hrFSLastFullBackupDate DateAndTime,
hrFSLastPartialBackupDate DateAndTime
}
hrFSIndex OBJECT-TYPE
SYNTAX Integer32 (1..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A unique value for each file system local to this
host. The value for each file system must remain
constant at least from one re-initialization of the
agent to the next re-initialization."
::= { hrFSEntry 1 }
hrFSMountPoint OBJECT-TYPE
SYNTAX InternationalDisplayString (SIZE(0..128))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The path name of the root of this file system."
::= { hrFSEntry 2 }
hrFSRemoteMountPoint OBJECT-TYPE
SYNTAX InternationalDisplayString (SIZE(0..128))
MAX-ACCESS read-only
3-28Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
STATUS current
DESCRIPTION
"A description of the name and/or address of the
server that this file system is mounted from. This
may also include parameters such as the mount point on
the remote file system. If this is not a remote file
system, this string should have a length of zero."
::= { hrFSEntry 3 }
hrFSType OBJECT-TYPE
SYNTAX AutonomousType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The value of this object identifies the type of this
file system."
::= { hrFSEntry 4 }
hrFSAccess OBJECT-TYPE
SYNTAX INTEGER {
readWrite(1),
readOnly(2)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"An indication if this file system is logically
configured by the operating system to be readable and
writable or only readable. This does not represent
any local access-control policy, except one that is
applied to the file system as a whole."
::= { hrFSEntry 5 }
hrFSBootable OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
3-29Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
"A flag indicating whether this file system is
bootable."
::= { hrFSEntry 6 }
hrFSStorageIndex OBJECT-TYPE
SYNTAX Integer32 (0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The index of the hrStorageEntry that represents
information about this file system. If there is no
such information available, then this value shall be
zero. The relevant storage entry will be useful in
tracking the percent usage of this file system and
diagnosing errors that may occur when it runs out of
space."
::= { hrFSEntry 7 }
hrFSLastFullBackupDate OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The last date at which this complete file system was
copied to another storage device for backup. This
information is useful for ensuring that backups are
being performed regularly.
If this information is not known, then this variable
shall have the value corresponding to January 1, year
0000, 00:00:00.0, which is encoded as
(hex)'00 00 01 01 00 00 00 00'."
::= { hrFSEntry 8 }
hrFSLastPartialBackupDate OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-write
3-30Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
STATUS current
DESCRIPTION
"The last date at which a portion of this file system
was copied to another storage device for backup. This
information is useful for ensuring that backups are
being performed regularly.
If this information is not known, then this variable
shall have the value corresponding to January 1, year
0000, 00:00:00.0, which is encoded as
(hex)'00 00 01 01 00 00 00 00'."
::= { hrFSEntry 9 }
-- The Host Resources Running Software Group
--
-- The hrSWRunTable contains an entry for each distinct piece of
-- software that is running or loaded into physical or virtual
-- memory in preparation for running. This includes the host's
-- operating system, device drivers, and applications.
hrSWOSIndex OBJECT-TYPE
SYNTAX Integer32 (1..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The value of the hrSWRunIndex for the hrSWRunEntry
that represents the primary operating system running
on this host. This object is useful for quickly and
uniquely identifying that primary operating system."
::= { hrSWRun 1 }
hrSWRunTable OBJECT-TYPE
SYNTAX SEQUENCE OF HrSWRunEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The (conceptual) table of software running on the
host."
3-31Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
::= { hrSWRun 2 }
hrSWRunEntry OBJECT-TYPE
SYNTAX HrSWRunEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A (conceptual) entry for one piece of software
running on the host Note that because the installed
software table only contains information for software
stored locally on this host, not every piece of
running software will be found in the installed
software table. This is true of software that was
loaded and run from a non-local source, such as a
network-mounted file system.
As an example of how objects in this table are named,
an instance of the hrSWRunName object might be named
hrSWRunName.1287"
INDEX { hrSWRunIndex }
::= { hrSWRunTable 1 }
HrSWRunEntry ::= SEQUENCE {
hrSWRunIndex Integer32,
hrSWRunName InternationalDisplayString,
hrSWRunID ProductID,
hrSWRunPath InternationalDisplayString,
hrSWRunParameters InternationalDisplayString,
hrSWRunType INTEGER,
hrSWRunStatus INTEGER
}
hrSWRunIndex OBJECT-TYPE
SYNTAX Integer32 (1..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A unique value for each piece of software running on
3-32Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
the host. Wherever possible, this should be the
system's native, unique identification number."
::= { hrSWRunEntry 1 }
hrSWRunName OBJECT-TYPE
SYNTAX InternationalDisplayString (SIZE (0..64))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A textual description of this running piece of
software, including the manufacturer, revision, and
the name by which it is commonly known. If this
software was installed locally, this should be the
same string as used in the corresponding
hrSWInstalledName."
::= { hrSWRunEntry 2 }
hrSWRunID OBJECT-TYPE
SYNTAX ProductID
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The product ID of this running piece of software."
::= { hrSWRunEntry 3 }
hrSWRunPath OBJECT-TYPE
SYNTAX InternationalDisplayString (SIZE(0..128))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A description of the location on long-term storage
(e.g. a disk drive) from which this software was
loaded."
::= { hrSWRunEntry 4 }
hrSWRunParameters OBJECT-TYPE
SYNTAX InternationalDisplayString (SIZE(0..128))
MAX-ACCESS read-only
3-33Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
STATUS current
DESCRIPTION
"A description of the parameters supplied to this
software when it was initially loaded."
::= { hrSWRunEntry 5 }
hrSWRunType OBJECT-TYPE
SYNTAX INTEGER {
unknown(1),
operatingSystem(2),
deviceDriver(3),
application(4)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The type of this software."
::= { hrSWRunEntry 6 }
hrSWRunStatus OBJECT-TYPE
SYNTAX INTEGER {
running(1),
runnable(2), -- waiting for resource
-- (i.e., CPU, memory, IO)
notRunnable(3), -- loaded but waiting for event
invalid(4) -- not loaded
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The status of this running piece of software.
Setting this value to invalid(4) shall cause this
software to stop running and to be unloaded. Sets to
other values are not valid."
::= { hrSWRunEntry 7 }
-- The Host Resources Running Software Performance Group
--
3-34Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
-- The hrSWRunPerfTable contains an entry corresponding to
-- each entry in the hrSWRunTable.
hrSWRunPerfTable OBJECT-TYPE
SYNTAX SEQUENCE OF HrSWRunPerfEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The (conceptual) table of running software
performance metrics."
::= { hrSWRunPerf 1 }
hrSWRunPerfEntry OBJECT-TYPE
SYNTAX HrSWRunPerfEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A (conceptual) entry containing software performance
metrics. As an example, an instance of the
hrSWRunPerfCPU object might be named
hrSWRunPerfCPU.1287"
AUGMENTS { hrSWRunEntry } -- This table augments information in
-- the hrSWRunTable.
::= { hrSWRunPerfTable 1 }
HrSWRunPerfEntry ::= SEQUENCE {
hrSWRunPerfCPU Integer32,
hrSWRunPerfMem KBytes
}
hrSWRunPerfCPU OBJECT-TYPE
SYNTAX Integer32 (0..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of centi-seconds of the total system's CPU
resources consumed by this process. Note that on a
multi-processor system, this value may increment by
3-35Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
more than one centi-second in one centi-second of real
(wall clock) time."
::= { hrSWRunPerfEntry 1 }
hrSWRunPerfMem OBJECT-TYPE
SYNTAX KBytes
UNITS "KBytes"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total amount of real system memory allocated to
this process."
::= { hrSWRunPerfEntry 2 }
-- The Host Resources Installed Software Group
--
-- The hrSWInstalledTable contains an entry for each piece
-- of software installed in long-term storage (e.g. a disk
-- drive) locally on this host. Note that this does not
-- include software loadable remotely from a network
-- server.
--
-- Different implementations may track software in varying
-- ways. For example, while some implementations may track
-- executable files as distinct pieces of software, other
-- implementations may use other strategies such as keeping
-- track of software "packages" (e.g., related groups of files)
-- or keeping track of system or application "patches".
--
-- This table is useful for identifying and inventorying
-- software on a host and for diagnosing incompatibility
-- and version mismatch problems between various pieces
-- of hardware and software.
hrSWInstalledLastChange OBJECT-TYPE
SYNTAX TimeTicks
MAX-ACCESS read-only
STATUS current
3-36Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
DESCRIPTION
"The value of sysUpTime when an entry in the
hrSWInstalledTable was last added, renamed, or
deleted. Because this table is likely to contain many
entries, polling of this object allows a management
station to determine when re-downloading of the table
might be useful."
::= { hrSWInstalled 1 }
hrSWInstalledLastUpdateTime OBJECT-TYPE
SYNTAX TimeTicks
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The value of sysUpTime when the hrSWInstalledTable
was last completely updated. Because caching of this
data will be a popular implementation strategy,
retrieval of this object allows a management station
to obtain a guarantee that no data in this table is
older than the indicated time."
::= { hrSWInstalled 2 }
hrSWInstalledTable OBJECT-TYPE
SYNTAX SEQUENCE OF HrSWInstalledEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The (conceptual) table of software installed on this
host."
::= { hrSWInstalled 3 }
hrSWInstalledEntry OBJECT-TYPE
SYNTAX HrSWInstalledEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A (conceptual) entry for a piece of software
installed on this host.
3-37Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
As an example of how objects in this table are named,
an instance of the hrSWInstalledName object might be
named hrSWInstalledName.96"
INDEX { hrSWInstalledIndex }
::= { hrSWInstalledTable 1 }
HrSWInstalledEntry ::= SEQUENCE {
hrSWInstalledIndex Integer32,
hrSWInstalledName InternationalDisplayString,
hrSWInstalledID ProductID,
hrSWInstalledType INTEGER,
hrSWInstalledDate DateAndTime
}
hrSWInstalledIndex OBJECT-TYPE
SYNTAX Integer32 (1..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A unique value for each piece of software installed
on the host. This value shall be in the range from 1
to the number of pieces of software installed on the
host."
::= { hrSWInstalledEntry 1 }
hrSWInstalledName OBJECT-TYPE
SYNTAX InternationalDisplayString (SIZE (0..64))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A textual description of this installed piece of
software, including the manufacturer, revision, the
name by which it is commonly known, and optionally,
its serial number."
::= { hrSWInstalledEntry 2 }
hrSWInstalledID OBJECT-TYPE
3-38Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
SYNTAX ProductID
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The product ID of this installed piece of software."
::= { hrSWInstalledEntry 3 }
hrSWInstalledType OBJECT-TYPE
SYNTAX INTEGER {
unknown(1),
operatingSystem(2),
deviceDriver(3),
application(4)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The type of this software."
::= { hrSWInstalledEntry 4 }
hrSWInstalledDate OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The last-modification date of this application as it
would appear in a directory listing.
If this information is not known, then this variable
shall have the value corresponding to January 1, year
0000, 00:00:00.0, which is encoded as
(hex)'00 00 01 01 00 00 00 00'."
::= { hrSWInstalledEntry 5 }
-- Conformance information
hrMIBCompliances OBJECT IDENTIFIER ::= { hrMIBAdminInfo 2 }
hrMIBGroups OBJECT IDENTIFIER ::= { hrMIBAdminInfo 3 }
3-39Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
-- Compliance Statements
hrMIBCompliance MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"The requirements for conformance to the Host Resources MIB."
MODULE -- this module
MANDATORY-GROUPS { hrSystemGroup, hrStorageGroup,
hrDeviceGroup }
OBJECT hrSystemDate
MIN-ACCESS read-only
DESCRIPTION
"Write access is not required."
OBJECT hrSystemInitialLoadDevice
MIN-ACCESS read-only
DESCRIPTION
"Write access is not required."
OBJECT hrSystemInitialLoadParameters
MIN-ACCESS read-only
DESCRIPTION
"Write access is not required."
OBJECT hrStorageSize
MIN-ACCESS read-only
DESCRIPTION
"Write access is not required."
OBJECT hrFSLastFullBackupDate
MIN-ACCESS read-only
DESCRIPTION
"Write access is not required."
OBJECT hrFSLastPartialBackupDate
MIN-ACCESS read-only
DESCRIPTION
3-40Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
"Write access is not required."
GROUP hrSWRunGroup
DESCRIPTION
"The Running Software Group. Implementation
of this group is mandatory only when the
hrSWRunPerfGroup is implemented."
OBJECT hrSWRunStatus
MIN-ACCESS read-only
DESCRIPTION
"Write access is not required."
GROUP hrSWRunPerfGroup
DESCRIPTION
"The Running Software Performance Group.
Implementation of this group is at the discretion
of the implementor."
GROUP hrSWInstalledGroup
DESCRIPTION
"The Installed Software Group.
Implementation of this group is at the discretion
of the implementor."
::= { hrMIBCompliances 1 }
hrSystemGroup OBJECT-GROUP
OBJECTS {
hrSystemUptime, hrSystemDate,
hrSystemInitialLoadDevice,
hrSystemInitialLoadParameters,
hrSystemNumUsers, hrSystemProcesses,
hrSystemMaxProcesses
}
STATUS current
DESCRIPTION
"The Host Resources System Group."
::= { hrMIBGroups 1 }
3-41Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
hrStorageGroup OBJECT-GROUP
OBJECTS {
hrMemorySize, hrStorageIndex, hrStorageType,
hrStorageDescr, hrStorageAllocationUnits,
hrStorageSize, hrStorageUsed,
hrStorageAllocationFailures
}
STATUS current
DESCRIPTION
"The Host Resources Storage Group."
::= { hrMIBGroups 2 }
hrDeviceGroup OBJECT-GROUP
OBJECTS {
hrDeviceIndex, hrDeviceType, hrDeviceDescr,
hrDeviceID, hrDeviceStatus, hrDeviceErrors,
hrProcessorFrwID, hrProcessorLoad,
hrNetworkIfIndex, hrPrinterStatus,
hrPrinterDetectedErrorState,
hrDiskStorageAccess, hrDiskStorageMedia,
hrDiskStorageRemoveble, hrDiskStorageCapacity,
hrPartitionIndex, hrPartitionLabel,
hrPartitionID, hrPartitionSize,
hrPartitionFSIndex, hrFSIndex, hrFSMountPoint,
hrFSRemoteMountPoint, hrFSType, hrFSAccess,
hrFSBootable, hrFSStorageIndex,
hrFSLastFullBackupDate,
hrFSLastPartialBackupDate
}
STATUS current
DESCRIPTION
"The Host Resources Device Group."
::= { hrMIBGroups 3 }
hrSWRunGroup OBJECT-GROUP
OBJECTS {
hrSWOSIndex, hrSWRunIndex, hrSWRunName,
3-42Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
hrSWRunID, hrSWRunPath, hrSWRunParameters,
hrSWRunType, hrSWRunStatus
}
STATUS current
DESCRIPTION
"The Host Resources Running Software Group."
::= { hrMIBGroups 4 }
hrSWRunPerfGroup OBJECT-GROUP
OBJECTS { hrSWRunPerfCPU, hrSWRunPerfMem }
STATUS current
DESCRIPTION
"The Host Resources Running Software
Performance Group."
::= { hrMIBGroups 5 }
hrSWInstalledGroup OBJECT-GROUP
OBJECTS {
hrSWInstalledLastChange,
hrSWInstalledLastUpdateTime,
hrSWInstalledIndex, hrSWInstalledName,
hrSWInstalledID, hrSWInstalledType,
hrSWInstalledDate
}
STATUS current
DESCRIPTION
"The Host Resources Installed Software Group."
::= { hrMIBGroups 6 }
END
Cisco Discovery Protocol (CDP) MIB The Cisco Discovery Protocol (CDP) is a Cisco-proprietary network protocol used to broadcast device discovery information to routers and/or switches on the network. Cisco Unified Operations Manager can use this device discovery data to build a network topology and to identify devices within that topology. This means that a network administrator could then click on the device icon for a product node and quickly identify it.
3-43Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
UCCX uses the platform supported subagent implementation to support CISCO-CDP-MIB. UCCX does not modify this MIB or its SubAgent implementation.
CISCO-CDP-MIB
This section contain the text of the CISCO-CDP-MIB file.
--CISCO-CDP-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY, OBJECT-TYPE,
Integer32
FROM SNMPv2-SMI
MODULE-COMPLIANCE, OBJECT-GROUP
FROM SNMPv2-CONF
TruthValue, DisplayString, TimeStamp
FROM SNMPv2-TC
ciscoMgmt
FROM CISCO-SMI
CiscoNetworkProtocol, CiscoNetworkAddress, Unsigned32
FROM CISCO-TC
VlanIndex
FROM CISCO-VTP-MIB
ifIndex
FROM IF-MIB
;
ciscoCdpMIB MODULE-IDENTITY
LAST-UPDATED"200111230000Z"
ORGANIZATION"Cisco System Inc."
CONTACT-INFO
"Cisco Systems
Customer Service
Postal: 170 West Tasman Drive,
San Jose CA 95134-1706.
USA
Tel: +1 800 553-NETS
3-44Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
E-mail: [email protected]"
DESCRIPTION
"The MIB module for management of the Cisco Discovery
Protocol in Cisco devices."
REVISION "200111230000Z"
DESCRIPTION
"Added cdpInterfaceExtTable which contains the following
objects:
cdpInterfaceExtendedTrust,
cdpInterfaceCosForUntrustedPort."
REVISION "200104230000Z"
DESCRIPTION
"Added the following objects:
cdpGlobalDeviceIdFormatCpb,
cdpGlobalDeviceIdFormat."
REVISION "200011220000Z"
DESCRIPTION
"Added the following objects:
cdpCacheApplianceID,
cdpCacheVlanID,
cdpCachePowerConsumption,
cdpCacheMTU,
cdpCachePrimaryMgmtAddrType,
cdpCachePrimaryMgmtAddr,
cdpCacheSecondaryMgmtAddrType,
cdpCacheSecondaryMgmtAddr,
cdpCacheLastChange,
cdpCachePhysLocation,
cdpCacheSysName,
cdpCacheSysObjectID,
cdpGlobalLastChange"
REVISION "9812100000Z"
DESCRIPTION
"Added cdpGlobalDeviceId object."
REVISION "9809160000Z"
DESCRIPTION
"added these objects to cdpCacheTable:
cdpCacheVTPMgmtDomain,
3-45Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
cdpCacheNativeVLAN,
cdpCacheDuplex.
"
REVISION "9607080000Z"
DESCRIPTION
"Obsolete cdpInterfaceMessageInterval and newly
define cdpGlobal object."
REVISION "9508150000Z"
DESCRIPTION
"Specify a correct (non-negative) range for several
index objects."
REVISION "9507270000Z"
DESCRIPTION
"Correct range of cdpInterfaceMessageInterval."
REVISION "9501250000Z"
DESCRIPTION
"Move from ciscoExperiment to ciscoMgmt oid subtree."
::= { ciscoMgmt 23 }
ciscoCdpMIBObjects OBJECT IDENTIFIER ::= { ciscoCdpMIB 1 }
cdpInterface OBJECT IDENTIFIER ::= { ciscoCdpMIBObjects 1 }
cdpCache OBJECT IDENTIFIER ::= { ciscoCdpMIBObjects 2 }
cdpGlobal OBJECT IDENTIFIER ::= { ciscoCdpMIBObjects 3 }
--
-- The CDP Interface Group
--
cdpInterfaceTable OBJECT-TYPE
SYNTAX SEQUENCE OF CdpInterfaceEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The (conceptual) table containing the status of CDP on
the device's interfaces."
::= { cdpInterface 1 }
3-46Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
cdpInterfaceEntry OBJECT-TYPE
SYNTAX CdpInterfaceEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry (conceptual row) in the cdpInterfaceTable,
containing the status of CDP on an interface."
INDEX { cdpInterfaceIfIndex }
::= { cdpInterfaceTable 1 }
CdpInterfaceEntry ::= SEQUENCE {
cdpInterfaceIfIndex Integer32,
cdpInterfaceEnable TruthValue,
cdpInterfaceMessageInterval INTEGER,
cdpInterfaceGroup Integer32,
cdpInterfacePort Integer32
}
cdpInterfaceIfIndex OBJECT-TYPE
SYNTAX Integer32 (0..2147483647)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The ifIndex value of the local interface.
For 802.3 Repeaters on which the repeater ports do not
have ifIndex values assigned, this value is a unique
value for the port, and greater than any ifIndex value
supported by the repeater; in this case, the specific
port is indicated by corresponding values of
cdpInterfaceGroup and cdpInterfacePort, where these
values correspond to the group number and port number
values of RFC 1516."
::= { cdpInterfaceEntry 1 }
cdpInterfaceEnable OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-write
3-47Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
STATUS current
DESCRIPTION
"An indication of whether the Cisco Discovery Protocol
is currently running on this interface. This variable
has no effect when CDP is disabled (cdpGlobalRun = FALSE)."
::= { cdpInterfaceEntry 2 }
cdpInterfaceMessageInterval OBJECT-TYPE
SYNTAX INTEGER (5..254)
UNITS "seconds"
MAX-ACCESS read-write
STATUS obsolete -- replaced by cdpGlobalMessageInterval
-- this object should be applied to the
-- whole system instead of per interface
DESCRIPTION
"The interval at which CDP messages are to be generated
on this interface. The default value is 60 seconds."
::= { cdpInterfaceEntry 3 }
cdpInterfaceGroup OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object is only relevant to interfaces which are
repeater ports on 802.3 repeaters. In this situation,
it indicates the RFC1516 group number of the repeater
port which corresponds to this interface."
::= { cdpInterfaceEntry 4 }
cdpInterfacePort OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object is only relevant to interfaces which are
repeater ports on 802.3 repeaters. In this situation,
it indicates the RFC1516 port number of the repeater
3-48Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
port which corresponds to this interface."
::= { cdpInterfaceEntry 5 }
cdpInterfaceExtTable OBJECT-TYPE
SYNTAX SEQUENCE OF CdpInterfaceExtEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This table contains the additional CDP configuration on
the device's interfaces."
::= { cdpInterface 2 }
cdpInterfaceExtEntry OBJECT-TYPE
SYNTAX CdpInterfaceExtEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry in the cdpInterfaceExtTable contains the values
configured for Extented Trust TLV and COS (Class of Service)
for Untrusted Ports TLV on an interface which supports the
sending of these TLVs."
INDEX { ifIndex }
::= { cdpInterfaceExtTable 1 }
CdpInterfaceExtEntry ::= SEQUENCE {
cdpInterfaceExtendedTrust INTEGER,
cdpInterfaceCosForUntrustedPort Unsigned32
}
cdpInterfaceExtendedTrust OBJECT-TYPE
SYNTAX INTEGER {
trusted(1),
noTrust(2)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Indicates the value to be sent by Extended Trust TLV.
3-49Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
If trusted(1) is configured, the value of Extended Trust TLV
is one byte in length with its least significant bit equal to
1 to indicate extended trust. All other bits are 0.
If noTrust(2) is configured, the value of Extended Trust TLV
is one byte in length with its least significant bit equal to
0 to indicate no extended trust. All other bits are 0."
::= { cdpInterfaceExtEntry 1 }
cdpInterfaceCosForUntrustedPort OBJECT-TYPE
SYNTAX Unsigned32 (0..7)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Indicates the value to be sent by COS for Untrusted Ports TLV."
::= { cdpInterfaceExtEntry 2 }
--
-- The CDP Address Cache Group
--
cdpCacheTable OBJECT-TYPE
SYNTAX SEQUENCE OF CdpCacheEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The (conceptual) table containing the cached
information obtained via receiving CDP messages."
::= { cdpCache 1 }
cdpCacheEntry OBJECT-TYPE
SYNTAX CdpCacheEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry (conceptual row) in the cdpCacheTable,
containing the information received via CDP on one
3-50Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
interface from one device. Entries appear when
a CDP advertisement is received from a neighbor
device. Entries disappear when CDP is disabled
on the interface, or globally."
INDEX { cdpCacheIfIndex, cdpCacheDeviceIndex }
::= { cdpCacheTable 1 }
CdpCacheEntry ::= SEQUENCE {
cdpCacheIfIndex Integer32,
cdpCacheDeviceIndex Integer32,
cdpCacheAddressType CiscoNetworkProtocol,
cdpCacheAddress CiscoNetworkAddress,
cdpCacheVersion DisplayString,
cdpCacheDeviceId DisplayString,
cdpCacheDevicePort DisplayString,
cdpCachePlatform DisplayString,
cdpCacheCapabilities OCTET STRING,
cdpCacheVTPMgmtDomain DisplayString,
cdpCacheNativeVLAN VlanIndex,
cdpCacheDuplex INTEGER,
cdpCacheApplianceID Unsigned32,
cdpCacheVlanID Unsigned32,
cdpCachePowerConsumption Unsigned32,
cdpCacheMTU Unsigned32,
cdpCacheSysName DisplayString,
cdpCacheSysObjectID OBJECT IDENTIFIER,
cdpCachePrimaryMgmtAddrType CiscoNetworkProtocol,
cdpCachePrimaryMgmtAddr CiscoNetworkAddress,
cdpCacheSecondaryMgmtAddrType CiscoNetworkProtocol,
cdpCacheSecondaryMgmtAddr CiscoNetworkAddress,
cdpCachePhysLocation DisplayString,
cdpCacheLastChange TimeStamp
}
cdpCacheIfIndex OBJECT-TYPE
SYNTAX Integer32 (0..2147483647)
MAX-ACCESS not-accessible
STATUS current
3-51Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
DESCRIPTION
"Normally, the ifIndex value of the local interface.
For 802.3 Repeaters for which the repeater ports do not
have ifIndex values assigned, this value is a unique
value for the port, and greater than any ifIndex value
supported by the repeater; the specific port number in
this case, is given by the corresponding value of
cdpInterfacePort."
::= { cdpCacheEntry 1 }
cdpCacheDeviceIndex OBJECT-TYPE
SYNTAX Integer32 (0..2147483647)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A unique value for each device from which CDP messages
are being received."
::= { cdpCacheEntry 2 }
cdpCacheAddressType OBJECT-TYPE
SYNTAX CiscoNetworkProtocol
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"An indication of the type of address contained in the
corresponding instance of cdpCacheAddress."
::= { cdpCacheEntry 3 }
cdpCacheAddress OBJECT-TYPE
SYNTAX CiscoNetworkAddress
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The (first) network-layer address of the device's
SNMP-agent as reported in the Address TLV of the most recently
received CDP message. For example, if the corresponding
instance of cacheAddressType had the value 'ip(1)', then
this object would be an IP-address."
3-52Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
::= { cdpCacheEntry 4 }
cdpCacheVersion OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The Version string as reported in the most recent CDP
message. The zero-length string indicates no Version
field (TLV) was reported in the most recent CDP
message."
::= { cdpCacheEntry 5 }
cdpCacheDeviceId OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The Device-ID string as reported in the most recent CDP
message. The zero-length string indicates no Device-ID
field (TLV) was reported in the most recent CDP
message."
::= { cdpCacheEntry 6 }
cdpCacheDevicePort OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The Port-ID string as reported in the most recent CDP
message. This will typically be the value of the ifName
object (e.g., 'Ethernet0'). The zero-length string
indicates no Port-ID field (TLV) was reported in the
most recent CDP message."
::= { cdpCacheEntry 7 }
cdpCachePlatform OBJECT-TYPE
SYNTAX DisplayString
3-53Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The Device's Hardware Platform as reported in the most
recent CDP message. The zero-length string indicates
that no Platform field (TLV) was reported in the most
recent CDP message."
::= { cdpCacheEntry 8 }
cdpCacheCapabilities OBJECT-TYPE
SYNTAX OCTET STRING (SIZE (0..4))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The Device's Functional Capabilities as reported in the
most recent CDP message. For latest set of specific
values, see the latest version of the CDP specification.
The zero-length string indicates no Capabilities field
(TLV) was reported in the most recent CDP message."
REFERENCE "Cisco Discovery Protocol Specification, 10/19/94."
::= { cdpCacheEntry 9 }
cdpCacheVTPMgmtDomain OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..32))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The VTP Management Domain for the remote device's interface,
as reported in the most recently received CDP message.
This object is not instantiated if no VTP Management Domain field
(TLV) was reported in the most recently received CDP message."
REFERENCE "managementDomainName in CISCO-VTP-MIB"
::= { cdpCacheEntry 10 }
cdpCacheNativeVLAN OBJECT-TYPE
SYNTAX VlanIndex
MAX-ACCESS read-only
3-54Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
STATUS current
DESCRIPTION
"The remote device's interface's native VLAN, as reported in the
most recent CDP message. The value 0 indicates
no native VLAN field (TLV) was reported in the most
recent CDP message."
::= { cdpCacheEntry 11 }
cdpCacheDuplex OBJECT-TYPE
SYNTAX INTEGER {
unknown(1),
halfduplex(2),
fullduplex(3)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The remote device's interface's duplex mode, as reported in the
most recent CDP message. The value unknown(1) indicates
no duplex mode field (TLV) was reported in the most
recent CDP message."
::= { cdpCacheEntry 12 }
cdpCacheApplianceID OBJECT-TYPE
SYNTAX Unsigned32 (0..255)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The remote device's Appliance ID, as reported in the
most recent CDP message. This object is not instantiated if
no Appliance VLAN-ID field (TLV) was reported in the most
recently received CDP message."
::= { cdpCacheEntry 13 }
cdpCacheVlanID OBJECT-TYPE
SYNTAX Unsigned32 (0..4095)
MAX-ACCESS read-only
STATUS current
3-55Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
DESCRIPTION
"The remote device's VoIP VLAN ID, as reported in the
most recent CDP message. This object is not instantiated if
no Appliance VLAN-ID field (TLV) was reported in the most
recently received CDP message."
::= { cdpCacheEntry 14 }
cdpCachePowerConsumption OBJECT-TYPE
SYNTAX Unsigned32
UNITS "milliwatts"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The amount of power consumed by remote device, as reported
in the most recent CDP message. This object is not instantiated
if no Power Consumption field (TLV) was reported in the most
recently received CDP message."
::= { cdpCacheEntry 15 }
cdpCacheMTU OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Indicates the size of the largest datagram that can be
sent/received by remote device, as reported in the most recent
CDP message. This object is not instantiated if no MTU field
(TLV) was reported in the most recently received CDP message."
::= { cdpCacheEntry 16 }
cdpCacheSysName OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..255))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Indicates the value of the remote device's sysName MIB object.
By convention, it is the device's fully qualified domain name.
This object is not instantiated if no sysName field (TLV) was
3-56Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
reported in the most recently received CDP message."
::= { cdpCacheEntry 17 }
cdpCacheSysObjectID OBJECT-TYPE
SYNTAX OBJECT IDENTIFIER
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Indicates the value of the remote device's sysObjectID MIB
object. This object is not instantiated if no sysObjectID field
(TLV) was reported in the most recently received CDP message."
::= { cdpCacheEntry 18 }
cdpCachePrimaryMgmtAddrType OBJECT-TYPE
SYNTAX CiscoNetworkProtocol
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"An indication of the type of address contained in the
corresponding instance of cdpCachePrimaryMgmtAddress."
::= { cdpCacheEntry 19 }
cdpCachePrimaryMgmtAddr OBJECT-TYPE
SYNTAX CiscoNetworkAddress
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object indicates the (first) network layer address at
which the device will accept SNMP messages as reported in the
most recently received CDP message. If the corresponding
instance of cdpCachePrimaryMgmtAddrType has the value 'ip(1)',
then this object would be an IP-address. If the remote device
is not currently manageable via any network protocol, this
object has the special value of the IPv4 address 0.0.0.0.
If the most recently received CDP message did not contain any
primary address at which the device prefers to receive
SNMP messages, then this object is not instanstiated."
::= { cdpCacheEntry 20 }
3-57Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
cdpCacheSecondaryMgmtAddrType OBJECT-TYPE
SYNTAX CiscoNetworkProtocol
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"An indication of the type of address contained in the
corresponding instance of cdpCacheSecondaryMgmtAddress."
::= { cdpCacheEntry 21 }
cdpCacheSecondaryMgmtAddr OBJECT-TYPE
SYNTAX CiscoNetworkAddress
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object indicates the alternate network layer address
(other than the one indicated by cdpCachePrimaryMgmtAddr) at
which the device will accept SNMP messages as reported in the
most recently received CDP message. If the corresponding
instance of cdpCacheSecondaryMgmtAddrType has the value 'ip(1)',
then this object would be an IP-address. If the most recently
received CDP message did not contain such an alternate network
layer address, then this object is not instanstiated."
::= { cdpCacheEntry 22 }
cdpCachePhysLocation OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Indicates the physical location, as reported by the most recent
CDP message, of a connector which is on, or physically connected
to, the remote device's interface over which the CDP packet is
sent. This object is not instantiated if no Physical Location
field (TLV) was reported by the most recently received CDP
message."
::= { cdpCacheEntry 23 }
3-58Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
cdpCacheLastChange OBJECT-TYPE
SYNTAX TimeStamp
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Indicates the time when this cache entry was last changed.
This object is initialised to the current time when the entry
gets created and updated to the current time whenever the value
of any (other) object instance in the corresponding row is
modified."
::= { cdpCacheEntry 24 }
--
-- The CDP Global Group
--
cdpGlobalRun OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"An indication of whether the Cisco Discovery Protocol
is currently running. Entries in cdpCacheTable are
deleted when CDP is disabled."
DEFVAL { true }
::= { cdpGlobal 1 }
cdpGlobalMessageInterval OBJECT-TYPE
SYNTAX INTEGER (5..254)
UNITS "seconds"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The interval at which CDP messages are to be generated.
The default value is 60 seconds."
DEFVAL { 60 }
::= { cdpGlobal 2 }
3-59Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
cdpGlobalHoldTime OBJECT-TYPE
SYNTAX INTEGER (10..255)
UNITS "seconds"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The time for the receiving device holds CDP message.
The default value is 180 seconds."
DEFVAL { 180 }
::= { cdpGlobal 3 }
cdpGlobalDeviceId OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The device ID advertised by this device. The format of this
device id is characterized by the value of
cdpGlobalDeviceIdFormat object."
::= { cdpGlobal 4 }
cdpGlobalLastChange OBJECT-TYPE
SYNTAX TimeStamp
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Indicates the time when the cache table was last changed. It
is the most recent time at which any row was last created,
modified or deleted."
::= { cdpGlobal 5 }
cdpGlobalDeviceIdFormatCpb OBJECT-TYPE
SYNTAX BITS {
serialNumber(0),
macAddress(1),
other (2)
}
MAX-ACCESS read-only
3-60Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
STATUS current
DESCRIPTION
"Indicate the Device-Id format capability of the device.
serialNumber(0) indicates that the device supports using
serial number as the format for its DeviceId.
macAddress(1) indicates that the device supports using
layer 2 MAC address as the format for its DeviceId.
other(2) indicates that the device supports using its
platform specific format as the format for its DeviceId."
::= { cdpGlobal 6 }
cdpGlobalDeviceIdFormat OBJECT-TYPE
SYNTAX INTEGER {
serialNumber(1),
macAddress(2),
other(3)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"An indication of the format of Device-Id contained in the
corresponding instance of cdpGlobalDeviceId. User can only
specify the formats that the device is capable of as
denoted in cdpGlobalDeviceIdFormatCpb object.
serialNumber(1) indicates that the value of cdpGlobalDeviceId
object is in the form of an ASCII string contain the device
serial number.
macAddress(2) indicates that the value of cdpGlobalDeviceId
object is in the form of Layer 2 MAC address.
other(3) indicates that the value of cdpGlobalDeviceId object
is in the form of a platform specific ASCII string contain
info that identifies the device. For example: ASCII string
3-61Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
contains serialNumber appended/prepened with system name."
::= { cdpGlobal 7 }
-- conformance information
ciscoCdpMIBConformance
OBJECT IDENTIFIER ::= { ciscoCdpMIB 2 }
ciscoCdpMIBCompliances
OBJECT IDENTIFIER ::= { ciscoCdpMIBConformance 1 }
ciscoCdpMIBGroups
OBJECT IDENTIFIER ::= { ciscoCdpMIBConformance 2 }
-- compliance statements
ciscoCdpMIBCompliance MODULE-COMPLIANCE
STATUS obsolete -- superseded by ciscoCdpMIBComplianceV11R01
DESCRIPTION
"The compliance statement for the CDP MIB."
MODULE -- this module
MANDATORY-GROUPS { ciscoCdpMIBGroup }
::= { ciscoCdpMIBCompliances 1 }
ciscoCdpMIBComplianceV11R01 MODULE-COMPLIANCE
STATUS obsolete -- superseded by ciscoCdpMIBComplianceV11R02
DESCRIPTION
"The compliance statement for the CDP MIB."
MODULE -- this module
MANDATORY-GROUPS { ciscoCdpMIBGroupV11R01 }
::= { ciscoCdpMIBCompliances 2 }
ciscoCdpMIBComplianceV11R02 MODULE-COMPLIANCE
STATUS obsolete -- superseded by ciscoCdpMIBComplianceV12R02
DESCRIPTION
"The compliance statement for the CDP MIB."
MODULE -- this module
3-62Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
MANDATORY-GROUPS { ciscoCdpMIBGroupV11R02 }
::= { ciscoCdpMIBCompliances 3 }
ciscoCdpMIBComplianceV12R02 MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"The compliance statement for the CDP MIB."
MODULE -- this module
MANDATORY-GROUPS { ciscoCdpMIBGroupV12R02 }
::= { ciscoCdpMIBCompliances 4 }
-- units of conformance
ciscoCdpMIBGroup OBJECT-GROUP
OBJECTS { cdpInterfaceEnable, cdpInterfaceMessageInterval,
cdpCacheAddressType, cdpCacheAddress, cdpCacheVersion,
cdpCacheDeviceId, cdpCacheDevicePort,
cdpCacheCapabilities, cdpCachePlatform
}
STATUS obsolete -- superseded by ciscoCdpMIBGroupV11R01
DESCRIPTION
"A collection of objects for use with the Cisco
Discovery Protocol."
::= { ciscoCdpMIBGroups 1 }
ciscoCdpMIBGroupV11R01 OBJECT-GROUP
OBJECTS { cdpInterfaceEnable, cdpInterfaceMessageInterval,
cdpInterfaceGroup, cdpInterfacePort,
cdpCacheAddressType, cdpCacheAddress, cdpCacheVersion,
cdpCacheDeviceId, cdpCacheDevicePort,
cdpCacheCapabilities, cdpCachePlatform
}
STATUS obsolete -- superseded by ciscoCdpMIBGroupV11R02
DESCRIPTION
"A collection of objects for use with the Cisco
Discovery Protocol."
3-63Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
::= { ciscoCdpMIBGroups 2 }
ciscoCdpMIBGroupV11R02 OBJECT-GROUP
OBJECTS { cdpInterfaceEnable,
cdpInterfaceGroup, cdpInterfacePort,
cdpCacheAddressType, cdpCacheAddress, cdpCacheVersion,
cdpCacheDeviceId, cdpCacheDevicePort,
cdpCacheCapabilities, cdpCachePlatform,
cdpGlobalRun, cdpGlobalMessageInterval, cdpGlobalHoldTime
}
STATUS obsolete -- superseded by ciscoCdpMIBGroupV12R02
DESCRIPTION
"A collection of objects for use with the Cisco
Discovery Protocol."
::= { ciscoCdpMIBGroups 3 }
ciscoCdpMIBGroupV12R02 OBJECT-GROUP
OBJECTS { cdpInterfaceEnable,
cdpInterfaceGroup, cdpInterfacePort,
cdpCacheAddressType, cdpCacheAddress, cdpCacheVersion,
cdpCacheDeviceId, cdpCacheDevicePort,
cdpCacheCapabilities, cdpCachePlatform,
cdpCacheVTPMgmtDomain, cdpCacheNativeVLAN, cdpCacheDuplex,
cdpGlobalRun, cdpGlobalMessageInterval, cdpGlobalHoldTime,
cdpGlobalDeviceId
}
STATUS current
DESCRIPTION
"A collection of objects for use with the Cisco
Discovery Protocol."
::= { ciscoCdpMIBGroups 5 }
ciscoCdpV2MIBGroup OBJECT-GROUP
OBJECTS {
cdpCacheApplianceID, cdpCacheVlanID,
cdpCachePowerConsumption, cdpCacheMTU,
cdpCacheSysName, cdpCacheSysObjectID,
cdpCacheLastChange, cdpCachePhysLocation,
3-64Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
cdpCachePrimaryMgmtAddrType,
cdpCachePrimaryMgmtAddr,
cdpCacheSecondaryMgmtAddrType,
cdpCacheSecondaryMgmtAddr,
cdpGlobalLastChange, cdpGlobalDeviceIdFormatCpb,
cdpGlobalDeviceIdFormat
}
STATUS current
DESCRIPTION
"A collection of objects for use with the Cisco
Discovery Protocol version 2."
::= { ciscoCdpMIBGroups 6 }
ciscoCdpV2IfExtGroup OBJECT-GROUP
OBJECTS {
cdpInterfaceExtendedTrust,
cdpInterfaceCosForUntrustedPort
}
STATUS current
DESCRIPTION
"A collection of objects for use with the Cisco
Discovery Protocol version 2 to configure the value
for Extended Trust TLV and COS for Untrusted Port TLV."
::= { ciscoCdpMIBGroups 7 }
END
MIB2 The MIB2 is defined in RFC 1213. It contains objects such as interfaces, ip, icmp, etc.
UCCX uses the platform supported MIB2 Subagent implementation
3-65Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
SYSAPPL MIB SubagentThe System-Level Managed Objects for Applications MIB (also known as SYSAPPL MIB) is an implementation of RFC-2287. This information allows for the description of applications as collections of executables and files installed and executing on a host computer. The MIB enumerates applications installed and provides application run status, associated processes and locations of executables and files on the disk.
UCCX leverages the SysAppl MIB for showing UCCX specific information, including the information regarding the common platform services and “System” services. UCCX does not modify the SysAppl MIB or its SubAgent implementation.
The SysAppl Subagent does provide the Unified CCX Subsystems and their status information.
SysAppl MIB
This section contains the text of the SysAppl MIB file.
SYSAPPL-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY, OBJECT-TYPE, mib-2,
Unsigned32, TimeTicks, Counter32, Gauge32
FROM SNMPv2-SMI
DateAndTime, TEXTUAL-CONVENTION
FROM SNMPv2-TC
MODULE-COMPLIANCE, OBJECT-GROUP
FROM SNMPv2-CONF;
-- System Application MIB
sysApplMIB MODULE-IDENTITY
LAST-UPDATED "200601060000Z"
ORGANIZATION "IETF Applications MIB Working Group"
CONTACT-INFO
"Cheryl Krupczak (Editor, WG Advisor)
Postal: Empire Technologies, Inc.
541 Tenth Street NW
Suite 169
Atlanta, GA 30318
USA
Phone: (770) 384-0184
Email: [email protected]
3-66Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
Jon Saperia (WG Chair)
Postal: BGS Systems, Inc.
One First Avenue
Waltham, MA 02254-9111
USA
Phone: (617) 891-0000
Email: [email protected]"
DESCRIPTION
"The MIB module defines management objects that model
applications as collections of executables and files
installed and executing on a host system. The MIB
presents a system-level view of applications; i.e.,
objects in this MIB are limited to those attributes
that can typically be obtained from the system itself
without adding special instrumentation to the applications."
REVISION "200601060000Z"
DESCRIPTION "Imported Unsigned32 from SNMPv2-SMI."
REVISION "9710200000Z"
DESCRIPTION "Initial version of the mib module, published as
RFC 2287."
::= { mib-2 54 }
sysApplOBJ OBJECT IDENTIFIER ::= { sysApplMIB 1 }
sysApplInstalled OBJECT IDENTIFIER ::= { sysApplOBJ 1 }
sysApplRun OBJECT IDENTIFIER ::= { sysApplOBJ 2 }
sysApplMap OBJECT IDENTIFIER ::= { sysApplOBJ 3 }
sysApplNotifications OBJECT IDENTIFIER ::= { sysApplMIB 2 }
sysApplConformance OBJECT IDENTIFIER ::= { sysApplMIB 3 }
-- Textual Conventions
RunState ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This TC describes the current execution state of
a running application or process. The possible
3-67Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
values are:
running(1),
runnable(2), - waiting for a resource (CPU, etc.)
waiting(3), - waiting for an event
exiting(4),
other(5) - other invalid state"
SYNTAX INTEGER {
running (1),
runnable (2), -- waiting for resource (CPU, etc.)
waiting (3), -- waiting for event
exiting (4),
other (5) -- other invalid state
}
LongUtf8String ::= TEXTUAL-CONVENTION
DISPLAY-HINT "1024a"
STATUS current
DESCRIPTION
"To facilitate internationalization, this TC
represents information taken from the ISO/IEC IS
10646-1 character set, encoded as an octet string
using the UTF-8 character encoding scheme described
in RFC 2044 [10]. For strings in 7-bit US-ASCII,
there is no impact since the UTF-8 representation
is identical to the US-ASCII encoding."
SYNTAX OCTET STRING (SIZE (0..1024))
Utf8String ::= TEXTUAL-CONVENTION
DISPLAY-HINT "255a"
STATUS current
DESCRIPTION
"To facilitate internationalization, this TC
represents information taken from the ISO/IEC IS
10646-1 character set, encoded as an octet string
using the UTF-8 character encoding scheme described
in RFC 2044 [10]. For strings in 7-bit US-ASCII,
there is no impact since the UTF-8 representation
is identical to the US-ASCII encoding."
3-68Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
SYNTAX OCTET STRING (SIZE (0..255))
-- sysApplInstalled Group
-- This group provides information about application packages
-- that have been installed on the host computer. The group
-- contains two tables. The first, the sysApplInstallPkgTable,
-- describes the application packages, the second, the
-- sysApplInstallElmtTable, describes the constituent elements
-- (files and executables) which compose an application package.
--
-- In order to appear in this group, an application and its
-- component files must be discoverable by the system itself,
-- possibly through some type of software installation mechanism
-- or registry.
-- sysApplInstallPkgTable
-- The system installed application packages table provides
-- information on the software packages installed on a system.
-- These packages may consist of many different files including
-- executable and non-executable files.
sysApplInstallPkgTable OBJECT-TYPE
SYNTAX SEQUENCE OF SysApplInstallPkgEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The table listing the software application packages
installed on a host computer. In order to appear in
this table, it may be necessary for the application
to be installed using some type of software
installation mechanism or global registry so that its
existence can be detected by the agent implementation."
::= { sysApplInstalled 1 }
sysApplInstallPkgEntry OBJECT-TYPE
3-69Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
SYNTAX SysApplInstallPkgEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The logical row describing an installed application
package."
INDEX { sysApplInstallPkgIndex }
::= { sysApplInstallPkgTable 1 }
SysApplInstallPkgEntry ::= SEQUENCE {
sysApplInstallPkgIndex Unsigned32,
sysApplInstallPkgManufacturer Utf8String,
sysApplInstallPkgProductName Utf8String,
sysApplInstallPkgVersion Utf8String,
sysApplInstallPkgSerialNumber Utf8String,
sysApplInstallPkgDate DateAndTime,
sysApplInstallPkgLocation LongUtf8String
}
sysApplInstallPkgIndex OBJECT-TYPE
SYNTAX Unsigned32 (1..'ffffffff'h)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An integer used only for indexing purposes.
Generally monotonically increasing from 1 as new
applications are installed.
The value for each installed application must
remain constant at least from one re-initialization of
the network management entity which implements this
MIB module to the next re-initialization.
The specific value is meaningful only within a given SNMP
entity. A sysApplInstallPkgIndex value must not be re-used
until the next agent entity restart in the event the
installed application entry is deleted."
::= { sysApplInstallPkgEntry 1 }
3-70Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
sysApplInstallPkgManufacturer OBJECT-TYPE
SYNTAX Utf8String
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The Manufacturer of the software application package."
::= { sysApplInstallPkgEntry 2 }
sysApplInstallPkgProductName OBJECT-TYPE
SYNTAX Utf8String
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The name assigned to the software application package
by the Manufacturer."
::= { sysApplInstallPkgEntry 3 }
sysApplInstallPkgVersion OBJECT-TYPE
SYNTAX Utf8String
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The version number assigned to the application package
by the manufacturer of the software."
::= { sysApplInstallPkgEntry 4 }
sysApplInstallPkgSerialNumber OBJECT-TYPE
SYNTAX Utf8String
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The serial number of the software assigned by the
manufacturer."
::= { sysApplInstallPkgEntry 5 }
sysApplInstallPkgDate OBJECT-TYPE
SYNTAX DateAndTime
3-71Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The date and time this software application was installed
on the host."
::= { sysApplInstallPkgEntry 6 }
sysApplInstallPkgLocation OBJECT-TYPE
SYNTAX LongUtf8String
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The complete path name where the application package
is installed. For example, the value would be
'/opt/MyapplDir' if the application package was installed
in the /opt/MyapplDir directory."
::= { sysApplInstallPkgEntry 7 }
-- sysApplInstallElmtTable
-- The table describing the individual application package
-- elements (files and executables) installed on the host computer.
sysApplInstallElmtTable OBJECT-TYPE
SYNTAX SEQUENCE OF SysApplInstallElmtEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This table details the individual application package
elements (files and executables) which comprise the
applications defined in the sysApplInstallPkg Table.
Each entry in this table has an index to the
sysApplInstallPkg table to identify the application
package of which it is a part. As a result, there may
be many entries in this table for each instance in the
sysApplInstallPkg Table.
Table entries are indexed by sysApplInstallPkgIndex,
3-72Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
sysApplInstallElmtIndex to facilitate retrieval of
all elements associated with a particular installed
application package."
::= { sysApplInstalled 2 }
sysApplInstallElmtEntry OBJECT-TYPE
SYNTAX SysApplInstallElmtEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The logical row describing an element of an installed
application. The element may be an executable or
non-executable file."
INDEX {sysApplInstallPkgIndex, sysApplInstallElmtIndex}
::= { sysApplInstallElmtTable 1 }
SysApplInstallElmtEntry ::= SEQUENCE {
sysApplInstallElmtIndex Unsigned32,
sysApplInstallElmtName Utf8String,
sysApplInstallElmtType INTEGER,
sysApplInstallElmtDate DateAndTime,
sysApplInstallElmtPath LongUtf8String,
sysApplInstallElmtSizeHigh Unsigned32,
sysApplInstallElmtSizeLow Unsigned32,
-- sysApplInstallElmtRole BITS,
sysApplInstallElmtRole OCTET STRING,
sysApplInstallElmtModifyDate DateAndTime,
sysApplInstallElmtCurSizeHigh Unsigned32,
sysApplInstallElmtCurSizeLow Unsigned32
}
sysApplInstallElmtIndex OBJECT-TYPE
SYNTAX Unsigned32 (1..'ffffffff'h)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An arbitrary integer used for indexing. The value
3-73Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
of this index is unique among all rows in this table
that exist or have existed since the last agent restart."
::= { sysApplInstallElmtEntry 1 }
sysApplInstallElmtName OBJECT-TYPE
SYNTAX Utf8String
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The name of this element which is contained in the
application."
::= { sysApplInstallElmtEntry 2 }
sysApplInstallElmtType OBJECT-TYPE
SYNTAX INTEGER {
unknown(1),
nonexecutable(2),
operatingSystem(3), -- executable
deviceDriver(4), -- executable
application(5) -- executable
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The type of element that is part of the installed
application."
::= { sysApplInstallElmtEntry 3 }
sysApplInstallElmtDate OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The date and time that this component was installed on
the system."
::= { sysApplInstallElmtEntry 4 }
3-74Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
sysApplInstallElmtPath OBJECT-TYPE
SYNTAX LongUtf8String
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The full directory path where this element is installed.
For example, the value would be '/opt/EMPuma/bin' for an
element installed in the directory '/opt/EMPuma/bin'.
Most application packages include information about the
elements contained in the package. In addition, elements
are typically installed in sub-directories under the
package installation directory. In cases where the
element path names are not included in the package
information itself, the path can usually be determined
by a simple search of the sub-directories. If the
element is not installed in that location and there is
no other information available to the agent implementation,
then the path is unknown and null is returned."
::= { sysApplInstallElmtEntry 5}
sysApplInstallElmtSizeHigh OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The installed file size in 2^32 byte blocks. This is
the size of the file on disk immediately after installation.
For example, for a file with a total size of 4,294,967,296
bytes, this variable would have a value of 1; for a file
with a total size of 4,294,967,295 bytes this variable
would be 0."
::= { sysApplInstallElmtEntry 6 }
sysApplInstallElmtSizeLow OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
3-75Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
DESCRIPTION
"The installed file size modulo 2^32 bytes. This is
the size of the file on disk immediately after installation.
For example, for a file with a total size of 4,294,967,296
bytes this variable would have a value of 0; for a file with
a total size of 4,294,967,295 bytes this variable would be
4,294,967,295."
::= { sysApplInstallElmtEntry 7 }
sysApplInstallElmtRole OBJECT-TYPE
SYNTAX OCTET STRING(SIZE(1))
-- SYNTAX BITS {
-- executable(0),
-- An application may have one or
-- more executable elements. The rest of the
-- bits have no meaning if the element is not
-- executable.
-- exclusive(1),
-- Only one copy of an exclusive element may be
-- running per invocation of the running
-- application.
-- primary(2),
-- The primary executable. An application can
-- have one, and only one element that is designated
-- as the primary executable. The execution of
-- this element constitutes an invocation of
-- the application. This is used by the agent
-- implementation to determine the initiation of
-- an application. The primary executable must
-- remain running long enough for the agent
-- implementation to detect its presence.
-- required(3),
-- An application may have zero or more required
-- elements. All required elements must be running
-- in order for the application to be judged to be
-- running and healthy.
-- dependent(4),
3-76Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
-- An application may have zero or more
-- dependent elements. Dependent elements may
-- not be running unless required elements are.
-- unknown(5)
-- Default value for the case when an operator
-- has not yet assigned one of the other values.
-- When set, bits 1, 2, 3, and 4 have no meaning.
-- }
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"An operator assigned value used in the determination of
application status. This value is used by the agent to
determine both the mapping of started processes to the
initiation of an application, as well as to allow for a
determination of application health. The default value,
unknown(5), is used when an operator has not yet assigned
one of the other values. If unknown(5) is set, bits
1 - 4 have no meaning. The possible values are:
executable(0),
An application may have one or
more executable elements. The rest of the
bits have no meaning if the element is not
executable.
exclusive(1),
Only one copy of an exclusive element may be
running per invocation of the running
application.
primary(2),
The primary executable. An application can
have one, and only one element that is designated
as the primary executable. The execution of
this element constitutes an invocation of
the application. This is used by the agent
implementation to determine the initiation of
an application. The primary executable must
3-77Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
remain running long enough for the agent
implementation to detect its presence.
required(3),
An application may have zero or more required
elements. All required elements must be running
in order for the application to be judged to be
running and healthy.
dependent(4),
An application may have zero or more
dependent elements. Dependent elements may
not be running unless required elements are.
unknown(5)
Default value for the case when an operator
has not yet assigned one of the other values.
When set, bits 1, 2, 3, and 4 have no meaning.
sysApplInstallElmtRole is used by the agent implementation
in determining the initiation of an application, the
current state of a running application (see
sysApplRunCurrentState), when an application invocation is
no longer running, and the exit status of a terminated
application invocation (see sysApplPastRunExitState)."
-- DEFVAL { 5 }
::= { sysApplInstallElmtEntry 8 }
sysApplInstallElmtModifyDate OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The date and time that this element was last modified.
Modification of the sysApplInstallElmtRole columnar
object does NOT constitute a modification of the element
itself and should not affect the value of this object."
::= { sysApplInstallElmtEntry 9 }
sysApplInstallElmtCurSizeHigh OBJECT-TYPE
SYNTAX Unsigned32
3-78Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The current file size in 2^32 byte blocks.
For example, for a file with a total size of 4,294,967,296
bytes, this variable would have a value of 1; for a file
with a total size of 4,294,967,295 bytes this variable
would be 0."
::= { sysApplInstallElmtEntry 10 }
sysApplInstallElmtCurSizeLow OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The current file size modulo 2^32 bytes.
For example, for a file with a total size of 4,294,967,296
bytes this variable would have a value of 0; for a file with
a total size of 4,294,967,295 bytes this variable would be
4,294,967,295."
::= { sysApplInstallElmtEntry 11 }
-- sysApplRun Group
-- This group models activity information for applications
-- that have been invoked and are either currently running,
-- or have previously run on the host system. Likewise,
-- the individual elements of an invoked application are
-- also modeled to show currently running processes, and
-- processes that have run in the past.
-- sysApplRunTable
-- The sysApplRunTable contains the application instances
-- which are currently running on the host. Since a single
-- application might be invoked multiple times, an entry is
-- added to this table for each INVOCATION of an application.
-- The table is indexed by sysApplInstallPkgIndex, sysApplRunIndex
3-79Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
-- to enable managers to easily locate all invocations of
-- a particular application package.
sysApplRunTable OBJECT-TYPE
SYNTAX SEQUENCE OF SysApplRunEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The table describes the applications which are executing
on the host. Each time an application is invoked,
an entry is created in this table. When an application ends,
the entry is removed from this table and a corresponding
entry is created in the SysApplPastRunTable.
A new entry is created in this table whenever the agent
implementation detects a new running process that is an
installed application element whose sysApplInstallElmtRole
designates it as being the application's primary executable
(sysApplInstallElmtRole = primary(2) ).
The table is indexed by sysApplInstallPkgIndex,
sysApplRunIndex to enable managers to easily locate all
invocations of a particular application package."
::= { sysApplRun 1 }
sysApplRunEntry OBJECT-TYPE
SYNTAX SysApplRunEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The logical row describing an application which is
currently running on this host."
INDEX { sysApplInstallPkgIndex, sysApplRunIndex }
::= { sysApplRunTable 1 }
SysApplRunEntry ::= SEQUENCE {
sysApplRunIndex Unsigned32,
sysApplRunStarted DateAndTime,
3-80Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
sysApplRunCurrentState RunState
}
sysApplRunIndex OBJECT-TYPE
SYNTAX Unsigned32 (1..'ffffffff'h)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Part of the index for this table. An arbitrary
integer used only for indexing purposes. Generally
monotonically increasing from 1 as new applications are
started on the host, it uniquely identifies application
invocations.
The numbering for this index increases by 1 for each
INVOCATION of an application, regardless of which
installed application package this entry represents a
running instance of.
An example of the indexing for a couple of entries is
shown below.
:
sysApplRunStarted.17.14
sysApplRunStarted.17.63
sysApplRunStarted.18.13
:
In this example, the agent has observed 12 application
invocations when the application represented by entry 18
in the sysApplInstallPkgTable is invoked. The next
invocation detected by the agent is an invocation of
installed application package 17. Some time later,
installed application 17 is invoked a second time.
NOTE: this index is not intended to reflect a real-time
(wall clock time) ordering of application invocations;
it is merely intended to uniquely identify running
3-81Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
instances of applications. Although the
sysApplInstallPkgIndex is included in the INDEX clause
for this table, it serves only to ease searching of
this table by installed application and does not
contribute to uniquely identifying table entries."
::= { sysApplRunEntry 1 }
sysApplRunStarted OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The date and time that the application was started."
::= { sysApplRunEntry 2 }
sysApplRunCurrentState OBJECT-TYPE
SYNTAX RunState
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The current state of the running application instance.
The possible values are running(1), runnable(2) but waiting
for a resource such as CPU, waiting(3) for an event,
exiting(4), or other(5). This value is based on an evaluation
of the running elements of this application instance (see
sysApplElmRunState) and their Roles as defined by
sysApplInstallElmtRole. An agent implementation may
detect that an application instance is in the process of
exiting if one or more of its REQUIRED elements are no
longer running. Most agent implementations will wait until
a second internal poll has been completed to give the
system time to start REQUIRED elements before marking the
application instance as exiting."
::= { sysApplRunEntry 3 }
-- sysApplPastRunTable
-- The sysApplPastRunTable provides a history of applications
3-82Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
-- previously run on the host computer. Entries are removed from
-- the sysApplRunTable and corresponding entries are added to this
-- table when an application becomes inactive. Entries remain in
-- this table until they are aged out when either the table size
-- reaches a maximum as determined by the sysApplPastRunMaxRows,
-- or when an entry has aged to exceed a time limit as set be
-- sysApplPastRunTblTimeLimit.
--
-- When aging out entries, the oldest entry, as determined by
-- the value of sysApplPastRunTimeEnded, will be removed first.
sysApplPastRunTable OBJECT-TYPE
SYNTAX SEQUENCE OF SysApplPastRunEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A history of the applications that have previously run
on the host computer. An entry's information is moved to
this table from the sysApplRunTable when the invoked
application represented by the entry ceases to be running.
An agent implementation can determine that an application
invocation is no longer running by evaluating the running
elements of the application instance and their Roles as
defined by sysApplInstallElmtRole. Obviously, if there
are no running elements for the application instance,
then the application invocation is no longer running.
If any one of the REQUIRED elements is not running,
the application instance may be in the process of exiting.
Most agent implementations will wait until a second internal
poll has been completed to give the system time to either
restart partial failures or to give all elements time to
exit. If, after the second poll, there are REQUIRED
elements that are not running, then the application
instance may be considered by the agent implementation
to no longer be running.
Entries remain in the sysApplPastRunTable until they
3-83Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
are aged out when either the table size reaches a maximum
as determined by the sysApplPastRunMaxRows, or when an entry
has aged to exceed a time limit as set by
sysApplPastRunTblTimeLimit.
Entries in this table are indexed by sysApplInstallPkgIndex,
sysApplPastRunIndex to facilitate retrieval of all past
run invocations of a particular installed application."
::= { sysApplRun 2 }
sysApplPastRunEntry OBJECT-TYPE
SYNTAX SysApplPastRunEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The logical row describing an invocation of an application
which was previously run and has terminated. The entry
is basically copied from the sysApplRunTable when the
application instance terminates. Hence, the entry's
value for sysApplPastRunIndex is the same as its value was
for sysApplRunIndex."
INDEX { sysApplInstallPkgIndex, sysApplPastRunIndex }
::= { sysApplPastRunTable 1 }
SysApplPastRunEntry ::= SEQUENCE {
sysApplPastRunIndex Unsigned32,
sysApplPastRunStarted DateAndTime,
sysApplPastRunExitState INTEGER,
sysApplPastRunTimeEnded DateAndTime
}
sysApplPastRunIndex OBJECT-TYPE
SYNTAX Unsigned32 (1..'ffffffff'h)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Part of the index for this table. An integer
matching the value of the removed sysApplRunIndex
3-84Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
corresponding to this row."
::= { sysApplPastRunEntry 1 }
sysApplPastRunStarted OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The date and time that the application was started."
::= { sysApplPastRunEntry 2 }
sysApplPastRunExitState OBJECT-TYPE
SYNTAX INTEGER {
complete (1), -- normal exit at sysApplRunTimeEnded
failed (2), -- abnormal exit
other (3)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The state of the application instance when it terminated.
This value is based on an evaluation of the running elements
of an application and their Roles as defined by
sysApplInstallElmtRole. An application instance is said to
have exited in a COMPLETE state and its entry is removed
from the sysApplRunTable and added to the sysApplPastRunTable
when the agent detects that ALL elements of an application
invocation are no longer running. Most agent implementations
will wait until a second internal poll has been completed to
give the system time to either restart partial failures or
to give all elements time to exit. A failed state occurs if,
after the second poll, any elements continue to run but
one or more of the REQUIRED elements are no longer running.
All other combinations MUST be defined as OTHER."
::= { sysApplPastRunEntry 3 }
sysApplPastRunTimeEnded OBJECT-TYPE
SYNTAX DateAndTime
3-85Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The DateAndTime the application instance was determined
to be no longer running."
::= { sysApplPastRunEntry 4 }
-- sysApplElmtRunTable
-- The sysApplElmtRunTable contains an entry for each process that
-- is currently running on the host. An entry is created in
-- this table for each process at the time it is started, and will
-- remain in the table until the process terminates.
--
-- The table is indexed by sysApplElmtRunInstallPkg,
-- sysApplElmtRunInvocID, and sysApplElmtRunIndex to make it easy
-- to locate all running elements of a particular invoked application
-- which has been installed on the system.
sysApplElmtRunTable OBJECT-TYPE
SYNTAX SEQUENCE OF SysApplElmtRunEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The table describes the processes which are
currently executing on the host system. Each entry
represents a running process and is associated with
the invoked application of which that process is a part, if
possible. This table contains an entry for every process
currently running on the system, regardless of whether its
'parent' application can be determined. So, for example,
processes like 'ps' and 'grep' will have entries though they
are not associated with an installed application package.
Because a running application may involve
more than one executable, it is possible to have
multiple entries in this table for each application.
Entries are removed from this table when the process
3-86Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
terminates.
The table is indexed by sysApplElmtRunInstallPkg,
sysApplElmtRunInvocID, and sysApplElmtRunIndex to
facilitate the retrieval of all running elements of a
particular invoked application which has been installed on
the system."
::= { sysApplRun 3 }
sysApplElmtRunEntry OBJECT-TYPE
SYNTAX SysApplElmtRunEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The logical row describing a process currently
running on this host. When possible, the entry is
associated with the invoked application of which it
is a part."
INDEX { sysApplElmtRunInstallPkg, sysApplElmtRunInvocID,
sysApplElmtRunIndex }
::= { sysApplElmtRunTable 1 }
SysApplElmtRunEntry ::= SEQUENCE {
sysApplElmtRunInstallPkg Unsigned32,
sysApplElmtRunInvocID Unsigned32,
sysApplElmtRunIndex Unsigned32,
sysApplElmtRunInstallID Unsigned32,
sysApplElmtRunTimeStarted DateAndTime,
sysApplElmtRunState RunState,
sysApplElmtRunName LongUtf8String,
sysApplElmtRunParameters Utf8String,
sysApplElmtRunCPU TimeTicks,
sysApplElmtRunMemory Gauge32,
sysApplElmtRunNumFiles Gauge32,
sysApplElmtRunUser Utf8String
}
sysApplElmtRunInstallPkg OBJECT-TYPE
SYNTAX Unsigned32 (0..'ffffffff'h)
3-87Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Part of the index for this table, this value
identifies the installed software package for
the application of which this process is a part.
Provided that the process's 'parent' application can be
determined, the value of this object is the same
value as the sysApplInstallPkgIndex for the
entry in the sysApplInstallPkgTable that corresponds
to the installed application of which this process
is a part.
If, however, the 'parent' application cannot be
determined, (for example the process is not part
of a particular installed application), the value
for this object is then '0', signifying that this
process cannot be related back to an application,
and in turn, an installed software package."
::= { sysApplElmtRunEntry 1 }
sysApplElmtRunInvocID OBJECT-TYPE
SYNTAX Unsigned32 (0..'ffffffff'h)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Part of the index for this table, this value
identifies the invocation of an application of which
this process is a part. Provided that the 'parent'
application can be determined, the value of this object
is the same value as the sysApplRunIndex for the
corresponding application invocation in the
sysApplRunTable.
If, however, the 'parent' application cannot be
determined, the value for this object is then '0',
signifying that this process cannot be related back
to an invocation of an application in the
3-88Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
sysApplRunTable."
::= { sysApplElmtRunEntry 2 }
sysApplElmtRunIndex OBJECT-TYPE
SYNTAX Unsigned32 (0..'ffffffff'h)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Part of the index for this table. A unique value
for each process running on the host. Wherever
possible, this should be the system's native, unique
identification number."
::= { sysApplElmtRunEntry 3 }
sysApplElmtRunInstallID OBJECT-TYPE
SYNTAX Unsigned32 (0..'ffffffff'h)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The index into the sysApplInstallElmtTable. The
value of this object is the same value as the
sysApplInstallElmtIndex for the application element
of which this entry represents a running instance.
If this process cannot be associated with an installed
executable, the value should be '0'."
::= { sysApplElmtRunEntry 4 }
sysApplElmtRunTimeStarted OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The time the process was started."
::= { sysApplElmtRunEntry 5 }
sysApplElmtRunState OBJECT-TYPE
SYNTAX RunState
3-89Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The current state of the running process. The
possible values are running(1), runnable(2) but waiting
for a resource such as CPU, waiting(3) for an event,
exiting(4), or other(5)."
::= { sysApplElmtRunEntry 6 }
sysApplElmtRunName OBJECT-TYPE
SYNTAX LongUtf8String
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The full path and filename of the process.
For example, '/opt/MYYpkg/bin/myyproc' would
be returned for process 'myyproc' whose execution
path is '/opt/MYYpkg/bin/myyproc'."
::= { sysApplElmtRunEntry 7 }
sysApplElmtRunParameters OBJECT-TYPE
SYNTAX Utf8String
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The starting parameters for the process."
::= { sysApplElmtRunEntry 8 }
sysApplElmtRunCPU OBJECT-TYPE
SYNTAX TimeTicks
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of centi-seconds of the total system's
CPU resources consumed by this process. Note that
on a multi-processor system, this value may
have been incremented by more than one centi-second
in one centi-second of real (wall clock) time."
3-90Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
::= { sysApplElmtRunEntry 9 }
sysApplElmtRunMemory OBJECT-TYPE
SYNTAX Gauge32
UNITS "Kbytes"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total amount of real system memory measured in
Kbytes currently allocated to this process."
::= { sysApplElmtRunEntry 10 }
sysApplElmtRunNumFiles OBJECT-TYPE
SYNTAX Gauge32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of regular files currently open by the
process. Transport connections (sockets)
should NOT be included in the calculation of
this value, nor should operating system specific
special file types."
::= { sysApplElmtRunEntry 11 }
sysApplElmtRunUser OBJECT-TYPE
SYNTAX Utf8String
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The process owner's login name (e.g. root)."
::= { sysApplElmtRunEntry 12 }
-- sysApplElmtPastRunTable
-- The sysApplElmtPastRunTable maintains a history of
-- processes which have previously executed on
-- the host as part of an application. Upon termination
-- of a process, the entry representing the process is removed from
3-91Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
-- the sysApplElmtRunTable and a corresponding entry is created in
-- this table provided that the process was part of an
-- identifiable application. If the process could not be associated
-- with an invoked application, no corresponding entry is created.
-- Hence, whereas the sysApplElmtRunTable contains an entry for
-- every process currently executing on the system, the
-- sysApplElmtPastRunTable only contains entries for processes
-- that previously executed as part of an invoked application.
--
-- Entries remain in this table until they are aged out when
-- either the number of entries in the table reaches a
-- maximum as determined by sysApplElmtPastRunMaxRows, or
-- when an entry has aged to exceed a time limit as set by
-- sysApplElmtPastRunTblTimeLimit. When aging out entries,
-- the oldest entry, as determined by the value of
-- sysApplElmtPastRunTimeEnded, will be removed first.
--
-- The table is indexed by sysApplInstallPkgIndex (from the
-- sysApplInstallPkgTable), sysApplElmtPastRunInvocID, and
-- sysApplElmtPastRunIndex to make it easy to locate all
-- previously executed processes of a particular invoked application
-- that has been installed on the system.
sysApplElmtPastRunTable OBJECT-TYPE
SYNTAX SEQUENCE OF SysApplElmtPastRunEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The table describes the processes which have previously
executed on the host system as part of an application.
Each entry represents a process which has previously
executed and is associated with the invoked application
of which it was a part. Because an invoked application
may involve more than one executable, it is possible
to have multiple entries in this table for
each application invocation. Entries are added
to this table when the corresponding process in the
3-92Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
sysApplElmtRun Table terminates.
Entries remain in this table until they are aged out when
either the number of entries in the table reaches a
maximum as determined by sysApplElmtPastRunMaxRows, or
when an entry has aged to exceed a time limit as set by
sysApplElmtPastRunTblTimeLimit. When aging out entries,
the oldest entry, as determined by the value of
sysApplElmtPastRunTimeEnded, will be removed first.
The table is indexed by sysApplInstallPkgIndex (from the
sysApplInstallPkgTable), sysApplElmtPastRunInvocID,
and sysApplElmtPastRunIndex to make it easy to locate all
previously executed processes of a particular invoked
application that has been installed on the system."
::= { sysApplRun 4 }
sysApplElmtPastRunEntry OBJECT-TYPE
SYNTAX SysApplElmtPastRunEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The logical row describing a process which was
previously executed on this host as part of an
installed application. The entry is basically copied
from the sysApplElmtRunTable when the process
terminates. Hence, the entry's value for
sysApplElmtPastRunIndex is the same as its value
was for sysApplElmtRunIndex. Note carefully: only those
processes which could be associated with an
identified application are included in this table."
INDEX { sysApplInstallPkgIndex, sysApplElmtPastRunInvocID,
sysApplElmtPastRunIndex }
::= { sysApplElmtPastRunTable 1 }
SysApplElmtPastRunEntry ::= SEQUENCE {
sysApplElmtPastRunInvocID Unsigned32,
sysApplElmtPastRunIndex Unsigned32,
3-93Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
sysApplElmtPastRunInstallID Unsigned32,
sysApplElmtPastRunTimeStarted DateAndTime,
sysApplElmtPastRunTimeEnded DateAndTime,
sysApplElmtPastRunName LongUtf8String,
sysApplElmtPastRunParameters Utf8String,
sysApplElmtPastRunCPU TimeTicks,
sysApplElmtPastRunMemory Unsigned32,
sysApplElmtPastRunNumFiles Unsigned32,
sysApplElmtPastRunUser Utf8String
}
sysApplElmtPastRunInvocID OBJECT-TYPE
SYNTAX Unsigned32 (1..'ffffffff'h)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Part of the index for this table, this value
identifies the invocation of an application of which
the process represented by this entry was a part.
The value of this object is the same value as the
sysApplRunIndex for the corresponding application
invocation in the sysApplRunTable. If the invoked
application as a whole has terminated, it will be the
same as the sysApplPastRunIndex."
::= { sysApplElmtPastRunEntry 1 }
sysApplElmtPastRunIndex OBJECT-TYPE
SYNTAX Unsigned32 (0..'ffffffff'h)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Part of the index for this table. An integer
assigned by the agent equal to the corresponding
sysApplElmtRunIndex which was removed from the
sysApplElmtRunTable and moved to this table
when the element terminated.
Note: entries in this table are indexed by
3-94Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
sysApplElmtPastRunInvocID, sysApplElmtPastRunIndex.
The possibility exists, though unlikely, of a
collision occurring by a new entry which was run
by the same invoked application (InvocID), and
was assigned the same process identification number
(ElmtRunIndex) as an element which was previously
run by the same invoked application.
Should this situation occur, the new entry replaces
the old entry.
See Section: 'Implementation Issues -
sysApplElmtPastRunTable Entry Collisions' for the
conditions that would have to occur in order for a
collision to occur."
::= { sysApplElmtPastRunEntry 2 }
sysApplElmtPastRunInstallID OBJECT-TYPE
SYNTAX Unsigned32 (1..'ffffffff'h)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The index into the installed element table. The
value of this object is the same value as the
sysApplInstallElmtIndex for the application element
of which this entry represents a previously executed
process."
::= { sysApplElmtPastRunEntry 3 }
sysApplElmtPastRunTimeStarted OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The time the process was started."
::= { sysApplElmtPastRunEntry 4 }
3-95Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
sysApplElmtPastRunTimeEnded OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The time the process ended."
::= { sysApplElmtPastRunEntry 5 }
sysApplElmtPastRunName OBJECT-TYPE
SYNTAX LongUtf8String
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The full path and filename of the process.
For example, '/opt/MYYpkg/bin/myyproc' would
be returned for process 'myyproc' whose execution
path was '/opt/MYYpkg/bin/myyproc'."
::= { sysApplElmtPastRunEntry 6 }
sysApplElmtPastRunParameters OBJECT-TYPE
SYNTAX Utf8String
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The starting parameters for the process."
::= { sysApplElmtPastRunEntry 7 }
sysApplElmtPastRunCPU OBJECT-TYPE
SYNTAX TimeTicks
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The last known number of centi-seconds of the total
system's CPU resources consumed by this process.
Note that on a multi-processor system, this value may
increment by more than one centi-second in one
centi-second of real (wall clock) time."
::= { sysApplElmtPastRunEntry 8 }
3-96Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
sysApplElmtPastRunMemory OBJECT-TYPE
SYNTAX Unsigned32 (0..'ffffffff'h)
UNITS "Kbytes"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The last known total amount of real system memory
measured in Kbytes allocated to this process before it
terminated."
::= { sysApplElmtPastRunEntry 9 }
sysApplElmtPastRunNumFiles OBJECT-TYPE
SYNTAX Unsigned32 (0..'ffffffff'h)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The last known number of files open by the
process before it terminated. Transport
connections (sockets) should NOT be included in
the calculation of this value."
::= { sysApplElmtPastRunEntry 10 }
sysApplElmtPastRunUser OBJECT-TYPE
SYNTAX Utf8String
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The process owner's login name (e.g. root)."
::= { sysApplElmtPastRunEntry 11 }
-- Additional Scalar objects to control table sizes
sysApplPastRunMaxRows OBJECT-TYPE
SYNTAX Unsigned32 (0..'ffffffff'h)
MAX-ACCESS read-write
STATUS current
3-97Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
DESCRIPTION
"The maximum number of entries allowed in the
sysApplPastRunTable. Once the number of rows in
the sysApplPastRunTable reaches this value, the
management subsystem will remove the oldest entry
in the table to make room for the new entry to be added.
Entries will be removed on the basis of oldest
sysApplPastRunTimeEnded value first.
This object may be used to control the amount of
system resources that can used for sysApplPastRunTable
entries. A conforming implementation should attempt
to support the default value, however, a lesser value
may be necessary due to implementation-dependent issues
and resource availability."
DEFVAL { 500 }
::= { sysApplRun 5 }
sysApplPastRunTableRemItems OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A counter of the number of entries removed from
the sysApplPastRunTable because of table size limitations
as set in sysApplPastRunMaxRows. This counter is the
number of entries the management subsystem has had to
remove in order to make room for new entries (so as not
to exceed the limit set by sysApplPastRunMaxRows) since
the last initialization of the management subsystem."
::= { sysApplRun 6 }
sysApplPastRunTblTimeLimit OBJECT-TYPE
SYNTAX Unsigned32 (0..'ffffffff'h)
UNITS "seconds"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
3-98Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
"The maximum time in seconds which an entry in the
sysApplPastRunTable may exist before it is removed.
Any entry that is older than this value will be
removed (aged out) from the table.
Note that an entry may be aged out prior to reaching
this time limit if it is the oldest entry in the
table and must be removed to make space for a new
entry so as to not exceed sysApplPastRunMaxRows."
DEFVAL { 7200 }
::= { sysApplRun 7 }
sysApplElemPastRunMaxRows OBJECT-TYPE
SYNTAX Unsigned32 (0..'ffffffff'h)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The maximum number of entries allowed in the
sysApplElmtPastRunTable. Once the number of rows in
the sysApplElmtPastRunTable reaches this value,
the management subsystem will remove the oldest entry
to make room for the new entry to be added. Entries
will be removed on the basis of oldest
sysApplElmtPastRunTimeEnded value first.
This object may be used to control the amount of
system resources that can used for sysApplElemPastRunTable
entries. A conforming implementation should attempt
to support the default value, however, a lesser value
may be necessary due to implementation-dependent issues
and resource availability."
DEFVAL { 500 }
::= { sysApplRun 8 }
sysApplElemPastRunTableRemItems OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
3-99Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
"A counter of the number of entries removed from the
sysApplElemPastRunTable because of table size limitations
as set in sysApplElemPastRunMaxRows. This counter is the
number of entries the management subsystem has had to
remove in order to make room for new entries (so as not
to exceed the limit set by sysApplElemPastRunMaxRows) since
the last initialization of the management subsystem."
::= { sysApplRun 9 }
sysApplElemPastRunTblTimeLimit OBJECT-TYPE
SYNTAX Unsigned32 (0..'ffffffff'h)
UNITS "seconds"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The maximum time in seconds which an entry in the
sysApplElemPastRunTable may exist before it is removed.
Any entry that is older than this value will be
removed (aged out) from the table.
Note that an entry may be aged out prior to reaching
this time limit if it is the oldest entry in the
table and must be removed to make space for a new
entry so as to not exceed sysApplElemPastRunMaxRows."
DEFVAL { 7200 }
::= { sysApplRun 10 }
sysApplAgentPollInterval OBJECT-TYPE
SYNTAX Unsigned32 (0..'ffffffff'h)
UNITS "seconds"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The minimum interval in seconds that the management
subsystem implementing this MIB will poll the status
of the managed resources. Because of the non-trivial
effort involved in polling the managed resources,
and because the method for obtaining the status of
3-100Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
the managed resources is implementation-dependent,
a conformant implementation may chose a lower bound
greater than 0.
A value of 0 indicates that there is no delay
in the passing of information from the managed
resources to the agent."
DEFVAL { 60 }
::= { sysApplRun 11 }
-- sysApplMap Group
-- This group contains a table, the sysApplMapTable,
-- whose sole purpose is to provide a 'backwards'
-- mapping so that, given a known sysApplElmtRunIndex
-- (process identification number), the corresponding invoked
-- application (sysApplRunIndex), installed element
-- (sysApplInstallElmtIndex), and installed application
-- package (sysApplInstallPkgIndex) can be quickly determined.
--
-- The table will contain one entry for each process
-- currently running on the system.
--
-- A backwards mapping is extremely useful since the tables
-- in this MIB module are typically indexed with the
-- installed application package (sysApplInstallPkgIndex)
-- as the primary key, and on down as required by the
-- specific table, with the process ID number (sysApplElmtRunIndex)
-- being the least significant key.
--
-- It is expected that management applications will use
-- this mapping table by doing a 'GetNext' operation with
-- the known process ID number (sysApplElmtRunIndex) as the partial
-- instance identifier. Assuming that there is an entry for
-- the process, the result should return a single columnar value,
-- the sysApplMapInstallPkgIndex, with the sysApplElmtRunIndex,
-- sysApplRunIndex, and sysApplInstallElmtIndex contained in the
-- instance identifier for the returned MIB object value.
3-101Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
--
-- NOTE: if the process can not be associated back to an
-- invoked application installed on the system, then the
-- value returned for the columnar value sysApplMapInstallPkgIndex
-- will be '0' and the instance portion of the object-identifier
-- will be the process ID number (sysApplElmtRunIndex) followed
-- by 0.0.
sysApplMapTable OBJECT-TYPE
SYNTAX SEQUENCE OF SysApplMapEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The sole purpose of this table is to provide a
'backwards' mapping so that, given a known
sysApplElmtRunIndex (process identification number),
the corresponding invoked application (sysApplRunIndex),
installed element (sysApplInstallElmtIndex), and
installed application package (sysApplInstallPkgIndex)
can be quickly determined.
This table will contain one entry for each process
that is currently executing on the system.
It is expected that management applications will use
this mapping table by doing a 'GetNext' operation with
the known process ID number (sysApplElmtRunIndex) as the
partial instance identifier. Assuming that there is an
entry for the process, the result should return a single
columnar value, the sysApplMapInstallPkgIndex, with the
sysApplElmtRunIndex, sysApplRunIndex, and
sysApplInstallElmtIndex contained in the instance identifier
for the returned MIB object value.
NOTE: if the process can not be associated back to an
invoked application installed on the system, then the
value returned for the columnar value
sysApplMapInstallPkgIndex will be '0' and the instance
3-102Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
portion of the object-identifier will be the process ID
number (sysApplElmtRunIndex) followed by 0.0."
::= { sysApplMap 1 }
sysApplMapEntry OBJECT-TYPE
SYNTAX SysApplMapEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A logical row representing a process currently running
on the system. This entry provides the index mapping from
process identifier, back to the invoked application,
installed element, and finally, the installed application
package. The entry includes only one accessible columnar
object, the sysApplMapInstallPkgIndex, but the
invoked application and installed element can be
determined from the instance identifier since they form
part of the index clause."
INDEX { sysApplElmtRunIndex, sysApplElmtRunInvocID,
sysApplMapInstallElmtIndex }
::= { sysApplMapTable 1 }
SysApplMapEntry ::= SEQUENCE {
sysApplMapInstallElmtIndex Unsigned32,
sysApplMapInstallPkgIndex Unsigned32
}
sysApplMapInstallElmtIndex OBJECT-TYPE
SYNTAX Unsigned32 (0..'ffffffff'h)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The index into the sysApplInstallElmtTable. The
value of this object is the same value as the
sysApplInstallElmtIndex for the application element
of which this entry represents a running instance.
If this process cannot be associated to an installed
executable, the value should be '0'."
3-103Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
::= { sysApplMapEntry 1 }
sysApplMapInstallPkgIndex OBJECT-TYPE
SYNTAX Unsigned32 (0..'ffffffff'h)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The value of this object identifies the installed
software package for the application of which this
process is a part. Provided that the process's 'parent'
application can be determined, the value of this object
is the same value as the sysApplInstallPkgIndex for the
entry in the sysApplInstallPkgTable that corresponds
to the installed application of which this process
is a part.
If, however, the 'parent' application cannot be
determined, (for example the process is not part
of a particular installed application), the value
for this object is then '0', signifying that this
process cannot be related back to an application,
and in turn, an installed software package."
::= { sysApplMapEntry 2 }
-- Conformance Macros
sysApplMIBCompliances OBJECT IDENTIFIER ::= { sysApplConformance 1 }
sysApplMIBGroups OBJECT IDENTIFIER ::= { sysApplConformance 2 }
sysApplMIBCompliance MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"Describes the requirements for conformance to
the System Application MIB"
MODULE -- this module
MANDATORY-GROUPS { sysApplInstalledGroup,
sysApplRunGroup, sysApplMapGroup }
::= { sysApplMIBCompliances 1 }
3-104Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
sysApplInstalledGroup OBJECT-GROUP
OBJECTS { sysApplInstallPkgManufacturer,
sysApplInstallPkgProductName,
sysApplInstallPkgVersion,
sysApplInstallPkgSerialNumber,
sysApplInstallPkgDate,
sysApplInstallPkgLocation,
sysApplInstallElmtName,
sysApplInstallElmtType,
sysApplInstallElmtDate,
sysApplInstallElmtPath,
sysApplInstallElmtSizeHigh,
sysApplInstallElmtSizeLow,
sysApplInstallElmtRole,
sysApplInstallElmtModifyDate,
sysApplInstallElmtCurSizeHigh,
sysApplInstallElmtCurSizeLow }
STATUS current
DESCRIPTION
"The system application installed group contains
information about applications and their constituent
components which have been installed on the host system."
::= { sysApplMIBGroups 1 }
sysApplRunGroup OBJECT-GROUP
OBJECTS { sysApplRunStarted,
sysApplRunCurrentState,
sysApplPastRunStarted,
sysApplPastRunExitState,
sysApplPastRunTimeEnded,
sysApplElmtRunInstallID,
sysApplElmtRunTimeStarted,
sysApplElmtRunState,
sysApplElmtRunName,
sysApplElmtRunParameters,
sysApplElmtRunCPU,
sysApplElmtRunMemory,
3-105Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Base Level MIB Support
sysApplElmtRunNumFiles,
sysApplElmtRunUser,
sysApplElmtPastRunInstallID,
sysApplElmtPastRunTimeStarted,
sysApplElmtPastRunTimeEnded,
sysApplElmtPastRunName,
sysApplElmtPastRunParameters,
sysApplElmtPastRunCPU,
sysApplElmtPastRunMemory,
sysApplElmtPastRunNumFiles,
sysApplElmtPastRunUser,
sysApplPastRunMaxRows,
sysApplPastRunTableRemItems,
sysApplPastRunTblTimeLimit,
sysApplElemPastRunMaxRows,
sysApplElemPastRunTableRemItems,
sysApplElemPastRunTblTimeLimit,
sysApplAgentPollInterval }
STATUS current
DESCRIPTION
"The system application run group contains information
about applications and associated elements which have
run or are currently running on the host system."
::= { sysApplMIBGroups 2 }
sysApplMapGroup OBJECT-GROUP
OBJECTS { sysApplMapInstallPkgIndex }
STATUS current
DESCRIPTION
"The Map Group contains a single table, sysApplMapTable,
that provides a backwards mapping for determining the
invoked application, installed element, and installed
application package given a known process identification
number."
::= { sysApplMIBGroups 3 }
END
3-106Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Monitoring and Fault Management
UCCX Monitoring and Fault ManagementThis section provides the MIB information related to monitoring and managing UCCX
Network StatisticsUCCX does not explicitly provide any network specific info via any MIBs or by other means. However, some of the common platform MIBs might contain relevant information.
UCCX Product Specific InformationProduct specific information is refers to things like servername, IP, MAC address, application, version including patch level, start time or runtime, license info, etc.
Product specific information is available from different sources as follows:
• Servername, IP and MAC address will be available via the platform MIBs.
• Application components, version information will be available via the web service on UCCX. We show component status and version info in SysAppl MIB
• Start time and run time information will be available from the HOST-RESOURCES-MIB (details of running processes).
UCCX ServicesUCCX supports various features with the help of subsystems. The running status of these subsystems can be obtained by monitoring the SNMP Traps that signal that certain subsystems are in-service, out-of-service or partial-service.
There is no separate API to obtain a list of currently offered services.
Service status is perhaps the only information worth presenting.
UCCX Specific MIB The CISCO-VOICE-APPS-MIB is the only UCCX specific MIB. The CISCO-VOICE-APPS-MIB provides information about supported SNMP traps for the Unified CCX subsystems and processes. One can set up SNMP traps to automatically notify the Network Administrators of high-severity messages and errors that come from the UCCX components. The CISCO-VOICE-APPS-MIB SubAgent can send traps that identify these important system events.
It also provides information about the UCCX Workflow Application information such as Auto Attendant and Integrated Contact Distribution applications installed on UNIFIED CCX.
CISCO-VOICE-APPS-MIB
This section contain the text of the CISCO-VOICE-APPS-MIB.
CISCO-VOICE-APPS-MIB DEFINITIONS ::= BEGIN
3-107Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Monitoring and Fault Management
IMPORTS
MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE,
Unsigned32
FROM SNMPv2-SMI
DisplayString, TruthValue
FROM SNMPv2-TC
SnmpAdminString
FROM SNMP-FRAMEWORK-MIB
MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
FROM SNMPv2-CONF
ciscoMgmt
FROM CISCO-SMI;
ciscoVoiceAppsMIB MODULE-IDENTITY
LAST-UPDATED "200512220000Z"
ORGANIZATION "Cisco Systems, Inc."
CONTACT-INFO
" Cisco Systems
Customer Service
Postal: 170 W. Tasman Drive
San Jose, CA 95134
USA
Tel: +1 800 553-NETS
E-mail: [email protected]"
DESCRIPTION
"The MIB Module for the management of Cisco Voice
Applications. This MIB is designed to work in
conjunction with the SYSAPPL-MIB to provide status
monitoring, provisioning and notification."
REVISION "200512220000Z"
DESCRIPTION
"Imported Unsigned32 from SNMPv2-SMI instead
of CISCO-TC."
3-108Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Monitoring and Fault Management
REVISION "200102260000Z"
DESCRIPTION
"The initial version of this MIB module."
::= { ciscoMgmt 190 }
ciscoVoiceAppsMIBObjects OBJECT IDENTIFIER ::=
{ ciscoVoiceAppsMIB 1 }
cvaGeneralInfo OBJECT IDENTIFIER ::=
{ ciscoVoiceAppsMIBObjects 1 }
cvaModuleFailureInfo OBJECT IDENTIFIER ::=
{ ciscoVoiceAppsMIBObjects 2 }
--
-- THE APPLICATION WORKFLOW INSTALLATION TABLE
--
cvaWorkflowInstallTable OBJECT-TYPE
SYNTAX SEQUENCE OF CvaWorkflowInstallEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The table containing the list of installed Workflow
applications provisioned on the media server.
For instance, this table may contain an entry for
each of the Auto Attendant(AA) or Integrated Contact
Distribution(ICD) application installed on the Cisco
Workflow Application."
::= { cvaGeneralInfo 1 }
cvaWorkflowInstallEntry OBJECT-TYPE
SYNTAX CvaWorkflowInstallEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
3-109Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Monitoring and Fault Management
"An entry (conceptual row) in the Workflow Installation
Table, containing information associated with the Cisco
Workflow Application. This entry is created when a
workflow application is installed via the application
Administration page."
INDEX { cvaWorkflowInstallIndex }
::= { cvaWorkflowInstallTable 1 }
CvaWorkflowInstallEntry ::= SEQUENCE {
cvaWorkflowInstallIndex Unsigned32,
cvaWorkflowInstallName SnmpAdminString,
cvaWorkflowInstallLocator OCTET STRING,
cvaWorkflowInstallScriptName SnmpAdminString,
cvaWorkflowInstallEnable TruthValue
}
cvaWorkflowInstallIndex OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An arbitrary integer which uniquely identifies an Workflow
Application."
::= { cvaWorkflowInstallEntry 1 }
cvaWorkflowInstallName OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE(0..128))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The name of the workflow application."
::= { cvaWorkflowInstallEntry 2 }
cvaWorkflowInstallLocator OBJECT-TYPE
SYNTAX OCTET STRING (SIZE(0..128))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
3-110Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Monitoring and Fault Management
"The extension number or CTI (Computer
Telephony Integration) route point associated
with the workflow application.
For instance, 5000 for extension 5000."
::= { cvaWorkflowInstallEntry 3 }
cvaWorkflowInstallScriptName OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE(0..128))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The workflow application script name."
::= { cvaWorkflowInstallEntry 4 }
cvaWorkflowInstallEnable OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The status of the workflow application.
true(1): Workflow Application is enabled
false(2): Workflow Application is disabled."
::= { cvaWorkflowInstallEntry 5 }
cvaNotificationEnable OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"To enable(1) or disable(2) generation of the following
notifications:
cvaModuleStart notification
cvaModuleStop notification
cvaModuleRunTimeFailure notification
cvaProcessStart notification
cvaProcessStop notification
The default value is enable(1)."
3-111Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Monitoring and Fault Management
::= { cvaGeneralInfo 3 }
--
-- THE MODULE FAILURE GROUP
-- a collection of objects common to application server notifications
--
cvaAlarmSeverity OBJECT-TYPE
SYNTAX INTEGER {
emergency(1),
alert(2),
critical(3),
error(4),
warning(5),
notice(6),
informational(7)
}
MAX-ACCESS accessible-for-notify
STATUS current
DESCRIPTION
"The application alarm notification severity code.
emergency: System unusable
alert: Immediate response needed
critical: Critical condition
error: Error condition
warning: Warning condition
notice: Normal but significant condition
informational: Informational situation."
::= { cvaModuleFailureInfo 1 }
cvaModuleName OBJECT-TYPE
SYNTAX DisplayString(SIZE(0..32))
MAX-ACCESS accessible-for-notify
STATUS current
DESCRIPTION
"The application module or subsystem name."
::= { cvaModuleFailureInfo 2 }
3-112Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Monitoring and Fault Management
cvaProcessId OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS accessible-for-notify
STATUS current
DESCRIPTION
"A unique value for each of the process running on the host.
Wherever possible, this should be the system's native, unique
Identification number (process id)."
::= { cvaModuleFailureInfo 3 }
cvaModuleFailureName OBJECT-TYPE
SYNTAX DisplayString(SIZE(0..32))
MAX-ACCESS accessible-for-notify
STATUS current
DESCRIPTION
"The application module name which causes the failure."
::= { cvaModuleFailureInfo 4 }
cvaModuleFailureCause OBJECT-TYPE
SYNTAX INTEGER {
other(1),
gracefulShutDown(2),
heartBeatFailure(3),
initFailure(4),
outOfResource(5),
partialFailure(6)
}
MAX-ACCESS accessible-for-notify
STATUS current
DESCRIPTION
"The application module failure cause code. This is used
by cvaModuleStop to indicate reason of module stop if known.
other: Other unspecified failure cause
gracefulShutDown: Module is gracefully shut down
heartBeatStopped: Module heart beat stopped is detected
initFailure: Module is failed during initialization
outOfResource: Module is failed due to out of resource
partialFailure: Module partially failure is detected."
3-113Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Monitoring and Fault Management
::= { cvaModuleFailureInfo 5 }
cvaModuleFailureMessage OBJECT-TYPE
SYNTAX DisplayString(SIZE(0..255))
MAX-ACCESS accessible-for-notify
STATUS current
DESCRIPTION
"The application module failure message."
::= { cvaModuleFailureInfo 6 }
cvaModuleRunTimeFailureCause OBJECT-TYPE
SYNTAX INTEGER {
other(1),
readAccessFailure(2),
writeAccessFailure(3),
createFailure(4),
deleteFailure(5),
updateFailure(6),
initFailure(7),
loadFailure(8),
outOfResource(9),
callProcessFailure(10),
registrationFailure(11),
deRegistrationFailure(12),
connectionFailure(13),
disconnectionFailure(14),
unknownTarget(15),
unReacheableTarget(16)
}
MAX-ACCESS accessible-for-notify
STATUS current
DESCRIPTION
"The application module run-time failure cause code.
other: Other or unspecified failure
readAccessFailure: Read Access failure
writeAccessFailure: Write Access failure
3-114Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Monitoring and Fault Management
createFailure: Resource Creation failure
deleteFailure: Resource Deletion failure
updateFailure: Update failure
initFailure: Initialization failure
loadFailure: Resource Load failure
outOfResource: Out of Resource
callProcessFailure: Call Processing failure
registrationFailure: Registration failure
deRegistrationFailure: De-Registration failure
connectionFailure: Connection failure
disconnectionFailure: Desconnection failure
unknownTarget: Unknown Target/destination
unReacheableTarget: UnReacheable Target/destination"
::= { cvaModuleFailureInfo 7 }
--
-- Notifications
--
ciscoVoiceAppsMIBNotificationPrefix OBJECT IDENTIFIER ::=
{ ciscoVoiceAppsMIB 2 }
ciscoVoiceAppsMIBNotifications OBJECT IDENTIFIER ::=
{ciscoVoiceAppsMIBNotificationPrefix 0 }
cvaModuleStart NOTIFICATION-TYPE
OBJECTS { cvaAlarmSeverity, cvaModuleName }
STATUS current
DESCRIPTION
"A cvaModuleStart notification signifies that an
application module or subsystem has successfully
started and transitioned into in-service state.
This notification is working in conjunction with
the cvaModuleStop notification to notify the start
and stop status of a particular application module."
::= {ciscoVoiceAppsMIBNotifications 1}
cvaModuleStop NOTIFICATION-TYPE
3-115Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Monitoring and Fault Management
OBJECTS { cvaAlarmSeverity, cvaModuleName, cvaModuleFailureCause,
cvaModuleFailureName, cvaModuleFailureMessage }
STATUS current
DESCRIPTION
"A cvaModuleStop notification signifies that an
application module or subsystem has stopped. This
notification is working in conjunction with the
cvaModuleStart notification to notify the start
and stop status of a particular application module.
If failure cause is known then it will be specified
in the cvaModuleFailureCause variable. Additional
failure information associated with cvaModuleFailureCause
can be specified in the cvaModuleFailureCauseMessage."
::= {ciscoVoiceAppsMIBNotifications 2}
cvaModuleRunTimeFailure NOTIFICATION-TYPE
OBJECTS { cvaAlarmSeverity, cvaModuleName,
cvaModuleRunTimeFailureCause, cvaModuleFailureName,
cvaModuleFailureMessage }
STATUS current
DESCRIPTION
"A cvaModuleRunTimeFailure notification signifies that a run
time failure has occurred. If failure cause is known then it
will be specified in the cvaModuleRunTimeFailureCause
variable. Additional failure information associated with
cvaModuleRunTimeFailureCause can be specified in the
cvaModuleFailureCauseMessage."
::= {ciscoVoiceAppsMIBNotifications 3}
cvaProcessStart NOTIFICATION-TYPE
OBJECTS { cvaAlarmSeverity, cvaModuleName, cvaProcessId }
STATUS current
DESCRIPTION
"A cvaProcessStart notification signifies that a process has
just started. This notification is intended to work in
conjunction with the caProcessStop notification to notify
the start and stop status of a particular process."
::= {ciscoVoiceAppsMIBNotifications 4}
3-116Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Monitoring and Fault Management
cvaProcessStop NOTIFICATION-TYPE
OBJECTS { cvaAlarmSeverity, cvaModuleName, cvaProcessId }
STATUS current
DESCRIPTION
"A cvaProcessStop notification signifies that a process has
just stopped. This notification is intended to work in
conjunction with the cvaProcessStart notification to notify
the start and stop status of a particular process."
::= {ciscoVoiceAppsMIBNotifications 5}
--
-- MIB Conformance Statements
--
ciscoVoiceAppsMIBConformance OBJECT IDENTIFIER ::=
{ ciscoVoiceAppsMIB 3 }
ciscoVoiceAppsMIBCompliances OBJECT IDENTIFIER ::=
{ ciscoVoiceAppsMIBConformance 1 }
ciscoVoiceAppsMIBGroups OBJECT IDENTIFIER ::=
{ ciscoVoiceAppsMIBConformance 2 }
-- Compliance Statements
ciscoVoiceAppsMIBCompliance MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"The compliance statement for entities which implement
the CISCO APPLICATION MIB."
MODULE
MANDATORY-GROUPS {
cvaModuleInfoGroup,
cvaNotificationInfoGroup
}
GROUP cvaNotificationGroup
DESCRIPTION
"Support for these notifications is optional."
3-117Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Monitoring and Fault Management
::= { ciscoVoiceAppsMIBCompliances 1 }
-- Units of Conformance
cvaModuleInfoGroup OBJECT-GROUP
OBJECTS {
cvaWorkflowInstallName,
cvaWorkflowInstallLocator,
cvaWorkflowInstallScriptName,
cvaWorkflowInstallEnable,
cvaNotificationEnable
}
STATUS current
DESCRIPTION
"A collection of objects which provide info about the
application. It comprises of all the modules and servers
associated with the application."
::= { ciscoVoiceAppsMIBGroups 1 }
cvaNotificationInfoGroup OBJECT-GROUP
OBJECTS {
cvaAlarmSeverity,
cvaModuleName,
cvaProcessId,
cvaModuleFailureName,
cvaModuleFailureCause,
cvaModuleFailureMessage,
cvaModuleRunTimeFailureCause
}
STATUS current
DESCRIPTION
"A collection of notification objects which provide info
about the application notification."
::= { ciscoVoiceAppsMIBGroups 2 }
cvaNotificationGroup NOTIFICATION-GROUP
NOTIFICATIONS {
cvaModuleStart,
3-118Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Monitoring and Fault Management
cvaModuleStop,
cvaModuleRunTimeFailure,
cvaProcessStart,
cvaProcessStop
}
STATUS current
DESCRIPTION
"A collection of notifications."
::= { ciscoVoiceAppsMIBGroups 3 }
END
3-119Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Chapter 3 Cisco Unified CCX MIBs UCCX Monitoring and Fault Management
3-120Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Cisco Unified Communications MIBs, SyslogsOL-19788-01
C H A P T E R 4
Cisco UCCX PerfMon and AlertsThis chapter contain perfmon and alert information for UCCX.
UCCX Performance CountersYou can use “Window Perfmon” utility to set and gather performance info of various processes etc. Windows Perfmon has a rich set of counters related to processes, CPU, disk usage, I/O, Memory etc.
Windows Perfmon utility
While Historical Reporting has been the mechanism of choice to check for various statistics there is no mechanism to expose this to an external application.
Products like Workforce Optimization however does this already. Please check http://wwwin.cisco.com/voice/products/customercontact/workforce/.
In UCCX, counters are already grouped together by Windows Perfmon.
Threshold values for CPU, Memory and disk usage have not been published although profiling data is gathered for various release and different platforms.
Faults (Events / Alarms)Subsystems which are the functional blocks for the main Engine of UCCX send out alarms which are routed to the Syslog or as SNMP Traps. SNMP Traps are generated when any UCCX Subsystem/module or processes starts or stops, a runtime failure occurs for a module. These can be tracked for each major component to track the health of the UCCX system. Syslog traps are also sent out for all Alarms of level 0 (catastrophic) to level 3 (error). These can be correlated to the failure of important features of UCCX.
Alarms for subsystem/component in-service can be used to clear previous out-of-service and partial-service. It depends on the end tool which will be processing the received traps.
Important alarms are delivered as SNMP traps which can be received by Cisco Works and other third party NMS Apps.
Setting Traces In UCCXAll traces and alarm logs can be set via Application Administrator.
4-1, and Alerts/Alarms for Managed Service Providers
Chapter 4 Cisco UCCX PerfMon and Alerts
UCCX Log and Trace FilesLog and trace files in UCCX are divided into several facilities. As mentioned earlier the main processes are also the facilities which create separate log files (MIVR for Engine, MCVD for NM/CVD process, MADM for Application Administrator). It must be noted that OEM-ed products like Cisco Agent Desktop also generate separate log/trace and are available at a different directory location. CC Support Tools is supported from UCCX 5.0(x) to 7.0(x).
UCCX Version and Configuration InformationVersion Information is obtained on Application Administrator about page. UCCX does not publish the versions of the OEM-ed product(s) separately.
UCCX does not currently provide any mechanism to do audit trail for configuration changes.
UCCX provisioning Support UCCX does not expose any API for configuration, activation of components or any provisioning mechanism. All configuration is done through the web based Application pages.
UCCX Change Notification and SynchronizationUCCX which is targeted at the small to medium size Contact Centers with max size of 300 agents has a comparatively simpler configuration. There has not been any need for an external management application for its provisioning. However, a few of the configuration will be good to be managed specially if there is one for the whole solution. These are items like changes in number of seats and ports, changes to existing agents or addition/removal of agents, changes in license and deployment of additional scripts and route points (which service other types of customers).
In subsequent releases may expose an API to provide change notification and/or synchronization mechanism.
UCCX Provisioning API or CLI UCCX does not currently have external provisioning management or CLI support .
UCCX Error MessagesThere should not be any revision dependence on error messages. If an error message is defined for an error condition, it should not change from one revision to another revision. If an error message must be changed to accommodate new functionality, list the changes below.
List below any new error messages or deprecated error messages that may be important to the provisioning process.
List of error messages and Alarms can be obtained from the Application Administrator “Alarm Definitions” page.
4-2Cisco Unified Communications MIBs, Syslogs, and Alerts/Alarms for Managed Service Providers
OL-19788-01
Top Related