EOS Working Group S. Chisholm Internet Draft Nortel Networks Document: draft-ietf-eos-snmpxproto-mib-03.txt Category: Standards Track Expiration Date: February 2003 August 2002 SNMP Extended Protocol MIB Status of this Memo This document is an Internet-Draft and is in full conformance with all provisions of Section 10 of RFC2026. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet- Drafts as reference material or to cite them other than as "work in progress." The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html. Abstract This memo defines a portion of the Management Information Base (MIB) for use with network management protocols in the Internet community. In particular, it describes SNMP protocol operations supported by an SNMP entity. Table of Contents 1. The SNMP Management Framework 2. Introduction 3. Extended Protocol Management 3.1. SNMP Extensions 3.2. Interoperability 3.3. Relation to MAX-ACCESS clause 3.4. Relation to Agent Capabilities 4. MIB Overview 5. IANA Considerations 6. Definitions Chisholm Standards Track [Page 1] SNMP Extended Protocol MIB August 2002 7. Security Considerations 8. Author's Address 9. Acknowledgements 10. References 11. Full Copyright Statement Chisholm Standards Track [Page 2] SNMP Extended Protocol MIB August 2002 1. The SNMP Management Framework The SNMP Management Framework presently consists of five major components: o An overall architecture, described in RFC 2571 [RFC2571]. o Mechanisms for describing and naming objects and events for the purpose of management. The first version of this Structure of Management Information (SMI) is called SMIv1 and described in STD 16, RFC 1155 [RFC1155], STD 16, RFC 1212 [RFC1212] and RFC 1215 [RFC1215]. The second version, called SMIv2, is described in STD 58, RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580 [RFC2580]. o Message protocols for transferring management information. The first version of the SNMP message protocol is called SNMPv1 and described in STD 15, RFC 1157 [RFC1157]. A second version of the SNMP message protocol, which is not an Internet standards track protocol, is called SNMPv2c and described in RFC 1901 [RFC1901] and RFC 1906 [RFC1906]. The third version of the message protocol is called SNMPv3 and described in RFC 1906 [RFC1906], RFC 2572 [RFC2572] and RFC 2574 [RFC2574]. o Protocol operations for accessing management information. The first set of protocol operations and associated PDU formats is described in STD 15, RFC 1157 [RFC1157]. A second set of protocol operations and associated PDU formats is described in RFC 1905 [RFC1905]. o A set of fundamental applications described in RFC 2573 [RFC2573] and the view-based access control mechanism described in RFC 2575 [RFC2575]. A more detailed introduction to the current SNMP Management Framework can be found in RFC 2570 [RFC2570]. Managed objects are accessed via a virtual information store, termed the Management Information Base or MIB. Objects in the MIB are defined using the mechanisms defined in the SMI. This memo specifies a MIB module that is compliant to the SMIv2. A MIB conforming to the SMIv1 can be produced through the appropriate translations. The resulting translated MIB must be semantically equivalent, except where objects or events are omitted because no translation is possible (use of Counter64). Some machine readable information in SMIv2 will be converted into textual descriptions in SMIv1 during the translation process. However, this loss of machine readable information is not considered to change the semantics of the MIB. Chisholm Standards Track [Page 3] SNMP Extended Protocol MIB August 2002 2. Introduction Traditionally, features have been added to SNMP by developing a new version of the protocol that supports these new features. Currently, SNMP entities that conform to [RFC 2571] are expected to implement all the protocol functionality defined by the standards. The idea, moving forward, is to add features to SNMP in a more modular fashion and without necessarily increasing the version number. Since the protocol version number is no longer sufficient information to determine which protocol features an SNMP entity supports, another method is required. This memo defines a MIB to be used to determine the SNMP capabilities of an SNMP entity, independent of its protocol version. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119. 3. Extended Protocol Management 3.1 SNMP Extensions SNMP extensions are those standard protocol extensions that are developed within the IETF and published in standards track RFCs. 3.2 Interoperability Chisholm Standards Track [Page 4] SNMP Extended Protocol MIB August 2002 +------------+ |Command | +--------+Generator |-----------+ | |Extended | | | |Protocol | | | +------------+ | | | | | | +--------+------------+ +------+-----+ |Command Responder | |Command | | | |Responder | | Extended Protocol | |Protocol | +--------+------------+ |Operations | | |v2 | | +-----+------+ | | +------------+ | | |Command | | | |Generator +--------+ +------------+Protocol | |Operations | |v2 | +------------+ An SNMP entity that supports version 2 of the protocol operations [RFC1905] MUST be able to communicate with an SNMP entity supporting extended protocol operations. This communication MUST be in a manner consistent with communicating with an SNMP entity that supports version 2 of the protocol operations. Similarly, an SNMP entity that supports extended protocol operations MUST be able to communicate with SNMP entities which support version 2 of the protocol operations. An SNMP entity that supports the extended protocol operations SHOULD support protocol operations as defined in version 2 of the protocol operations [RFC1905]. The get-request operation MUST be supported. A command generator SHOULD query a command responder before issuing an extended protocol operation to determine if the command responder supports the operation. An SNMP entity MUST only issue a response using an extended protocol feature if it received the request using the extended protocol feature. If an SNMP entity receives an extended protocol feature it does not understand, it MUST follow the unknown PDU response mechanism as defined in [RFC2262] section 4.2.2.1 Chisholm Standards Track [Page 5] SNMP Extended Protocol MIB August 2002 3.3 Relation to MAX-ACCESS Clause MAX-ACCESS, as defined in [RFC1902], indicates whether it makes "protocol sense" to read, write and/or create an instance of the object, or to include its value in a notification. It is useful for this discussion to term read, write, create and accessible for notify as different classes of access to MIB objects. In the case of the protocol operations defined in [RFC1905], the get-request, get-next-request, get-bulk-request would all belong to the read class. The set-request would belong to the write class and the create class. The inform-request and the snmpV2-trap would both belong to the accessible for notify class. The protocol capabilities identified using this memo indicate which specific protocol operations are supported on the object if the appropriate class of access is allowed. If a protocol operation is not supported on a given object, it only affects the protocol capabilities statement, if its access class is supported for that object. For example, if an object is read-only and therefore does not support the write class, the system can still claim support of the set-request operation so long as all objects that do support the write class support the set-request. However, if the object does not support the get-bulk-request, the system cannot claim support of this protocol operation as this object supports the read class. 3.4 Relation to Agent Capabilities Agent capability statements are used when describing capabilities of agents with respect to object definitions. The extended protocol MIB is used when describing the capabilities of agents with respect to protocol operations. 4. MIB Overview The snmpXProtoSystem object indicates which protocol operations are supported by the entire SNMP entity. snmpXProtoSubTreeTable indicates additional protocol operations supported on particular MIB sub trees. 5. IANA Considerations IANASnmpProtocol is a bitmap that indicates which standard SNMP operations an SNMP entity supports. New values for this bitmap may be given out for SNMP protocol extensions published as standards track RFCs. The following shall be used as the initial values, but the latest values for these textual conventions should be obtained from IANA: IANA-SNMP-PROTOCOL-TC DEFINITIONS ::= BEGIN Chisholm Standards Track [Page 6] SNMP Extended Protocol MIB August 2002 IMPORTS MODULE-IDENTITY, mib-2 FROM SNMPv2-SMI TEXTUAL-CONVENTION FROM SNMPv2-TC; ianaSnmpProtoNumbers MODULE-IDENTITY LAST-UPDATED "200202200000Z" ORGANIZATION "IANA" CONTACT-INFO "Postal: Internet Assigned Numbers Authority Internet Corporation for Assigned Names and Numbers 4676 Admiralty Way, Suite 330 Marina del Rey, CA 90292-6601 USA Tel: +1 310-823-9358 E-Mail: iana@iana.org" DESCRIPTION "The MIB module defines textual conventions for use in identifying SNMP protocol operations." ::= { mib-2 xx } -- IANA IANASnmpProtocol ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "Standard SNMP protocol operations." SYNTAX BITS { getRequest (0), getNextRequest (1), getBulkRequest (2), response (3), setRequest (4), informRequest (5), snmpV2Trap (6), report (7) } END 6. Definitions SNMP-EXTENDED-PROTOCOL-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, Unsigned32, mib-2 FROM SNMPv2-SMI IANASnmpProtocol FROM IANA-SNMP-PROTOCOL-TC MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF; snmpXProtoMIB MODULE-IDENTITY LAST-UPDATED "200202200000Z" ORGANIZATION "IETF Evolution of SNMP Working Group" Chisholm Standards Track [Page 7] SNMP Extended Protocol MIB August 2002 CONTACT-INFO " Sharon Chisholm Nortel Networks PO Box 3511 Station C Ottawa, Ont. K1Y 4H7 Canada schishol@nortelnetworks.com" DESCRIPTION "The MIB module describes the SNMP protocol operations supported by this SNMP entity." REVISION "200202200000Z" DESCRIPTION "Initial version, published as RFC XXXX." ::= { mib-2 xx } snmpXProtoObjects OBJECT IDENTIFIER ::= { snmpXProtoMIB 1 } snmpXProtoConformance OBJECT IDENTIFIER ::= { snmpXProtoMIB 3 } snmpXProtoCompliances OBJECT IDENTIFIER ::= { snmpXProtoConformance 1 } snmpXProtoSystem OBJECT-TYPE SYNTAX IANASnmpProtocol MAX-ACCESS read-only STATUS current DESCRIPTION "The standard SNMP protocol operations supported by this SNMP entity on all objects with appropriate access permissions. For example, SNMP sets may be included in this list, even if the MAX-ACCESS of some objects is read-only." ::= { snmpXProtoObjects 1 } -- Extra Protocol Support per SubTree snmpXProtoSubTreeTable OBJECT-TYPE SYNTAX SEQUENCE OF SnmpXProtoSubTreeEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A table of additional SNMP protocol operations supported on objects in the specific subTrees." ::= { snmpXProtoObjects 2 } snmpXProtoSubTreeEntry OBJECT-TYPE SYNTAX SnmpXProtoSubTreeEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A MIB subtree that supports additional Chisholm Standards Track [Page 8] SNMP Extended Protocol MIB August 2002 protocol operations above that specified in snmpXProtoSystem." INDEX { snmpXProtoSubTreeIndex } ::= { snmpXProtoSubTreeTable 1 } SnmpXProtoSubTreeEntry ::= SEQUENCE { snmpXProtoSubTreeIndex Unsigned32, snmpXProtoSubTreeBranch OBJECT IDENTIFIER, snmpXProtoSubTreeFeature IANASnmpProtocol } snmpXProtoSubTreeIndex OBJECT-TYPE SYNTAX Unsigned32(1..4294967295) MAX-ACCESS not-accessible STATUS current DESCRIPTION "An arbitrary index into this table." ::= { snmpXProtoSubTreeEntry 1 } snmpXProtoSubTreeBranch OBJECT-TYPE SYNTAX OBJECT IDENTIFIER MAX-ACCESS read-only STATUS current DESCRIPTION "The OID that identifies this MIB SubTree." ::= { snmpXProtoSubTreeEntry 2 } snmpXProtoSubTreeFeature OBJECT-TYPE SYNTAX IANASnmpProtocol MAX-ACCESS read-only STATUS current DESCRIPTION "The standard SNMP protocol operations supported by this subTree above and beyond protocol support as indicated by snmpXProtoSystem." ::= { snmpXProtoSubTreeEntry 3 } snmpXProtoCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for systems supporting the snmpXProto MIB." MODULE -- this module MANDATORY-GROUPS { snmpXProtoGroup } ::= { snmpXProtoCompliances 1 } snmpXProtoGroups OBJECT IDENTIFIER ::= { snmpXProtoConformance 2 } snmpXProtoGroup OBJECT-GROUP OBJECTS { Chisholm Standards Track [Page 9] SNMP Extended Protocol MIB August 2002 snmpXProtoSystem } STATUS current DESCRIPTION "Standard snmpXProto group." ::= { snmpXProtoGroups 1} snmpXProtoSubTreeGroup OBJECT-GROUP OBJECTS { snmpXProtoSubTreeFeature, snmpXProtoSubTreeBranch } STATUS current DESCRIPTION "SubTree specific snmpXProto group." ::= { snmpXProtoGroups 2} END 7. Security Considerations There are no management objects defined in this MIB that have a MAX-ACCESS clause of read-write and/or read-create. So, if this MIB is implemented correctly, then there is no risk that an intruder can alter or create any management objects of this MIB via direct SNMP SET operations. 8. Author's Address Sharon Chisholm Nortel Networks PO Box 3511, Station C Ottawa, Ontario, K1Y 4H7 Canada Email: schishol@nortelnetworks.com 9. Acknowledgments This document is a product of the Evolution of SNMP Working Group. ... 10. References [RFC2571] Harrington, D., Presuhn, R., and B. Wijnen, "An Architecture for Describing SNMP Management Frameworks", RFC 2571, April 41999. [RFC1155] Rose, M., and K. McCloghrie, "Structure and Identification of Management Information for TCP/IP-based Internets", STD 16, RFC 1155, May 1990. Chisholm Standards Track [Page 10] SNMP Extended Protocol MIB August 2002 [RFC1212] Rose, M., and K. McCloghrie, "Concise MIB Definitions", STD 16, RFC 1212, March 1991. [RFC1215] M. Rose, "A Convention for Defining Traps for use with the SNMP", RFC 1215, March 1991. [RFC2578] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M., and S. Waldbusser, "Structure of Management Information Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. [RFC2579] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M., and S. Waldbusser, "Textual Conventions for SMIv2", STD 58, RFC 2579, April 1999. [RFC2580] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M., and S. Waldbusser, "Conformance Statements for SMIv2", STD 58, RFC 2580, April 1999. [RFC1157] Case, J., Fedor, M., Schoffstall, M., and J. Davin, "Simple Network Management Protocol", STD 15, RFC 1157, May 1990. [RFC1901] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, "Introduction to Community-based SNMPv2", RFC 1901, January 1996. [RFC1906] 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. [RFC2572] Case, J., Harrington D., Presuhn R., and B. Wijnen, "Message Processing and Dispatching for the Simple Network Management Protocol (SNMP)", RFC 2572, April 1999. [RFC2574] Blumenthal, U., and B. Wijnen, "User-based Security Model (USM) for version 3 of the Simple Network Management Protocol (SNMPv3)", RFC 2574, April 1999. [RFC1905] 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. [RFC2573] Levi, D., Meyer, P., and B. Stewart, "SNMPv3 Applications", RFC 2573, April 1999. [RFC2575] Wijnen, B., Presuhn, R., and K. McCloghrie, "View-based Access Control Model (VACM) for the Simple Network Management Protocol (SNMP)", RFC 2575, April 1999. Chisholm Standards Track [Page 11] SNMP Extended Protocol MIB August 2002 [RFC2570] Case, J., Mundy, R., Partain, D., and B. Stewart, "Introduction to Version 3 of the Internet-standard Network Management Framework", RFC 2570, April 1999. [RFC2021] Waldbusser, S. "Remote Network Monitoring Management Information Base Version 2 using SMIv2", RFC 2021, January 1997 [RFC2274] Blumenthal, U. and B. Wijnen, "User-based Security Model (USM) for version 3 of the Simple Network Management Protocol (SNMPv3)", RFC 2274, January 1998. [RFC2275] Wijnen, B., Presuhn, R. and K. McCloghrie, "View-based Access Control Model (VACM) for the Simple Network Management Protocol (SNMP)", RFC 2275, January 1998. [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. [RFC1905] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser, "Protocol Operations for SNMPv2", RFC 1905, January 1996 [RFC2262] Case, J., Harrington, D, Presuhn, R., Wijnen, B., "Message Processing and Dispatching for the Simple Network Management Protocol (SNMP)", RFC 2262, January 1998 11. Full Copyright Statement Copyright (C) The Internet Society (2002). All Rights Reserved. This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to the Internet Society or other Internet organizations, except as needed for the purpose of developing Internet standards in which case the procedures for copyrights defined in the Internet Standards process must be followed, or as required to translate it into languages other than English. The limited permissions granted above are perpetual and will not be revoked by the Internet Society or its successors or assigns. This document and the information contained herein is provided on an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF Chisholm Standards Track [Page 12] SNMP Extended Protocol MIB August 2002 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Chisholm Standards Track [Page 13]