Internet Draft The Definitions of Managed Objects for the Link Control Protocol of the Point-to-Point Protocol 19 April 1993 Frank Kastenholz FTP Software, Inc 2 High Street North Andover, Mass 01845 USA kasten@ftp.com Status of this Memo This document is an Internet Draft. 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. Internet Drafts may be updated, replaced, or obsoleted by other documents at any time. It is not appropriate to use Internet Drafts as reference material or to cite them other than as a ``working draft'' or ``work in progress.'' Please check the 1id-abstracts.txt listing contained in the internet-drafts Shadow Directories on nic.ddn.mil, nnsc.nsf.net, nic.nordu.net, ftp.nisc.sri.com, or munnari.oz.au to learn the current status of any Internet Draft. Internet Draft PPP/LCP MIB April 1993 This document will be submitted to the Internet Activities Board as a Proposed Standard. This document defines an experimental extension to the SNMP MIB. Upon publication as a Proposed Standard, a new MIB number will be assigned. This is a working document only, it should neither be cited nor quoted in any formal document. This document will expire before 24 Oct. 1993. Distribution of this document is unlimited. Please send comments to the author. 1. Abstract This memo defines an experimental portion of the Management Information Base (MIB) for use with network management protocols in TCP/IP-based internets. In particular, it describes managed objects used for managing the Link Control Protocol and Link Quality Monitoring on subnetwork interfaces that use the family of Point-to-Point Protocols[8, 9, 10, 11, & 12]. This memo does not specify a standard for the Internet community. Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 2] Internet Draft PPP/LCP MIB April 1993 2. The Network Management Framework The Internet-standard Network Management Framework consists of three components. They are: RFC 1155 which defines the SMI, the mechanisms used for describing and naming objects for the purpose of management. RFC 1212 defines a more concise description mechanism, which is wholly consistent with the SMI. RFC 1213 defines MIB-II, the core set of managed objects for the Internet suite of protocols. RFC 1157 which defines the SNMP, the protocol used for network access to managed objects. The Framework permits new objects to be defined for the purpose of experimentation and evaluation. Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 3] Internet Draft PPP/LCP MIB April 1993 3. Objects Managed objects are accessed via a virtual information store, termed the Management Information Base or MIB. Objects in the MIB are defined using the subset of Abstract Syntax Notation One (ASN.1) [3] defined in the SMI. In particular, each object type is named by an OBJECT IDENTIFIER, an administratively assigned name. The object type together with an object instance serves to uniquely identify a specific instantiation of the object. For human convenience, we often use a textual string, termed the descriptor, to refer to the object type. 3.1. Format of Definitions Section 5 contains the specification of all object types contained in this MIB module. The object types are defined using the conventions defined in the SMI, as amended by the extensions specified in [5,6]. Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 4] Internet Draft PPP/LCP MIB April 1993 4. Overview 4.1. Object Selection Criteria To be consistent with IAB directives and good engineering practice, an explicit attempt was made to keep this MIB as simple as possible. This was accomplished by applying the following criteria to objects proposed for inclusion: (1) Require objects be essential for either fault or configuration management. In particular, objects for which the sole purpose was to debug implementations were explicitly excluded from the MIB. (2) Consider evidence of current use and/or utility. (3) Limit the total number of objects. (4) Exclude objects which are simply derivable from others in this or other MIBs. 4.2. Structure of the PPP This section describes the basic model of PPP used in developing the PPP MIB. This information should be useful to the implementor in understanding some of the basic design decisions of the MIB. The PPP is not one single protocol but a large family of protocols. Each of these is, in itself, a fairly complex protocol. The PPP protocols may be divided into three rough categories: Control Protocols The Control Protocols are used to control the operation of the PPP. The Control Protocols include the Link Control Protocol (LCP), the Password Authentication Protocol (PAP), the Link Quality Report (LQR), and the Challenge Handshake Authentication Protocol (CHAP). Network Protocols The Network Protocols are used to move the network traffic over the PPP interface. A Network Protocol Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 5] Internet Draft PPP/LCP MIB April 1993 encapsulates the datagrams of a specific higher-layer protocol that is using the PPP as a data link. Note that within the context of PPP, the term "Network Protocol" does not imply an OSI Layer-3 protocol; for instance, there is a Bridging network protocol. Network Control Protocols (NCPs) The NCPs are used to control the operation of the Network Protocols. Generally, each Network Protocol has its own Network Control Protocol; thus, the IP Network Protocol has its IP Control Protocol, the Bridging Network Protocol has its Bridging Network Control Protocol and so on. This document specifies the objects used in managing one of these protocols, namely the Link Control Protocol and Link Quality Monitoring Protocol. 4.3. MIB Groups Objects in this MIB are arranged into several MIB groups. Each group is organized as a set of related objects. These groups are the basic unit of conformance: if the semantics of a group are applicable to an implementation then all objects in the group must be implemented. The PPP MIB is organized into several MIB Groups, including, but not limited to, the following groups: o The PPP Link Group o The PPP LQR Group o The PPP LQR Extensions Group o The PPP IP Group o The PPP Bridge Group o The PPP Security Group This document specifies the following groups: The PPP Link Group This group represents the lowest "level" of the PPP protocol. Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 6] Internet Draft PPP/LCP MIB April 1993 This group contains two tables, one containing status information and the other configuration information. The configuration table is split off of the status so that it may be placed in a separate MIB View for security purposes. Implementation of this group is mandatory for all PPP implementations. The PPP LQR Group This group provides the basic MIB variables that apply to the PPP LQR Protocol. This group provides MIB access to the information required for LQR processing. This group contains two tables, one containing status information and the other configuration information. The configuration table is split off of the status so that it may be placed in a separate MIB View for security purposes. Implementation of the PPP LQR Group is mandatory for all PPP implementations that implement LQR. The PPP LQR Extensions Group The PPP LQR Extensions group contains the most recently received LQR packet, as well as the "save" fields that are "logically appended"[12] to received LQR packets. This is done in order to facilitate external implementations of the Link Quality Monitoring policies. It is not practical to examine the relevant MIB objects which are used to generate LQR packets since LQR policies may require synchronization of the values of all data used to determine Link Quality; i.e., the values of the relevant counters must all be taken at the same instant in time. Thus, by recording the last received LQR packet, a synchronized record of the relevant data is available. As this information may not be efficiently maintained on all PPP implementations, implementation of this group is optional. Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 7] Internet Draft PPP/LCP MIB April 1993 4.4. Relationship to Interface and Interface Extensions Groups The PPP Mib is a medium-specific extension to the standard MIB-2 interface group[2] and to the Interface Extensions MIB [7]. This section discusses certain components of these groups when the interface is a PPP interface. The entire PPP instance represents a single interface in the sense used in [2] and thus has a single entry in the ifTable. All PPP packets are defined in [8] as being broadcast packets. Thus, the packets are counted as non-unicast packets in the ifTable (ifInNUcastPkts and ifOutNUCastPkts) and as broadcasts in the ifExtnsTable (ifExtnsBroadcastsReceivedOks and ifExtnsBroadcastsTransmittedOks). ifSpecific Contains the OBJECT IDENTIFIER ppp. ifAdminStatus Setting this object to up will inject an administrative open event into the LCP's finite state machine. Setting this object to down will inject an administrative close event into the LCP's finite state machine. The use of the testing value is beyond the scope of this document. ifOperStatus Represents the state of the LCP Finite State Machine. If the Finite State Machine is in the Opened state then the value of ifOperStatus is up, otherwise the value of ifOperStatus is down. The meaning of the testing value is beyond the scope of this document. Per the SNMP Protocol Specification, [13], the linkUp and linkDown traps apply to the PPP Protocol entity. When the LCP's Finite State Machine attains the Opened state, a linkUp trap should be sent. When the Finite State Machine leaves the Opened state, a linkDown trap should be sent. Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 8] Internet Draft PPP/LCP MIB April 1993 Some tests for the link are defined in this document. Execution of these tests does not place the link's ifOperStatus in the testing state as these tests do not prevent normal data transmission from occuring over the link. Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 9] Internet Draft PPP/LCP MIB April 1993 5. Definitions PPP-LCP-MIB DEFINITIONS ::= BEGIN IMPORTS experimental, Counter FROM RFC1155-SMI ifIndex FROM RFC1213-MIB OBJECT-TYPE FROM RFC-1212; -- PPP MIB ppp OBJECT IDENTIFIER ::= { experimental 18 } pppLcp OBJECT IDENTIFIER ::= { ppp 1 } -- The individual groups within the PPP-LCP-MIB pppLink OBJECT IDENTIFIER ::= { pppLcp 1 } pppLqr OBJECT IDENTIFIER ::= { pppLcp 2 } pppTests OBJECT IDENTIFIER ::= { pppLcp 3 } Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 10] Internet Draft PPP/LCP MIB April 1993 5.1. PPP Link Group -- -- The PPP Link Group. Implementation of this -- group is mandatory for all PPP entities. -- pppLinkStatusTable OBJECT-TYPE SYNTAX SEQUENCE OF PppLinkStatusEntry ACCESS not-accessible STATUS mandatory DESCRIPTION "A table containing PPP-link specific variables for this PPP implementation." ::= { pppLink 1 } pppLinkStatusEntry OBJECT-TYPE SYNTAX PppLinkStatusEntry ACCESS not-accessible STATUS mandatory DESCRIPTION "Management information about a particular PPP Link." INDEX { ifIndex } ::= { pppLinkStatusTable 1 } PppLinkStatusEntry ::= SEQUENCE { pppLinkStatusPhysicalIndex INTEGER, pppLinkStatusBadAddresses Counter, pppLinkStatusBadControls Counter, pppLinkStatusPacketTooLongs Counter, pppLinkStatusBadFCSs Counter, pppLinkStatusLocalMRU INTEGER, pppLinkStatusRemoteMRU INTEGER, Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 11] Internet Draft PPP/LCP MIB April 1993 pppLinkStatusLocalToPeerACCMap OCTET STRING, pppLinkStatusPeerToLocalACCMap OCTET STRING, pppLinkStatusLocalToRemoteProtocolCompression INTEGER, pppLinkStatusRemoteToLocalProtocolCompression INTEGER, pppLinkStatusLocalToRemoteACCompression INTEGER, pppLinkStatusRemoteToLocalACCompression INTEGER, pppLinkStatusTransmitFcsSize INTEGER, pppLinkStatusReceiveFcsSize INTEGER } pppLinkStatusPhysicalIndex OBJECT-TYPE SYNTAX INTEGER(0..2147483648) ACCESS read-only STATUS mandatory DESCRIPTION "The value of ifIndex that identifies the interface over which this PPP Link is operating. This interface would usually be an HDLC or RS-232 type of interface. If there is no lower-layer interface element, or there is no ifEntry for the element, or the element can not be identified, then the value of this object is 0." ::= { pppLinkStatusEntry 1 } pppLinkStatusBadAddresses OBJECT-TYPE SYNTAX Counter ACCESS read-only STATUS mandatory DESCRIPTION "The number of packets received with an incorrect Address Field. This counter is a component of the ifInErrors variable that is associated with the interface that represents this PPP Link." REFERENCE Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 12] Internet Draft PPP/LCP MIB April 1993 "Section 3.1, Address Field, of RFC1331." ::= { pppLinkStatusEntry 2 } pppLinkStatusBadControls OBJECT-TYPE SYNTAX Counter ACCESS read-only STATUS mandatory DESCRIPTION "The number of packets received on this link with an incorrect Control Field. This counter is a component of the ifInErrors variable that is associated with the interface that represents this PPP Link." REFERENCE "Section 3.1, Control Field, of RFC1331." ::= { pppLinkStatusEntry 3 } pppLinkStatusPacketTooLongs OBJECT-TYPE SYNTAX Counter ACCESS read-only STATUS mandatory DESCRIPTION "The number of received packets that have been discarded because their length exceeded the MRU. This counter is a component of the ifInErrors variable that is associated with the interface that represents this PPP Link. NOTE, packets which are longer than the MRU but which are successfully received and processed are NOT included in this count." ::= { pppLinkStatusEntry 4 } pppLinkStatusBadFCSs OBJECT-TYPE SYNTAX Counter ACCESS read-only STATUS mandatory DESCRIPTION "The number of received packets that have been discarded due to having an incorrect FCS. This counter is a component of the ifInErrors variable that is associated with the interface Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 13] Internet Draft PPP/LCP MIB April 1993 that represents this PPP Link." ::= { pppLinkStatusEntry 5 } pppLinkStatusLocalMRU OBJECT-TYPE SYNTAX INTEGER(1..2147483648) ACCESS read-only STATUS mandatory DESCRIPTION "The current value of the MRU for the local PPP Entity. This value is the MRU that the remote entity is using when sending packets to the local PPP entity." ::= { pppLinkStatusEntry 6 } pppLinkStatusRemoteMRU OBJECT-TYPE SYNTAX INTEGER(1..2147483648) ACCESS read-only STATUS mandatory DESCRIPTION "The current value of the MRU for the remote PPP Entity. This value is the MRU that the local entity is using when sending packets to the remote PPP entity." ::= { pppLinkStatusEntry 7 } pppLinkStatusLocalToPeerACCMap OBJECT-TYPE SYNTAX OCTET STRING (SIZE (4)) ACCESS read-only STATUS mandatory DESCRIPTION "The current value of the ACC Map used for sending packets from the local PPP entity to the remote PPP entity." ::= { pppLinkStatusEntry 8 } pppLinkStatusPeerToLocalACCMap OBJECT-TYPE SYNTAX OCTET STRING (SIZE (4)) ACCESS read-only STATUS mandatory DESCRIPTION Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 14] Internet Draft PPP/LCP MIB April 1993 "The ACC Map used by the remote PPP entity when transmitting packets to the local PPP entity." ::= { pppLinkStatusEntry 9 } pppLinkStatusLocalToRemoteProtocolCompression OBJECT-TYPE SYNTAX INTEGER { enabled(1), disabled(2) } ACCESS read-only STATUS mandatory DESCRIPTION "Indicates whether the local PPP entity will use Protocol Compression when transmitting packets to the remote PPP entity." ::= { pppLinkStatusEntry 10 } pppLinkStatusRemoteToLocalProtocolCompression OBJECT-TYPE SYNTAX INTEGER { enabled(1), disabled(2) } ACCESS read-only STATUS mandatory DESCRIPTION "Indicates whether the remote PPP entity will use Protocol Compression when transmitting packets to the local PPP entity." ::= { pppLinkStatusEntry 11 } pppLinkStatusLocalToRemoteACCompression OBJECT-TYPE SYNTAX INTEGER { enabled(1), disabled(2) } ACCESS read-only STATUS mandatory DESCRIPTION "Indicates whether the local PPP entity will Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 15] Internet Draft PPP/LCP MIB April 1993 use Address and Control Compression when transmitting packets to the remote PPP entity." ::= { pppLinkStatusEntry 12 } pppLinkStatusRemoteToLocalACCompression OBJECT-TYPE SYNTAX INTEGER { enabled(1), disabled(2) } ACCESS read-only STATUS mandatory DESCRIPTION "Indicates whether the remote PPP entity will use Address and Control Compression when transmitting packets to the local PPP entity." ::= { pppLinkStatusEntry 13 } pppLinkStatusTransmitFcsSize OBJECT-TYPE SYNTAX INTEGER (0..128) ACCESS read-only STATUS mandatory DESCRIPTION "The size of the Frame Check Sequence (FCS) in bits that the local node will generate when sending packets to the remote node." ::= { pppLinkStatusEntry 14 } pppLinkStatusReceiveFcsSize OBJECT-TYPE SYNTAX INTEGER (0..128) ACCESS read-only STATUS mandatory DESCRIPTION "The size of the Frame Check Sequence (FCS) in bits that the remote node will generate when sending packets to the local node." ::= { pppLinkStatusEntry 15 } pppLinkConfigTable OBJECT-TYPE SYNTAX SEQUENCE OF PppLinkConfigEntry Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 16] Internet Draft PPP/LCP MIB April 1993 ACCESS not-accessible STATUS mandatory DESCRIPTION "A table containing the LCP configuration parameters for this PPP Link. These variables represent the initial configuration of the PPP Link. The actual values of the parameters may be changed when the link is brought up via the LCP options negotiation mechanism." ::= { pppLink 2 } pppLinkConfigEntry OBJECT-TYPE SYNTAX PppLinkConfigEntry ACCESS not-accessible STATUS mandatory DESCRIPTION "Configuration information about a particular PPP Link." INDEX { ifIndex } ::= { pppLinkConfigTable 1 } PppLinkConfigEntry ::= SEQUENCE { pppLinkConfigInitialMRU INTEGER, pppLinkConfigReceiveACCMap OCTET STRING, pppLinkConfigTransmitACCMap OCTET STRING, pppLinkConfigMagicNumber INTEGER, pppLinkConfigFcsSize INTEGER } pppLinkConfigInitialMRU OBJECT-TYPE SYNTAX INTEGER(0..2147483648) ACCESS read-write STATUS mandatory DESCRIPTION "The initial Maximum Receive Unit (MRU) that the local PPP entity will advertise to the remote entity. If the value of this variable is Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 17] Internet Draft PPP/LCP MIB April 1993 0 then the local PPP entity will not advertise any MRU to the remote entity and the default MRU will be assumed. Changing this object will have effect when the link is next restarted." REFERENCE "Section 7.2, Maximum Receive Unit of RFC1331." DEFVAL { 1500 } ::= { pppLinkConfigEntry 1 } pppLinkConfigReceiveACCMap OBJECT-TYPE SYNTAX OCTET STRING (SIZE (4)) ACCESS read-write STATUS mandatory DESCRIPTION "The Asynchronous-Control-Character-Map (ACC) that the local PPP entity requires for use on its receive side. In effect, this is the ACC Map that is required in order to ensure that the local modem will successfully receive all characters. The actual ACC map used on the receive side of the link will be a combination of the local node's pppLinkConfigReceiveACCMap and the remote node's pppLinkConfigTransmitACCMap. Changing this object will have effect when the link is next restarted." REFERENCE "Section 7.3, page 4, Async-Control-Character- Map of RFC1331." DEFVAL { 'ffffffff'h } ::= { pppLinkConfigEntry 2 } pppLinkConfigTransmitACCMap OBJECT-TYPE SYNTAX OCTET STRING (SIZE (4)) ACCESS read-write STATUS mandatory DESCRIPTION "The Asynchronous-Control-Character-Map (ACC) that the local PPP entity requires for use on its transmit side. In effect, this is the ACC Map that is required in order to ensure that all characters can be successfully transmitted Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 18] Internet Draft PPP/LCP MIB April 1993 through the local modem. The actual ACC map used on the transmit side of the link will be a combination of the local node's pppLinkConfigTransmitACCMap and the remote node's pppLinkConfigReceiveACCMap. Changing this object will have effect when the link is next restarted." REFERENCE "Section 7.3, page 4, Async-Control-Character- Map of RFC1331." DEFVAL { 'ffffffff'h } ::= { pppLinkConfigEntry 3 } pppLinkConfigMagicNumber OBJECT-TYPE SYNTAX INTEGER {false (1), true (2)} ACCESS read-write STATUS mandatory DESCRIPTION "If true(2) then the local node will attempt to perform Magic Number negotiation with the remote node. If false(1) then this negotiation is not performed. In any event, the local node will comply with any magic number negotiations attempted by the remote node, per the PPP specification. Changing this object will have effect when the link is next restarted." REFERENCE "Section 7.6, Magic Number, of RFC1331." DEFVAL { false } ::= { pppLinkConfigEntry 4 } pppLinkConfigFcsSize OBJECT-TYPE SYNTAX INTEGER (0..128) ACCESS read-write STATUS mandatory DESCRIPTION "The size of the FCS, in bits, the local node will attempt to negotiate for use with the remote node. Regardless of the value of this object, the local node will comply with any FCS size negotiations initiated by the remote node, per the PPP specification. Changing this object Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 19] Internet Draft PPP/LCP MIB April 1993 will have effect when the link is next restarted." DEFVAL { 16 } ::= { pppLinkConfigEntry 5 } Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 20] Internet Draft PPP/LCP MIB April 1993 5.2. PPP LQR Group -- -- The PPP LQR Group. -- Implementation of this group is mandatory for all -- PPP implementations that implement LQR. -- pppLqrTable OBJECT-TYPE SYNTAX SEQUENCE OF PppLqrEntry ACCESS not-accessible STATUS mandatory DESCRIPTION "Table containing the LQR parameters and statistics for the local PPP entity." ::= { pppLqr 1 } pppLqrEntry OBJECT-TYPE SYNTAX PppLqrEntry ACCESS not-accessible STATUS mandatory DESCRIPTION "LQR information for a particular PPP link. A PPP link will have an entry in this table if and only if LQR Quality Monitoring has been successfully negotiated for said link." INDEX { ifIndex } ::= { pppLqrTable 1 } PppLqrEntry ::= SEQUENCE { pppLqrQuality INTEGER, pppLqrInGoodOctets Counter, pppLqrLocalPeriod INTEGER, pppLqrRemotePeriod INTEGER, pppLqrOutLQRs Counter, pppLqrInLQRs Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 21] Internet Draft PPP/LCP MIB April 1993 Counter } pppLqrQuality OBJECT-TYPE SYNTAX INTEGER { good(1), bad(2), not-determined(3) } ACCESS read-only STATUS mandatory DESCRIPTION "The current quality of the link as declared by the local PPP entity's Link-Quality Management modules. No effort is made to define good or bad, nor the policy used to determine it. The not-determined value indicates that the entity does not actually evaluate the link's quality. This value is used to disambiguate the `determined to be good' case from the `no determination made and presumed to be good' case." ::= { pppLqrEntry 1 } pppLqrInGoodOctets OBJECT-TYPE SYNTAX Counter ACCESS read-only STATUS mandatory DESCRIPTION "The LQR InGoodOctets counter for this link." REFERENCE "Section 2.2, Counters, of RFC1333." ::= { pppLqrEntry 2 } pppLqrLocalPeriod OBJECT-TYPE SYNTAX INTEGER(1..2147483648) ACCESS read-only STATUS mandatory DESCRIPTION "The LQR reporting period, in hundredths of a second that is in effect for the local PPP entity." Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 22] Internet Draft PPP/LCP MIB April 1993 REFERENCE "Section 2.5, Configuration Option Format, of RFC1333." ::= { pppLqrEntry 3 } pppLqrRemotePeriod OBJECT-TYPE SYNTAX INTEGER(1..2147483648) ACCESS read-only STATUS mandatory DESCRIPTION "The LQR reporting period, in hundredths of a second, that is in effect for the remote PPP entity." REFERENCE "Section 2.5, Configuration Option Format, of RFC1333." ::= { pppLqrEntry 4 } pppLqrOutLQRs OBJECT-TYPE SYNTAX Counter ACCESS read-only STATUS mandatory DESCRIPTION "The value of the OutLQRs counter on the local node for the link identified by pppLqrLinkIndex." REFERENCE "Section 2.2, Counters, of RFC1333." ::= { pppLqrEntry 5 } pppLqrInLQRs OBJECT-TYPE SYNTAX Counter ACCESS read-only STATUS mandatory DESCRIPTION "The value of the InLQRs counter on the local node for the link identified by pppLqrLinkIndex." REFERENCE "Section 2.2, Counters, of RFC1333." ::= { pppLqrEntry 6 } Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 23] Internet Draft PPP/LCP MIB April 1993 -- -- The PPP LQR Configuration table. -- pppLqrConfigTable OBJECT-TYPE SYNTAX SEQUENCE OF PppLqrConfigEntry ACCESS not-accessible STATUS mandatory DESCRIPTION "Table containing the LQR Configuration parameters for the local PPP entity." ::= { pppLqr 2 } pppLqrConfigEntry OBJECT-TYPE SYNTAX PppLqrConfigEntry ACCESS not-accessible STATUS mandatory DESCRIPTION "LQR configuration information for a particular PPP link." INDEX { ifIndex } ::= { pppLqrConfigTable 1 } PppLqrConfigEntry ::= SEQUENCE { pppLqrConfigPeriod INTEGER, pppLqrConfigStatus INTEGER } pppLqrConfigPeriod OBJECT-TYPE SYNTAX INTEGER(0..2147483648) ACCESS read-write STATUS mandatory DESCRIPTION "The LQR Reporting Period that the local PPP entity will attempt to negotiate with the remote entity, in units of hundredths of a second. Changing this object will have effect when the link is next restarted." REFERENCE Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 24] Internet Draft PPP/LCP MIB April 1993 "Section 2.5, Configuration Option Format, of RFC1333." DEFVAL { 0 } ::= { pppLqrConfigEntry 1 } pppLqrConfigStatus OBJECT-TYPE SYNTAX INTEGER {disabled (1), enabled (2)} ACCESS read-write STATUS mandatory DESCRIPTION "If enabled(2) then the local node will attempt to perform LQR negotiation with the remote node. If disabled(1) then this negotiation is not performed. In any event, the local node will comply with any magic number negotiations attempted by the remote node, per the PPP specification. Changing this object will have effect when the link is next restarted. Setting this object to the value disabled(1) has the effect of invalidating the corresponding entry in the pppLqrConfigTable object. It is an implementation-specific matter as to whether the agent removes an invalidated entry from the table. Accordingly, management stations must be prepared to receive tabular information from agents that corresponds to entries not currently in use." REFERENCE "Section 7.6, Magic Number, of RFC1331." DEFVAL { enabled } ::= { pppLqrConfigEntry 2 } Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 25] Internet Draft PPP/LCP MIB April 1993 5.3. PPP LQR Extensions Group -- -- The PPP LQR Extensions Group. -- Implementation of this group is optional. -- -- The intent of this group is to allow external -- implementation of the policy mechanisms that -- are used to declare a link to be "bad" or not. -- -- It is not practical to examine the MIB objects -- which are used to generate LQR packets since -- LQR policies tend to require synchronization of -- the values of all data used to determine Link -- Quality; i.e. the values of the relevant counters -- must all be taken at the same instant in time. -- pppLqrExtnsTable OBJECT-TYPE SYNTAX SEQUENCE OF PppLqrExtnsEntry ACCESS not-accessible STATUS mandatory DESCRIPTION "Table containing additional LQR information for the local PPP entity." ::= { pppLqr 3 } pppLqrExtnsEntry OBJECT-TYPE SYNTAX PppLqrExtnsEntry ACCESS not-accessible STATUS mandatory DESCRIPTION "Extended LQR information for a particular PPP link. Assuming that this group has been implemented, a PPP link will have an entry in this table if and only if LQR Quality Monitoring has been successfully negotiated for said link." INDEX { ifIndex } ::= { pppLqrExtnsTable 1 } Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 26] Internet Draft PPP/LCP MIB April 1993 PppLqrExtnsEntry ::= SEQUENCE { pppLqrExtnsLastReceivedLqrPacket OCTET STRING(SIZE(68)) } pppLqrExtnsLastReceivedLqrPacket OBJECT-TYPE SYNTAX OCTET STRING(SIZE(68)) ACCESS read-only STATUS mandatory DESCRIPTION "This object contains the most recently received LQR packet. The format of the packet is as described in the LQM Protocol specificiation. All fields of the packet, including the `save' fields, are stored in this object. The LQR packet is stored in network byte order. The LAP-B and PPP headers are not stored in this object; the first four octets of this variable contain the Magic-Number field, the second four octets contain the LastOutLQRs field and so on. The last four octets of this object contain the SaveInOctets field of the LQR packet." REFERENCE "Section 2.6, Packet Format, of RFC1333" ::= { pppLqrExtnsEntry 1 } Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 27] Internet Draft PPP/LCP MIB April 1993 5.4. PPP Tests The extensions to the interface table in RFC1229 define a table through which the network manager can instruct the managed object to perform various tests of the interface. This is the ifExtnsTestTable. The PPP MIB defines two such tests. 5.4.1. PPP Echo Test The PPP Echo Test is defined as pppEchoTest OBJECT IDENTIFIER ::= { pppTests 1 } Invoking this test causes a PPP Echo Packet to be sent on the line. ifExtnsTestResult returns success(2) if the echo response came back properly. It returns failed(7) if the response did not properly return. The definition of "proper" in this context is left to the discretion of the implementor. 5.4.2. PPP Discard Test The PPP Discard Test is defined as pppDiscardTest OBJECT IDENTIFIER ::= { pppTests 2 } Invoking this test causes a PPP Discard Packet to be sent on the line. ifExtnsTestResult returns success(2) if the discard packet was successfully transmitted and failed(7) if an error was detected on transmission. The definition of "transmission error" in this context is left to the discretion of the implementor. END Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 28] Internet Draft PPP/LCP MIB April 1993 6. Acknowledgements This document was produced by the PPP working group. In addition to the working group, the author wishes to thank the following individuals for their comments and contributions: Bill Simpson -- Daydreamer Glenn McGregor -- Merit Jesse Walker -- DEC Chris Gunner -- DEC Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 29] Internet Draft PPP/LCP MIB April 1993 7. Security Considerations The PPP MIB affords the network operator the ability to configure and control the PPP links of a particular system. This represents a security risk. These risks are addressed in the following manners: (1) All variables which represent a significant security risk are placed in separate, optional, MIB Groups. As the MIB Group is the quantum of implementation within a MIB, the implementor of the MIB may elect not to implement these groups. (2) The implementor may choose to implement the variables which present a security risk so that they may not be written, i.e., the variables are READ-ONLY. This method still presents a security risk, and is not recommended, in that the variables, specifically the PPP Authentication Protocols' variables, may be easily read. (3) Using SNMPv2, the operator can place the variables into MIB views which are protected in that the parties which have access to those MIB views use authentication and privacy protocols, or the operator may elect to make these views not accessible to any party. In order to facilitate this placement, all security-related variables are placed in separate MIB Tables. This eases the identification of the necessary MIB View Subtree. Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 30] Internet Draft PPP/LCP MIB April 1993 8. References [1] M.T. Rose and K. McCloghrie, Structure and Identification of Management Information for TCP/IP-based internets, Internet Working Group Request for Comments 1155. Network Information Center, SRI International, Menlo Park, California, (May, 1990). [2] K. McCloghrie and M.T. Rose, Management Information Base for Network Management of TCP/IP-based internets - MIB-2, Internet Working Group Request for Comments 1213. Network Information Center, SRI International, Menlo Park, California, (March, 1991). [3] Information processing systems - Open Systems Interconnection - Specification of Abstract Syntax Notation One (ASN.1), International Organization for Standardization. International Standard 8824, (December, 1987). [4] Information processing systems - Open Systems Interconnection - Specification of Basic Encoding Rules for Abstract Notation One (ASN.1), International Organization for Standardization. International Standard 8825, (December, 1987). [5] Rose, M., and K. McCloghrie, Editors, Concise MIB Definitions, RFC 1212, Performance Systems International, Hughes LAN Systems, March 1991. [6] Rose, M., Editor, A Convention for Defining Traps for use with the SNMP, RFC 1215, Performance Systems International, March 1991. [7] K. McCloghrie, Extensions to the Generic-Interface MIB, RFC1229, Hughes LAN Systems, May 1991. [8] W. Simpson, The Point-to-Point Protocol for the Transmission of Multi-protocol Datagrams over Point-to- Point Links, RFC 1331, May 1992. [9] G. McGregor, The PPP Internet Protocol Control Protocol, RFC 1332, Merit, May 1992. Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 31] Internet Draft PPP/LCP MIB April 1993 [10] F. Baker, Point-to-Point Protocol Extensions for Bridging, RFC1220, ACC, April 1991. [11] B. Lloyd, and Simpson, W., PPP Authentication Protocols RFC1334, October 1992. [12] W. Simpson, PPP Link Quality Monitoring, RFC 1333, May 1992. [13] J. Case, Fedor, M., Schoffstall, M., and Davin, J., A Simple Network Management Protocol, RFC1157, May 1990. Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 32] Internet Draft PPP/LCP MIB April 1993 Table of Contents Status of this Memo .................................... 1 1 Abstract .............................................. 2 2 The Network Management Framework ...................... 3 3 Objects ............................................... 4 3.1 Format of Definitions ............................... 4 4 Overview .............................................. 5 4.1 Object Selection Criteria ........................... 5 4.2 Structure of the PPP ................................ 5 4.3 MIB Groups .......................................... 6 4.4 Relationship to Interface and Interface Extensions Groups ............................................. 8 5 Definitions ........................................... 10 5.1 PPP Link Group ...................................... 11 5.2 PPP LQR Group ....................................... 21 5.3 PPP LQR Extensions Group ............................ 26 5.4 PPP Tests ........................................... 28 5.4.1 PPP Echo Test ..................................... 28 5.4.2 PPP Discard Test .................................. 28 6 Acknowledgements ...................................... 29 7 Security Considerations ............................... 30 8 References ............................................ 31 Frank J. Kastenholz Exp. 24 Oct. 1993 [Page 33]