1-- *******************************************************************
2-- CISCO-NOTIFICATION-CONTROL-MIB
3-- MIB for controlling notifications.
4-- September 2006, Sujay M
5--
6-- Copyright (c) 2006, 2009 by Cisco Systems Inc.
7-- All rights reserved.
8-- *******************************************************************
9
10CISCO-NOTIFICATION-CONTROL-MIB DEFINITIONS ::= BEGIN
11
12IMPORTS
13    MODULE-IDENTITY,
14    Unsigned32,
15    OBJECT-TYPE
16        FROM SNMPv2-SMI
17    MODULE-COMPLIANCE,
18    OBJECT-GROUP
19        FROM SNMPv2-CONF
20    AutonomousType,
21    StorageType,
22    RowStatus
23        FROM SNMPv2-TC
24    SnmpAdminString
25        FROM SNMP-FRAMEWORK-MIB
26    ciscoMgmt
27        FROM CISCO-SMI;
28
29
30ciscoNotificationControlMIB MODULE-IDENTITY
31    LAST-UPDATED    "200909200000Z"
32    ORGANIZATION    "Cisco Systems, Inc."
33    CONTACT-INFO
34            "Cisco Systems
35            Customer Service
36
37            Postal: 170 W Tasman Drive
38            San Jose, CA  95134
39            USA
40            Tel: +1 800 553-NETS
41
42            E-mail: cs-wanatm@cisco.com"
43    DESCRIPTION
44        "This MIB provides network management support to regulate
45        the transmission of notifications generated by a
46        system providing networking services.  The system could
47        be generating several notifications pertaining to
48        various events.  Allowing every notification to be
49        transmitted out may lead to the network being flooded
50        with an excess of network management traffic.  Hence it
51        is required to regulate the generation and transmission
52        of notifications.
53
54                        GLOSSARY
55
56        Network Management Station (NMS)
57
58        An external network entity that monitors and manages the
59        network."
60    REVISION        "200909200000Z"
61    DESCRIPTION
62        "Added new object cNotifCtrlDescr to cNotifCtrlTable.Deprecated
63        cNotifCtrlMIBCompliance and added cNotifCtrlMIBComplianceRev1."
64    REVISION        "200609270000Z"
65    DESCRIPTION
66        "Initial version of this MIB module."
67    ::= { ciscoMgmt 586 }
68
69
70cNotifCtrlMIBObjects  OBJECT IDENTIFIER
71    ::= { ciscoNotificationControlMIB 1 }
72
73cNotifCtrlConfig  OBJECT IDENTIFIER
74    ::= { cNotifCtrlMIBObjects 1 }
75
76
77cNotifCtrlMode OBJECT-TYPE
78    SYNTAX          INTEGER  {
79                        noControl(1),
80                        forcedControl(2),
81                        automaticControl(3)
82                    }
83    MAX-ACCESS      read-write
84    STATUS          current
85    DESCRIPTION
86        "This object represents the notification control mode.
87        The semantics are as follows.
88
89        noControl - There is no control on notifications.
90
91        forcedControl - All notifications configured through
92        cNotifCtrlTable are filtered at all times.
93
94        automaticControl - Notifications configured through
95        cNotifCtrlTable are filtered only when number of
96        notifications generated exceeds the value represented
97        by cNotifCtrlThreshold in the given time interval
98        represented by cNotifCtrlSamplingInterval."
99    DEFVAL          { noControl }
100    ::= { cNotifCtrlConfig 1 }
101
102cNotifCtrlCurrentState OBJECT-TYPE
103    SYNTAX          INTEGER  {
104                        controlOn(1),
105                        controlOff(2)
106                    }
107    MAX-ACCESS      read-only
108    STATUS          current
109    DESCRIPTION
110        "This object represents the current state of notification
111        control. The semantics are as follows.
112
113        controlOn - This indicates that notifications configured in
114        cNotifCtrlTable are currently getting filtered on the
115        system.  This object will always be 'controlOn', when
116        cNotifCtrlMode is 'forcedControl'.
117
118        controlOff - This indicates that notifications configured
119        in cNotifCtrlTable are currently not being filtered on the
120        system.  This object will always be 'controlOff', when
121        cNotifCtrlMode is 'noControl'.
122
123        If cNotifCtrlMode is set to 'automaticControl', the agent
124        sets this object to 'controlOn', when number of
125        notifications generated by  the system exceeds the value
126        represented by cNotifCtrlThreshold in the time interval
127        represented by cNotifCtrlSamplingInterval.  The agent sets
128        this object to 'controlOff', when the number of
129        notifications generated by the system falls below the value
130        represented by cNotifCtrlThreshold in the time interval
131        represented by  cNotifCtrlSamplingInterval."
132    DEFVAL          { controlOff }
133    ::= { cNotifCtrlConfig 2 }
134
135cNotifCtrlThreshold OBJECT-TYPE
136    SYNTAX          Unsigned32 (1..4294967295)
137    UNITS           "notifications"
138    MAX-ACCESS      read-write
139    STATUS          current
140    DESCRIPTION
141        "This object represents the threshold value to initiate
142        controlling of notifications.  Notifications will be
143        controlled when the number of notifications generated
144        by this system exceeds the threshold represented by
145        this object in the sampling interval represented by
146        cNotifCtrlSamplingInterval.  The configured value takes
147        effect only when cNotifCtrlMode is set to
148        'automaticControl'."
149    DEFVAL          { 50 }
150    ::= { cNotifCtrlConfig 3 }
151
152cNotifCtrlSamplingInterval OBJECT-TYPE
153    SYNTAX          Unsigned32 (1..4294967295)
154    UNITS           "minutes"
155    MAX-ACCESS      read-write
156    STATUS          current
157    DESCRIPTION
158        "This object represents the sampling interval in which the
159        notification generation rate will be monitored.  The
160        configured value takes effect only when cNotifCtrlMode is
161        set to 'automaticControl'."
162    DEFVAL          { 5 }
163    ::= { cNotifCtrlConfig 4 }
164
165cNotifCtrlTableSize OBJECT-TYPE
166    SYNTAX          Unsigned32 (1..4294967295)
167    MAX-ACCESS      read-write
168    STATUS          current
169    DESCRIPTION
170        "This object represents maximum number of rows possible in
171        cNotifCtrlTable."
172    DEFVAL          { 200 }
173    ::= { cNotifCtrlConfig 5 }
174
175cNotifCtrlIndexNext OBJECT-TYPE
176    SYNTAX          Unsigned32 (0..4294967295)
177    MAX-ACCESS      read-only
178    STATUS          current
179    DESCRIPTION
180        "This object represents the next available free index in
181        the cNotifCtrlTable.  This number can be used as an index
182        to create a valid entry into cNotifCtrlTable.
183
184        A value of 0 indicates that no free indices are available to
185        create entries in cNotifCtrlTable."
186    ::= { cNotifCtrlConfig 6 }
187
188cNotifCtrlTable OBJECT-TYPE
189    SYNTAX          SEQUENCE OF CNotifCtrlEntry
190    MAX-ACCESS      not-accessible
191    STATUS          current
192    DESCRIPTION
193        "This table represents the notifications to be controlled.
194        To control a particular notification, user creates a row
195        uniquely indexed by cNotifCtrlIndex using the
196        cNotifCtrlRowStatus object.  The storage type of each row
197        is indicated by  cNotifCtrlStorageType.
198
199        The agent filters out the notification depending on the
200        current value of cNotifCtrlMode.  The agent also indicates
201        the current state of notification control through
202        cNotifCtrlCurrentState.
203
204        This notification control mechanism is illustrated as follows.
205
206        cNotifCtrlTable contains the list of notifications, that
207        need to be controlled from the agent when
208        cNotifCtrlCurrentState is 'controlOn'.
209
210        When cNotifCtrlMode is set to 'automaticControl', a timer is
211        started for the time interval represented by
212        cNotifCtrlSamplingInterval(eg: 10 mins) to monitor the number
213        of notifications being generated by the agent.  If the number
214        of notifications generated exceeds the value represented by
215        cNotifCtrlThreshold (eg: 100) before the timer expires, all
216        notifications mentioned in cNotifCtrlTable are throttled.
217
218        When the timer expires, it is restarted and the counter used
219        to track the number of notifications generated is initialized to
220        zero.  This controlling of notifications will continue until
221        the number of notifications generated falls below the threshold
222        in the given interval.
223
224        When cNotifCtrlMode is set to 'forcedControl', all the
225        notifications mentioned in cNotifCtrlTable are always
226        throttled, irrespective of the values of
227        threshold and sampling interval."
228    ::= { cNotifCtrlConfig 7 }
229
230cNotifCtrlEntry OBJECT-TYPE
231    SYNTAX          CNotifCtrlEntry
232    MAX-ACCESS      not-accessible
233    STATUS          current
234    DESCRIPTION
235        "A conceptual row in cNotifCtrlTable and corresponds
236        to the notification to be filtered."
237    INDEX           { cNotifCtrlIndex }
238    ::= { cNotifCtrlTable 1 }
239
240CNotifCtrlEntry ::= SEQUENCE {
241        cNotifCtrlIndex       Unsigned32,
242        cNotifCtrlOID         AutonomousType,
243        cNotifCtrlStorageType StorageType,
244        cNotifCtrlRowStatus   RowStatus,
245        cNotifCtrlDescr       SnmpAdminString
246}
247
248cNotifCtrlIndex OBJECT-TYPE
249    SYNTAX          Unsigned32 (1..4294967295)
250    MAX-ACCESS      not-accessible
251    STATUS          current
252    DESCRIPTION
253        "This object uniquely identifies an entry in cNotifCtrlTable."
254    ::= { cNotifCtrlEntry 1 }
255
256cNotifCtrlOID OBJECT-TYPE
257    SYNTAX          AutonomousType
258    MAX-ACCESS      read-create
259    STATUS          current
260    DESCRIPTION
261        "This object represents the notification to be controlled."
262    ::= { cNotifCtrlEntry 2 }
263
264cNotifCtrlStorageType OBJECT-TYPE
265    SYNTAX          StorageType
266    MAX-ACCESS      read-create
267    STATUS          current
268    DESCRIPTION
269        "This object represents the storage type for this
270        conceptual row in cNotifCtrlTable.
271
272        A value of 'volatile' indicates that the entry won't be
273        persistent across system reloads.  A value of 'nonVolatile'
274        indicates that the entry will be persistent across
275        system reloads."
276    DEFVAL          { nonVolatile }
277    ::= { cNotifCtrlEntry 3 }
278
279cNotifCtrlRowStatus OBJECT-TYPE
280    SYNTAX          RowStatus
281    MAX-ACCESS      read-create
282    STATUS          current
283    DESCRIPTION
284        "This object represents the status of a conceptual row.
285
286        Following objects are mandatory while creating an entry
287        in this table:
288
289        cNotifCtrlOID
290
291        Entries can't be modified after the agent sets
292        cNotifCtrlRowStatus to 'active'."
293    ::= { cNotifCtrlEntry 4 }
294
295cNotifCtrlDescr OBJECT-TYPE
296    SYNTAX          SnmpAdminString (SIZE  (0..255))
297    MAX-ACCESS      read-create
298    STATUS          current
299    DESCRIPTION
300        "This object specifies a human readable string which has more
301        descriptive information about the notification."
302    ::= { cNotifCtrlEntry 5 }
303
304
305-- conformance information
306
307cNotifCtrlMIBConformance  OBJECT IDENTIFIER
308    ::= { ciscoNotificationControlMIB 2 }
309
310cNotifCtrlMIBCompliances  OBJECT IDENTIFIER
311    ::= { cNotifCtrlMIBConformance 1 }
312
313cNotifCtrlMIBGroups  OBJECT IDENTIFIER
314    ::= { cNotifCtrlMIBConformance 2 }
315
316
317-- compliance statements
318
319cNotifCtrlMIBCompliance MODULE-COMPLIANCE
320    STATUS          deprecated
321    DESCRIPTION
322        "The compliance statement for the SNMP entities that
323        implement the ciscoNotifactionControlMIB module."
324    MODULE          -- this module
325    MANDATORY-GROUPS { cNotifCtrlConfigGroup }
326
327    OBJECT          cNotifCtrlStorageType
328    SYNTAX          INTEGER  {
329                        volatile(2),
330                        nonVolatile(3)
331                    }
332    DESCRIPTION
333        "An implementation is required to support only
334        two of the the five enumerated values of the
335        StorageType, namely 'volatile' and
336        'nonVolatile'."
337
338    OBJECT          cNotifCtrlRowStatus
339    SYNTAX          INTEGER  {
340                        active(1),
341                        createAndGo(4),
342                        destroy(6)
343                    }
344    DESCRIPTION
345        "An implementation is required to support only
346        three of the six enumerated values of the
347        RowStatus textual convention, namely 'active',
348        'createAndGo' and 'destroy'."
349    ::= { cNotifCtrlMIBCompliances 1 }
350
351cNotifCtrlMIBComplianceRev1 MODULE-COMPLIANCE
352    STATUS          current
353    DESCRIPTION
354        "The compliance statement for the SNMP entities that
355        implement the ciscoNotifactionControlMIB module."
356    MODULE          -- this module
357    MANDATORY-GROUPS { cNotifCtrlConfigGroup }
358
359    GROUP           cNotifCtrlConfigExtGroup
360    DESCRIPTION
361        "This group is required for if user wants to specify
362        trap description."
363
364    OBJECT          cNotifCtrlStorageType
365    SYNTAX          INTEGER  {
366                        volatile(2),
367                        nonVolatile(3)
368                    }
369    DESCRIPTION
370        "An implementation is required to support only
371        two of the the five enumerated values of the
372        StorageType, namely 'volatile' and
373        'nonVolatile'."
374
375    OBJECT          cNotifCtrlRowStatus
376    SYNTAX          INTEGER  {
377                        active(1),
378                        createAndGo(4),
379                        destroy(6)
380                    }
381    DESCRIPTION
382        "An implementation is required to support only
383        three of the six enumerated values of the
384        RowStatus textual convention, namely 'active',
385        'createAndGo' and 'destroy'."
386
387    OBJECT          cNotifCtrlDescr
388    MIN-ACCESS      read-only
389    DESCRIPTION
390        "Write access is not required."
391    ::= { cNotifCtrlMIBCompliances 2 }
392
393-- units of conformance
394
395cNotifCtrlConfigGroup OBJECT-GROUP
396    OBJECTS         {
397                        cNotifCtrlMode,
398                        cNotifCtrlCurrentState,
399                        cNotifCtrlThreshold,
400                        cNotifCtrlSamplingInterval,
401                        cNotifCtrlTableSize,
402                        cNotifCtrlIndexNext,
403                        cNotifCtrlOID,
404                        cNotifCtrlStorageType,
405                        cNotifCtrlRowStatus
406                    }
407    STATUS          current
408    DESCRIPTION
409        "This collection of objects represents the configuration,
410        monitoring and status parameters related to notification
411        control."
412    ::= { cNotifCtrlMIBGroups 1 }
413
414cNotifCtrlConfigExtGroup OBJECT-GROUP
415    OBJECTS         { cNotifCtrlDescr }
416    STATUS          current
417    DESCRIPTION
418        "The extended set of notification control variable(s)."
419    ::= { cNotifCtrlMIBGroups 2 }
420
421END
422
423
424
425