Warning, /frameworks/syntax-highlighting/autotests/input/test.mib is written in an unsupported language. File is not indexed.

0001 SNMP-FRAMEWORK-MIB DEFINITIONS ::= BEGIN
0002 
0003 IMPORTS
0004     MODULE-IDENTITY, OBJECT-TYPE,
0005     OBJECT-IDENTITY,
0006     snmpModules                           FROM SNMPv2-SMI
0007     TEXTUAL-CONVENTION                    FROM SNMPv2-TC
0008     MODULE-COMPLIANCE, OBJECT-GROUP       FROM SNMPv2-CONF;
0009 
0010 snmpFrameworkMIB MODULE-IDENTITY
0011     LAST-UPDATED "200210140000Z"
0012     ORGANIZATION "SNMPv3 Working Group"
0013     CONTACT-INFO "WG-EMail:   snmpv3@lists.tislabs.com
0014                   Subscribe:  snmpv3-request@lists.tislabs.com
0015 
0016                   Co-Chair:   Russ Mundy
0017                               Network Associates Laboratories
0018                   postal:     15204 Omega Drive, Suite 300
0019                               Rockville, MD 20850-4601
0020                               USA
0021                   EMail:      mundy@tislabs.com
0022                   phone:      +1 301-947-7107
0023 
0024                   Co-Chair &
0025                   Co-editor:  David Harrington
0026                               Enterasys Networks
0027                   postal:     35 Industrial Way
0028                               P. O. Box 5005
0029                               Rochester, New Hampshire 03866-5005
0030                               USA
0031                   EMail:      dbh@enterasys.com
0032                   phone:      +1 603-337-2614
0033 
0034                   Co-editor:  Randy Presuhn
0035                               BMC Software, Inc.
0036                   postal:     2141 North First Street
0037                               San Jose, California 95131
0038                               USA
0039                   EMail:      randy_presuhn@bmc.com
0040                   phone:      +1 408-546-1006
0041 
0042                   Co-editor:  Bert Wijnen
0043                               Lucent Technologies
0044                   postal:     Schagen 33
0045                               3461 GL Linschoten
0046                               Netherlands
0047 
0048                   EMail:      bwijnen@lucent.com
0049                   phone:      +31 348-680-485
0050                     "
0051        DESCRIPTION  "The SNMP Management Architecture MIB
0052 
0053                      Copyright (C) The Internet Society (2002). This
0054                      version of this MIB module is part of RFC 3411;
0055                      see the RFC itself for full legal notices.
0056                     "
0057 
0058        REVISION     "200210140000Z"         -- 14 October 2002
0059        DESCRIPTION  "Changes in this revision:
0060                      - Updated various administrative information.
0061                      - Corrected some typos.
0062                      - Corrected typo in description of SnmpEngineID
0063                        that led to range overlap for 127.
0064                      - Changed '255a' to '255t' in definition of
0065                        SnmpAdminString to align with current SMI.
0066                      - Reworded 'reserved' for value zero in
0067                        DESCRIPTION of SnmpSecurityModel.
0068                      - The algorithm for allocating security models
0069                        should give 256 per enterprise block, rather
0070                        than 255.
0071                      - The example engine ID of 'abcd' is not
0072                        legal. Replaced with '800002b804616263'H based
0073                        on example enterprise 696, string 'abc'.
0074                      - Added clarification that engineID should
0075                        persist across re-initializations.
0076                      This revision published as RFC 3411.
0077                     "
0078        REVISION     "199901190000Z"         -- 19 January 1999
0079        DESCRIPTION  "Updated editors' addresses, fixed typos.
0080                      Published as RFC 2571.
0081                     "
0082        REVISION     "199711200000Z"         -- 20 November 1997
0083        DESCRIPTION  "The initial version, published in RFC 2271.
0084                     "
0085        ::= { snmpModules 10 }
0086 
0087    -- Textual Conventions used in the SNMP Management Architecture ***
0088 
0089 SnmpEngineID ::= TEXTUAL-CONVENTION
0090     STATUS       current
0091     DESCRIPTION "An SNMP engine's administratively-unique identifier.
0092                  Objects of this type are for identification, not for
0093                  addressing, even though it is possible that an
0094                  address may have been used in the generation of
0095                  a specific value.
0096 
0097                  The value for this object may not be all zeros or
0098                  all 'ff'H or the empty (zero length) string.
0099 
0100                  The initial value for this object may be configured
0101                  via an operator console entry or via an algorithmic
0102                  function.  In the latter case, the following
0103                  example algorithm is recommended.
0104 
0105                  In cases where there are multiple engines on the
0106                  same system, the use of this algorithm is NOT
0107                  appropriate, as it would result in all of those
0108                  engines ending up with the same ID value.
0109 
0110                  1) The very first bit is used to indicate how the
0111                     rest of the data is composed.
0112 
0113                     0 - as defined by enterprise using former methods
0114                         that existed before SNMPv3. See item 2 below.
0115 
0116                     1 - as defined by this architecture, see item 3
0117                         below.
0118 
0119                     Note that this allows existing uses of the
0120                     engineID (also known as AgentID [RFC1910]) to
0121                     co-exist with any new uses.
0122 
0123                  2) The snmpEngineID has a length of 12 octets.
0124 
0125                     The first four octets are set to the binary
0126                     equivalent of the agent's SNMP management
0127                     private enterprise number as assigned by the
0128                     Internet Assigned Numbers Authority (IANA).
0129                     For example, if Acme Networks has been assigned
0130                     { enterprises 696 }, the first four octets would
0131                     be assigned '000002b8'H.
0132 
0133                     The remaining eight octets are determined via
0134                     one or more enterprise-specific methods. Such
0135                     methods must be designed so as to maximize the
0136                     possibility that the value of this object will
0137                     be unique in the agent's administrative domain.
0138                     For example, it may be the IP address of the SNMP
0139                     entity, or the MAC address of one of the
0140                     interfaces, with each address suitably padded
0141                     with random octets.  If multiple methods are
0142                     defined, then it is recommended that the first
0143                     octet indicate the method being used and the
0144                     remaining octets be a function of the method.
0145 
0146                  3) The length of the octet string varies.
0147 
0148                     The first four octets are set to the binary
0149                     equivalent of the agent's SNMP management
0150                     private enterprise number as assigned by the
0151                     Internet Assigned Numbers Authority (IANA).
0152                     For example, if Acme Networks has been assigned
0153                     { enterprises 696 }, the first four octets would
0154                     be assigned '000002b8'H.
0155 
0156                     The very first bit is set to 1. For example, the
0157                     above value for Acme Networks now changes to be
0158                     '800002b8'H.
0159 
0160                     The fifth octet indicates how the rest (6th and
0161                     following octets) are formatted. The values for
0162                     the fifth octet are:
0163 
0164                       0     - reserved, unused.
0165 
0166                       1     - IPv4 address (4 octets)
0167                               lowest non-special IP address
0168 
0169                       2     - IPv6 address (16 octets)
0170                               lowest non-special IP address
0171 
0172                       3     - MAC address (6 octets)
0173                               lowest IEEE MAC address, canonical
0174                               order
0175 
0176                       4     - Text, administratively assigned
0177                               Maximum remaining length 27
0178 
0179                       5     - Octets, administratively assigned
0180                               Maximum remaining length 27
0181 
0182                       6-127 - reserved, unused
0183 
0184                     128-255 - as defined by the enterprise
0185                               Maximum remaining length 27
0186                 "
0187     SYNTAX       OCTET STRING (SIZE(5..32))
0188 
0189 SnmpSecurityModel ::= TEXTUAL-CONVENTION
0190     STATUS       current
0191     DESCRIPTION "An identifier that uniquely identifies a
0192                  Security Model of the Security Subsystem within
0193                  this SNMP Management Architecture.
0194 
0195                  The values for securityModel are allocated as
0196                  follows:
0197 
0198                  - The zero value does not identify any particular
0199                    security model.
0200 
0201                  - Values between 1 and 255, inclusive, are reserved
0202                    for standards-track Security Models and are
0203                    managed by the Internet Assigned Numbers Authority
0204                    (IANA).
0205                  - Values greater than 255 are allocated to
0206                    enterprise-specific Security Models.  An
0207                    enterprise-specific securityModel value is defined
0208                    to be:
0209 
0210                    enterpriseID * 256 + security model within
0211                    enterprise
0212 
0213                    For example, the fourth Security Model defined by
0214                    the enterprise whose enterpriseID is 1 would be
0215                    259.
0216 
0217                  This scheme for allocation of securityModel
0218                  values allows for a maximum of 255 standards-
0219                  based Security Models, and for a maximum of
0220                  256 Security Models per enterprise.
0221 
0222                  It is believed that the assignment of new
0223                  securityModel values will be rare in practice
0224                  because the larger the number of simultaneously
0225                  utilized Security Models, the larger the
0226                  chance that interoperability will suffer.
0227                  Consequently, it is believed that such a range
0228                  will be sufficient.  In the unlikely event that
0229                  the standards committee finds this number to be
0230                  insufficient over time, an enterprise number
0231                  can be allocated to obtain an additional 256
0232                  possible values.
0233 
0234                  Note that the most significant bit must be zero;
0235                  hence, there are 23 bits allocated for various
0236                  organizations to design and define non-standard
0237 
0238                  securityModels.  This limits the ability to
0239                  define new proprietary implementations of Security
0240                  Models to the first 8,388,608 enterprises.
0241 
0242                  It is worthwhile to note that, in its encoded
0243                  form, the securityModel value will normally
0244                  require only a single byte since, in practice,
0245                  the leftmost bits will be zero for most messages
0246                  and sign extension is suppressed by the encoding
0247                  rules.
0248 
0249                  As of this writing, there are several values
0250                  of securityModel defined for use with SNMP or
0251                  reserved for use with supporting MIB objects.
0252                  They are as follows:
0253 
0254                      0  reserved for 'any'
0255                      1  reserved for SNMPv1
0256                      2  reserved for SNMPv2c
0257                      3  User-Based Security Model (USM)
0258                 "
0259     SYNTAX       INTEGER(0 .. 2147483647)
0260 
0261 SnmpMessageProcessingModel ::= TEXTUAL-CONVENTION
0262     STATUS       current
0263     DESCRIPTION "An identifier that uniquely identifies a Message
0264                  Processing Model of the Message Processing
0265                  Subsystem within this SNMP Management Architecture.
0266 
0267                  The values for messageProcessingModel are
0268                  allocated as follows:
0269 
0270                  - Values between 0 and 255, inclusive, are
0271                    reserved for standards-track Message Processing
0272                    Models and are managed by the Internet Assigned
0273                    Numbers Authority (IANA).
0274 
0275                  - Values greater than 255 are allocated to
0276                    enterprise-specific Message Processing Models.
0277                    An enterprise messageProcessingModel value is
0278                    defined to be:
0279 
0280                    enterpriseID * 256 +
0281                         messageProcessingModel within enterprise
0282 
0283                    For example, the fourth Message Processing Model
0284                    defined by the enterprise whose enterpriseID
0285 
0286                    is 1 would be 259.
0287 
0288                  This scheme for allocating messageProcessingModel
0289                  values allows for a maximum of 255 standards-
0290                  based Message Processing Models, and for a
0291                  maximum of 256 Message Processing Models per
0292                  enterprise.
0293 
0294                  It is believed that the assignment of new
0295                  messageProcessingModel values will be rare
0296                  in practice because the larger the number of
0297                  simultaneously utilized Message Processing Models,
0298                  the larger the chance that interoperability
0299                  will suffer. It is believed that such a range
0300                  will be sufficient.  In the unlikely event that
0301                  the standards committee finds this number to be
0302                  insufficient over time, an enterprise number
0303                  can be allocated to obtain an additional 256
0304                  possible values.
0305 
0306                  Note that the most significant bit must be zero;
0307                  hence, there are 23 bits allocated for various
0308                  organizations to design and define non-standard
0309                  messageProcessingModels.  This limits the ability
0310                  to define new proprietary implementations of
0311                  Message Processing Models to the first 8,388,608
0312                  enterprises.
0313 
0314                  It is worthwhile to note that, in its encoded
0315                  form, the messageProcessingModel value will
0316                  normally require only a single byte since, in
0317                  practice, the leftmost bits will be zero for
0318                  most messages and sign extension is suppressed
0319                  by the encoding rules.
0320 
0321                  As of this writing, there are several values of
0322                  messageProcessingModel defined for use with SNMP.
0323                  They are as follows:
0324 
0325                      0  reserved for SNMPv1
0326                      1  reserved for SNMPv2c
0327                      2  reserved for SNMPv2u and SNMPv2*
0328                      3  reserved for SNMPv3
0329                 "
0330     SYNTAX       INTEGER(0 .. 2147483647)
0331 
0332 SnmpSecurityLevel ::= TEXTUAL-CONVENTION
0333     STATUS       current
0334     DESCRIPTION "A Level of Security at which SNMP messages can be
0335                  sent or with which operations are being processed;
0336                  in particular, one of:
0337 
0338                    noAuthNoPriv - without authentication and
0339                                   without privacy,
0340                    authNoPriv   - with authentication but
0341                                   without privacy,
0342                    authPriv     - with authentication and
0343                                   with privacy.
0344 
0345                  These three values are ordered such that
0346                  noAuthNoPriv is less than authNoPriv and
0347                  authNoPriv is less than authPriv.
0348                 "
0349     SYNTAX       INTEGER { noAuthNoPriv(1),
0350                            authNoPriv(2),
0351                            authPriv(3)
0352                          }
0353 
0354 SnmpAdminString ::= TEXTUAL-CONVENTION
0355     DISPLAY-HINT "255t"
0356     STATUS       current
0357     DESCRIPTION "An octet string containing administrative
0358                  information, preferably in human-readable form.
0359 
0360                  To facilitate internationalization, this
0361                  information is represented using the ISO/IEC
0362                  IS 10646-1 character set, encoded as an octet
0363                  string using the UTF-8 transformation format
0364                  described in [RFC2279].
0365 
0366                  Since additional code points are added by
0367                  amendments to the 10646 standard from time
0368                  to time, implementations must be prepared to
0369                  encounter any code point from 0x00000000 to
0370                  0x7fffffff.  Byte sequences that do not
0371                  correspond to the valid UTF-8 encoding of a
0372                  code point or are outside this range are
0373                  prohibited.
0374 
0375                  The use of control codes should be avoided.
0376 
0377                  When it is necessary to represent a newline,
0378                  the control code sequence CR LF should be used.
0379 
0380                  The use of leading or trailing white space should
0381                  be avoided.
0382 
0383                  For code points not directly supported by user
0384                  interface hardware or software, an alternative
0385                  means of entry and display, such as hexadecimal,
0386                  may be provided.
0387 
0388                  For information encoded in 7-bit US-ASCII,
0389                  the UTF-8 encoding is identical to the
0390                  US-ASCII encoding.
0391 
0392                  UTF-8 may require multiple bytes to represent a
0393                  single character / code point; thus the length
0394                  of this object in octets may be different from
0395                  the number of characters encoded.  Similarly,
0396                  size constraints refer to the number of encoded
0397                  octets, not the number of characters represented
0398                  by an encoding.
0399 
0400                  Note that when this TC is used for an object that
0401                  is used or envisioned to be used as an index, then
0402                  a SIZE restriction MUST be specified so that the
0403                  number of sub-identifiers for any object instance
0404                  does not exceed the limit of 128, as defined by
0405                  [RFC3416].
0406 
0407                  Note that the size of an SnmpAdminString object is
0408                  measured in octets, not characters.
0409                 "
0410     SYNTAX       OCTET STRING (SIZE (0..255))
0411 
0412 -- Administrative assignments ***************************************
0413 
0414 snmpFrameworkAdmin
0415     OBJECT IDENTIFIER ::= { snmpFrameworkMIB 1 }
0416 snmpFrameworkMIBObjects
0417     OBJECT IDENTIFIER ::= { snmpFrameworkMIB 2 }
0418 snmpFrameworkMIBConformance
0419     OBJECT IDENTIFIER ::= { snmpFrameworkMIB 3 }
0420 
0421 -- the snmpEngine Group ********************************************
0422 
0423 snmpEngine OBJECT IDENTIFIER ::= { snmpFrameworkMIBObjects 1 }
0424 
0425 snmpEngineID     OBJECT-TYPE
0426     SYNTAX       SnmpEngineID
0427     MAX-ACCESS   read-only
0428     STATUS       current
0429     DESCRIPTION "An SNMP engine's administratively-unique identifier.
0430 
0431                  This information SHOULD be stored in non-volatile
0432                  storage so that it remains constant across
0433                  re-initializations of the SNMP engine.
0434                 "
0435     ::= { snmpEngine 1 }
0436 
0437 snmpEngineBoots  OBJECT-TYPE
0438     SYNTAX       INTEGER (1..2147483647)
0439     MAX-ACCESS   read-only
0440     STATUS       current
0441     DESCRIPTION "The number of times that the SNMP engine has
0442                  (re-)initialized itself since snmpEngineID
0443                  was last configured.
0444                 "
0445     ::= { snmpEngine 2 }
0446 
0447 snmpEngineTime   OBJECT-TYPE
0448     SYNTAX       INTEGER (0..2147483647)
0449     UNITS        "seconds"
0450     MAX-ACCESS   read-only
0451     STATUS       current
0452     DESCRIPTION "The number of seconds since the value of
0453                  the snmpEngineBoots object last changed.
0454                  When incrementing this object's value would
0455                  cause it to exceed its maximum,
0456                  snmpEngineBoots is incremented as if a
0457                  re-initialization had occurred, and this
0458                  object's value consequently reverts to zero.
0459                 "
0460     ::= { snmpEngine 3 }
0461 
0462 snmpEngineMaxMessageSize OBJECT-TYPE
0463     SYNTAX       INTEGER (484..2147483647)
0464     MAX-ACCESS   read-only
0465     STATUS       current
0466     DESCRIPTION "The maximum length in octets of an SNMP message
0467                  which this SNMP engine can send or receive and
0468                  process, determined as the minimum of the maximum
0469                  message size values supported among all of the
0470                  transports available to and supported by the engine.
0471                 "
0472     ::= { snmpEngine 4 }
0473 
0474 -- Registration Points for Authentication and Privacy Protocols **
0475 
0476 snmpAuthProtocols OBJECT-IDENTITY
0477     STATUS        current
0478     DESCRIPTION  "Registration point for standards-track
0479                   authentication protocols used in SNMP Management
0480                   Frameworks.
0481                  "
0482     ::= { snmpFrameworkAdmin 1 }
0483 
0484 snmpPrivProtocols OBJECT-IDENTITY
0485     STATUS        current
0486     DESCRIPTION  "Registration point for standards-track privacy
0487                   protocols used in SNMP Management Frameworks.
0488                  "
0489     ::= { snmpFrameworkAdmin 2 }
0490 
0491 -- Conformance information ******************************************
0492 
0493 snmpFrameworkMIBCompliances
0494                OBJECT IDENTIFIER ::= {snmpFrameworkMIBConformance 1}
0495 snmpFrameworkMIBGroups
0496                OBJECT IDENTIFIER ::= {snmpFrameworkMIBConformance 2}
0497 
0498 -- compliance statements
0499 
0500 snmpFrameworkMIBCompliance MODULE-COMPLIANCE
0501     STATUS       current
0502     DESCRIPTION "The compliance statement for SNMP engines which
0503                  implement the SNMP Management Framework MIB.
0504                 "
0505     MODULE    -- this module
0506         MANDATORY-GROUPS { snmpEngineGroup }
0507     ::= { snmpFrameworkMIBCompliances 1 }
0508 
0509 -- units of conformance
0510 
0511 snmpEngineGroup OBJECT-GROUP
0512     OBJECTS {
0513               snmpEngineID,
0514               snmpEngineBoots,
0515               snmpEngineTime,
0516               snmpEngineMaxMessageSize
0517             }
0518     STATUS       current
0519     DESCRIPTION "A collection of objects for identifying and
0520                  determining the configuration and current timeliness
0521 
0522                  values of an SNMP engine.
0523                 "
0524     ::= { snmpFrameworkMIBGroups 1 }
0525 
0526 END