userapps/opensource/net-snmp/mibs/SNMP-NOTIFICATION-MIB.txt

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