Internet Draft Network Working Group H. Sjostrand Internet-Draft Ericsson Expires March 2000 September 1999 Definitions of Managed Objects for the General Switch Management Protocol (GSMP) <draft-ietf-gsmp-mib-00.txt> Status of this Memo This document is an Internet-Draft and is in full conformance with all provisions of Section 10 of RFC 2026. 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 Distribution of this document is unlimited. Please send comments to the General Switch Management Protocol (gsmp) Working Group,. Copyright Notice Copyright (C) The Internet Society (1999). All Rights Reserved. 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 managed objects for the General Switch Management Protocol (GSMP). Sjostrand Expires April 2000 [Page 1] INTERNET-DRAFT GSMP MIB October 1999 Table of Contents 1 Introduction ................................................. 3 2 The SNMP Management Framework ................................ 3 3 Structure of the MIB ......................................... 5 3.1 The GSMP Server Group ...................................... 5 3.1.1 The GSMP Control Port .................................... 5 3.1.2 The GSMP Status .......................................... 5 3.1.3 The GSMP Port table ...................................... 5 3.2 The GSMP Notifications Group ............................... 5 4 GSMP MIB Definitions ......................................... 5 5 Revision History ............................................. 11 6 Acknowledgments .............................................. 11 7 References ................................................... 11 8 Security Considerations ...................................... 13 9 Authors' Addresses ........................................... 13 10 Full Copyright Statement .................................... 13 Sjostrand Expires April 2000 [Page 2] INTERNET-DRAFT GSMP MIB October 1999 1. Introduction 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 managed objects for the General Switch Management Protocol (gsmp) [RFC1987]. 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 [RFC2119]. 2. 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], RFC 2579 [RFC2579] and 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 Sjostrand Expires April 2000 [Page 3] INTERNET-DRAFT GSMP MIB October 1999 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. Sjostrand Expires April 2000 [Page 4] INTERNET-DRAFT GSMP MIB October 1999 3. Structure of the MIB This mib modelsprovides some managed objects according to GSMP v1.1 [RFC1987]. It does not address any of the new features in version 2 [RFC2397]. It is provided as a base for the work within the working group to define a mib. 3.1 The GSMP Server Group 3.1.1. The GSMP Control Port Used to configure the interface used for the control port. This does not deal with the extended bearer capabilities of [24]. 3.1.2. The GSMP Status The status of the GSMP adjacency. THis does not deal with the additional states defined in [24]. 3.1.3. The GSMP Port table This is a read only table of all ports available to the GSMP. This does not deal with the new interface types or cababilities as defined in [24]. 3.2. The GSMP Notifications Group This is currently empty, but should be extended with notifications as defined in [24]. 4. GSMP MIB Definitions GSMP-MIB DEFINITIONS ::= BEGIN IMPORTS OBJECT-TYPE, MODULE-IDENTITY, NOTIFICATION-TYPE, Unsigned32, experimental FROM SNMPv2-SMI MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP FROM SNMPv2-CONF TEXTUAL-CONVENTION, TruthValue, RowStatus, TimeInterval FROM SNMPv2-TC InterfaceIndex Sjostrand Expires April 2000 [Page 5] INTERNET-DRAFT GSMP MIB October 1999 FROM IF-MIB AtmVcIdentifier, AtmVpIdentifier FROM ATM-TC-MIB ; gsmpMIB MODULE-IDENTITY LAST-UPDATED "9910111200Z" -- October 11, 1999 ORGANIZATION "General Switch Management Protocol (gsmp) Working Group" CONTACT-INFO "Hans Sjostrand (hans.sjostrand@etx.ericsson.se) Ericsson" DESCRIPTION "This MIB contains managed object definitions for the General Switch Management Protocol, GSMP, as defined in [RFC1987]." ::= { experimental 9877 } -- to be assigned --**************************************************************** -- GSMP Textual Conventions --**************************************************************** gsmpServerObjects OBJECT IDENTIFIER ::= { gsmpMIB 1 } gsmpClientObjects OBJECT IDENTIFIER ::= { gsmpMIB 2 } gsmpNotifications OBJECT IDENTIFIER ::= { gsmpMIB 3 } gsmpConformance OBJECT IDENTIFIER ::= { gsmpMIB 4 } --**************************************************************** -- GSMP Objects --**************************************************************** -- -- GSMP Control Port -- gmspCtrlPortId OBJECT-TYPE SYNTAX InterfaceIndex MAX-ACCESS read-write STATUS current DESCRIPTION "Identifyer of the interface which is used by the control part to control via GSMP the forwarding part. In the case with intergrated control part, this object is undefined. Changing this value is not allowed if thera are any gsmp ports defined. " ::= { gsmpServerObjects 1 } -- -- GSMP Status -- Sjostrand Expires April 2000 [Page 6] INTERNET-DRAFT GSMP MIB October 1999 gsmpAdjacencyStatus OBJECT-TYPE SYNTAX INTEGER { up(1), down(2) } MAX-ACCESS read-only STATUS current DESCRIPTION "Gives the status of the GSMP adjacency." ::= { gsmpServerObjects 2 } -- -- GSMP Port table -- gsmpPortTable OBJECT-TYPE SYNTAX SEQUENCE OF GsmpPortEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The table showing all ports that are accesible and controlable over the GSMP interface." ::= { gsmpServerObjects 3 } gsmpPortEntry OBJECT-TYPE SYNTAX GsmpPortEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "An entry in the table showing the data belonging to one port as defined over the GSMP interface." INDEX { gsmpPortId } ::= { gsmpPortTable 1 } GsmpPortEntry ::= SEQUENCE { gsmpPortId InterfaceIndex, gsmpPortSessionNbr Unsigned32, gsmpPortMinVpi INTEGER, gsmpPortMinVci INTEGER, gsmpPortMaxVpi INTEGER, gsmpPortMaxVci INTEGER, gsmpPortCellRate Unsigned32, gsmpPortStatus INTEGER, gsmpPortLineStatus INTEGER } gsmpPortId OBJECT-TYPE Sjostrand Expires April 2000 [Page 7] INTERNET-DRAFT GSMP MIB October 1999 SYNTAX InterfaceIndex MAX-ACCESS not-accessible STATUS current DESCRIPTION "This attribute identifies the ATM port over GSMP to to this ocnfiguration information refers. It corresponds to the IfIndex. " ::= { gsmpPortEntry 1 } gsmpPortSessionNbr OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-only STATUS current DESCRIPTION "The current Port Session Number for the specified port. Each switch port maintains a Port Session Number assigned by the switch. The Port Session Number of a port remains unchanged while the port is continuously in the Available state. When a port returns to the Available state after it has been Unavailable, or after a power cycle, its Port Session Number is changed." ::= { gsmpPortEntry 2 } gsmpPortMinVpi OBJECT-TYPE SYNTAX AtmVpIdentifier MAX-ACCESS read-only STATUS current DESCRIPTION "The minimum value of dynamically assigned incoming VPI that the connection table on the input port can support and may be controlled by GSMP." ::= { gsmpPortEntry 3 } gsmpPortMinVci OBJECT-TYPE SYNTAX AtmVcIdentifier MAX-ACCESS read-only STATUS current DESCRIPTION "The minimum value of dynamically assigned incoming VCI that the connection table on the input port can support and may be controlled by GSMP." ::= { gsmpPortEntry 4 } gsmpPortMaxVpi OBJECT-TYPE SYNTAX AtmVpIdentifier MAX-ACCESS read-only STATUS current DESCRIPTION Sjostrand Expires April 2000 [Page 8] INTERNET-DRAFT GSMP MIB October 1999 "The maximum value of dynamically assigned incoming VPI that the connection table on the input port can support and may be controlled by GSMP. It is assumed that the input port can handle all values of VPI within the range Min VPI to Max VPI inclusive and that GSMP may control all values within this range." ::= { gsmpPortEntry 5 } gsmpPortMaxVci OBJECT-TYPE SYNTAX AtmVpIdentifier MAX-ACCESS read-only STATUS current DESCRIPTION "The maximum value of dynamically assigned incoming VPI that the connection table on the input port can support and may be controlled by GSMP. It is assumed that the input port can handle all values of VPI within the range Min VPI to Max VPI inclusive and that GSMP may control all values within this range." ::= { gsmpPortEntry 6 } gsmpPortCellRate OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-only STATUS current DESCRIPTION "A measure of the bandwidth of the port. It is the rate of cells arriving at or departing from the port in cells/s. It is assumed that both input port and output port have the same cell rate." ::= { gsmpPortEntry 7 } gsmpPortStatus OBJECT-TYPE SYNTAX INTEGER { available(1), unavailable(2), internalloopback(3), externalloopback(4), bothwayloopback(5) } MAX-ACCESS read-only STATUS current DESCRIPTION "Gives the administrative state of the port." ::= { gsmpPortEntry 8 } gsmpPortLineStatus OBJECT-TYPE SYNTAX INTEGER { Sjostrand Expires April 2000 [Page 9] INTERNET-DRAFT GSMP MIB October 1999 up(1), down(2), test(3) } MAX-ACCESS read-only STATUS current DESCRIPTION "The status of the physical transmission medium connected to the port." ::= { gsmpPortEntry 9 } --****************************************************************** -- Module Compliance Statement --****************************************************************** gsmpGroups OBJECT IDENTIFIER ::= { gsmpConformance 1 } gsmpCompliances OBJECT IDENTIFIER ::= { gsmpConformance 2 } gsmpModuleCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for agents that support the GSMP MIB." MODULE -- this module MANDATORY-GROUPS { gsmpServerGroup } ::= { gsmpCompliances 1 } -- units of conformance gsmpServerGroup OBJECT-GROUP OBJECTS { gmspCtrlPortId, gsmpAdjacencyStatus, gsmpPortSessionNbr, gsmpPortMinVpi, gsmpPortMinVci, gsmpPortMaxVpi, gsmpPortMaxVci, gsmpPortCellRate, gsmpPortStatus, gsmpPortLineStatus } STATUS current Sjostrand Expires April 2000 [Page 10] INTERNET-DRAFT GSMP MIB October 1999 DESCRIPTION "Objects that apply to all GSMP Server implementations." ::= { gsmpGroups 1 } END 5. Revision History This section should be removed when this document is published as an RFC. This is the 00 version. 6. Acknowledgments The authors would like to thank the following people: Zoltan Takacs and Bo Augustsson from Ericsson. 7. References [RFC2571] Harrington, D., Presuhn, R., and B. Wijnen, "An Architecture for Describing SNMP Management Frameworks", RFC 2571, April 1999 [RFC1155] Rose, M., and K. McCloghrie, "Structure and Identification of Management Information for TCP/IP-based Internets", STD 16, RFC 1155, May 1990 [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 Sjostrand Expires April 2000 [Page 11] INTERNET-DRAFT GSMP MIB October 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 [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 [RFC2434] Narten, T., and H. Alvestrand, "Guidelines for Writing an IANA Considerations Section in RFCs.", RFC 2434, IBM, Maxware, October 1998 [RFC1987] Newman, P, Edwards, W., Hinden, R., Hoffman, E. Ching Liaw, F., Lyon, T. and Minshall, G., "Ipsilon's General Switch Management Protocol Specification," Version 1.1, RFC 1987, August 1996. [RFC2397] Newman, P, Edwards, W., Hinden, R., Hoffman, E., Ching Liaw, F., Lyon, T. and Minshall, G., "Ipsilon's General Switch Management Protocol Specification," Version 2.0, RFC 2397, March 1998. Sjostrand Expires April 2000 [Page 12] INTERNET-DRAFT GSMP MIB October 1999 [RFC2514] Noto, M., E. Spiegel, K. Tesink, "Definition of Textual Conventions and OBJECT-IDENTITIES for ATM Management", RFC 2514, February 1999. [RFC2233] McCloghrie, K., F. Kastenholz, "The Interfaces Group MIB using SMIv2", RFC 2233, November 1997. [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, Harvard University, March 1997 [RFC2026] Bradner, S., "The Internet Standards Process -- Revision 3", BCP 9, RFC 2026, Harvard University, October 1996 [24] Worster, et. al., "General Switch Management Protocol", work in progress, October 1999 8. Security Considerations Assuming that secure network management (such as SNMP v3) is implemented, the objects represented in this MIB do not pose a threat to the security of the network. 9. Authors' Addresses Hans Sjostrand Ericsson Business Unit Datacom Networks and IP Services S-126 25 Stockholm, Sweden Phone: +46 8 719 9960 Email: hans.sjostrand@etx.ericsson.se 10. Full Copyright Statement Copyright (C) The Internet Society (1999). 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 Sjostrand Expires April 2000 [Page 13] INTERNET-DRAFT GSMP MIB October 1999 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 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Sjostrand Expires April 2000 [Page 14]