Network Working Group G. Zorn Internet-Draft Cisco Systems Expires: December 18, 2006 June 16, 2006 Diameter Credit Control Application MIB draft-zorn-dime-diameter-cc-app-mib-00.txt Status of this Memo By submitting this Internet-Draft, each author represents that any applicable patent or other IPR claims of which he or she is aware have been or will be disclosed, and any of which he or she becomes aware will be disclosed, in accordance with Section 6 of BCP 79. 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. This Internet-Draft will expire on December 18, 2006. Copyright Notice Copyright (C) The Internet Society (2006). Abstract Along with providing support for certain basic authentication, authorization and accounting functions, the Diameter base protocol is intended to provide a framework for AAA applications. This document defines the Management Information Base (MIB) module which describes the minimum set of objects needed to manage an implementation of the Diameter Credit Control application. Zorn Expires December 18, 2006 [Page 1] Internet-Draft DCCA MIB June 2006 Table of Contents 1. The Internet-Standard Management Framework . . . . . . . . . . 3 2. Requirements Language . . . . . . . . . . . . . . . . . . . . 3 3. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 4. Diameter Credit Control Application MIB Definitions . . . . . 3 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 12 6. Security Considerations . . . . . . . . . . . . . . . . . . . 12 7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 12 8. References . . . . . . . . . . . . . . . . . . . . . . . . . . 13 8.1 Normative References . . . . . . . . . . . . . . . . . . . 13 8.2 Informative References . . . . . . . . . . . . . . . . . . 13 Author's Address . . . . . . . . . . . . . . . . . . . . . . . 14 Intellectual Property and Copyright Statements . . . . . . . . 15 Zorn Expires December 18, 2006 [Page 2] Internet-Draft DCCA MIB June 2006 1. The Internet-Standard Management Framework For a detailed overview of the documents that describe the current Internet-Standard Management Framework, please refer to section 7 of RFC 3410 [RFC3410]. Managed objects are accessed via a virtual information store, termed the Management Information Base or MIB. MIB objects are generally accessed through the Simple Network Management Protocol (SNMP). Objects in the MIB are defined using the mechanisms defined in the Structure of Management Information (SMI). This memo specifies a MIB module that is compliant to the SMIv2, which is described in STD 58, RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580 [RFC2580]. In particular, it describes managed objects used for managing the Diameter base protocol. Discussion of this draft may be directed to the author. 2. Requirements Language 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 [RFC1215]. 3. Overview The base Diameter protocol [RFC3588] is never used alone; it is always extended for a particular application. Four Diameter applications have been defined to date: NASREQ [RFC4005], Mobile IP [RFC4004] [RFC3141], Credit Control [RFC4006] and EAP [RFC4072]; others may be defined in the future. This MIB defines objects supporting the management of the Diameter Credit Control Application protocol as described in [RFC4006]. The MIB specification for the Diameter base protocol [BASEMIB] SHOULD be implemented prior to the implementation of this MIB. 4. Diameter Credit Control Application MIB Definitions DIAMETER-CC-APPLICATION-MIB DEFINITIONS ::= BEGIN IMPORTS InetAddressType, InetAddress FROM INET-ADDRESS-MIB -- [RFC4001] MODULE-IDENTITY, OBJECT-TYPE, OBJECT-IDENTITY, Counter32, Unsigned32, TimeTicks, mib-2 FROM SNMPv2-SMI -- [RFC2578] SnmpAdminString Zorn Expires December 18, 2006 [Page 3] Internet-Draft DCCA MIB June 2006 FROM SNMP-FRAMEWORK-MIB -- [RFC3411] MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF; -- [RFC2580] RowStatus FROM SNMPv2-TC; -- [RFC2579] diameterMIB MODULE-IDENTITY LAST-UPDATED "200606140000Z" -- 14 June 2006 ORGANIZATION "IETF dime Working Group." CONTACT-INFO "Glen Zorn Cisco Systems, Inc. 2901 Third Avenue, Suite 600 SEA1/5/ Seattle, WA 98121 USA Phone: +1 (425) 344 8113 Email: gwz@cisco.com" DESCRIPTION "The MIB module for entities implementing the Diameter Credit Control Application, RFC 4006. Copyright (C) The Internet Society (2006). This initial version of this MIB module was published in RFC yyyy; for full legal notices see the RFC itself. Supplementary information may be available on http://www.ietf.org/copyrights/ianamib.html." -- RFC Ed.: replace yyyy with actual RFC number and remove this note REVISION "200606140000Z" -- 14 June 2006 DESCRIPTION "Initial version as published in RFC yyyy" -- RFC Ed.: replace yyyy with actual RFC number and remove this note ::= { mib-2 119 } -- Experimental value assigned by IANA. -- Top-Level Components of this MIB. diameterCcAppMIB OBJECT ::= { diameterMIB 2 } diameterCcAppTraps OBJECT IDENTIFIER ::= { diameterCcAppMIB 0 } diameterCcAppObjects OBJECT IDENTIFIER ::= { diameterCcAppMIB 1 } diameterCcAppConform OBJECT IDENTIFIER ::= { diameterCcAppMIB 2 } dcaHostCfgs OBJECT IDENTIFIER ::= { diameterCcAppObjects 1 } dcaPeerStats OBJECT IDENTIFIER ::= { diameterCcAppObjects 2 } dcaHostID OBJECT-TYPE Zorn Expires December 18, 2006 [Page 4] Internet-Draft DCCA MIB June 2006 SYNTAX SnmpAdminString MAX-ACCESS read-only STATUS current DESCRIPTION "The implementation identification string for the Diameter software in use on the system, for example; 'diameterd'" ::= { dcaHostCfgs 1 } dcaHostAddressType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-only STATUS current DESCRIPTION "The type of internet address stored in dcaHostAddress." ::= { dcaHostCfgs 2 } dcaHostAddress OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-only STATUS current DESCRIPTION "The IP-Address that corresponds to the Origin-Host AVP." ::= { dcaHostCfgs 3 } dcaPeerTable OBJECT-TYPE SYNTAX SEQUENCE OF DcaPeerEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The table listing information regarding the discovered or configured Diameter Credit Control peers." ::= { dcaPeerCfgs 1 } dcaPeerEntry OBJECT-TYPE SYNTAX DcaPeerEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A row entry representing a discovered or configured Diameter Credit Control peer." INDEX { dcaPeerIndex } ::= { dcaPeerTable 1 } Zorn Expires December 18, 2006 [Page 5] Internet-Draft DCCA MIB June 2006 DcaPeerEntry ::= SEQUENCE { dcaPeerIndex Unsigned32, dcaPeerId SnmpAdminString, dcaPeerVendorId Unsigned32, dcaPeerFirmwareRevision Unsigned32, dcaPeerStatus RowStatus } dcaPeerIndex OBJECT-TYPE SYNTAX Unsigned32 (1..4294967295) MAX-ACCESS not-accessible STATUS current DESCRIPTION "A number uniquely identifying each Diameter Credit Control peer with which this host communicates." ::= { dcaPeerEntry 1 } dcaPeerId OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-create STATUS current DESCRIPTION "The server identifier for the Diameter Credit Control peer." ::= { dcaPeerEntry 2 } dcaPeerVendorId OBJECT-TYPE SYNTAX Unsigned32 (1..4294967295) MAX-ACCESS read-create STATUS current DESCRIPTION "The IANA Enterprise Code value assigned to the vendor of the Diameter Credit Control peer." ::= { dcaPeerEntry 3 } dcaPeerFirmwareRevision OBJECT-TYPE SYNTAX Unsigned32 (1..4294967295) MAX-ACCESS read-create STATUS current DESCRIPTION "Firmware revision of peer. If no firmware revision, the revision of the Diameter Credit Control software module may be reported instead." ::= { dcaPeerEntry 4 } dcaPeerStatus OBJECT-TYPE Zorn Expires December 18, 2006 [Page 6] Internet-Draft DCCA MIB June 2006 SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "Status of the DCCA peer entry: creating the entry enables the peer, destroying the entry disables the peer." ::= { dcaPeerEntry 5 } -- per-peer statistics dcaPerPeerStatsTable OBJECT-TYPE SYNTAX SEQUENCE OF dcaPerPeerStatsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The table listing the Diameter Credit Control per-peer Statistics." ::= { dcaPeerStats 1 } dcaPerPeerStatsEntry OBJECT-TYPE SYNTAX dcaPerPeerStatsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A row entry representing a Diameter Credit Control Peer." INDEX { dcaPeerIndex } ::= { dcaPerPeerStatsTable 1 } dcaPerPeerStatsEntry ::= SEQUENCE { dcaPeerStatsIndex Unsigned32, dcaPerPeerStatsCCRIn Counter32, dcaPerPeerStatsCCROut Counter32, dcaPerPeerStatsCCRDropped Counter32, dcaPerPeerStatsCCAIn Counter32, dcaPerPeerStatsCCAOut Counter32, dcaPerPeerStatsCCADropped Counter32, dcaPerPeerStatsRARIn Counter32, dcaPerPeerStatsRARDropped Counter32, dcaPerPeerStatsRAAOut Counter32, dcaPerPeerStatsRAADropped Counter32, dcaPerPeerStatsSTROut Counter32, dcaPerPeerStatsSTRDropped Counter32, dcaPerPeerStatsSTAIn Counter32, dcaPerPeerStatsSTADropped Counter32, dcaPerPeerStatsAAROut Counter32, Zorn Expires December 18, 2006 [Page 7] Internet-Draft DCCA MIB June 2006 dcaPerPeerStatsAARDropped Counter32, dcaPerPeerStatsAAAIn Counter32, dcaPerPeerStatsAAADropped Counter32 } dcaPeerStatsIndex OBJECT-TYPE SYNTAX Unsigned32 (1..4294967295) MAX-ACCESS not-accessible STATUS current DESCRIPTION "A number uniquely identifying each Diameter Credit Control Peer with which this host communicates." ::= { dcaPerPeerStatsEntry 1 } dcaPerPeerStatsCCRIn OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of Diameter Credit-Control-Request (CCR) messages received, per peer." ::= { dcaPerPeerStatsEntry 2 } dcaPerPeerStatsCCROut OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of Diameter Credit-Control-Request (CCR) messages sent, per peer." ::= { dcaPerPeerStatsEntry 3 } dcaPerPeerStatsCCRDropped OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of Diameter Credit-Control-Request (CCR) messages dropped, per peer." ::= { dcaPerPeerStatsEntry 4 } dcaPerPeerStatsCCAIn OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of Diameter Credit-Control-Answer (CCA) messages received, per peer." Zorn Expires December 18, 2006 [Page 8] Internet-Draft DCCA MIB June 2006 ::= { dcaPerPeerStatsEntry 5 } dcaPerPeerStatsCCAOut OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of Diameter Credit-Control-Answer (CCA) messages sent, per peer." ::= { dcaPerPeerStatsEntry 6 } dcaPerPeerStatsCCADropped OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of Diameter Credit-Control-Answer (CCA) messages dropped, per peer." ::= { dcaPerPeerStatsEntry 7 } dcaPerPeerStatsRARIn OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of Diameter Re-Auth-Request(RAR) messages received, per peer." ::= { dcaPerPeerStatsEntry 8 } dcaPerPeerStatsRARDropped OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of Diameter Re-Auth-Request(RAR) messages dropped, per peer." ::= { dcaPerPeerStatsEntry 9 } dcaPerPeerStatsRAAOut OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of Diameter Re-Auth-Answer(RAA) messages transmitted, per peer." ::= { dcaPerPeerStatsEntry 10 } dcaPerPeerStatsRAADropped OBJECT-TYPE Zorn Expires December 18, 2006 [Page 9] Internet-Draft DCCA MIB June 2006 SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of Diameter Re-Auth-Answer(RAA) messages dropped, per peer." ::= { dcaPerPeerStatsEntry 11 } dcaPerPeerStatsSTROut OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of Diameter Session-Termination-Request(STR) messages transmitted, per peer." ::= { dcaPerPeerStatsEntry 12 } dcaPerPeerStatsSTRDropped OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of Diameter Session-Termination-Request(STR) messages dropped, per peer." ::= { dcaPerPeerStatsEntry 13 } dcaPerPeerStatsSTAIn OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of Diameter Session-Termination-Answer(STA) messages received, per peer." ::= { dcaPerPeerStatsEntry 14 } dcaPerPeerStatsSTADropped OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of Diameter Session-Termination-Answer(STA) messages dropped, per peer." ::= { dcaPerPeerStatsEntry 15 } Zorn Expires December 18, 2006 [Page 10] Internet-Draft DCCA MIB June 2006 dcaPerPeerStatsAAROut OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of Diameter AA-Request(AAR) messages transmitted, per peer." ::= { dcaPerPeerStatsEntry 16 } dcaPerPeerStatsAARDropped OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of Diameter AA-Request(AAR) messages dropped, per peer." ::= { dcaPerPeerStatsEntry 17 } dcaPerPeerStatsAAAIn OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of Diameter AA-Answer(AAA) messages received, per peer." ::= { dcaPerPeerStatsEntry 18 } dcaPerPeerStatsAAADropped OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of Diameter AA-Answer(AAA) messages dropped, per peer." ::= { dcaPerPeerStatsEntry 19 } -- -- Conformance -- dcaMIBCompliances OBJECT IDENTIFIER ::= { diameterCcAppConform 1 } dcaMIBGroups OBJECT IDENTIFIER ::= { diameterCcAppConform 2 } -- -- Compliance Statements -- dcaMIBCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for Diameter Credit Control Zorn Expires December 18, 2006 [Page 11] Internet-Draft DCCA MIB June 2006 application entities." MODULE -- this module MANDATORY-GROUPS { dcaHostCfgGroup } ::= { dcaMIBCompliances 1 } -- -- Units of Conformance -- dcaHostCfgGroup OBJECT-GROUP OBJECTS { dcaHostAddressType, dcaHostAddress, dcaHostId } STATUS current DESCRIPTION "A collection of objects providing configuration common to the server." ::= { dcaMIBGroups 1 } END 5. IANA Considerations IANA is requested to assign an OID under mib-2. 6. Security Considerations SNMPv1 by itself is not a secure environment. Even if the network itself is secure (for example by using IPSec), there is no control as to who on the secure network is allowed to access and GET (read) the objects in this MIB. It is recommended that the implementers consider the security features as provided by the SNMPv3 framework. Specifically, the use of the User-based Security Model [RFC2574] and the View-based Access Control Model [RFC2575] is recommended. It is then a customer/user responsibility to ensure that the SNMP entity giving access to an instance of this MIB, is properly configured to give access to the objects only to those principals (users) that have legitimate rights to indeed GET or SET (change/ create/delete) them. 7. Acknowledgements Thanks to Subash Comerica, Sumanth Mithra and Biswaranjan Panda for helpful suggestions and feedback. Zorn Expires December 18, 2006 [Page 12] Internet-Draft DCCA MIB June 2006 8. References 8.1 Normative References [BASEMIB] Zorn, G., "Diameter Base Protocol MIB", draft-zorn-dime-diameter-base-protocol-mib-00.txt (work in progress), June 2006. [RFC1215] Rose, M., "Convention for defining traps for use with the SNMP", RFC 1215, March 1991. [RFC2578] McCloghrie, K., Ed., Perkins, D., Ed., and J. Schoenwaelder, Ed., "Structure of Management Information Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. [RFC2579] McCloghrie, K., Ed., Perkins, D., Ed., and J. Schoenwaelder, Ed., "Textual Conventions for SMIv2", STD 58, RFC 2579, April 1999. [RFC2580] McCloghrie, K., Perkins, D., and J. Schoenwaelder, "Conformance Statements for SMIv2", STD 58, RFC 2580, April 1999. [RFC3588] Calhoun, P., Loughney, J., Guttman, E., Zorn, G., and J. Arkko, "Diameter Base Protocol", RFC 3588, September 2003. [RFC4004] Calhoun, P., Johansson, T., Perkins, C., Hiller, T., and P. McCann, "Diameter Mobile IPv4 Application", RFC 4004, August 2005. 8.2 Informative References [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. [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. [RFC3141] Hiller, T., Walsh, P., Chen, X., Munson, M., Dommety, G., Sivalingham, S., Lim, B., McCann, P., Shiino, H., Hirschman, B., Manning, S., Hsu, R., Koo, H., Lipford, M., Calhoun, P., Lo, C., Jaques, E., Campbell, E., Y.Xu, S.Baba, T.Ayaki, T.Seki, and A.Hameed, "CDMA2000 Wireless Data Requirements for AAA", RFC 3141, June 2001. [RFC3410] Case, J., Mundy, R., Partain, D., and B. Stewart, Zorn Expires December 18, 2006 [Page 13] Internet-Draft DCCA MIB June 2006 "Introduction and Applicability Statements for Internet- Standard Management Framework", RFC 3410, December 2002. [RFC4005] Calhoun, P., Zorn, G., Spence, D., and D. Mitton, "Diameter Network Access Server Application", RFC 4005, August 2005. [RFC4006] Hakala, H., Mattila, L., Koskinen, J-P., Stura, M., and J. Loughney, "Diameter Credit-Control Application", RFC 4006, August 2005. [RFC4072] Eronen, P., Hiller, T., and G. Zorn, "Diameter Extensible Authentication Protocol (EAP) Application", RFC 4072, August 2005. Author's Address Glen Zorn Cisco Systems 2901 Third Avenue, Suite 600 SEA1/5/ Seattle, WA 98121 USA Phone: +1 (425) 344 8113 Email: gwz@cisco.com Zorn Expires December 18, 2006 [Page 14] Internet-Draft DCCA MIB June 2006 Intellectual Property Statement The IETF takes no position regarding the validity or scope of any Intellectual Property Rights or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; nor does it represent that it has made any independent effort to identify any such rights. Information on the procedures with respect to rights in RFC documents can be found in BCP 78 and BCP 79. Copies of IPR disclosures made to the IETF Secretariat and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF on-line IPR repository at http://www.ietf.org/ipr. The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights that may cover technology that may be required to implement this standard. Please address the information to the IETF at ietf-ipr@ietf.org. Disclaimer of Validity This document and the information contained herein are provided on an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM 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. Copyright Statement Copyright (C) The Internet Society (2006). This document is subject to the rights, licenses and restrictions contained in BCP 78, and except as set forth therein, the authors retain all their rights. Acknowledgment Funding for the RFC Editor function is currently provided by the Internet Society. Zorn Expires December 18, 2006 [Page 15]