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

   1 SNMP-COMMUNITY-MIB DEFINITIONS ::= BEGIN
   2
   3 IMPORTS
   4     IpAddress,
   5     MODULE-IDENTITY,
   6     OBJECT-TYPE,
   7     Integer32,
   8     snmpModules
   9         FROM SNMPv2-SMI
  10     RowStatus,
  11     StorageType
  12         FROM SNMPv2-TC
  13     SnmpAdminString,
  14     SnmpEngineID
  15         FROM SNMP-FRAMEWORK-MIB
  16     SnmpTagValue,
  17     snmpTargetAddrEntry
  18         FROM SNMP-TARGET-MIB
  19     MODULE-COMPLIANCE,
  20     OBJECT-GROUP
  21         FROM SNMPv2-CONF;
  22
  23 snmpCommunityMIB MODULE-IDENTITY
  24     LAST-UPDATED "200003060000Z"          -- 6 Mar 2000, midnight
  25     ORGANIZATION "SNMPv3 Working Group"
  26     CONTACT-INFO "WG-email:   snmpv3@lists.tislabs.com
  27                   Subscribe:  majordomo@lists.tislabs.com
  28                               In msg body:  subscribe snmpv3
  29
  30                   Chair:      Russ Mundy
  31                               TIS Labs at Network Associates
  32                   Postal:     3060 Washington Rd
  33                               Glenwood MD 21738
  34                               USA
  35                   Email:      mundy@tislabs.com
  36                   Phone:      +1-301-854-6889
  37
  38                   Co-editor:  Rob Frye
  39                               CoSine Communications
  40                   Postal:     1200 Bridge Parkway
  41                               Redwood City, CA 94065
  42                               USA
  43                   E-mail:     rfrye@cosinecom.com
  44                   Phone:      +1 703 725 1130
  45
  46                   Co-editor:  David B. Levi
  47                               Nortel Networks
  48                   Postal:     3505 Kesterwood Drive
  49                               Knoxville, TN 37918
  50                   E-mail:     dlevi@nortelnetworks.com
  51                   Phone:      +1 423 686 0432
  52
  53                   Co-editor:  Shawn A. Routhier
  54                               Integrated Systems Inc.
  55                   Postal:     333 North Ave 4th Floor
  56                               Wakefield, MA 01880
  57                   E-mail:     sar@epilogue.com
  58                   Phone:      +1 781 245 0804
  59
  60                   Co-editor:  Bert Wijnen
  61                               Lucent Technologies
  62                   Postal:     Schagen 33
  63                               3461 GL Linschoten
  64                               Netherlands
  65                   Email:      bwijnen@lucent.com
  66                   Phone:      +31-348-407-775
  67                  "
  68         DESCRIPTION
  69             "This MIB module defines objects to help support coexistence
  70              between SNMPv1, SNMPv2c, and SNMPv3."
  71         REVISION "200003060000Z" -- 6 Mar 2000
  72         DESCRIPTION "This version published as RFC 2576."
  73         REVISION "199905130000Z" -- 13 May 1999
  74         DESCRIPTION "The Initial Revision"
  75     ::= { snmpModules 18 }
  76
  77 -- Administrative assignments ****************************************
  78
  79 snmpCommunityMIBObjects     OBJECT IDENTIFIER ::= { snmpCommunityMIB 1 }
  80 snmpCommunityMIBConformance OBJECT IDENTIFIER ::= { snmpCommunityMIB 2 }
  81
  82 --
  83 -- The snmpCommunityTable contains a database of community strings.
  84 -- This table provides mappings between community strings, and the
  85
  86 -- parameters required for View-based Access Control.
  87 --
  88
  89 snmpCommunityTable OBJECT-TYPE
  90     SYNTAX       SEQUENCE OF SnmpCommunityEntry
  91     MAX-ACCESS   not-accessible
  92     STATUS       current
  93     DESCRIPTION
  94         "The table of community strings configured in the SNMP
  95          engine's Local Configuration Datastore (LCD)."
  96     ::= { snmpCommunityMIBObjects 1 }
  97
  98 snmpCommunityEntry OBJECT-TYPE
  99     SYNTAX       SnmpCommunityEntry
 100     MAX-ACCESS   not-accessible
 101     STATUS       current
 102     DESCRIPTION
 103         "Information about a particular community string."
 104     INDEX       { IMPLIED snmpCommunityIndex }
 105     ::= { snmpCommunityTable 1 }
 106
 107 SnmpCommunityEntry ::= SEQUENCE {
 108     snmpCommunityIndex               SnmpAdminString,
 109     snmpCommunityName                OCTET STRING,
 110     snmpCommunitySecurityName        SnmpAdminString,
 111     snmpCommunityContextEngineID     SnmpEngineID,
 112     snmpCommunityContextName         SnmpAdminString,
 113     snmpCommunityTransportTag        SnmpTagValue,
 114     snmpCommunityStorageType         StorageType,
 115     snmpCommunityStatus              RowStatus
 116 }
 117
 118 snmpCommunityIndex OBJECT-TYPE
 119     SYNTAX      SnmpAdminString (SIZE(1..32))
 120     MAX-ACCESS  not-accessible
 121     STATUS      current
 122     DESCRIPTION
 123         "The unique index value of a row in this table."
 124     ::= { snmpCommunityEntry 1 }
 125
 126 snmpCommunityName OBJECT-TYPE
 127     SYNTAX       OCTET STRING
 128     MAX-ACCESS   read-create
 129     STATUS       current
 130     DESCRIPTION
 131         "The community string for which a row in this table
 132          represents a configuration."
 133     ::= { snmpCommunityEntry 2 }
 134
 135 snmpCommunitySecurityName OBJECT-TYPE
 136     SYNTAX       SnmpAdminString (SIZE(1..32))
 137     MAX-ACCESS   read-create
 138     STATUS       current
 139     DESCRIPTION
 140         "A human readable string representing the corresponding
 141          value of snmpCommunityName in a Security Model
 142          independent format."
 143     ::= { snmpCommunityEntry 3 }
 144
 145 snmpCommunityContextEngineID OBJECT-TYPE
 146     SYNTAX       SnmpEngineID
 147     MAX-ACCESS   read-create
 148     STATUS       current
 149     DESCRIPTION
 150         "The contextEngineID indicating the location of the
 151          context in which management information is accessed
 152          when using the community string specified by the
 153          corresponding instance of snmpCommunityName.
 154
 155          The default value is the snmpEngineID of the entity in
 156          which this object is instantiated."
 157     ::= { snmpCommunityEntry 4 }
 158
 159 snmpCommunityContextName OBJECT-TYPE
 160     SYNTAX       SnmpAdminString (SIZE(0..32))
 161     MAX-ACCESS   read-create
 162     STATUS       current
 163     DESCRIPTION
 164         "The context in which management information is accessed
 165          when using the community string specified by the corresponding
 166          instance of snmpCommunityName."
 167     DEFVAL      { ''H }   -- the empty string
 168     ::= { snmpCommunityEntry 5 }
 169
 170 snmpCommunityTransportTag OBJECT-TYPE
 171     SYNTAX       SnmpTagValue
 172     MAX-ACCESS   read-create
 173     STATUS       current
 174     DESCRIPTION
 175         "This object specifies a set of transport endpoints
 176          from which a command responder application will accept
 177          management requests.  If a management request containing
 178          this community is received on a transport endpoint other
 179          than the transport endpoints identified by this object,
 180          the request is deemed unauthentic.
 181
 182          The transports identified by this object are specified
 183
 184          in the snmpTargetAddrTable.  Entries in that table
 185          whose snmpTargetAddrTagList contains this tag value
 186          are identified.
 187
 188          If the value of this object has zero-length, transport
 189          endpoints are not checked when authenticating messages
 190          containing this community string."
 191     DEFVAL      { ''H }   -- the empty string
 192     ::= { snmpCommunityEntry 6 }
 193
 194 snmpCommunityStorageType OBJECT-TYPE
 195     SYNTAX       StorageType
 196     MAX-ACCESS   read-create
 197     STATUS       current
 198     DESCRIPTION
 199         "The storage type for this conceptual row in the
 200          snmpCommunityTable.  Conceptual rows having the value
 201          'permanent' need not allow write-access to any
 202          columnar object in the row."
 203     ::= { snmpCommunityEntry 7 }
 204
 205 snmpCommunityStatus OBJECT-TYPE
 206     SYNTAX       RowStatus
 207     MAX-ACCESS   read-create
 208     STATUS       current
 209     DESCRIPTION
 210         "The status of this conceptual row in the snmpCommunityTable.
 211
 212          An entry in this table is not qualified for activation
 213          until instances of all corresponding columns have been
 214          initialized, either through default values, or through
 215          Set operations.  The snmpCommunityName and
 216          snmpCommunitySecurityName objects must be explicitly set.
 217
 218          There is no restriction on setting columns in this table
 219          when the value of snmpCommunityStatus is active(1)."
 220     ::= { snmpCommunityEntry 8 }
 221
 222 --
 223 -- The snmpTargetAddrExtTable
 224 --
 225
 226 snmpTargetAddrExtTable OBJECT-TYPE
 227     SYNTAX       SEQUENCE OF SnmpTargetAddrExtEntry
 228     MAX-ACCESS   not-accessible
 229     STATUS       current
 230     DESCRIPTION
 231         "The table of mask and mms values associated with the
 232
 233          snmpTargetAddrTable.
 234
 235          The snmpTargetAddrExtTable augments the
 236          snmpTargetAddrTable with a transport address mask value
 237          and a maximum message size value.  The transport address
 238          mask allows entries in the snmpTargetAddrTable to define
 239          a set of addresses instead of just a single address.
 240          The maximum message size value allows the maximum
 241          message size of another SNMP entity to be configured for
 242          use in SNMPv1 (and SNMPv2c) transactions, where the
 243          message format does not specify a maximum message size."
 244     ::= { snmpCommunityMIBObjects 2 }
 245
 246 snmpTargetAddrExtEntry OBJECT-TYPE
 247     SYNTAX       SnmpTargetAddrExtEntry
 248     MAX-ACCESS   not-accessible
 249     STATUS       current
 250     DESCRIPTION
 251         "Information about a particular mask and mms value."
 252     AUGMENTS       { snmpTargetAddrEntry }
 253     ::= { snmpTargetAddrExtTable 1 }
 254
 255 SnmpTargetAddrExtEntry ::= SEQUENCE {
 256     snmpTargetAddrTMask              OCTET STRING,
 257     snmpTargetAddrMMS                Integer32
 258 }
 259
 260 snmpTargetAddrTMask OBJECT-TYPE
 261     SYNTAX      OCTET STRING (SIZE (0..255))
 262     MAX-ACCESS  read-create
 263     STATUS      current
 264     DESCRIPTION
 265         "The mask value associated with an entry in the
 266          snmpTargetAddrTable.  The value of this object must
 267          have the same length as the corresponding instance of
 268          snmpTargetAddrTAddress, or must have length 0.  An
 269          attempt to set it to any other value will result in
 270          an inconsistentValue error.
 271
 272          The value of this object allows an entry in the
 273          snmpTargetAddrTable to specify multiple addresses.
 274          The mask value is used to select which bits of
 275          a transport address must match bits of the corresponding
 276          instance of snmpTargetAddrTAddress, in order for the
 277          transport address to match a particular entry in the
 278          snmpTargetAddrTable.  Bits which are 1 in the mask
 279          value indicate bits in the transport address which
 280          must match bits in the snmpTargetAddrTAddress value.
 281
 282          Bits which are 0 in the mask indicate bits in the
 283          transport address which need not match.  If the
 284          length of the mask is 0, the mask should be treated
 285          as if all its bits were 1 and its length were equal
 286          to the length of the corresponding value of
 287          snmpTargetAddrTable.
 288
 289          This object may not be modified while the value of the
 290          corresponding instance of snmpTargetAddrRowStatus is
 291          active(1).  An attempt to set this object in this case
 292          will result in an inconsistentValue error."
 293     DEFVAL { ''H }
 294     ::= { snmpTargetAddrExtEntry 1 }
 295
 296 snmpTargetAddrMMS OBJECT-TYPE
 297     SYNTAX      Integer32 (0|484..2147483647)
 298     MAX-ACCESS  read-create
 299     STATUS      current
 300     DESCRIPTION
 301         "The maximum message size value associated with an entry
 302          in the snmpTargetAddrTable."
 303     DEFVAL { 484 }
 304     ::= { snmpTargetAddrExtEntry 2 }
 305
 306 --
 307 -- The snmpTrapAddress and snmpTrapCommunity objects are included
 308 -- in notifications that are forwarded by a proxy, which were
 309 -- originally received as SNMPv1 Trap messages.
 310 --
 311
 312 snmpTrapAddress OBJECT-TYPE
 313     SYNTAX      IpAddress
 314     MAX-ACCESS  accessible-for-notify
 315     STATUS      current
 316     DESCRIPTION
 317         "The value of the agent-addr field of a Trap PDU which
 318          is forwarded by a proxy forwarder application using
 319          an SNMP version other than SNMPv1.  The value of this
 320          object SHOULD contain the value of the agent-addr field
 321          from the original Trap PDU as generated by an SNMPv1
 322          agent."
 323     ::= { snmpCommunityMIBObjects 3 }
 324
 325 snmpTrapCommunity OBJECT-TYPE
 326     SYNTAX      OCTET STRING
 327     MAX-ACCESS  accessible-for-notify
 328     STATUS      current
 329     DESCRIPTION
 330         "The value of the community string field of an SNMPv1
 331          message containing a Trap PDU which is forwarded by a
 332          a proxy forwarder application using an SNMP version
 333          other than SNMPv1.  The value of this object SHOULD
 334          contain the value of the community string field from
 335          the original SNMPv1 message containing a Trap PDU as
 336          generated by an SNMPv1 agent."
 337     ::= { snmpCommunityMIBObjects 4 }
 338
 339 -- Conformance Information *******************************************
 340
 341 snmpCommunityMIBCompliances OBJECT IDENTIFIER
 342                             ::= { snmpCommunityMIBConformance 1 }
 343 snmpCommunityMIBGroups      OBJECT IDENTIFIER
 344                             ::= { snmpCommunityMIBConformance 2 }
 345
 346 -- Compliance statements
 347
 348 snmpCommunityMIBCompliance MODULE-COMPLIANCE
 349     STATUS       current
 350     DESCRIPTION
 351         "The compliance statement for SNMP engines which
 352          implement the SNMP-COMMUNITY-MIB."
 353
 354     MODULE       -- this module
 355         MANDATORY-GROUPS { snmpCommunityGroup }
 356
 357         OBJECT           snmpCommunityName
 358         MIN-ACCESS       read-only
 359         DESCRIPTION     "Write access is not required."
 360
 361         OBJECT           snmpCommunitySecurityName
 362         MIN-ACCESS       read-only
 363         DESCRIPTION     "Write access is not required."
 364
 365         OBJECT           snmpCommunityContextEngineID
 366         MIN-ACCESS       read-only
 367         DESCRIPTION     "Write access is not required."
 368
 369         OBJECT           snmpCommunityContextName
 370         MIN-ACCESS       read-only
 371         DESCRIPTION     "Write access is not required."
 372
 373         OBJECT           snmpCommunityTransportTag
 374         MIN-ACCESS       read-only
 375         DESCRIPTION     "Write access is not required."
 376
 377         OBJECT           snmpCommunityStorageType
 378         MIN-ACCESS       read-only
 379         DESCRIPTION     "Write access is not required."
 380
 381         OBJECT           snmpCommunityStatus
 382         MIN-ACCESS       read-only
 383         DESCRIPTION     "Write access is not required."
 384     ::= { snmpCommunityMIBCompliances 1 }
 385
 386 snmpProxyTrapForwardCompliance MODULE-COMPLIANCE
 387     STATUS       current
 388     DESCRIPTION
 389         "The compliance statement for SNMP engines which
 390          contain a proxy forwarding application which is
 391          capable of forwarding SNMPv1 traps using SNMPv2c
 392          or SNMPv3."
 393     MODULE       -- this module
 394         MANDATORY-GROUPS { snmpProxyTrapForwardGroup }
 395     ::= { snmpCommunityMIBCompliances 2 }
 396
 397 snmpCommunityGroup OBJECT-GROUP
 398     OBJECTS {
 399         snmpCommunityName,
 400         snmpCommunitySecurityName,
 401         snmpCommunityContextEngineID,
 402         snmpCommunityContextName,
 403         snmpCommunityTransportTag,
 404         snmpCommunityStorageType,
 405         snmpCommunityStatus,
 406         snmpTargetAddrTMask,
 407         snmpTargetAddrMMS
 408     }
 409     STATUS       current
 410     DESCRIPTION
 411         "A collection of objects providing for configuration
 412          of community strings for SNMPv1 (and SNMPv2c) usage."
 413     ::= { snmpCommunityMIBGroups 1 }
 414
 415 snmpProxyTrapForwardGroup OBJECT-GROUP
 416     OBJECTS {
 417         snmpTrapAddress,
 418         snmpTrapCommunity
 419     }
 420     STATUS       current
 421     DESCRIPTION
 422         "Objects which are used by proxy forwarding applications
 423          when translating traps between SNMP versions.  These are
 424          used to preserve SNMPv1-specific information when
 425
 426          translating to SNMPv2c or SNMPv3."
 427     ::= { snmpCommunityMIBGroups 3 }
 428
 429 END