1-- *****************************************************************
2-- CISCO-ENTITY-SENSOR-EXT-MIB.my
3--
4-- Copyright (c) 2010 by cisco Systems Inc.
5-- All rights reserved.
6--
7-- *****************************************************************
8
9CISCO-ENTITY-SENSOR-EXT-MIB DEFINITIONS ::= BEGIN
10
11IMPORTS
12    MODULE-IDENTITY,
13    OBJECT-TYPE,
14    NOTIFICATION-TYPE,
15    Unsigned32
16        FROM SNMPv2-SMI
17    MODULE-COMPLIANCE,
18    OBJECT-GROUP,
19    NOTIFICATION-GROUP
20        FROM SNMPv2-CONF
21    TEXTUAL-CONVENTION,
22    TruthValue
23        FROM SNMPv2-TC
24    entPhysicalName,
25    entPhysicalDescr,
26    entPhysicalIndex
27        FROM ENTITY-MIB
28    EntitySensorValue,
29    entPhySensorValue,
30    entPhySensorType
31        FROM ENTITY-SENSOR-MIB
32    ciscoMgmt
33        FROM CISCO-SMI;
34
35
36ciscoEntitySensorExtMIB MODULE-IDENTITY
37    LAST-UPDATED    "201006100000Z"
38    ORGANIZATION    "Cisco Systems, Inc."
39    CONTACT-INFO
40            "Postal: Cisco Systems, Inc.
41            170 West Tasman Drive
42            San Jose, CA 95134-1706
43            USA
44
45            Tel: +1 408 526 4000
46
47            E-mail: cs-snmp@cisco.com"
48    DESCRIPTION
49        "This MIB is extension to ENTITY-SENSOR-MIB(RFC 3433). This MIB
50        also defines the notifications applicable for sensors reported
51        in ENTITY-MIB(RFC 4133)."
52    REVISION        "201006090000Z"
53    DESCRIPTION
54        "Initial version of this MIB module."
55    ::= { ciscoMgmt 745 }
56
57
58ciscoEntitySensorExtMIBNotifs  OBJECT IDENTIFIER
59    ::= { ciscoEntitySensorExtMIB 0 }
60
61ciscoEntitySensorExtMIBObjects  OBJECT IDENTIFIER
62    ::= { ciscoEntitySensorExtMIB 1 }
63
64ciscoEntitySensorExtMIBConform  OBJECT IDENTIFIER
65    ::= { ciscoEntitySensorExtMIB 2 }
66
67
68CiscoSensorThresholdSeverity ::= TEXTUAL-CONVENTION
69    STATUS          current
70    DESCRIPTION
71        "sensor threshold severity.  Valid values are:
72
73        other(1)    : a severity other than those listed below.
74        minor(10)   : Minor Problem threshold.
75        major(20)   : Major Problem threshold.
76        critical(30): Critical problem threshold. A system might shut
77                      down the sensor associated FRU automatically if
78                      the sensor value reach the critical problem
79                      threshold."
80    SYNTAX          INTEGER  {
81                        other(1),
82                        minor(10),
83                        major(20),
84                        critical(30)
85                    }
86
87CiscoSensorThresholdRelation ::= TEXTUAL-CONVENTION
88    STATUS          current
89    DESCRIPTION
90        "sensor threshold relational operator types.  valid values are:
91
92        lessThan(1):        if the sensor value is less than
93                            the threshold value
94        lessOrEqual(2):     if the sensor value is less than or equal to
95                            the threshold value
96        greaterThan(3):     if the sensor value is greater than
97                            the threshold value
98        greaterOrEqual(4):  if the sensor value is greater than or equal
99                            to the threshold value
100        equalTo(5):         if the sensor value is equal to
101                            the threshold value
102        notEqualTo(6):      if the sensor value is not equal to
103                            the threshold value"
104    SYNTAX          INTEGER  {
105                        lessThan(1),
106                        lessOrEqual(2),
107                        greaterThan(3),
108                        greaterOrEqual(4),
109                        equalTo(5),
110                        notEqualTo(6)
111                    }
112-- ceSensorExtThresholdTable
113
114ceSensorExtThresholdTable OBJECT-TYPE
115    SYNTAX          SEQUENCE OF CeSensorExtThresholdEntry
116    MAX-ACCESS      not-accessible
117    STATUS          current
118    DESCRIPTION
119        "This table lists the threshold severity, relation, and
120        comparison value, for a sensor entity listed in
121        entPhysicalTable."
122    REFERENCE
123        "ENTITY-MIB contains definition for entPhysicalTable"
124    ::= { ciscoEntitySensorExtMIBObjects 1 }
125
126ceSensorExtThresholdEntry OBJECT-TYPE
127    SYNTAX          CeSensorExtThresholdEntry
128    MAX-ACCESS      not-accessible
129    STATUS          current
130    DESCRIPTION
131        "An ceSensorExtThresholdTable entry describes the
132        thresholds for a sensor: the threshold severity,
133        the threshold value, the relation, and the
134        evaluation of the threshold.
135
136        Only entities with entPhysicalClass 'sensor'
137        are listed in this table.
138
139        For non FRU entities the entries are created by the agent at
140        system startup and entries are never deleted by the agent.
141
142        For FRU entities the entries are created at system startup
143        if FRU is inserted at system startup, else entries are created
144        when FRU is inserted.  Entries are deleted by the agent when
145        FRU is removed."
146    REFERENCE
147        "ENTITY-MIB contains definition for entPhysicalClass"
148    INDEX           {
149                        entPhysicalIndex,
150                        ceSensorExtThresholdIndex
151                    }
152    ::= { ceSensorExtThresholdTable 1 }
153
154CeSensorExtThresholdEntry ::= SEQUENCE {
155        ceSensorExtThresholdIndex       Unsigned32,
156        ceSensorExtThresholdSeverity    CiscoSensorThresholdSeverity,
157        ceSensorExtThresholdRelation    CiscoSensorThresholdRelation,
158        ceSensorExtThresholdValue       EntitySensorValue,
159        ceSensorExtThresholdEvaluation  TruthValue,
160        ceSensorExtThresholdNotifEnable INTEGER
161}
162
163ceSensorExtThresholdIndex OBJECT-TYPE
164    SYNTAX          Unsigned32 (1..4294967295)
165    MAX-ACCESS      not-accessible
166    STATUS          current
167    DESCRIPTION
168        "An index that uniquely identifies an entry
169        in the ceSensorExtThresholdTable. This index
170        permits the same sensor to have several
171        different thresholds."
172    ::= { ceSensorExtThresholdEntry 1 }
173
174ceSensorExtThresholdSeverity OBJECT-TYPE
175    SYNTAX          CiscoSensorThresholdSeverity
176    MAX-ACCESS      read-write
177    STATUS          current
178    DESCRIPTION
179        "This object specifies the severity of this threshold."
180    ::= { ceSensorExtThresholdEntry 2 }
181
182ceSensorExtThresholdRelation OBJECT-TYPE
183    SYNTAX          CiscoSensorThresholdRelation
184    MAX-ACCESS      read-write
185    STATUS          current
186    DESCRIPTION
187        "This object specifies the boolean relation between
188        sensor value (entPhySensorValue) and threshold value
189        (ceSensorExtThresholdValue), required to
190        trigger the alarm.
191
192        in pseudo-code, the evaluation-alarm mechanism is:
193
194        ...
195        if (evaluate(entPhySensorValue,
196                     ceSensorExtThresholdRelation,
197                     ceSensorExtThresholdValue))
198        then
199            if (((ceSensorExtThresholdNotifEnable
200                    == enabled) ||
201                  (ceSensorExtThresholdNotifEnable
202                    == transparent)) &&
203                  (ceSensorExtThresholdNotifGlobalEnable
204                    == enabled))
205            then
206                raise_alarm(sensor's entPhysicalIndex);
207               endif
208        endif
209        ..."
210    ::= { ceSensorExtThresholdEntry 3 }
211
212ceSensorExtThresholdValue OBJECT-TYPE
213    SYNTAX          EntitySensorValue
214    MAX-ACCESS      read-write
215    STATUS          current
216    DESCRIPTION
217        "This object specifies the value of the threshold.
218
219        The value of objects entPhySensorType, entPhysSensorScale
220        and entPhySensorPrecision for this sensor entity defines
221        how ceSensorExtThresholdValue can be displayed or
222        intepreted by the user.
223
224        entPhySensorValue can be compared with
225        ceSensorExtThresholdValue without taking
226        care of semantics of both objects."
227    REFERENCE
228        "ENTITY-SENSOR-MIB contains definitions for
229          entPhysSensorScale and entPhySensorPrecision"
230    ::= { ceSensorExtThresholdEntry 4 }
231
232ceSensorExtThresholdEvaluation OBJECT-TYPE
233    SYNTAX          TruthValue
234    MAX-ACCESS      read-only
235    STATUS          current
236    DESCRIPTION
237        "This object indicates the result of the most
238        recent evaluation of the threshold.
239
240        The agent will execute the below 'evaluate' function
241        to generate the notification. 'evaluate' function
242        returns a boolean value.
243
244        evaluate(entPhySensorValue,
245                 ceSensorExtThresholdRelation,
246                 ceSensorExtThresholdValue)
247
248        If evalute function returns true then
249        ceSensorExtThresholdEvaluation is set to 'true'
250
251        If evaluate function returns false then
252        ceSensorExtThresholdEvaluation is set to 'false'.
253
254        Thresholds are evaluated at the rate indicated by
255        entPhySensorValueUpdateRate."
256    REFERENCE
257        "ENTITY-SENSOR-MIB contains definition for
258        entPhySensorValueUpdateRate"
259    ::= { ceSensorExtThresholdEntry 5 }
260
261ceSensorExtThresholdNotifEnable OBJECT-TYPE
262    SYNTAX          INTEGER  {
263                        enabled(1),
264                        disabled(2),
265                        transparent(3)
266                    }
267    MAX-ACCESS      read-write
268    STATUS          current
269    DESCRIPTION
270        "A control object to activate/deactivate
271        ceSensorExtThresholdNotification.
272
273        This object should hold any of the below values.
274        enabled(1)    - The notification is enabled for this entity
275        disabled(2)   - The notification is disabled for this entity
276        transparent(3)- The notification is enabled/disabled based on
277                        ceSensorExtThresholdNotifGlobalEnable
278                        object
279
280        This object controls generation of
281        ceSensorExtThresholdNotification for this threshold.
282        An exception to this is, if this object is set to 'transparent'
283        then ceSensorExtThresholdNotification for this threshold
284        is controlled by ceSensorExtThresholdNotifGlobalEnable
285        object.
286
287        This truth table explains how
288        ceSensorExtThresholdNotifEnable is related with
289        ceSensorExtThresholdNotifGlobalEnable to control the
290        ceSensorExtThresholdNotification for this threshold
291
292        E = enabled, D = Disabled, T = Transparent
293        local_flag =  ceSensorExtThresholdNotifEnable
294        global_flag = ceSensorExtThresholdNotifGlobalEnable
295
296        local_flag  global_flag   outcome_per_interface
297        ---------------------------------------------
298           E            E            E
299           E            D            D
300           D            E            D
301           D            D            D
302           T            E            E
303           T            D            D"
304    DEFVAL          { transparent }
305    ::= { ceSensorExtThresholdEntry 6 }
306
307
308ciscoEntSensorExtGlobalObjects  OBJECT IDENTIFIER
309    ::= { ciscoEntitySensorExtMIBObjects 2 }
310
311
312-- Extended entity Sensor Global Objects
313
314ceSensorExtThresholdNotifGlobalEnable OBJECT-TYPE
315    SYNTAX          INTEGER  {
316                        enabled(1),
317                        disabled(2)
318                    }
319    MAX-ACCESS      read-write
320    STATUS          current
321    DESCRIPTION
322        "A control object to activate/deactivate
323        ceSensorExtThresholdNotification.
324
325        This object should hold any of the below values.
326        enabled(1) - The notification is enabled globally
327                     on the device
328        disabled(2)- The notification is disabled globally
329                     on the device
330
331        This object enables the generation of
332        ceSensorExtThresholdNotification globally
333        on the device. If this object value is
334        'disabled', then no ceSensorExtThresholdNotification
335        will be generated on this device. If this object
336        value is 'enabled', then whether a
337        ceSensorExtThresholdNotification for a threshold will
338        be generated or not depends on the instance value of
339        ceSensorExtThresholdNotifEnable for that
340        threshold."
341    DEFVAL          { disabled }
342    ::= { ciscoEntSensorExtGlobalObjects 1 }
343
344-- Extended entity Sensor notifications
345
346ceSensorExtThresholdNotification NOTIFICATION-TYPE
347    OBJECTS         {
348                        entPhysicalName,
349                        entPhysicalDescr,
350                        entPhySensorValue,
351                        entPhySensorType,
352                        ceSensorExtThresholdValue
353                    }
354    STATUS          current
355    DESCRIPTION
356        "This notification is generated once each time
357        the sensor value crosses the threshold value
358        specified by ceSensorExtThresholdValue object."
359   ::= { ciscoEntitySensorExtMIBNotifs 1 }
360-- conformance information
361
362ciscoEntSensorExtMIBCompliances  OBJECT IDENTIFIER
363    ::= { ciscoEntitySensorExtMIBConform 1 }
364
365ciscoEntSensorExtMIBGroups  OBJECT IDENTIFIER
366    ::= { ciscoEntitySensorExtMIBConform 2 }
367
368
369-- compliance statements
370
371ciscoEntSensorExtMIBCompliance MODULE-COMPLIANCE
372    STATUS          current
373    DESCRIPTION
374        "An ENTITY-MIB implementation that adds notification
375        for sensors in the entPhysicalTable must implement
376        this group."
377    MODULE          -- this module
378    MANDATORY-GROUPS { ciscoEntSensorExtThresholdGroup }
379
380    GROUP           ciscoEntSensorExtNotificationCtrlGroup
381    DESCRIPTION
382        "This group is mandatory for the platforms which support
383        global notification control on
384        ceSensorExtThresholdNotification."
385
386    GROUP           ciscoEntSensorExtNotificationGroup
387    DESCRIPTION
388        "This group is mandatory for the platforms which support
389        ceSensorExtThresholdTable and entPhySensorTable."
390    ::= { ciscoEntSensorExtMIBCompliances 1 }
391
392-- units of conformance
393
394ciscoEntSensorExtThresholdGroup OBJECT-GROUP
395    OBJECTS         {
396                        ceSensorExtThresholdSeverity,
397                        ceSensorExtThresholdRelation,
398                        ceSensorExtThresholdValue,
399                        ceSensorExtThresholdEvaluation,
400                        ceSensorExtThresholdNotifEnable
401                    }
402    STATUS          current
403    DESCRIPTION
404        "The collection of objects which are used
405        to describe and monitor thresholds for
406        sensors."
407    ::= { ciscoEntSensorExtMIBGroups 1 }
408
409ciscoEntSensorExtNotificationGroup NOTIFICATION-GROUP
410   NOTIFICATIONS    { ceSensorExtThresholdNotification }
411    STATUS          current
412    DESCRIPTION
413        "The collection of notifications used for
414        monitoring sensor threshold activity."
415    ::= { ciscoEntSensorExtMIBGroups 2 }
416
417ciscoEntSensorExtNotificationCtrlGroup OBJECT-GROUP
418    OBJECTS         { ceSensorExtThresholdNotifGlobalEnable }
419    STATUS          current
420    DESCRIPTION
421        "The collection of objects which provide the global
422        notification control on
423        ceSensorExtThresholdNotification."
424    ::= { ciscoEntSensorExtMIBGroups 3 }
425
426END
427
428
429
430
431
432
433