mibs/ietf/SNMP-NOTIFICATION-MIB

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