Network Working Group J Senthilnathan, Rohit Verma, INTERNET DRAFT Bill Vroman Category: Internet Draft 3Com Corporation Title:draft-wheeler-info-pppoe-mib-01.txt Ross Wheeler Date: October 2000 Wind River MIB Definition for PPP Over Ethernet (PPPoE) 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. 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 TCP/IP-based internets. In particular, it defines objects for managing networks using PPP over Ethernet Protocol. Expires April 2000 Senthilnathan, Verma, Vroman, Wheeler [Page 1] INTERNET DRAFT October 2000 This memo specifies a MIB module in a manner that is both compliant to the SNMPv2 SMI, and semantically identical to the peer SNMPv1 definitions. 1.0 Introduction PPPoE [1] defines a mechanism for transporting PPP over Ethernet. This draft specifies the objects for managing devices that use PPPoE. 2.0 Conventions The following language conventions are used in the items of specification in this document: o MUST, SHALL, or MANDATORY -- This item is an absolute requirement of the specification. o SHOULD or RECOMMEND -- This item should generally be followed for all but exceptional circumstances. o MAY or OPTIONAL -- This item is truly optional and may be followed or ignored according to the needs of the implementor. Expires April 2000 Senthilnathan, Verma, Vroman, Wheeler [Page 2] INTERNET DRAFT October 2000 3.0 PPPoE MIB Object Definitions PPPOE-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, experimental, OBJECT-TYPE, Integer32, Counter32, Gauge32 FROM SNMPv2-SMI InterfaceIndex FROM IF-MIB RowStatus, TruthValue, DisplayString FROM SNMPv2-TC MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF ; -- Begin managed object definitions here... pPPoE MODULE-IDENTITY LAST-UPDATED "0010012000Z" -- October 01, 2000 ORGANIZATION "IETF Network Working Group" CONTACT-INFO "J Senthilnathan Postal: 3Com Corporation 1800 W. Central Road Mount Prospect Illinois 60056 Tel: +1 847342 6954 Email: jsenthil@mw.3com.com Rohit Verma Postal: Deloitte Consultin 180, N. Stetson Avenue Chicago, Illinois 60601 Tel: +1 312374 2475 Email: Rohit_Verma@mw.3com.com Bill Vroman Postal: 3Com Corporation 1800 W. Central Road Mount Prospect Illinois 60056 Tel: +1 847222 2008 Email: Bill_Vroman@mw.3com.com Ross Wheeler Expires April 2000 Senthilnathan, Verma, Vroman, Wheeler [Page 3] INTERNET DRAFT October 2000 Postal: Wind River 17771 Cowan Ave Irvine, CA 92614 Tel: +1 949442 0770 Email: ross@windriver.com" DESCRIPTION "The MIB module that describes managed objects of general use by the PPP over Ethernet Protocol." ::= { experimental 9999 1 } -- Top level MIB structure pPPoEObjects OBJECT IDENTIFIER ::= { pPPoE 1 } pPPoEConformance OBJECT IDENTIFIER ::= { pPPoE 2 } -- MIB Groups pPPoEConfig OBJECT IDENTIFIER ::= { pPPoEObjects 1 } pPPoEBindings OBJECT IDENTIFIER ::= { pPPoEObjects 2 } pPPoESession OBJECT IDENTIFIER ::= { pPPoEObjects 3 } -- MIB Objects pPPoEConfigMaxTotalSessions OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-write STATUS current DESCRIPTION "The number of maximum allowed PPPoE sessions" ::= { pPPoEConfig 1 } pPPoEConfigMaxSessionsPerHost OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-write STATUS current DESCRIPTION "The number of maximum allowed PPPoE sessions from a peer" ::= { pPPoEConfig 2 } pPPoEConfigPADITxInterval OBJECT-TYPE SYNTAX Integer32 (1..60) MAX-ACCESS read-write STATUS current DESCRIPTION "The time n seconds between PADI retries from the Expires April 2000 Senthilnathan, Verma, Vroman, Wheeler [Page 4] INTERNET DRAFT October 2000 Host" DEFVAL { 5 } ::= { pPPoEConfig 3 } pPPoEConfigPADIMaxNumberOfRetries OBJECT-TYPE SYNTAX Integer32 (1..10) MAX-ACCESS read-write STATUS current DESCRIPTION "The number of times the Host sends a PADI" DEFVAL { 5 } ::= { pPPoEConfig 4 } -- The PPPoE service names table pPPoEConfigServiceNameTable OBJECT-TYPE SYNTAX SEQUENCE OF PPPoEConfigServiceNameEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The table listing the service names configured for PPPoE." ::= { pPPoEConfig 5 } pPPoEConfigServiceNameEntry OBJECT-TYPE SYNTAX PPPoEConfigServiceNameEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "An entry representing service name enabled for PPPoE" INDEX { pPPoEConfigServiceName } ::= { pPPoEConfigServiceNameTable 1 } PPPoEConfigServiceNameEntry ::= SEQUENCE { pPPoEConfigServiceName DisplayString, pPPoEConfigServiceRowStatus RowStatus } pPPoEConfigServiceName OBJECT-TYPE SYNTAX DisplayString (SIZE (1..32)) MAX-ACCESS read-create STATUS current DESCRIPTION "The service name enabled for PPPoE." ::= { pPPoEConfigServiceNameEntry 1 } pPPoEConfigServiceRowStatus OBJECT-TYPE SYNTAX RowStatus Expires April 2000 Senthilnathan, Verma, Vroman, Wheeler [Page 5] INTERNET DRAFT October 2000 MAX-ACCESS read-create STATUS current DESCRIPTION "This object is used to create and delete rows from the pPPoEServiceTable. It can be set only to the value of createAndGo and destroy. It returns only the value of active." ::= { pPPoEConfigServiceNameEntry 2 } -- The PPPoE Bindings Table pPPoEBindingsTable OBJECT-TYPE SYNTAX SEQUENCE OF PPPoEBindingsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The table listing the Ethernet interfaces on which PPPoE is bound." ::= { pPPoEBindings 1 } pPPoEBindingsEntry OBJECT-TYPE SYNTAX PPPoEBindingsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "An entry representing an interface on which PPPoE is bound." INDEX { pPPoEBindingsIndex } ::= { pPPoEBindingsTable 1 } PPPoEBindingsEntry ::= SEQUENCE { pPPoEBindingsIndex InterfaceIndex, pPPoEBindingsEnabled TruthValue, pPPoEBindingsNumberActiveSessions Gauge32, pPPoEBindingsTotalNumberSessions Counter32, pPPoEBindingsNumberPADIRejected Counter32, pPPoEBindingsNumberPADIReceived Counter32, pPPoEBindingsNumberPADRRejected Counter32, pPPoEBindingsNumberPADRReceived Counter32, pPPoEBindingsNumberPADOTransmitted Counter32, pPPoEBindingsNumberPADSTransmitted Counter32, pPPoEBindingsNumberPADTReceived Counter32, pPPoEBindingsNumberPADTTransmitted Counter32, pPPoEBindingsNumberServiceNameErrors Counter32, pPPoEBindingsNumberACSystemErrors Counter32, pPPoEBindingsNumberGenericErrorsReceived Counter32, Expires April 2000 Senthilnathan, Verma, Vroman, Wheeler [Page 6] INTERNET DRAFT October 2000 pPPoEBindingsNumberGenericErrorsTransmitted Counter32, pPPoEBindingsNumberMalformedPackets Counter32, pPPoEBindingsNumberPADITimeouts Counter32, pPPoEBindingsNumberMultiplePADOReceived Counter32 } pPPoEBindingsIndex OBJECT-TYPE SYNTAX InterfaceIndex MAX-ACCESS read-only STATUS current DESCRIPTION "This value for this object is equal to the value of ifIndex of the Interfaces MIB for the Ethernet interfaces." ::= { pPPoEBindingsEntry 1 } pPPoEBindingsEnabled OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-write STATUS current DESCRIPTION "Whether pppoe is enabled or not." DEFVAL { false } ::= { pPPoEBindingsEntry 2 } pPPoEBindingsNumberActiveSessions OBJECT-TYPE SYNTAX Gauge32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of Active PPPoE Sessions" ::= { pPPoEBindingsEntry 3 } pPPoEBindingsTotalNumberSessions OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The total number of PPPoE Sessions since last counter reset" ::= { pPPoEBindingsEntry 4 } pPPoEBindingsNumberPADIRejected OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of PADI discarded" ::= { pPPoEBindingsEntry 5 } Expires April 2000 Senthilnathan, Verma, Vroman, Wheeler [Page 7] INTERNET DRAFT October 2000 pPPoEBindingsNumberPADIReceived OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of PPPoE PADI received" ::= { pPPoEBindingsEntry 6 } pPPoEBindingsNumberPADRRejected OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of PPPoE PADR discarded" ::= { pPPoEBindingsEntry 7 } pPPoEBindingsNumberPADRReceived OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of PPPoE PADR received" ::= { pPPoEBindingsEntry 8 } pPPoEBindingsNumberPADOTransmitted OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of PPPoE PADO transmitted" ::= { pPPoEBindingsEntry 9 } pPPoEBindingsNumberPADSTransmitted OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of PPPoE PADS transmitted" ::= { pPPoEBindingsEntry 10 } pPPoEBindingsNumberPADTReceived OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of PPPoE PADT received" ::= { pPPoEBindingsEntry 11 } Expires April 2000 Senthilnathan, Verma, Vroman, Wheeler [Page 8] INTERNET DRAFT October 2000 pPPoEBindingsNumberPADTTransmitted OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of PPPoE PADT transmitted" ::= { pPPoEBindingsEntry 12 } pPPoEBindingsNumberServiceNameErrors OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of PPPoE Service-Name-Error tags received/transmitted" ::= { pPPoEBindingsEntry 13 } pPPoEBindingsNumberACSystemErrors OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of PPPoE AC-System-Error tags received/transmitted" ::= { pPPoEBindingsEntry 14 } pPPoEBindingsNumberGenericErrorsReceived OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of PPPoE Generic-Error tags received" ::= { pPPoEBindingsEntry 15 } pPPoEBindingsNumberGenericErrorsTransmitted OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of PPPoE Generic-Error tags transmitted" ::= { pPPoEBindingsEntry 16 } pPPoEBindingsNumberMalformedPackets OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of malformed PPPoE packets received" Expires April 2000 Senthilnathan, Verma, Vroman, Wheeler [Page 9] INTERNET DRAFT October 2000 ::= { pPPoEBindingsEntry 17 } pPPoEBindingsNumberPADITimeouts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of PPPoE timeouts waiting for a response to a PADI" ::= { pPPoEBindingsEntry 18 } pPPoEBindingsNumberMultiplePADOReceived OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of PPPoE multiple PADO's received after a PADI request" ::= { pPPoEBindingsEntry 19 } -- The PPPoE sessions table pPPoESessionTable OBJECT-TYPE SYNTAX SEQUENCE OF PPPoESessionEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table lists the PPPoE sessions established in the device" ::= { pPPoESession 1 } pPPoESessionEntry OBJECT-TYPE SYNTAX PPPoESessionEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Table of PPPoE sessions in the device" INDEX { pPPoESessionIfIndex} ::= { pPPoESessionTable 1 } PPPoESessionEntry ::= SEQUENCE { pPPoESessionIfIndex InterfaceIndex, pPPoESessionID Integer32, pPPoESessionPeerAddress DisplayString, pPPoESessionState INTEGER } Expires April 2000 Senthilnathan, Verma, Vroman, Wheeler [Page 10] INTERNET DRAFT October 2000 pPPoESessionIfIndex OBJECT-TYPE SYNTAX InterfaceIndex MAX-ACCESS read-only STATUS current DESCRIPTION "The value for this object is equal to the value of ifIndex of the Interfaces MIB for the PPPoE interface instantiated for this session." ::= { pPPoESessionEntry 1 } pPPoESessionID OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object contains the session identifier for this session as assigned by the AC in the PADS message." ::= { pPPoESessionEntry 2 } pPPoESessionPeerAddress OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "This object contains the MAC address for the session peer." ::= { pPPoESessionEntry 3 } pPPoESessionState OBJECT-TYPE SYNTAX INTEGER { noState(1), pADISent(2), pADIRcvd(3), pADOSent(4), pADORcvd(5), pADRSent(6), pADRRcvd(7), pADSSent(8), pADSRcvd(9), sessionStage(10) } MAX-ACCESS read-only STATUS current DESCRIPTION "This object contains the session state for this session" ::= { pPPoESessionEntry 4 } Expires April 2000 Senthilnathan, Verma, Vroman, Wheeler [Page 11] INTERNET DRAFT October 2000 -- Conformance Definitions pPPoEConformanceGroups OBJECT IDENTIFIER ::= { pPPoEConformance 1 } pPPoECompliances OBJECT IDENTIFIER ::= { pPPoEConformance 2 } -- compliance statements pPPoECompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for agents that support the PPPOE-MIB." MODULE -- this module MANDATORY-GROUPS { pPPoEGeneralConformanceGroup } GROUP pPPoEHostConformanceGroup DESCRIPTION "This group of objects is mandatory for the Host side implementation of PPPoE." GROUP pPPoEACConformanceGroup DESCRIPTION "This group of objects is mandatory for the AC side implementation of PPPoE." OBJECT pPPoEConfigMaxTotalSessions MIN-ACCESS read-only DESCRIPTION " The agent is not required to allow the user to change the quantity of the maximum quantity of allowed sessions. This may be due to the implementation of the system. The agent is not required to support a SET operation to this object in the absence of adequate security." OBJECT pPPoEConfigMaxSessionsPerHost MIN-ACCESS read-only DESCRIPTION " The agent is not required to allow the user to change the quantity of the maximum quantity of allowed sessions. This may be due to the implementation of the system. The agent is not required to support a SET operation to this object in the absence of adequate security." Expires April 2000 Senthilnathan, Verma, Vroman, Wheeler [Page 12] INTERNET DRAFT October 2000 OBJECT pPPoEConfigPADITxInterval MIN-ACCESS read-only DESCRIPTION " The agent is not required to allow the user to change the quantity of the maximum quantity of allowed sessions. This may be due to the implementation of the system. The agent is not required to support a SET operation to this object in the absence of adequate security." OBJECT pPPoEConfigPADIMaxNumberOfRetries MIN-ACCESS read-only DESCRIPTION "The agent is not required to support a SET operation to this object in the absence of adequate security." OBJECT pPPoEConfigServiceName MIN-ACCESS read-only DESCRIPTION "The agent is not required to support a SET operation to this object in the absence of adequate security." OBJECT pPPoEConfigServiceRowStatus MIN-ACCESS read-only DESCRIPTION "The agent is not required to support a SET operation to this object in the absence of adequate security." OBJECT pPPoEBindingsEnabled MIN-ACCESS read-only DESCRIPTION "The agent is not required to support a SET operation to this object in the absence of adequate security." ::= { pPPoECompliances 1 } -- units of conformance pPPoEGeneralConformanceGroup OBJECT-GROUP OBJECTS { pPPoEBindingsEnabled, pPPoEBindingsNumberActiveSessions, pPPoEBindingsTotalNumberSessions, pPPoEBindingsNumberPADTReceived, pPPoEBindingsNumberPADTTransmitted, pPPoEBindingsNumberGenericErrorsReceived, pPPoEBindingsNumberGenericErrorsTransmitted, pPPoEBindingsNumberMalformedPackets, pPPoESessionID, Expires April 2000 Senthilnathan, Verma, Vroman, Wheeler [Page 13] INTERNET DRAFT October 2000 pPPoESessionPeerAddress, pPPoESessionState, pPPoEConfigServiceName, pPPoEConfigServiceRowStatus } STATUS current DESCRIPTION "This group is mandatory for all PPPoE entities." ::= { pPPoEConformanceGroups 1 } pPPoEHostConformanceGroup OBJECT-GROUP OBJECTS { pPPoEBindingsNumberPADITimeouts, pPPoEBindingsNumberMultiplePADOReceived } STATUS current DESCRIPTION "This group is mandatory for all Host entities." ::= { pPPoEConformanceGroups 2 } pPPoEACConformanceGroup OBJECT-GROUP OBJECTS { pPPoEBindingsNumberPADIRejected, pPPoEBindingsNumberPADIReceived, pPPoEBindingsNumberPADRRejected, pPPoEBindingsNumberPADRReceived, pPPoEBindingsNumberPADOTransmitted, pPPoEBindingsNumberPADSTransmitted, pPPoEBindingsNumberServiceNameErrors, pPPoEBindingsNumberACSystemErrors } STATUS current DESCRIPTION "This group is mandatory for all AC entities." ::= { pPPoEConformanceGroups 3 } END -- End Template MIB definitions 4.0 References [1] Mamakos, L., et al, "A Method for Transmitting PPP Over Ethernet, (PPPoE)", RFC 2516, February 1999 [2] Simpson, W., Editor, "The Point-to-Point Protocol (PPP)", STD 51, RFC 1661, July 1994 [3] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. [4] Reynolds, J. and J. Postel, "Assigned Numbers", STD Expires April 2000 Senthilnathan, Verma, Vroman, Wheeler [Page 14] INTERNET DRAFT October 2000 2, RFC 1700, October 1994. See also: http://www.iana.org/numbers.html 5.0 Author's Addresses J Senthilnathan 3Com Corporation 1800 W. Central Road Mount Prospect Illinois 60056 jsenthil@mw.3com.com Rohit Verma Deloitte Consulting 180, N. Stetson Avenue Chicago, Illinois 60601 rverma@dc.com Bill Vroman 3Com Corporation 1800 W. Central Road Mount Prospect Illinois 60056 Bill_Vroman@mw.3com.com Ross Wheeler Wind River 17771 Cowan Ave Irvine, CA 92614 ross@windriver.com Expires April 2000 Senthilnathan, Verma, Vroman, Wheeler [Page 15]