1SNMP-NOTIFICATION-MIB(7)              MIB             SNMP-NOTIFICATION-MIB(7)
2
3
4
5   SNMP-NOTIFICATION-MIB DEFINITIONS ::= BEGIN
6
7   IMPORTS
8       MODULE-IDENTITY,
9       OBJECT-TYPE,
10       snmpModules
11           FROM SNMPv2-SMI
12
13       RowStatus,
14       StorageType
15           FROM SNMPv2-TC
16
17       SnmpAdminString
18           FROM SNMP-FRAMEWORK-MIB
19
20       SnmpTagValue,
21       snmpTargetParamsName
22           FROM SNMP-TARGET-MIB
23
24       MODULE-COMPLIANCE,
25       OBJECT-GROUP
26           FROM SNMPv2-CONF;
27
28   snmpNotificationMIB MODULE-IDENTITY
29       LAST-UPDATED "9808040000Z"
30       ORGANIZATION "IETF SNMPv3 Working Group"
31       CONTACT-INFO
32           "WG-email:   snmpv3@tis.com
33            Subscribe:  majordomo@tis.com
34                        In message body:  subscribe snmpv3
35
36            Chair:      Russ Mundy
37                        Trusted Information Systems
38            Postal:     3060 Washington Rd
39                        Glenwood MD 21738
40                        USA
41            EMail:      mundy@tis.com
42            Phone:      +1-301-854-6889
43
44            Co-editor:  David B. Levi
45                        SNMP Research, Inc.
46            Postal:     3001 Kimberlin Heights Road
47                        Knoxville, TN 37920-9716
48            EMail:      levi@snmp.com
49            Phone:      +1 423 573 1434
50
51            Co-editor:  Paul Meyer
52                        Secure Computing Corporation
53            Postal:     2675 Long Lake Road
54                        Roseville, MN 55113
55            EMail:      paul_meyer@securecomputing.com
56            Phone:      +1 651 628 1592
57
58            Co-editor:  Bob Stewart
59                        Cisco Systems, Inc.
60            Postal:     170 West Tasman Drive
61                        San Jose, CA 95134-1706
62            EMail:      bstewart@cisco.com
63            Phone:      +1 603 654 2686"
64       DESCRIPTION
65           "This MIB module defines MIB objects which provide
66            mechanisms to remotely configure the parameters
67            used by an SNMP entity for the generation of
68            notifications."
69       REVISION    "9808040000Z"
70       DESCRIPTION "Clarifications, published as
71                    draft-ietf-snmpv3-appl-v2-01.txt."
72       REVISION    "9707140000Z"
73       DESCRIPTION "The initial revision, published as RFC2273."
74       ::= { snmpModules 13 }
75
76   snmpNotifyObjects       OBJECT IDENTIFIER ::=
77                                             { snmpNotificationMIB 1 }
78
79   snmpNotifyConformance   OBJECT IDENTIFIER ::=
80                                             { snmpNotificationMIB 3 }
81
82   --
83   --
84   -- The snmpNotifyObjects group
85   --
86   --
87
88   snmpNotifyTable OBJECT-TYPE
89       SYNTAX      SEQUENCE OF SnmpNotifyEntry
90       MAX-ACCESS  not-accessible
91       STATUS      current
92       DESCRIPTION
93           "This table is used to select management targets which should
94            receive notifications, as well as the type of notification
95            which should be sent to each selected management target."
96       ::= { snmpNotifyObjects 1 }
97
98   snmpNotifyEntry OBJECT-TYPE
99       SYNTAX      SnmpNotifyEntry
100       MAX-ACCESS  not-accessible
101       STATUS      current
102       DESCRIPTION
103           "An entry in this table selects a set of management targets
104            which should receive notifications, as well as the type of
105            notification which should be sent to each selected
106            management target.
107
108            Entries in the snmpNotifyTable are created and
109            deleted using the snmpNotifyRowStatus object."
110       INDEX { IMPLIED snmpNotifyName }
111       ::= { snmpNotifyTable 1 }
112
113   SnmpNotifyEntry ::= SEQUENCE {
114       snmpNotifyName         SnmpAdminString,
115       snmpNotifyTag          SnmpTagValue,
116       snmpNotifyType         INTEGER,
117       snmpNotifyStorageType  StorageType,
118       snmpNotifyRowStatus    RowStatus
119   }
120
121   snmpNotifyName OBJECT-TYPE
122       SYNTAX      SnmpAdminString (SIZE(1..32))
123       MAX-ACCESS  not-accessible
124       STATUS      current
125       DESCRIPTION
126           "The locally arbitrary, but unique identifier associated
127            with this snmpNotifyEntry."
128       ::= { snmpNotifyEntry 1 }
129
130   snmpNotifyTag OBJECT-TYPE
131       SYNTAX      SnmpTagValue
132       MAX-ACCESS  read-create
133       STATUS      current
134       DESCRIPTION
135           "This object contains a single tag value which is used
136            to select entries in the snmpTargetAddrTable.  Any entry
137            in the snmpTargetAddrTable which contains a tag value
138            which is equal to the value of an instance of this
139            object is selected.  If this object contains a value
140            of zero length, no entries are selected."
141       DEFVAL { "" }
142       ::= { snmpNotifyEntry 2 }
143
144   snmpNotifyType OBJECT-TYPE
145       SYNTAX      INTEGER {
146                       trap(1),
147                       inform(2)
148                   }
149       MAX-ACCESS  read-create
150       STATUS      current
151       DESCRIPTION
152           "This object determines the type of notification to
153            be generated for entries in the snmpTargetAddrTable
154            selected by the corresponding instance of
155            snmpNotifyTag.  This value is only used when
156            generating notifications, and is ignored when
157            using the snmpTargetAddrTable for other purposes.
158
159            If the value of this object is trap(1), then any
160            messages generated for selected rows will contain
161            Unconfirmed-Class PDUs.
162
163            If the value of this object is inform(2), then any
164            messages generated for selected rows will contain
165            Confirmed-Class PDUs.
166
167            Note that if an SNMP entity only supports
168            generation of Unconfirmed-Class PDUs (and not
169            Confirmed-Class PDUs), then this object may be
170            read-only."
171       DEFVAL { trap }
172       ::= { snmpNotifyEntry 3 }
173
174   snmpNotifyStorageType OBJECT-TYPE
175       SYNTAX      StorageType
176       MAX-ACCESS  read-create
177       STATUS      current
178       DESCRIPTION
179           "The storage type for this conceptual row."
180       DEFVAL { nonVolatile }
181       ::= { snmpNotifyEntry 4 }
182
183   snmpNotifyRowStatus OBJECT-TYPE
184       SYNTAX      RowStatus
185       MAX-ACCESS  read-create
186       STATUS      current
187       DESCRIPTION
188           "The status of this conceptual row.
189
190            To create a row in this table, a manager must
191            set this object to either createAndGo(4) or
192            createAndWait(5)."
193       ::= { snmpNotifyEntry 5 }
194
195   snmpNotifyFilterProfileTable OBJECT-TYPE
196       SYNTAX      SEQUENCE OF SnmpNotifyFilterProfileEntry
197       MAX-ACCESS  not-accessible
198       STATUS      current
199       DESCRIPTION
200           "This table is used to associate a notification filter
201            profile with a particular set of target parameters."
202       ::= { snmpNotifyObjects 2 }
203
204   snmpNotifyFilterProfileEntry OBJECT-TYPE
205       SYNTAX      SnmpNotifyFilterProfileEntry
206       MAX-ACCESS  not-accessible
207       STATUS      current
208       DESCRIPTION
209           "An entry in this table indicates the name of the filter
210            profile to be used when generating notifications using
211            the corresponding entry in the snmpTargetParamsTable.
212
213            Entries in the snmpNotifyFilterProfileTable are created
214            and deleted using the snmpNotifyFilterProfileRowStatus
215            object."
216       INDEX { IMPLIED snmpTargetParamsName }
217       ::= { snmpNotifyFilterProfileTable 1 }
218
219   SnmpNotifyFilterProfileEntry ::= SEQUENCE {
220       snmpNotifyFilterProfileName         SnmpAdminString,
221       snmpNotifyFilterProfileStorType     StorageType,
222       snmpNotifyFilterProfileRowStatus    RowStatus
223   }
224
225   snmpNotifyFilterProfileName OBJECT-TYPE
226       SYNTAX      SnmpAdminString (SIZE(1..32))
227       MAX-ACCESS  read-create
228       STATUS      current
229       DESCRIPTION
230           "The name of the filter profile to be used when generating
231            notifications using the corresponding entry in the
232            snmpTargetAddrTable."
233       ::= { snmpNotifyFilterProfileEntry 1 }
234
235   snmpNotifyFilterProfileStorType OBJECT-TYPE
236       SYNTAX      StorageType
237       MAX-ACCESS  read-create
238       STATUS      current
239       DESCRIPTION
240           "The storage type of this conceptual row."
241       DEFVAL { nonVolatile }
242       ::= { snmpNotifyFilterProfileEntry 2 }
243
244   snmpNotifyFilterProfileRowStatus OBJECT-TYPE
245       SYNTAX      RowStatus
246       MAX-ACCESS  read-create
247       STATUS      current
248       DESCRIPTION
249           "The status of this conceptual row.
250
251            To create a row in this table, a manager must
252            set this object to either createAndGo(4) or
253            createAndWait(5).
254
255            Until instances of all corresponding columns are
256            appropriately configured, the value of the
257            corresponding instance of the
258            snmpNotifyFilterProfileRowStatus column is 'notReady'.
259
260            In particular, a newly created row cannot be made
261            active until the corresponding instance of
262            snmpNotifyFilterProfileName has been set."
263       ::= { snmpNotifyFilterProfileEntry 3 }
264
265   snmpNotifyFilterTable OBJECT-TYPE
266       SYNTAX      SEQUENCE OF SnmpNotifyFilterEntry
267       MAX-ACCESS  not-accessible
268       STATUS      current
269       DESCRIPTION
270           "The table of filter profiles.  Filter profiles are used
271            to determine whether particular management targets should
272            receive particular notifications.
273
274            When a notification is generated, it must be compared
275            with the filters associated with each management target
276            which is configured to receive notifications, in order to
277            determine whether it may be sent to each such management
278            target.
279
280            A more complete discussion of notification filtering
281            can be found in section 6. of [SNMP-APPL]."
282       ::= { snmpNotifyObjects 3 }
283
284   snmpNotifyFilterEntry OBJECT-TYPE
285       SYNTAX      SnmpNotifyFilterEntry
286       MAX-ACCESS  not-accessible
287       STATUS      current
288       DESCRIPTION
289           "An element of a filter profile.
290
291            Entries in the snmpNotifyFilterTable are created and
292            deleted using the snmpNotifyFilterRowStatus object."
293       INDEX {         snmpNotifyFilterProfileName,
294               IMPLIED snmpNotifyFilterSubtree }
295       ::= { snmpNotifyFilterTable 1 }
296
297   SnmpNotifyFilterEntry ::= SEQUENCE {
298       snmpNotifyFilterSubtree           OBJECT IDENTIFIER,
299       snmpNotifyFilterMask              OCTET STRING,
300       snmpNotifyFilterType              INTEGER,
301       snmpNotifyFilterStorageType       StorageType,
302       snmpNotifyFilterRowStatus         RowStatus
303   }
304
305   snmpNotifyFilterSubtree OBJECT-TYPE
306       SYNTAX      OBJECT IDENTIFIER
307       MAX-ACCESS  not-accessible
308       STATUS      current
309       DESCRIPTION
310           "The MIB subtree which, when combined with the corresponding
311            instance of snmpNotifyFilterMask, defines a family of
312            subtrees which are included in or excluded from the
313            filter profile."
314       ::= { snmpNotifyFilterEntry 1 }
315
316   snmpNotifyFilterMask OBJECT-TYPE
317       SYNTAX      OCTET STRING (SIZE(0..16))
318       MAX-ACCESS  read-create
319       STATUS      current
320       DESCRIPTION
321           "The bit mask which, in combination with the corresponding
322            instance of snmpNotifyFilterSubtree, defines a family of
323            subtrees which are included in or excluded from the
324            filter profile.
325
326            Each bit of this bit mask corresponds to a
327            sub-identifier of snmpNotifyFilterSubtree, with the
328            most significant bit of the i-th octet of this octet
329            string value (extended if necessary, see below)
330            corresponding to the (8*i - 7)-th sub-identifier, and
331            the least significant bit of the i-th octet of this
332            octet string corresponding to the (8*i)-th
333            sub-identifier, where i is in the range 1 through 16.
334
335            Each bit of this bit mask specifies whether or not
336            the corresponding sub-identifiers must match when
337            determining if an OBJECT IDENTIFIER matches this
338            family of filter subtrees; a '1' indicates that an
339            exact match must occur; a '0' indicates 'wild card',
340            i.e., any sub-identifier value matches.
341
342            Thus, the OBJECT IDENTIFIER X of an object instance
343            is contained in a family of filter subtrees if, for
344            each sub-identifier of the value of
345            snmpNotifyFilterSubtree, either:
346
347              the i-th bit of snmpNotifyFilterMask is 0, or
348
349              the i-th sub-identifier of X is equal to the i-th
350              sub-identifier of the value of
351              snmpNotifyFilterSubtree.
352
353            If the value of this bit mask is M bits long and
354            there are more than M sub-identifiers in the
355            corresponding instance of snmpNotifyFilterSubtree,
356            then the bit mask is extended with 1's to be the
357            required length.
358
359            Note that when the value of this object is the
360            zero-length string, this extension rule results in
361            a mask of all-1's being used (i.e., no 'wild card'),
362            and the family of filter subtrees is the one
363            subtree uniquely identified by the corresponding
364            instance of snmpNotifyFilterSubtree."
365       DEFVAL { ''H }
366       ::= { snmpNotifyFilterEntry 2 }
367
368   snmpNotifyFilterType OBJECT-TYPE
369       SYNTAX      INTEGER {
370                       included(1),
371                       excluded(2)
372                   }
373       MAX-ACCESS  read-create
374       STATUS      current
375       DESCRIPTION
376           "This object indicates whether the family of filter subtrees
377            defined by this entry are included in or excluded from a
378            filter.  A more detailed discussion of the use of this
379            object can be found in section 6. of [SNMP-APPL]."
380       DEFVAL { included }
381       ::= { snmpNotifyFilterEntry 3 }
382
383   snmpNotifyFilterStorageType OBJECT-TYPE
384       SYNTAX      StorageType
385       MAX-ACCESS  read-create
386       STATUS      current
387       DESCRIPTION
388           "The storage type of this conceptual row."
389       DEFVAL { nonVolatile }
390       ::= { snmpNotifyFilterEntry 4 }
391
392   snmpNotifyFilterRowStatus OBJECT-TYPE
393       SYNTAX      RowStatus
394       MAX-ACCESS  read-create
395       STATUS      current
396       DESCRIPTION
397           "The status of this conceptual row.
398
399            To create a row in this table, a manager must
400            set this object to either createAndGo(4) or
401            createAndWait(5)."
402       ::= { snmpNotifyFilterEntry 5 }
403
404   --
405   --
406   -- Conformance information
407   --
408   --
409   snmpNotifyCompliances OBJECT IDENTIFIER ::=
410                                           { snmpNotifyConformance 1 }
411   snmpNotifyGroups      OBJECT IDENTIFIER ::=
412                                           { snmpNotifyConformance 2 }
413
414   --
415   --
416   -- Compliance statements
417   --
418   --
419
420   snmpNotifyBasicCompliance MODULE-COMPLIANCE
421       STATUS      current
422       DESCRIPTION
423           "The compliance statement for minimal SNMP entities which
424            implement only SNMP Unconfirmed-Class notifications and
425            read-create operations on only the snmpTargetAddrTable."
426       MODULE SNMP-TARGET-MIB
427           MANDATORY-GROUPS { snmpTargetBasicGroup }
428
429           OBJECT snmpTargetParamsMPModel
430           MIN-ACCESS    read-only
431           DESCRIPTION
432               "Create/delete/modify access is not required."
433
434           OBJECT snmpTargetParamsSecurityModel
435           MIN-ACCESS    read-only
436           DESCRIPTION
437               "Create/delete/modify access is not required."
438
439           OBJECT snmpTargetParamsSecurityName
440           MIN-ACCESS    read-only
441           DESCRIPTION
442               "Create/delete/modify access is not required."
443
444           OBJECT snmpTargetParamsSecurityLevel
445           MIN-ACCESS    read-only
446           DESCRIPTION
447               "Create/delete/modify access is not required."
448
449           OBJECT snmpTargetParamsStorageType
450           SYNTAX INTEGER {
451               readOnly(5)
452           }
453           MIN-ACCESS    read-only
454           DESCRIPTION
455               "Create/delete/modify access is not required.
456                Support of the values other(1), volatile(2),
457                nonVolatile(3), and permanent(4) is not required."
458
459           OBJECT snmpTargetParamsRowStatus
460           SYNTAX INTEGER {
461               active(1)
462           }
463           MIN-ACCESS    read-only
464           DESCRIPTION
465               "Create/delete/modify access to the
466                snmpTargetParamsTable is not required.
467                Support of the values notInService(2), notReady(3),
468                createAndGo(4), createAndWait(5), and destroy(6) is
469                not required."
470
471       MODULE -- This Module
472           MANDATORY-GROUPS { snmpNotifyGroup }
473
474           OBJECT snmpNotifyTag
475           MIN-ACCESS    read-only
476           DESCRIPTION
477               "Create/delete/modify access is not required."
478
479           OBJECT snmpNotifyType
480           SYNTAX INTEGER {
481               trap(1)
482           }
483           MIN-ACCESS    read-only
484           DESCRIPTION
485               "Create/delete/modify access is not required.
486                Support of the value notify(2) is not required."
487
488           OBJECT snmpNotifyStorageType
489           SYNTAX INTEGER {
490               readOnly(5)
491           }
492           MIN-ACCESS    read-only
493           DESCRIPTION
494               "Create/delete/modify access is not required.
495                Support of the values other(1), volatile(2),
496                nonVolatile(3), and permanent(4) is not required."
497
498           OBJECT snmpNotifyRowStatus
499           SYNTAX INTEGER {
500               active(1)
501           }
502           MIN-ACCESS    read-only
503           DESCRIPTION
504               "Create/delete/modify access to the
505                snmpNotifyTable is not required.
506                Support of the values notInService(2), notReady(3),
507                createAndGo(4), createAndWait(5), and destroy(6) is
508                not required."
509
510       ::= { snmpNotifyCompliances 1 }
511
512   snmpNotifyBasicFiltersCompliance MODULE-COMPLIANCE
513       STATUS      current
514       DESCRIPTION
515           "The compliance statement for SNMP entities which implement
516            SNMP Unconfirmed-Class notifications with filtering, and
517            read-create operations on all related tables."
518       MODULE SNMP-TARGET-MIB
519           MANDATORY-GROUPS { snmpTargetBasicGroup }
520       MODULE -- This Module
521           MANDATORY-GROUPS { snmpNotifyGroup,
522                              snmpNotifyFilterGroup }
523       ::= { snmpNotifyCompliances 2 }
524
525   snmpNotifyFullCompliance MODULE-COMPLIANCE
526       STATUS      current
527       DESCRIPTION
528           "The compliance statement for SNMP entities which either
529            implement only SNMP Confirmed-Class notifications, or both
530            SNMP Unconfirmed-Class and Confirmed-Class notifications,
531            plus filtering and read-create operations on all related
532            tables."
533       MODULE SNMP-TARGET-MIB
534           MANDATORY-GROUPS { snmpTargetBasicGroup,
535                              snmpTargetResponseGroup }
536       MODULE -- This Module
537           MANDATORY-GROUPS { snmpNotifyGroup,
538                              snmpNotifyFilterGroup }
539       ::= { snmpNotifyCompliances 3 }
540
541   snmpNotifyGroup OBJECT-GROUP
542       OBJECTS {
543           snmpNotifyTag,
544           snmpNotifyType,
545           snmpNotifyStorageType,
546           snmpNotifyRowStatus
547       }
548       STATUS      current
549       DESCRIPTION
550           "A collection of objects for selecting which management
551            targets are used for generating notifications, and the
552            type of notification to be generated for each selected
553            management target."
554       ::= { snmpNotifyGroups 1 }
555
556   snmpNotifyFilterGroup OBJECT-GROUP
557       OBJECTS {
558           snmpNotifyFilterProfileName,
559           snmpNotifyFilterProfileStorType,
560           snmpNotifyFilterProfileRowStatus,
561           snmpNotifyFilterMask,
562           snmpNotifyFilterType,
563           snmpNotifyFilterStorageType,
564           snmpNotifyFilterRowStatus
565       }
566       STATUS      current
567       DESCRIPTION
568           "A collection of objects providing remote configuration
569            of notification filters."
570       ::= { snmpNotifyGroups 2 }
571
572   END
573
574
575
576
577Erlang/OTP                           SNMP             SNMP-NOTIFICATION-MIB(7)
Impressum