RFC 1908

Coexistence between Version 1 and Version 2 of the Internet-standard Network Management Framework

πŸ“… published January 1996, from ietf

RFC 1908: Coexistence between Version 1 and Version 2 of the Internet-standard Network Management Framework πŸ¦‹

Okay bestie, this one is a Standards Track doc (so it's official, not just vibes) from January 1996 🌸 It's RFC 1908, and it came out of the Network Working Group, specifically the SNMPv2 Working Group. The authors are J. Case (SNMP Research, Inc.), K. McCloghrie (Cisco Systems, Inc.), M. Rose (Dover Beach Consulting, Inc.), and S. Waldbusser (International Network Services). It obsoletes RFC 1452, so that older one is out and this is the new hotness ✨

Status of this Memo πŸ’–

This doc specifies an Internet standards track protocol for the Internet community, and it's asking for discussion and suggestions for improvements. If you want to know where this protocol stands in terms of standardization, check the current edition of the "Internet Official Protocol Standards" (STD 1). Distribution of this memo is unlimited 🫢

Table of Contents ✨

   1. Introduction ................................................    2
   2. Management Information ......................................    2
   2.1 Object Definitions .........................................    3
   2.2 Trap Definitions ...........................................    5
   2.3 Compliance Statements ......................................    5
   2.4 Capabilities Statements ....................................    6
   3 Protocol Operations ..........................................    6
   3.1 Proxy Agent Behavior .......................................    6
   3.1.1 SNMPv2 -> SNMPv1 .........................................    7
   3.1.2 SNMPv1 -> SNMPv2 .........................................    7
   3.2 Bi-lingual Manager Behavior ................................    8
   4. Security Considerations .....................................    8
   5. Editor's Address ............................................    8
   6. Acknowledgements ............................................    8
   7. References ..................................................    9

1. Introduction πŸŽ€

So the whole point of this doc is to explain how version 2 of the Internet-standard Network Management Framework [1-6] (called SNMPv2) gets along with the original Internet-standard Network Management Framework (SNMPv1). The original one is made up of three documents:

  • STD 16, RFC 1155 [7] is the one that defines the Structure of Management Information (SMI). That's the stuff for describing and naming objects so you can manage them.
  • STD 16, RFC 1212 [8] is a more concise way to describe things, and it's totally consistent with the SMI.
  • STD 15, RFC 1157 [9] is the one that defines the Simple Network Management Protocol (SNMP), which is how you get network access to those managed objects.

2. Management Information πŸ’…

Okay so SNMPv2's way of describing groups of managed objects is basically a proper superset of the way the original framework does it πŸ”₯ Both of them use ASN.1 [10] as the base for a formal descriptive notation. Honestly, SNMPv2 mostly just codifies what people were already doing for defining MIB modules, based on lots of experience with the current framework. It's giving "we learned from the past" energy 😭

The SNMPv2 documents that deal with information modules are:

  • Structure of Management Information for SNMPv2 [1], which defines concise notations for describing information modules, managed objects and notifications;
  • Textual Conventions for SNMPv2 [2], which defines a concise notation for describing textual conventions, and also defines some initial conventions; and,
  • Conformance Statements for SNMPv2 [3], which defines concise notation for describing compliance and capabilities statements.

The next sections cover the three areas: MIB modules, compliance statements, and capabilities statements.

MIB modules that were defined using the current framework MAY continue to be used with the SNMPv2 protocol 🌈 Just know that for those MIB modules to conform to the SNMPv2 framework, the following changes are REQUIRED:

2.1. Object Definitions 🧚

Good news: converting a MIB module doesn't mean you have to deprecate all the objects in it πŸ₯° You only SHOULD do deprecation if the semantics of an object actually change.

  1. The IMPORTS statement must reference SNMPv2-SMI, instead of RFC1155-SMI and RFC-1212.

Wait, that one needs a MUST, so: the IMPORTS statement MUST reference SNMPv2-SMI, instead of RFC1155-SMI and RFC-1212.

  1. The MODULE-IDENTITY macro MUST be invoked immediately after any IMPORTS statement.
  2. For any descriptor that contains the hyphen character, the hyphen character is removed.
  3. For any label for a named-number enumeration that contains the hyphen character, the hyphen character is removed.
  4. For any object with an integer-valued SYNTAX clause, where the corresponding INTEGER does not have a range restriction (meaning the INTEGER has neither a defined set of named-number enumerations nor an assignment of lower- and upper-bounds on its value), the object MUST have the value of its SYNTAX clause changed to Integer32.
  5. For any object with a SYNTAX clause value of an enumerated INTEGER, the hyphen character is removed from any named-number labels that contain the hyphen character.
  6. For any object with a SYNTAX clause value of Counter, the object MUST have the value of its SYNTAX clause changed to Counter32.
  7. For any object with a SYNTAX clause value of Gauge, the object MUST have the value of its SYNTAX clause changed to Gauge32.
  8. For all objects, the ACCESS clause MUST be replaced by a MAX-ACCESS clause. The value of the MAX-ACCESS clause is the same as that of the ACCESS clause, unless some other value makes "protocol sense" as the maximal level of access for the object. In particular, object types whose instances can be explicitly created by a protocol set operation will have a MAX-ACCESS clause of "read-create". If the value of the ACCESS clause is "write-only", then the value of the MAX-ACCESS clause is "read-write", and the DESCRIPTION clause notes that reading this object will result in implementation-specific results.
  9. For all objects, if the value of the STATUS clause is "mandatory", the value MUST be replaced with "current".
  10. For all objects, if the value of the STATUS clause is "optional", the value MUST be replaced with "obsolete".
  11. For any object not containing a DESCRIPTION clause, the object MUST have a DESCRIPTION clause defined.
  12. For any object corresponding to a conceptual row that does not have an INDEX clause, the object MUST have either an INDEX clause or an AUGMENTS clause defined.
  13. For any object with an INDEX clause that references an object with a syntax of NetworkAddress, the value of the STATUS clause of both objects is changed to "obsolete".
  14. For any object containing a DEFVAL clause with an OBJECT IDENTIFIER value that is expressed as a collection of sub-identifiers, change the value to reference a single ASN.1 identifier.

Other changes are desirable, but not necessary πŸ“

  1. Creating and deleting conceptual rows is inconsistent under the current framework, and SNMPv2 fixes that. So if the MIB module gets reviewed early in its lifetime, and it has conceptual tables that allow creating and deleting conceptual rows, then it MAY be worthwhile to deprecate the objects relating to those tables and replace them with objects defined using the new approach.
  2. For any object with a string-valued SYNTAX clause, where the corresponding OCTET STRING does not have a size restriction (meaning the OCTET STRING has no assignment of lower- and upper-bounds on its length), one might consider defining the bounds for the size of the object.
  3. For all textual conventions that are informally defined in the MIB module, one might consider redefining those conventions using the TEXTUAL-CONVENTION macro. A change like that would not necessitate deprecating objects that were previously defined using an informal textual convention.
  4. For any object that represents a measurement in some kind of units, one might consider adding a UNITS clause to the definition of that object.
  5. For any conceptual row that is an extension of another conceptual row (so the subordinate columnar objects exist and are identified via the same semantics as the other conceptual row), one might consider using an AUGMENTS clause in place of the INDEX clause for the object corresponding to the conceptual row that is the extension.

Finally, when you run into common errors in SNMPv1 MIB modules πŸ‘€

  1. For any non-columnar object that is instanced as if it were immediately subordinate to a conceptual row, the value of the STATUS clause of that object is changed to "obsolete".
  2. For any conceptual row object that is not contained immediately subordinate to a conceptual table, the value of the STATUS clause of that object (and of all subordinate objects) is changed to "obsolete".

2.2. Trap Definitions πŸ¦‹

If a MIB module is changed to conform to the SNMPv2 framework, then each occurrence of the TRAP-TYPE macro MUST be changed to a corresponding invocation of the NOTIFICATION-TYPE macro:

  1. The IMPORTS statement MUST NOT reference RFC-1215.
  2. The ENTERPRISES clause MUST be removed.
  3. The VARIABLES clause MUST be renamed to the OBJECTS clause.
  4. The STATUS clause MUST be added.
  5. The value of an invocation of the NOTIFICATION-TYPE macro is an OBJECT IDENTIFIER, not an INTEGER, and MUST be changed accordingly. Specifically, if the value of the ENTERPRISE clause is not 'snmp', then the value of the invocation is the value of the ENTERPRISE clause extended with two sub-identifiers. The first of those has the value 0, and the second has the value of the invocation of the TRAP-TYPE.

2.3. Compliance Statements πŸ‘‘

For information modules that are "standard", a corresponding invocation of the MODULE-COMPLIANCE macro MUST be included within the information module (or in a companion information module). Any commentary text in the information module that relates to compliance MUST be removed. Usually this editing happens when the information module goes through review 🌸

2.4. Capabilities Statements πŸŽ€

okay so in the current framework, the informational doc [11] uses the MODULE-CONFORMANCE macro to describe an agent's capabilities with respect to one or more MIB modules πŸ“š. if you wanna turn that description into something the SNMPv2 framework can use, you need these changes:

  1. Use the macro name AGENT-CAPABILITIES instead of MODULE-CONFORMANCE.
  2. The STATUS clause must be added.
  3. For all occurrences of the CREATION-REQUIRES clause, note the slight change in semantics, and omit this clause if appropriate.

ok and for coexistence between SNMPv1 and SNMPv2 πŸ¦‹, object groups defined in an SNMPv1 MIB module may be referenced by the INCLUDES clause of an invocation of the AGENT-CAPABILITIES macro. basically, when you hit a reference to an OBJECT IDENTIFIER subtree defined in an SNMPv1 MIB module, all leaf objects which are subordinate to that subtree and have a STATUS clause value of mandatory are deemed to be INCLUDEd. (heads up, this method is ambiguous when different revisions of an SNMPv1 MIB have different sets of mandatory objects under the same subtree πŸ™ˆ. in those cases, the only solution is to rewrite the MIB using the SNMPv2 SMI so the object groups get defined unambiguously.)


3. Protocol Operations ✨

the SNMPv2 documents that deal with protocol operations are:

  • Protocol Operations for SNMPv2 [4], which defines the syntax and semantics of the operations conveyed by the protocol; and,
  • Transport Mappings for SNMPv2 [5], which defines how the protocol operations are carried over different transport services.

this section looks at two areas: the proxy behavior between a SNMPv2 entity and a SNMPv1 agent; and, the behavior of "bi-lingual" protocol entities acting in a manager role πŸ’….

3.1. Proxy Agent Behavior

to achieve coexistence at the protocol level, a proxy mechanism may be used. a SNMPv2 entity acting in an agent role may be implemented and configured to act in the role of a proxy agent 🧚.

3.1.1. SNMPv2 -> SNMPv1

when converting requests from a SNMPv2 entity acting in a manager role into requests sent to a SNMPv1 entity acting in an agent role:

  1. If a GetRequest-PDU, GetNextRequest-PDU, or SetRequest-PDU is received, then it is passed unaltered by the proxy agent.
  2. If a GetBulkRequest-PDU is received, the proxy agent sets the non-repeaters and max-repetitions fields to zero, and sets the tag of the PDU to GetNextRequest-PDU.

3.1.2. SNMPv1 -> SNMPv2

when converting responses received from a SNMPv1 entity acting in an agent role into responses sent to a SNMPv2 entity acting in a manager role:

  1. If a GetResponse-PDU is received, then it is passed unaltered by the proxy agent. Note that even though a SNMPv2 entity will never generate a Response-PDU with an error-status field having a value of noSuchName, badValue, or readOnly, the proxy agent must not change this field. This allows the SNMPv2 entity acting in a manager role to interpret the response correctly 🫢.

If a GetResponse-PDU is received with an error-status field having a value of tooBig, the proxy agent will remove the contents of the variable-bindings field before propagating the response. Note that even though a SNMPv2 entity will never generate a tooBig in response to a GetBulkRequest-PDU, the proxy agent must propagate such a response.

  1. If a Trap-PDU is received, then it is mapped into a SNMPv2-Trap-PDU. This is done by prepending onto the variable-bindings field two new bindings: sysUpTime.0 [6], which takes its value from the timestamp field of the Trap-PDU; and, snmpTrapOID.0 [6], which gets worked out like this: if the value of the generic-trap field is enterpriseSpecific, then the value used is the concatenation of the enterprise field from the Trap-PDU with two additional sub-identifiers, 0, and the value of the specific-trap field; otherwise, the value of the corresponding trap defined in [6] is used. (For example, if the value of the generic-trap field is coldStart, then the coldStart trap [6] is used.) Then, one new binding is appended onto the variable-bindings field: snmpTrapEnterprise.0 [6], which takes its value from the enterprise field of the Trap-PDU. The destinations for the SNMPv2-Trap-PDU are determined in an implementation-dependent fashion by the proxy agent πŸ¦‹.

3.2. Bi-lingual Manager Behavior

to achieve coexistence at the protocol level, a protocol entity acting in a manager role might support both SNMPv1 and SNMPv2. when a management application needs to contact a protocol entity acting in an agent role, the entity acting in a manager role consults a local database to select the correct management protocol to use πŸ”.

in order to provide transparency to management applications, the entity acting in a manager role must map operations as if it were acting as a proxy agent πŸ’–.


4. Security Considerations πŸ”₯

Security issues are not discussed in this memo. 😭 bestie, this one is serious, so read it twice.

5. Editor's Address πŸ’Œ

Keith McCloghrie
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA  95134-1706
US

Phone: +1 408 526 5260
EMail: kzm@cisco.com

6. Acknowledgements 🫢

this document is the result of significant work by the four major contributors:

  • Jeffrey D. Case (SNMP Research, case@snmp.com)
  • Keith McCloghrie (Cisco Systems, kzm@cisco.com)
  • Marshall T. Rose (Dover Beach Consulting, mrose@dbc.mtview.ca.us)
  • Steven Waldbusser (International Network Services, stevew@uni.ins.com)

in addition, the contributions of the SNMPv2 Working Group are acknowledged. in particular, a special thanks is extended for the contributions of:

  • Alexander I. Alten (Novell)
  • Dave Arneson (Cabletron)
  • Uri Blumenthal (IBM)
  • Doug Book (Chipcom)
  • Kim Curran (Bell-Northern Research)
  • Jim Galvin (Trusted Information Systems)
  • Maria Greene (Ascom Timeplex)
  • Iain Hanson (Digital)
  • Dave Harrington (Cabletron)
  • Nguyen Hien (IBM)
  • Jeff Johnson (Cisco Systems)
  • Michael Kornegay (Object Quest)
  • Deirdre Kostick (AT&T Bell Labs)
  • David Levi (SNMP Research)
  • Daniel Mahoney (Cabletron)
  • Bob Natale (ACE*COMM)
  • Brian O'Keefe (Hewlett Packard)
  • Andrew Pearson (SNMP Research)
  • Dave Perkins (Peer Networks)
  • Randy Presuhn (Peer Networks)
  • Aleksey Romanov (Quality Quorum)
  • Shawn Routhier (Epilogue)
  • Jon Saperia (BGS Systems)
  • Bob Stewart (Cisco Systems, bstewart@cisco.com), chair
  • Kaj Tesink (Bellcore)
  • Glenn Waters (Bell-Northern Research)
  • Bert Wijnen (IBM)

7. References πŸ“š

[1] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, "Structure of Management Information for Version 2 of the Simple Network Management Protocol (SNMPv2)", RFC 1902, January 1996.

[2] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, "Textual Conventions for Version 2 of the Simple Network Management Protocol (SNMPv2)", RFC 1903, January 1996.

[3] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, "Conformance Statements for Version 2 of the Simple Network Management Protocol (SNMPv2)", RFC 1904, January 1996.

[4] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, "Protocol Operations for Version 2 of the Simple Network Management Protocol (SNMPv2)", RFC 1905, January 1996.

[5] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, "Transport Mappings for Version 2 of the Simple Network Management Protocol (SNMPv2)", RFC 1906, January 1996.

[6] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, "Management Information Base for Version 2 of the Simple Network Management Protocol (SNMPv2)", RFC 1907, January 1996.

[7] Rose, M., and K. McCloghrie, "Structure and Identification of Management Information for TCP/IP-based internets", STD 16, RFC 1155, May 1990.

[8] Rose, M., and K. McCloghrie, "Concise MIB Definitions", STD 16, RFC 1212, March 1991.

[9] Case, J., Fedor, M., Schoffstall, M., and J. Davin, "Simple Network Management Protocol", STD 15, RFC 1157, SNMP Research, Performance Systems International, MIT Laboratory for Computer Science, May 1990.

[10] Information processing systems - Open Systems Interconnection - Specification of Abstract Syntax Notation One (ASN.1), International Organization for Standardization. International Standard 8824, (December, 1987).

[11] McCloghrie, K., and M. Rose, "A Convention for Describing SNMP-based Agents", RFC 1303, Hughes LAN Systems, Dover Beach Consulting, Inc., February 1992.

πŸ“¦ where this page comes from