1-- *****************************************************************
2-- CISCO-DEVICE-EXCEPTION-REPORTING-MIB.txt:
3--     CISCO Device Exception Reporting MIB
4--
5-- August 2001  P. Eric Chi
6--
7-- Copyright (c) 2001 by cisco Systems, Inc.
8-- All rights reserved.
9--
10-- *****************************************************************
11-- $Endlog$
12
13
14
15CISCO-DEVICE-EXCEPTION-REPORTING-MIB DEFINITIONS ::= BEGIN
16
17IMPORTS
18    MODULE-IDENTITY,
19    NOTIFICATION-TYPE,
20    OBJECT-TYPE,
21    Counter32,
22    Unsigned32
23            FROM SNMPv2-SMI
24    InetAddressType,
25    InetAddress
26            FROM INET-ADDRESS-MIB
27    SnmpAdminString
28            FROM SNMP-FRAMEWORK-MIB
29    TruthValue,
30    TimeStamp
31	    FROM SNMPv2-TC
32    MODULE-COMPLIANCE,
33    NOTIFICATION-GROUP,
34    OBJECT-GROUP
35            FROM SNMPv2-CONF
36    ciscoMgmt
37            FROM CISCO-SMI;
38
39
40ciscoDevExcepReportMIB MODULE-IDENTITY
41    LAST-UPDATED    "200108140000Z"
42    ORGANIZATION    "Cisco Systems, Inc."
43    CONTACT-INFO
44                    "Cisco Systems
45                     Customer Service
46
47             Postal: 170 W. Tasman Drive
48                     San Jose, CA 95134
49                     USA
50
51             Tel:    +1 800 553-NETS
52
53             E-mail: cs-crm@cisco.com"
54    DESCRIPTION
55        "This mib defines the SNMP objects to report
56         exceptions to north-bound NMS.
57
58         The devices implementing this MIB monitor
59         the status of hardware and software services, and
60         report any exceptions regarding these components.
61         These hardware and software services could
62         belong to the monitoring devices or other managed
63         devices.
64
65         An exception is something abnormal that the system
66         administrators should pay attention to. The criteria
67         for what is an exception could vary by system
68         and should be defined by the system administrators.
69         Certain NM devices or applications may have
70         pre-defined exceptions.
71
72         This MIB does not try to define exceptions. But
73         rather it defines SNMP objects for devices to
74         use SNMP notification as an exception reporting
75         mechanism. Exceptions may be pre-defined or defined
76         through other device management interface such as
77         CLI, GUI, or HTTP."
78
79    ::= { ciscoMgmt 224 }
80
81ciscoDevExcepReportMIBObjects  OBJECT IDENTIFIER
82        ::= { ciscoDevExcepReportMIB 1 }
83
84cderExceptionData OBJECT IDENTIFIER
85        ::= { ciscoDevExcepReportMIBObjects 1 }
86
87-- Exception data
88
89cderMaxExceptionRecords  OBJECT-TYPE
90    SYNTAX      Unsigned32 (0..1024)
91    MAX-ACCESS  read-write
92    STATUS      current
93    DESCRIPTION
94        "The maximun number of records to keep in
95         cderExceptionTable. New records will replace
96         the old records on a first-in-first-out
97         basis.
98         A value of 0 indicates no history will be
99         retained."
100    DEFVAL      { 100 }
101    ::= { cderExceptionData 1 }
102
103cderNotificationEnabled  OBJECT-TYPE
104    SYNTAX      TruthValue
105    MAX-ACCESS  read-write
106    STATUS      current
107    DESCRIPTION
108        "Enable or disable exception notification
109         via SNMP."
110    DEFVAL      { false }
111    ::= { cderExceptionData 2 }
112
113cderNotificationsSent  OBJECT-TYPE
114    SYNTAX      Counter32
115    MAX-ACCESS  read-only
116    STATUS      current
117    DESCRIPTION
118        "The number of cderMonitoredExceptionEvent
119         events.
120
121         If a NMS is receiving notifications,
122         it can periodically poll this object
123         to find out if any notifications were
124         missed. In that case it could poll
125         cderExceptionTable to find out missing
126         exceptions."
127    ::= { cderExceptionData 3 }
128
129cderNotificationsDropped  OBJECT-TYPE
130    SYNTAX      Counter32
131    MAX-ACCESS  read-only
132    STATUS      current
133    DESCRIPTION
134        "The number of notifications dropped from the
135         cderExceptionTable table.
136         If the difference between two consecutive
137         polls of this object is greater than
138         cderMaxExceptionRecords, then it indicates
139         the NMS will not be able to find missing
140         exceptions. The solution is to either poll
141         the cderExceptionTable more frequently
142         or increase the size of the cderExceptionTable
143         by setting cderMaxExceptionRecords."
144    ::= { cderExceptionData 4 }
145
146cderExceptionTable OBJECT-TYPE
147    SYNTAX      SEQUENCE OF CderExceptionEntry
148    MAX-ACCESS  not-accessible
149    STATUS      current
150    DESCRIPTION
151        "This table keeps an history of exceptions
152         found."
153    ::= { cderExceptionData 5 }
154
155cderExceptionEntry OBJECT-TYPE
156    SYNTAX      CderExceptionEntry
157    MAX-ACCESS  not-accessible
158    STATUS      current
159    DESCRIPTION
160        "An entry containing information about an
161         exception."
162    INDEX { cderExcepTableIndex }
163    ::= { cderExceptionTable 1 }
164
165CderExceptionEntry::=
166    SEQUENCE {
167        cderExcepTableIndex          Unsigned32,
168	cderExcepId                  SnmpAdminString,
169        cderExcepHostAddressType     InetAddressType,
170        cderExcepHostAddress         InetAddress,
171        cderExcepPriorityDescription SnmpAdminString,
172        cderExcepTime                TimeStamp,
173        cderExcepData                OCTET STRING,
174        cderExcepReportedBy          SnmpAdminString
175       }
176
177cderExcepTableIndex OBJECT-TYPE
178    SYNTAX      Unsigned32 (1..4294967295)
179    MAX-ACCESS  not-accessible
180    STATUS      current
181    DESCRIPTION
182        "An monotonically increasing number for
183         the sole purpose of indexing entries. When
184         it reaches maximum value, the agent sets
185         it back to 1."
186    ::= { cderExceptionEntry 1 }
187
188cderExcepId  OBJECT-TYPE
189    SYNTAX      SnmpAdminString (SIZE (1..32))
190    MAX-ACCESS  read-only
191    STATUS      current
192    DESCRIPTION
193        "Identification for this exception. This
194         object should uniquely identify the
195         exception."
196    ::= { cderExceptionEntry 2 }
197
198cderExcepHostAddressType  OBJECT-TYPE
199    SYNTAX      InetAddressType
200    MAX-ACCESS  read-only
201    STATUS      current
202    DESCRIPTION
203        "Represents the type of address stored in
204         cderExcepHostAddress."
205    ::= { cderExceptionEntry 3 }
206
207
208cderExcepHostAddress  OBJECT-TYPE
209    SYNTAX      InetAddress
210    MAX-ACCESS  read-only
211    STATUS      current
212    DESCRIPTION
213        "Host device address where the exception
214         happened."
215    ::= { cderExceptionEntry 4 }
216
217cderExcepPriorityDescription  OBJECT-TYPE
218    SYNTAX         SnmpAdminString (SIZE (1..64))
219    MAX-ACCESS     read-only
220    STATUS         current
221    DESCRIPTION
222        "A string that tells the system administrator
223         about the priority of this exception.
224         This string is provided to the snmp agent
225         by the reporting service(s) which could be
226         any services or applications on the device.
227         The receiving NMS of this object should
228         understand the string in order to utilize this
229         object."
230    ::= { cderExceptionEntry 5 }
231
232cderExcepTime    OBJECT-TYPE
233    SYNTAX      TimeStamp
234    MAX-ACCESS  read-only
235    STATUS      current
236    DESCRIPTION
237        "Timestamp when the exception happened."
238    ::= { cderExceptionEntry 6 }
239
240cderExcepData    OBJECT-TYPE
241    SYNTAX      OCTET STRING (SIZE (0..1024))
242    MAX-ACCESS  read-only
243    STATUS      current
244    DESCRIPTION
245        "More information about the exception that
246         the reporting service(s) want to convey to
247         the NMS.
248         The receiving NMS should understand the
249         meaning of this object value in order to
250         use it."
251    ::= { cderExceptionEntry 7 }
252
253cderExcepReportedBy    OBJECT-TYPE
254    SYNTAX      SnmpAdminString
255    MAX-ACCESS  read-only
256    STATUS      current
257    DESCRIPTION
258        "Name of the reporting service, or process,
259         or other component of the device that
260         reports this exception."
261    ::= { cderExceptionEntry 8 }
262
263-- Notifications
264
265cderMIBNotifPrefix OBJECT IDENTIFIER
266        ::= { ciscoDevExcepReportMIB 2 }
267
268cderMIBNotifications OBJECT IDENTIFIER
269        ::= { cderMIBNotifPrefix  0 }
270
271cderMonitoredExceptionEvent NOTIFICATION-TYPE
272    OBJECTS {
273        cderExcepId,
274        cderExcepHostAddressType,
275        cderExcepHostAddress,
276        cderExcepPriorityDescription,
277        cderExcepTime,
278        cderExcepData,
279        cderExcepReportedBy
280    }
281    STATUS  current
282    DESCRIPTION
283        "This notification is sent when an exception
284         is detected on the managed device. This
285         notification can be enabled or disabled via
286         cderNotificationEnable."
287    ::= { cderMIBNotifications 1 }
288
289-- conformance
290
291ciscoDEReportMIBConformance OBJECT IDENTIFIER
292    ::= { ciscoDevExcepReportMIB 3 }
293
294ciscoDEReportMIBCompliances OBJECT IDENTIFIER
295    ::= { ciscoDEReportMIBConformance 1 }
296
297ciscoDEReportMIBGroups OBJECT IDENTIFIER
298    ::= { ciscoDEReportMIBConformance 2 }
299
300-- compliance
301
302ciscoDEReportMIBCompliance MODULE-COMPLIANCE
303    STATUS  current
304    DESCRIPTION
305        "The compliance statement for entities
306         which implement the
307         CISCO-DEVICE-EXCEPTION-REPORTING-MIB."
308
309    MODULE  -- This module
310    	MANDATORY-GROUPS {
311            ciscoDERExceptionDataGroup,
312            ciscoDERExceptionGroup
313	}
314
315    ::= { ciscoDEReportMIBCompliances 1 }
316
317-- Units of conformance
318
319ciscoDERExceptionDataGroup OBJECT-GROUP
320    OBJECTS {
321        cderMaxExceptionRecords,
322        cderNotificationEnabled,
323        cderNotificationsSent,
324        cderNotificationsDropped,
325        cderExcepId,
326        cderExcepHostAddressType,
327        cderExcepHostAddress,
328        cderExcepPriorityDescription,
329        cderExcepTime,
330        cderExcepData,
331        cderExcepReportedBy
332    }
333    STATUS  current
334    DESCRIPTION
335        "A collection of objects that enable the
336         exception notification for monitored
337         exceptions of network elements."
338    ::= { ciscoDEReportMIBGroups 1 }
339
340ciscoDERExceptionGroup NOTIFICATION-GROUP
341    NOTIFICATIONS {
342	cderMonitoredExceptionEvent
343    }
344    STATUS  current
345    DESCRIPTION
346        "A collection of the monitored
347         exception events."
348    ::= { ciscoDEReportMIBGroups 2 }
349
350END
351
352