IPCDN Working Group D. Raftus Internet Draft Terayon Canada Ltd. Document: draft-ietf-ipcdn-docs-rfmibv2-08 October 2003 Expires: April 2004 Obsoletes: RFC2670 Radio Frequency (RF) Interface Management Information Base for DOCSIS 2.0 compliant RF interfaces Status of this Memo 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 (2003). All Rights Reserved. Abstract This memo is a draft revision of the standards track RFC-2670. Please see "Section 9 Changes from RFC2670" for a description of modifications. This document or its successor will obsolete RFC-2670 when accepted. This memo defines a portion of the Management Information Base (MIB) for use with network management protocols in the Internet community. In particular, it defines a basic set of managed objects for SNMP- based management of DOCSIS compliant Radio Frequency (RF) interfaces. This memo is a product of the IPCDN working group within the Internet Engineering Task Force. Comments are solicited and should be addressed to the working group's mailing list at ipcdn@ietf.org and/or the authors. Conventions used in this document Raftus [Page 1] Internet Draft DOCSIS RF Interface MIB October 2003 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 BCP 14, RFC 2119 [RFC2119]. Table of Contents 1 The SNMP Management Framework ................................. 3 2 Glossary ...................................................... 3 2.1 CATV ........................................................ 3 2.2 Channel ..................................................... 3 2.3 CM .......................................................... 4 2.4 CMTS ........................................................ 4 2.5 Codeword .................................................... 4 2.6 Data Packet ................................................. 4 2.7 dBmV ........................................................ 4 2.8 DOCSIS ...................................................... 4 2.9 Downstream .................................................. 4 2.10 Head-end ................................................... 5 2.11 MAC Packet ................................................. 5 2.12 MCNS ....................................................... 5 2.13 Mini-slot .................................................. 5 2.14 QPSK ....................................................... 5 2.15 QAM ........................................................ 5 2.16 RF ......................................................... 5 2.17 Symbol-times ............................................... 5 2.18 Upstream ................................................... 5 3 Overview ...................................................... 5 3.1 Structure of the MIB ........................................ 6 3.1.1 docsIfBaseObjects ......................................... 6 3.1.2 docsIfCmObjects ........................................... 6 3.1.3 docsIfCmtsObjects ......................................... 7 3.2 Relationship to the Interfaces MIB .......................... 7 3.2.1 Layering Model ............................................ 7 3.2.2 Virtual Circuits .......................................... 9 3.2.3 ifTestTable ............................................... 9 3.2.4 ifRcvAddressTable ......................................... 9 3.2.5 ifEntry ................................................... 9 3.2.5.1 ifEntry for Downstream interfaces ....................... 9 3.2.5.1.1 ifEntry for Downstream interfaces in Cable Modem Termination Systems ........................................ 9 3.2.5.1.2 ifEntry for Downstream interfaces in Cable Modems .... 11 3.2.5.2 ifEntry for Upstream interfaces ........................ 13 3.2.5.2.1 ifEntry for Upstream interfaces in Cable Modem Termination Systems ....................................... 13 3.2.5.2.2 ifEntry for Upstream interfaces in Cable Modems ...... 15 3.2.5.3 ifEntry for Upstream channels .......................... 16 3.2.5.3.1 ifEntry for Upstream Channels in Cable Modem Termination Systems ....................................... 17 3.2.5.4 ifEntry for the MAC Layer .............................. 18 4 Definitions .................................................. 20 5 Acknowledgments ............................................. 120 6 Revision History ............................................ 120 7 Normative References ........................................ 120 Raftus Expires April 2004 [Page 2] Internet Draft DOCSIS RF Interface MIB October 2003 8 Informative References ...................................... 124 9 Security Considerations ..................................... 124 10 Changes from RFC2670 ....................................... 124 11 Conflict Resolution with docsIfExt MIB ..................... 126 12 Intellectual Property .......................................126 13 Author's Address ........................................... 127 14 Full Copyright Statement ................................... 127 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]. 2. Glossary The terms in this document are derived either from normal cable system usage, or from the documents associated with the Data Over Cable Service Interface Specification process. 2.1. CATV Originally "Community Antenna Television", now used to refer to any cable or hybrid fiber and cable system used to deliver video signals to a community. 2.2. Channel A specific frequency allocation with an RF medium, specified by channel width in Hertz (cycles per second) and by center frequency. Within the US Cable Systems, upstream channels are generally allocated from the 5-42MHz range while down stream channels are generally allocated from the 50-750MHz range depending on the capabilities of the given system. The typical broadcast channel width in the US is 6MHz. Upstream channel widths for DOCSIS vary. For European cable systems, upstream channels vary by country. The upper edge of upstream channel allocations vary between 25 MHz to 65 MHz, and the lower edge of downstream channel allocations vary between 47 MHz and 87.5 MHz. The typical broadcast channel width in Europe is 8MHz. The actual parameters are of concern to systems Raftus Expires April 2004 [Page 3] Internet Draft DOCSIS RF Interface MIB October 2003 deploying EuroDOCSIS technology. 2.3. CM Cable Modem. A CM acts as a "slave" station in a DOCSIS compliant cable data system. 2.4. CMTS Cable Modem Termination System. A generic term covering a cable bridge or cable router in a head-end. A CMTS acts as the master station in a DOCSIS compliant cable data system. It is the only station that transmits downstream, and it controls the scheduling of upstream transmissions by its associated CMs. 2.5. Codeword A characteristic of the Forward Error Correction scheme used above the RF media layer. See "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730" 2.6. Data Packet The payload portion of the MAC Packet. 2.7. dBmV A measure of RF signal voltage amplitude, whose power level is determined by the characteristic impedance. A zero dB signal power is equivalent to 48.75 dBmV signal amplitude in a 75 Ohm system. 2.8. DOCSIS "Data Over Cable Service Interface Specification". A term referring to the ITU-T J.112 Annex B standard for cable modem systems [7]. 2.8.1. DOCSIS 1.0 Cable modem systems CM/CMTS compliant to requirements in [2] 2.8.2 DOCSIS 1.1 Cable modem systems CM/CMTS compliant to requirements in [3]. The term DOCSIS 1.x is used in this document to refer both DOCSIS 1.0 and DOCSIS 1.1. 2.8.3. DOCSIS 2.0 Cable modem systems CM/CMTS compliant to requirements in [4] 2.9. Downstream The direction from the head-end towards the subscriber. Raftus Expires April 2004 [Page 4] Internet Draft DOCSIS RF Interface MIB October 2003 2.10. Head-end The origination point in most cable systems of the subscriber video signals. 2.11. MAC Packet A DOCSIS PDU. 2.12. MCNS "Multimedia Cable Network System". Generally replaced in usage by DOCSIS. 2.13. Mini-slot In general, an interval of time which is allocated by the CMTS to a given CM for that CM to transmit in an upstream direction. See "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730", 2.14. QPSK Quadrature Phase Shift Keying. A particular modulation scheme on an RF medium. See [6]. 2.15. QAM Quadrature Amplitude Modulation. A particular modulation scheme on RF medium. Usually expressed with a number indicating the size of the modulation constellation (e.g. 16 QAM). See [6], or any other book on digital communications over RF for a complete explanation of this. 2.16. RF Radio Frequency. 2.17. Symbol-times A characteristic of the RF modulation scheme. See "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730" 2.18. Upstream The direction from the subscriber towards the head-end. 3. Overview This MIB provides a set of objects required for the management of MCNS/DOCSIS compliant Cable Modem (CM) and Cable Modem Termination System (CMTS) RF interfaces. The specification is derived in part from the parameters and protocols described in "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730". Raftus Expires April 2004 [Page 5] Internet Draft DOCSIS RF Interface MIB October 2003 3.1. Structure of the MIB This MIB is structured as three groups: o Management information pertinent to both Cable Modems (CM) and Cable Modem Termination Systems (CMTS) (docsIfBaseObjects). o Management information pertinent to Cable Modems only (docsIfCmObjects). o Management information pertinent to Cable Modem Termination Systems only (docsIfCmtsObjects). Tables within each of these groups group objects functionally - e.g. Quality of Service, Channel characteristics, MAC layer management, etc. Rows created automatically (e.g. by the device according to the hardware configuration) may and generally will have a mixture of configuration and status objects within them. Rows that are meant to be created by the management station are generally restricted to configuration (read-create) objects. 3.1.1. docsIfBaseObjects docsIfDownstreamChannelTable - This table describes the active downstream channels for a CMTS and the received downstream channel for a CM. docsIfUpstreamChannelTable - This table describes the active upstream channels for a CMTS and the current upstream transmission channel for a CM. docsIfQosProfileTable - This table describes the valid Quality of Service profiles for the cable data system. docsIfSignalQualityTable - This table is used to monitor RF signal quality characteristics of received signals. docsIfDocsisBaseCapability - This object is used to indicate the highest level of DOCSIS version a cable device can support. 3.1.2. docsIfCmObjects docsIfCmMacTable - This table is used to monitor the DOCSIS MAC interface and can be considered an extension to the ifEntry. docsIfCmStatusTable - This table maintains a number of status objects and counters for cable modems. There is a comparable table at the CMTS, docsIfCmtsCmStatusTable, which maintains similar counters from the CMTS point of view. docsIfCmServiceTable - This table describes the upstream service queues available at this CM. There is a comparable table at the CMTS, docsIfCmtsServiceEntry, which describes the service queues from the point of view of the CMTS. Raftus Expires April 2004 [Page 6] Internet Draft DOCSIS RF Interface MIB October 2003 3.1.3. docsIfCmtsObjects docsIfCmtsMacTable - Describes the attributes of each CMTS MAC interface. docsIfCmtsStatusTable - This table provides a set of aggregated counters which roll-up values and events that occur on the underlying sub-interfaces. docsIfCmtsCmStatusTable - This table is used to hold information about known (i.e. ranging, registered, and/or previously online) cable modems on the system serviced by this CMTS. docsIfCmtsServiceTable - This table provides access to the information related to upstream service queues. docsIfCmtsModulationTable - This table allows control over the modulation profiles for RF channels associated with this CMTS. docsIfCmtsMacToCmTable - This table allows fast access into the docsIfCmtsCmTable via a MAC address (of the CM) interface. docsIfCmtsChannelUtilizationTable - This table provides statistical load usage data for attached upstream and downstream physical channels. docsIfCmtsDownChannelCounterTable - This table provides statistical data for attached downstream channels, appropriate as input for load usage calculations. docsIfCmtsUpChannelCounterTable - This table provides statistical data for attached upstream channels, appropriate as input for load usage calculations. 3.2. Relationship to the Interfaces MIB This section clarifies the relationship of this MIB to the Interfaces MIB [RFC2863]. Several areas of correlation are addressed in the following subsections. The implementer is referred to the Interfaces MIB document in order to understand the general intent of these areas. 3.2.1. Layering Model An instance of ifEntry exists for each RF Downstream interface, for each RF Upstream interface, for each Upstream logical Channel and for each RF MAC layer. The ifStackTable [RFC2863] MUST be implemented to identify relationships among sub-interfaces. The following example illustrates a CMTS MAC interface with one downstream and two upstream interfaces. Raftus Expires April 2004 [Page 7] Internet Draft DOCSIS RF Interface MIB October 2003 | <== to network layer +------------------ --+-------------------------------+ | RF MAC | +--+------------------+------------------------+------+ | | | +-------+-----+ +------+------+ +------+------+ | Downstream1 | | Upstream1 | | Upstream2 | | | | | | | +-------------+ ++-----------++ ++-----------++ | | | | +----+----+ +----+----+ +----+----+ +----+----+ | Ch-1 | | Ch-2 | | Ch-1 | | Ch-2 | |(A/TDMA) | |(S-CDMA) | |(A/TDMA) | |(S-CDMA) | +---------+ +---------+ +---------+ +---------+ As can be seen from this example, the RF MAC interface is layered on top of the downstream and upstream interfaces, and the RF Upstream interface is layered on top of an Upstream Logical Channels. In this example, the assignment of index values could be as follows: ifIndex ifType Description 2 docsCableMaclayer(127) CATV MAC Layer 3 docsCableDownstream(128) CATV Downstream interface 4 docsCableUpstream(129) CATV Upstream interface 5 docsCableUpstream(129) CATV Upstream interface 6 docsCableUpstreamChannel(205) CATV Upstream Channel 7 docsCableUpstreamChannel(205) CATV Upstream Channel 8 docsCableUpstreamChannel(205) CATV Upstream Channel 9 docsCableUpstreamChannel(205) CATV Upstream Channel The corresponding ifStack entries would then be: | IfStackHigherLayer | ifStackLowerLayer | | 0 | 2 | | 2 | 3 | | 2 | 4 | | 2 | 5 | | 4 | 6 | | 4 | 7 | | 5 | 8 | | 5 | 9 | | 3 | 0 | | 6 | 0 | | 7 | 0 | | 8 | 0 | | 9 | 0 | The same interface model can also be used in Telephony or Telco Return systems. A pure Telco Return system (Cable Modem as well as Cable Modem Termination System) would not have upstream, but only downstream cable channels. Systems supporting both Telco Return and Raftus Expires April 2004 [Page 8] Internet Draft DOCSIS RF Interface MIB October 2003 cable upstream channels can use the above model without modification. Telco Return Upstream channel(s) are handled by the appropriate MIBs, such as PPP or Modem MIBs. 3.2.2. Virtual Circuits This medium does not support virtual circuits and this area is not applicable to this MIB. 3.2.3. ifTestTable The ifTestTable is optional for Docsis CM/CMTS implementations, but is not specifically influenced by the RF mib. 3.2.4. ifRcvAddressTable The ifRcvAddressTable is optional for Docsis CM/CMTS implementations, but is not specifically influenced by the RF mib. 3.2.5. ifEntry This section documents only the differences from the requirements specified in the Interfaces MIB. See that MIB for columns omitted from the descriptions below. 3.2.5.1. ifEntry for Downstream interfaces The ifEntry for Downstream interfaces supports the ifGeneralInformationGroup and the ifPacketGroup of the Interfaces MIB. This is an output only interface at the CMTS and all input status counters - ifIn* - will return zero. This is an input only interface at the CM and all output status counters - ifOut* - will return zero. 3.2.5.1.1. ifEntry for Downstream interfaces in Cable Modem Termination Systems ifTable Comments ============== =========================================== ifIndex Each RF Cable Downstream interface is represented by an ifEntry. ifType The IANA value of docsCableDownstream(128). ifSpeed Return the speed of this downstream channel. The returned value is the raw bandwidth in bits/s of this interface. This is the symbol rate multiplied with the number of bits per symbol. ifHighSpeed Return the speed of this downstream channel. The returned value is the raw bandwidth in megabits/s of this interface. This is the symbol rate multiplied with the number of bits per Raftus Expires April 2004 [Page 9] Internet Draft DOCSIS RF Interface MIB October 2003 symbol. ifPhysAddress Return an empty string. ifAdminStatus The administrative status of this interface. ifOperStatus The current operational status of this interface. ifMtu The size of the largest frame which can be sent on this interface, specified in octets. The value includes the length of the MAC header. ifInOctets Return zero. ifHCInOctets ifInUcastPkts Return zero. ifHCInUcastPkts ifInMulticastPkts Return zero. ifHCInMulticastPkts ifInBroadcastPkts Return zero. ifHCInBroadcastPkts ifInDiscards Return zero. ifInErrors Return zero. ifInUnknownProtos Return zero. ifOutOctets The total number of octets transmitted on this ifHCOutOctets interface. This includes MAC packets as well as data packets, and includes the length of the MAC header. ifOutUcastPkts The number of Unicast packets transmitted on this ifHCOutUcastPkts interface. This includes MAC packets as well as data packets. ifOutMulticastPkts ifHCOutMulticastPkts Return the number of Multicast packets transmitted on this interface. This includes MAC packets as well as data packets. ifOutBroadcastPkts ifHCOutBroadcastPkts Return the number of broadcast packets transmitted on this interface. This includes MAC packets as well as data packets. ifOutDiscards The total number of outbound packets which were discarded. Possible reasons are: buffer shortage. Raftus Expires April 2004 [Page 10] Internet Draft DOCSIS RF Interface MIB October 2003 ifOutErrors The number of packets which could not be transmitted due to errors. ifPromiscuousMode Return false. 3.2.5.1.2. ifEntry for Downstream interfaces in Cable Modems ifTable Comments ============== =========================================== ifIndex Each RF Cable Downstream interface is represented by an ifEntry. ifType The IANA value of docsCableDownstream(128). ifSpeed Return the speed of this downstream channel. The returned value the raw bandwidth in bits/s of this interface. This is the symbol rate multiplied with the number of bits per symbol. ifHighSpeed Return the speed of this downstream channel. The returned value the raw bandwidth in megabits/s of this interface. This is the symbol rate multiplied with the number of bits per symbol. ifPhysAddress Return an empty string. ifAdminStatus The administrative status of this interface. ifOperStatus The current operational status of this interface. ifMtu The size of the largest frame which can be received from this interface, specified in octets. The value includes the length of the MAC header. ifInOctets The total number of octets received on this ifHCInOctets interface. This includes data packets as well as MAC packets, and includes the length of the MAC header. ifInUcastPkts The number of Unicast packets received on this ifHCInUcastPkts interface. This includes data packets as well as MAC packets. ifInMulticastPkts ifHCInMulticastPkts Return the number of Multicast packets received on this interface. This includes data packets as well as MAC packets. ifInBroadcastPkts ifHCInBroadcastPkts Return the number of Broadcast packets received on this interface. This includes data packets as well as MAC packets. Raftus Expires April 2004 [Page 11] Internet Draft DOCSIS RF Interface MIB October 2003 ifInDiscards The total number of received packets that have been discarded. The possible reasons are: buffer shortage. ifInErrors The number of inbound packets that contained errors preventing them from being deliverable to higher layers. Possible reasons are: MAC FCS error. ifInUnknownProtos The number of frames with an unknown packet type. These are MAC frames with an unknown packet type. ifOutOctets Return zero. ifHCOutOctets ifOutUcastPkts Return zero. ifHCOutUcastPkts ifOutMulticastPkts ifHCOutMulticastPkts Return zero. ifOutBroadcastPkts ifHCOutBroadcastPkts Return zero. ifOutDiscards Return zero. ifOutErrors Return zero. ifPromiscuousMode Refer to the Interfaces MIB. 3.2.5.2. ifEntry for Upstream interfaces Each supported interface of the type docsCableUpstream(129) must have a corresponding ifEntry. The ifEntry for Upstream interfaces supports the ifGeneralInformationGroup and the ifPacketGroup of the Interfaces MIB. This is an input only interface at the CMTS and all output status counters - ifOut* - will return zero. This is an output only interface at the CM and all input status counters - ifIn* - will return zero. 3.2.5.2.1. ifEntry for Upstream interfaces in Cable Modem Termination Systems ifTable Comments ============== =========================================== ifIndex Each RF Cable Upstream interface is represented by an ifEntry. ifType The IANA value of docsCableUpstream (129). ifSpeed Return the maximum channel throughput (not payload throughput) supported by the interface. Raftus Expires April 2004 [Page 12] Internet Draft DOCSIS RF Interface MIB October 2003 The maximum throughput is calculated for the case where upstream channels are configured to maximize interface throughput. ifHighSpeed Return the maximum channel throughput (not payload throughput) supported by the interface. The maximum throughput is calculated for the case where upstream channels are configured to maximize interface throughput. Units for this object are (1/1 000 000) * IfSpeed. ifPhysAddress Return an empty string. ifAdminStatus The administrative status of this interface. This reflect the total status of all the channels under this interface. So if at least one channel has a physical connection this interface has connection. Any SNMP SET on this interface will cause a SET to all the channels under this interface. ifOperStatus The current operational status of this interface. This reflects the total status of all the channels under this interface. So if at least one channel has a physical connection this interface has connection. ifMtu The size of the largest frame which can be transmitted on this interface, specified in octets. The value includes the length of the MAC header. This is the maximum of all the ifMtu of all the channels under this interface. ifInOctets ifHCInOctets The total (sum) number of octets received on all the Upstream channels under this interface. This includes data packets as well as MAC packets, and includes the length of the MAC header. ifInUcastPkts ifHCInUcastPkts The total number of Unicast packets received on all the upstream channels under this interface. This includes data packets as well as MAC packets. ifInMulticastPkts ifHCInMulticastPkts Return the total number of Multicast packets received on all the Upstream channels under this interface. This includes data packets as well as MAC layer packets. Raftus Expires April 2004 [Page 13] Internet Draft DOCSIS RF Interface MIB October 2003 ifInBroadcastPkts ifHCInBroadcastPkts Return the total number of Broadcast packets received on all the Upstream channels under this interface. This includes data packets as well as MAC packets. ifInDiscards The total number of received packets, which have been discarded on all the Upstream channels under this interface. The possible reasons are: buffer shortage. ifInErrors The total number of inbound packets that contained errors preventing them from being deliverable to higher layers. Possible reasons are: MAC FCS error. ifInUnknownProtos The total number of frames with an unknown packet type. These are MAC frames with an unknown packet type. ifOutOctets Return zero. ifHCOutOctets ifOutUcastPkts Return zero. ifHCOutOctets ifOutMulticastPkts ifHCOutMulticastPkts Return zero. ifOutBroadcastPkts ifHCOutBroadcastPkts Return zero. ifOutDiscards Return zero. ifOutErrors Return zero. 3.2.5.2.2. ifEntry for Upstream interfaces in Cable Modems ifTable Comments ============== =========================================== ifIndex Each RF Cable Upstream interface is represented by an ifEntry. ifType The IANA value of docsCableUpstream (129). ifSpeed Return the speed of this upstream interface. The returned value is the raw bandwidth in bits/s of this interface. ifHighSpeed Return the speed of this upstream interface. The returned value is the raw bandwidth in megabits/s of this interface. Raftus Expires April 2004 [Page 14] Internet Draft DOCSIS RF Interface MIB October 2003 ifPhysAddress Return an empty string. ifAdminStatus The administrative status of this interface. ifOperStatus The current operational status of this interface. ifMtu The size of the largest frame which can be transmitted on this interface, specified in octets. The value includes the length of the MAC header. ifInOctets Return zero. ifHCInOctets ifInUcastPkts Return zero. ifHCInUcastPkts ifInMulticastPkts Return zero. ifHCInMulticastPkts ifInBroadcastPkts Return zero. ifHCInBroadcastPkts ifInDiscards Return zero. ifInErrors Return zero. ifInUnknownProtos Return zero. ifOutOctets The total number of octets transmitted on this ifHCOutOctets interface. This includes MAC packets as well as data packets, and includes the length of the MAC header. ifOutUcastPkts The number of Unicast packets transmitted on this ifHCOutUcastPkts interface. This includes MAC packets as well as data packets. ifOutMulticastPkts ifHCOutMulticastPkts Return the number of Multicast packets transmitted on this interface. This includes MAC packets as well as data packets. ifOutBroadcastPkts ifHCOutBroadcastPkts Return the number of broadcast packets transmitted on this interface. This includes MAC packets as well as data packets. ifOutDiscards The total number of outbound packets which were discarded. Possible reasons are: buffer shortage. Raftus Expires April 2004 [Page 15] Internet Draft DOCSIS RF Interface MIB October 2003 ifOutErrors The number of packets which could not be transmitted due to errors. ifPromiscuousMode Return false. 3.2.5.3. ifEntry for Upstream channels Each supported channel of the type docsCableUpstreamChannel(205) must have a corresponding ifEntry. The ifEntry for Upstream channels supports the ifGeneralInformationGroup and the ifPacketGroup of the Interfaces MIB. This is an input only interface at the CMTS and all output status counters - ifOut* - will return zero. At the time of this mib creation, DOCSIS CMs are not required to support logical upstream channels. 3.2.5.3.1. ifEntry for Upstream Channels in Cable Modem Termination Systems ifTable Comments ============== =========================================== ifIndex Each RF Cable Upstream channel is represented by an ifEntry. ifType The IANA value of docsCableUpstreamChannel (205). ifSpeed Return the speed of this upstream channel. The returned value is the raw bandwidth in bits/s of this channel. ifHighSpeed Return the speed of this upstream channel. The returned value is the raw bandwidth in megabits/s of this channel. ifPhysAddress Return an empty string. ifAdminStatus The administrative status of this interface. ifOperStatus The current operational status of this interface. ifMtu The size of the largest frame which can be received on this interface, specified in octets. The value includes the length of the MAC header. ifInOctets The total number of octets received on this interface. This includes data packets as well as MAC packets, and includes the length of the MAC header. ifInUcastPkts The number of Unicast packets received on this ifHCInUcastPkts interface. This includes data packets as well as MAC packets. Raftus Expires April 2004 [Page 16] Internet Draft DOCSIS RF Interface MIB October 2003 ifInMulticastPkts ifHCInMulticastPkts Return the number of Multicast packets received on this interface. This includes data packets as well as MAC layer packets. ifInBroadcastPkts ifHCInBroadcastPkts Return the number of Broadcast packets received on this interface. This includes data packets as well as MAC packets. ifInDiscards The total number of received packets that have been discarded. The possible reasons are: buffer shortage. ifInErrors The number of inbound packets that contained errors preventing them from being deliverable to higher layers. Possible reasons are: MAC FCS error. ifInUnknownProtos The number of frames with an unknown packet type. These are MAC frames with an unknown packet type. ifOutOctets Return zero. ifHCOutOctets ifOutUcastPkts Return zero. ifHCOutUcastPkts ifOutMulticastPkts ifHCOutMulticastPkts Return zero. ifOutBroadcastPkts ifHCOutBroadcastPkts Return zero. ifOutDiscards Return zero. ifOutErrors Return zero. 3.2.5.4. ifEntry for the MAC Layer The ifEntry for the MAC Layer supports the ifGeneralInformationGroup and the ifPacketGroup of the Interfaces MIB. This interface provides an aggregate view of status for the lower level Downstream and Upstream interfaces. ifTable Comments ============== =========================================== ifIndex Each RF Cable MAC layer entity is represented by an ifEntry. Raftus Expires April 2004 [Page 17] Internet Draft DOCSIS RF Interface MIB October 2003 ifType The IANA value of docsCableMaclayer(127). ifSpeed Return zero. ifPhysAddress Return the physical address of this interface. ifAdminStatus The administrative status of this interface. ifOperStatus The current operational status of the MAC layer interface. ifHighSpeed Return zero. ifMtu Return 1500. ifInOctets The total number of data octets received on this ifHCInOctets interface, targeted for upper protocol layers. ifInUcastPkts The number of Unicast packets received on this ifHCInUcastPkts interface, targeted for upper protocol layers. ifInMulticastPkts ifHCInMulticastPkts Return the number of Multicast packets received on this interface, targeted for upper protocol layers. ifInBroadcastPkts ifHCInBroadcastPkts Return the number of Broadcast packets received on this interface, targeted for upper protocol layers. ifInDiscards The total number of received packets that have been discarded. The possible reasons are: buffer shortage. ifInErrors The number of inbound packets that contained errors preventing them from being deliverable to higher layers. Possible reasons are: data packet FCS error, invalid MAC header. ifInUnknownProtos The number of frames with an unknown packet type. This is the number of data packets targeted for upper protocol layers with an unknown packet type. ifOutOctets The total number of octets, received from upper ifHCOutOctets protocol layers and transmitted on this interface. ifOutUcastPkts The number of Unicast packets, received from upper ifHCOutUcastPkts protocol layers and transmitted on this interface. ifOutMulticastPkts ifHCOutMulticastPkts Raftus Expires April 2004 [Page 18] Internet Draft DOCSIS RF Interface MIB October 2003 Return the number of Multicast packets received from upper protocol layers and transmitted on this interface. ifOutBroadcastPkts ifHCOutBroadcastPkts Return the number of broadcast packets received from upper protocol layers and transmitted on this interface. ifOutDiscards The total number of outbound packets which were discarded. Possible reasons are: buffer shortage. ifOutErrors The number of packets which could not be transmitted due to errors. ifPromiscuousMode Refer to the Interfaces MIB. 4. Definitions DOCS-IF-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, -- do not import BITS, Unsigned32, Integer32, Counter32, Counter64, TimeTicks, IpAddress, transmission FROM SNMPv2-SMI TEXTUAL-CONVENTION, MacAddress, RowStatus, TruthValue, TimeInterval, TimeStamp FROM SNMPv2-TC OBJECT-GROUP, MODULE-COMPLIANCE FROM SNMPv2-CONF ifIndex, InterfaceIndexOrZero FROM IF-MIB InetAddressType, InetAddress FROM INET-ADDRESS-MIB IANAifType Raftus Expires April 2004 [Page 19] Internet Draft DOCSIS RF Interface MIB October 2003 FROM IANAifType-MIB; docsIfMib MODULE-IDENTITY LAST-UPDATED "200310240000Z" -- October 24, 2003 ORGANIZATION "IETF IPCDN Working Group" CONTACT-INFO " David Raftus Postal: Terayon Communications 340 Terry Fox Drive, Suite 202 Ottawa Ontario Canada Phone: +1 613 592 1052 ext.222 E-mail: david.raftus@terayon.com IETF IPCDN Working Group General Discussion: ipcdn@ietf.org Subscribe: http://www.ietf.org/mailman/listinfo/ipcdn Archive: ftp://ftp.ietf.org/ietf-mail-archive/ipcdn Co-chairs: Richard Woundy, Richard_Woundy@cable.comcast.com Jean-Francois Mule, jf.mule@cablelabs.com" DESCRIPTION "This is the MIB Module for DOCSIS 2.0 compliant Radio Frequency (RF) interfaces in Cable Modems (CM) and Cable Modem Termination Systems (CMTS)." REVISION "200310220000Z" DESCRIPTION "pre-RFC draft v8: Modified by editor to update Normative References including associated with IMPORTS statement in the MIB MODULE. Modified by editor to add DEFVAL clause to object docsIfUpChannelPreEqEnable to propely initialize temporary created rows. Modified by editor to define docsIfCmtsOptionalv2 GROUP which includes CMTS optional objects from table docsIfCmtsDownChannelCounterTable. The DESCRIPTION clauses of those objects were modified to remove optional requirements of objects support. Added a section to explain the interaction between DOCSIS 1.0, 1.1 and 2.0. Modified by editor to change MAX-CLAUSE of object docsIfUpChannelType to read-only, also removed same object object Clause in docsIfBasicComplianceV2 Section 11 Conflict Resolution with docsIfExt MIB was removed New section 11 Management Interoperability of DOCSIS 1.0, 1.1 and 2.0 added as well as glossary terms DOCSIS 1.0/1.1/2.0. to handle more intuitively 'DOCSIS 1.x' extensive term usage." REVISION "200309100000Z" DESCRIPTION "pre-RFC draft v7: Modified by David Raftus to return name to pre v6 title DOCS-IF-MIB, to clarify descriptive wording of various objects, tables and methodologies, to add new objects to count UCC transactions, to add enumeration values to Raftus Expires April 2004 [Page 20] Internet Draft DOCSIS RF Interface MIB October 2003 docsIfCmtsModPreambleType and docsIfCmtsCmStatusValue, to to add new object to indicate the last update time of docsIfCmtsCmStatusValueLastUpdate, to update references to the latest Docsis versions. pre-RFC draft v6: Modified by David Raftus to update references, boilerplate to format suggested by IPCDN workgroup. Also clarified descriptions of some objects, added size constraints to selected objects to fix compiler warnings. pre-RFC draft v5: Modified by David Raftus to add channel utilization related objects, upstream channel equalization related objects, a cmts upstream minislot counter table, a cmts downstream byte counter table, 64 bit versions of existing 32 bit docsIfSigQTable objects, and perform some editorial adjustments. pre-RFC draft v4: Modified by David Raftus to fix docsIfUpChannelWidth range in compliance statements to accommodate 6.4Mhz channel at 5.12 Msymbol/sec. Also adjusted description of docsIfUpChannelStatus to use correct rowStatus terminology. pre-RFC draft v3: Modified by David Raftus to add new textual convention describing upstream modulation status. Also clarified some object descriptions, fixed error in docsIfSignalQualityEntry, fixed upstreamTable compliance statements. pre-RFC draft v2: Modified by David Raftus to add capability to adjust and verify upstream channel parameters as a group. Also adjusted syntax and clarified descriptions of selected objects. pre-RFC draft v1: Modified by Aviv Goren and David Raftus to accommodate Docsis 2.0 Advanced Phy capabilities, as well as to incorporate objects from the docsIfExt mib. Modified by Rich Woundy to use IPv6-friendly address objects, to accommodate EuroDOCSIS, and to correct the SYNTAX of various objects." REVISION "199908190000Z" DESCRIPTION "Initial Version, published as RFC 2670. Modified by Mike StJohns to fix problems identified by the first pass of the MIB doctor. Of special note, docsIfRangingResp and docsIfCmtsInsertionInterval were obsoleted and replaced by other objects with the same functionality, but more appropriate SYNTAX." ::= { transmission 127 } -- Textual Conventions TenthdBmV ::= TEXTUAL-CONVENTION Raftus Expires April 2004 [Page 21] Internet Draft DOCSIS RF Interface MIB October 2003 DISPLAY-HINT "d-1" STATUS current DESCRIPTION "This data type represents power levels that are normally expressed in dBmV. Units are in tenths of a dBmV; for example, 5.1 dBmV will be represented as 51." SYNTAX Integer32 TenthdB ::= TEXTUAL-CONVENTION DISPLAY-HINT "d-1" STATUS current DESCRIPTION "This data type represents power levels that are normally expressed in dB. Units are in tenths of a dB; for example, 5.1 dB will be represented as 51." SYNTAX Integer32 DocsisVersion ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "Indicates the DOCSIS version number." SYNTAX INTEGER { docsis10 (1), docsis11 (2), docsis20 (3) } DocsisQosVersion ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "Indicates the quality of service level." SYNTAX INTEGER { docsis10 (1), docsis11 (2) } DocsisUpstreamType ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "Indicates the DOCSIS Upstream Channel Type." SYNTAX INTEGER { unknown (0), tdma (1), atdma (2), scdma (3), tdmaAndAtdma (4) } DocsisUpstreamTypeStatus ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "Indicates the DOCSIS Upstream Channel Type Status. The shared channel indicator type is not valid, since this type is used to specifically identify PHY mode." SYNTAX INTEGER { unknown (0), tdma (1), atdma (2), Raftus Expires April 2004 [Page 22] Internet Draft DOCSIS RF Interface MIB October 2003 scdma (3) } docsIfMibObjects OBJECT IDENTIFIER ::= { docsIfMib 1 } docsIfBaseObjects OBJECT IDENTIFIER ::= { docsIfMibObjects 1 } docsIfCmObjects OBJECT IDENTIFIER ::= { docsIfMibObjects 2 } docsIfCmtsObjects OBJECT IDENTIFIER ::= { docsIfMibObjects 3 } -- -- BASE GROUP -- -- -- The following table is implemented on both the Cable Modem (CM) -- and the Cable Modem Termination System (CMTS). This table is -- read only for the CM. -- docsIfDownstreamChannelTable OBJECT-TYPE SYNTAX SEQUENCE OF DocsIfDownstreamChannelEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table describes the attributes of downstream channels (frequency bands)." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Table 6-12 and Table 6-13." ::= { docsIfBaseObjects 1 } docsIfDownstreamChannelEntry OBJECT-TYPE SYNTAX DocsIfDownstreamChannelEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "An entry provides a list of attributes for a single Downstream channel. An entry in this table exists for each ifEntry with an ifType of docsCableDownstream(128)." INDEX { ifIndex } ::= { docsIfDownstreamChannelTable 1 } DocsIfDownstreamChannelEntry ::= SEQUENCE { docsIfDownChannelId Integer32, docsIfDownChannelFrequency Integer32, docsIfDownChannelWidth Integer32, docsIfDownChannelModulation INTEGER, docsIfDownChannelInterleave INTEGER, docsIfDownChannelPower TenthdBmV, docsIfDownChannelAnnex INTEGER } Raftus Expires April 2004 [Page 23] Internet Draft DOCSIS RF Interface MIB October 2003 docsIfDownChannelId OBJECT-TYPE SYNTAX Integer32 (0..255) MAX-ACCESS read-only STATUS current DESCRIPTION "The Cable Modem Termination System (CMTS) identification of the downstream channel within this particular MAC interface. If the interface is down, the object returns the most current value. If the downstream channel ID is unknown, this object returns a value of 0." ::= { docsIfDownstreamChannelEntry 1 } docsIfDownChannelFrequency OBJECT-TYPE SYNTAX Integer32 (0..1000000000) UNITS "hertz" MAX-ACCESS read-write STATUS current DESCRIPTION "The center of the downstream frequency associated with this channel. This object will return the current tuner frequency. If a CMTS provides IF output, this object will return 0, unless this CMTS is in control of the final downstream RF frequency. See the associated compliance object for a description of valid frequencies that may be written to this object." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Tables 4-1, 6-14." ::= { docsIfDownstreamChannelEntry 2 } docsIfDownChannelWidth OBJECT-TYPE SYNTAX Integer32 (0..16000000) UNITS "hertz" MAX-ACCESS read-write STATUS current DESCRIPTION "The bandwidth of this downstream channel. Most implementations are expected to support a channel width of 6 MHz (North America) and/or 8 MHz (Europe). See the associated compliance object for a description of the valid channel widths for this object." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Table 6-14." ::= { docsIfDownstreamChannelEntry 3 } docsIfDownChannelModulation OBJECT-TYPE SYNTAX INTEGER { unknown(1), other(2), qam64(3), qam256(4) } Raftus Expires April 2004 [Page 24] Internet Draft DOCSIS RF Interface MIB October 2003 MAX-ACCESS read-write STATUS current DESCRIPTION "The modulation type associated with this downstream channel. If the interface is down, this object either returns the configured value (CMTS), the most current value (CM), or the value of unknown(1). See the associated conformance object for write conditions and limitations. See the reference for specifics on the modulation profiles implied by qam64 and qam256." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Table 6-14." ::= { docsIfDownstreamChannelEntry 4 } docsIfDownChannelInterleave OBJECT-TYPE SYNTAX INTEGER { unknown(1), other(2), taps8Increment16(3), taps16Increment8(4), taps32Increment4(5), taps64Increment2(6), taps128Increment1(7), taps12increment17(8) } MAX-ACCESS read-write STATUS current DESCRIPTION "The Forward Error Correction (FEC) interleaving used for this downstream channel. Values are defined as follows: taps8Increment16(3): protection 5.9/4.1 usec, latency .22/.15 msec taps16Increment8(4): protection 12/8.2 usec, latency .48/.33 msec taps32Increment4(5): protection 24/16 usec, latency .98/.68 msec taps64Increment2(6): protection 47/33 usec, latency 2/1.4 msec taps128Increment1(7): protection 95/66 usec, latency 4/2.8 msec taps12increment17(8): protection 18/14 usec, latency 0.43/0.32 msec taps12increment17 is implemented in conformance with EuroDOCSIS document 'Adapted MIB-definitions - and a clarification for MPEG-related issues - for EuroDOCSIS cable modem systems' by tComLabs and should only be used for a EuroDOCSIS MAC interface. If the interface is down, this object either returns Raftus Expires April 2004 [Page 25] Internet Draft DOCSIS RF Interface MIB October 2003 the configured value (CMTS), the most current value (CM), or the value of unknown(1). The value of other(2) is returned if the interleave is known but not defined in the above list. See the associated conformance object for write conditions and limitations. See the reference for the FEC configuration described by the setting of this object." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Table 6-13." ::= { docsIfDownstreamChannelEntry 5 } docsIfDownChannelPower OBJECT-TYPE SYNTAX TenthdBmV UNITS "dBmV" MAX-ACCESS read-write STATUS current DESCRIPTION "At the CMTS, the operational transmit power. At the CM, the received power level. If the interface is down, this object either returns the configured value (CMTS), the most current value (CM) or the value of 0. See the associated conformance object for write conditions and limitations. See the reference for recommended and required power levels." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Table 6-15." ::= { docsIfDownstreamChannelEntry 6 } docsIfDownChannelAnnex OBJECT-TYPE SYNTAX INTEGER { unknown(1), other(2), annexA(3), annexB(4), annexC(5) } MAX-ACCESS read-only STATUS current DESCRIPTION "The value of this object indicates the conformance of the implementation to important regional cable standards. annexA : Annex A from ITU-J83 is used. annexB : Annex B from ITU-J83 is used. annexC : Annex C from ITU-J83 is used. AnnexB is used for DOCSIS implementations" REFERENCE "Document Adapted MIB-definitions and a clarification for MPEG-related issues for EuroDOCSIS cable modem systems v1.01, tComLabs, May 2000, Section 2.2" ::= { docsIfDownstreamChannelEntry 7 } Raftus Expires April 2004 [Page 26] Internet Draft DOCSIS RF Interface MIB October 2003 -- -- The following table is implemented on both the CM and the CMTS. -- For the CM, only attached channels appear in the table. For the -- CM, this table is read only as well. -- docsIfUpstreamChannelTable OBJECT-TYPE SYNTAX SEQUENCE OF DocsIfUpstreamChannelEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table describes the attributes of attached upstream channels." ::= { docsIfBaseObjects 2 } docsIfUpstreamChannelEntry OBJECT-TYPE SYNTAX DocsIfUpstreamChannelEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "List of attributes for a single upstream channel. For Docsis 2.0 CMTSs, an entry in this table exists for each ifEntry with an ifType of docsCableUpstreamChannel (205). For Docsis 1.x CM/CMTSs and Docsis 2.0 CMs, an entry in this table exists for each ifEntry with an ifType of docsCableUpstreamInterface (129)." INDEX { ifIndex } ::= { docsIfUpstreamChannelTable 1 } DocsIfUpstreamChannelEntry ::= SEQUENCE { docsIfUpChannelId Integer32, docsIfUpChannelFrequency Integer32, docsIfUpChannelWidth Integer32, docsIfUpChannelModulationProfile Unsigned32, docsIfUpChannelSlotSize Unsigned32, docsIfUpChannelTxTimingOffset Unsigned32, docsIfUpChannelRangingBackoffStart Integer32, docsIfUpChannelRangingBackoffEnd Integer32, docsIfUpChannelTxBackoffStart Integer32, docsIfUpChannelTxBackoffEnd Integer32, docsIfUpChannelScdmaActiveCodes Unsigned32, docsIfUpChannelScdmaCodesPerSlot Integer32, docsIfUpChannelScdmaFrameSize Unsigned32, docsIfUpChannelScdmaHoppingSeed Unsigned32, docsIfUpChannelType DocsisUpstreamType, docsIfUpChannelCloneFrom InterfaceIndexOrZero, docsIfUpChannelUpdate TruthValue, docsIfUpChannelStatus RowStatus, docsIfUpChannelPreEqEnable TruthValue } docsIfUpChannelId OBJECT-TYPE SYNTAX Integer32 (0..255) MAX-ACCESS read-only Raftus Expires April 2004 [Page 27] Internet Draft DOCSIS RF Interface MIB October 2003 STATUS current DESCRIPTION "The CMTS identification of the upstream channel." ::= { docsIfUpstreamChannelEntry 1 } docsIfUpChannelFrequency OBJECT-TYPE SYNTAX Integer32 (0..1000000000) UNITS "hertz" MAX-ACCESS read-create STATUS current DESCRIPTION "The center of the frequency band associated with this upstream interface. This object returns 0 if the frequency is undefined or unknown. Minimum permitted upstream frequency is 5,000,000 Hz for current technology. See the associated conformance object for write conditions and limitations." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Table 4-2." ::= { docsIfUpstreamChannelEntry 2 } docsIfUpChannelWidth OBJECT-TYPE SYNTAX Integer32 (0..64000000) UNITS "hertz" MAX-ACCESS read-create STATUS current DESCRIPTION "The bandwidth of this upstream interface. This object returns 0 if the interface width is undefined or unknown. Minimum permitted interface width is 200,000 Hz currently. See the associated conformance object for write conditions and limitations." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Table 6-12." ::= { docsIfUpstreamChannelEntry 3 } docsIfUpChannelModulationProfile OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-create STATUS current DESCRIPTION "An entry identical to the docsIfModIndex in the docsIfCmtsModulationTable that describes this channel. This channel is further instantiated there by a grouping of interval usage codes (IUCs)which together fully describe the channel modulation. This object returns 0 if the docsIfCmtsModulationTable entry does not exist or is empty. See the associated conformance object for write conditions and limitations. Raftus Expires April 2004 [Page 28] Internet Draft DOCSIS RF Interface MIB October 2003 Setting this object returns a genErr error if the following conditions are not satisfied: 1. All the IUC entries in the selected modulation profile MUST have the same value of docsIfCmtsModChannelType. 2. All of the Modulation parameters in the selected modulation profile MUST be consistent with the other parameters in this docsIfUpstreamChannelEntry." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Table 8-19." ::= { docsIfUpstreamChannelEntry 4 } docsIfUpChannelSlotSize OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-create STATUS current DESCRIPTION "Applicable to TDMA and ATDMA channel types only. The number of 6.25 microsecond ticks in each upstream mini-slot. Returns zero if the value is undefined, unknown or in case of an SCDMA channel. See the associated conformance object for write conditions and limitations. " REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 8.1.2.4." ::= { docsIfUpstreamChannelEntry 5 } docsIfUpChannelTxTimingOffset OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-only STATUS current DESCRIPTION "At the CM, a measure of the current round trip time obtained from the ranging offset (initial ranging offset + ranging offset adjustments). At the CMTS, the maximum of timing offset, among all the CMs that are/were present on the channel, taking into account all ( initial + periodic ) timing offset corrections that were sent for each of the CMs. Generally, these measurements are positive, but if the measurements are negative, the value of this object is zero. Used for timing of CM upstream transmissions to ensure synchronized arrivals at the CMTS. Units are in terms of (6.25 microseconds/64)." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 6.2.18." ::= { docsIfUpstreamChannelEntry 6 } docsIfUpChannelRangingBackoffStart OBJECT-TYPE Raftus Expires April 2004 [Page 29] Internet Draft DOCSIS RF Interface MIB October 2003 SYNTAX Integer32 (0..16) MAX-ACCESS read-create STATUS current DESCRIPTION "The initial random backoff window to use when retrying Ranging Requests. Expressed as a power of 2. A value of 16 at the CMTS indicates that a proprietary adaptive retry mechanism is to be used. See the associated conformance object for write conditions and limitations." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 8.3.4." ::= { docsIfUpstreamChannelEntry 7 } docsIfUpChannelRangingBackoffEnd OBJECT-TYPE SYNTAX Integer32 (0..16) MAX-ACCESS read-create STATUS current DESCRIPTION "The final random backoff window to use when retrying Ranging Requests. Expressed as a power of 2. A value of 16 at the CMTS indicates that a proprietary adaptive retry mechanism is to be used. See the associated conformance object for write conditions and limitations." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 8.3.4." ::= { docsIfUpstreamChannelEntry 8 } docsIfUpChannelTxBackoffStart OBJECT-TYPE SYNTAX Integer32 (0..16) MAX-ACCESS read-create STATUS current DESCRIPTION "The initial random backoff window to use when retrying transmissions. Expressed as a power of 2. A value of 16 at the CMTS indicates that a proprietary adaptive retry mechanism is to be used. See the associated conformance object for write conditions and limitations." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 8.3.4." ::= { docsIfUpstreamChannelEntry 9 } docsIfUpChannelTxBackoffEnd OBJECT-TYPE SYNTAX Integer32 (0..16) MAX-ACCESS read-create STATUS current DESCRIPTION "The final random backoff window to use when retrying transmissions. Expressed as a power of 2. A value of 16 at the CMTS indicates that a proprietary adaptive retry Raftus Expires April 2004 [Page 30] Internet Draft DOCSIS RF Interface MIB October 2003 mechanism is to be used. See the associated conformance object for write conditions and limitations." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 8.3.4." ::= { docsIfUpstreamChannelEntry 10 } docsIfUpChannelScdmaActiveCodes OBJECT-TYPE SYNTAX Unsigned32 (0 | 64..128) MAX-ACCESS read-create STATUS current DESCRIPTION "Applicable for SCDMA channel types only. Number of active codes. Returns zero for Non-SCDMA channel types. Note that legal values from 64..128 MUST be non-prime." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 6.2.11.2.1." ::= { docsIfUpstreamChannelEntry 11 } docsIfUpChannelScdmaCodesPerSlot OBJECT-TYPE SYNTAX Integer32(0 | 2..32) MAX-ACCESS read-create STATUS current DESCRIPTION "Applicable for SCDMA channel types only. The number of SCDMA codes per mini-slot. Returns zero if the value is undefined, unknown or in case of a TDMA or ATDMA channel." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 6.2.11.2.1." ::= { docsIfUpstreamChannelEntry 12 } docsIfUpChannelScdmaFrameSize OBJECT-TYPE SYNTAX Unsigned32 (0..32) MAX-ACCESS read-create STATUS current DESCRIPTION "Applicable for SCDMA channel types only. SCDMA Frame size in units of spreading intervals. This value returns zero for non SCDMA Profiles." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 6.2.12." ::= { docsIfUpstreamChannelEntry 13 } docsIfUpChannelScdmaHoppingSeed OBJECT-TYPE SYNTAX Unsigned32 (0..32767) MAX-ACCESS read-create Raftus Expires April 2004 [Page 31] Internet Draft DOCSIS RF Interface MIB October 2003 STATUS current DESCRIPTION "Applicable for SCDMA channel types only. 15 bit seed used for code hopping sequence initialization. Returns zero for non-SCDMA channel types." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 6.2.14.1." ::= { docsIfUpstreamChannelEntry 14 } docsIfUpChannelType OBJECT-TYPE SYNTAX DocsisUpstreamType MAX-ACCESS read-only STATUS current DESCRIPTION "Reflects the Upstream channel type. This object returns the value of docsIfCmtsModChannelType for the modulation profile selected in docsIfUpChannelModulationProfile for this row. " REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 6.2.1." ::= { docsIfUpstreamChannelEntry 15 } docsIfUpChannelCloneFrom OBJECT-TYPE SYNTAX InterfaceIndexOrZero MAX-ACCESS read-create STATUS current DESCRIPTION "Intended for use when a temporary upstream row entry is created for the purpose of manipulating parameters for a physical upstream channel. Refer to the descriptions of docsIfUpChannelStatus and docsIfUpChannelUpdate for details of this procedure. This object contains the ifIndex value of the physical upstream row whose parameters are to be adjusted. Upon setting this object, the values of docsIfUpChannelFrequency, docsIfUpChannelWidth, docsIfUpChannelModulationProfile, docsIfUpChannelSlotSize, docsIfUpChannelRangingBackoffStart, docsIfUpChannelRangingBackoffEnd, docsIfUpChannelTxBackoffStart, docsIfUpChannelTxBackoffEnd, docsIfUpChannelScdmaActiveCodes, docsIfUpChannelScdmaCodesPerSlot, docsIfUpChannelScdmaFrameSize, docsIfUpChannelScdmaHoppingSeed, docsIfUpChannelType, and Raftus Expires April 2004 [Page 32] Internet Draft DOCSIS RF Interface MIB October 2003 docsIfUpChannelPreEqEnable for this row are populated with the corresponding values from the row referenced by this object. Setting this object to a non-existent or temporary upstream returns an error wrongValue. This object MUST contain a value of zero for physical upstream rows." ::= { docsIfUpstreamChannelEntry 16 } docsIfUpChannelUpdate OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-create STATUS current DESCRIPTION "Used to perform the transfer of adjusted SCDMA parameters from the temporary upstream row to the active upstream row indicated by the docsIfUpChannelCloneFrom object. The transfer is initiated through an SNMP SET of TRUE to this object. The SNMP SET will fail with a GEN_ERROR (snmpv1) or COMMIT_FAILED_ERROR (snmpv2c/v3) if the adjusted SCDMA parameter values are not compatible with each other. Although this object was created to facilitate SCDMA parameter adjustment, it may also be used at the vendor's discretion for non-SCDMA parameter adjustment. An SNMP GET of this object always returns FALSE." ::= { docsIfUpstreamChannelEntry 17 } docsIfUpChannelStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "This object is generally intended to be used for the creation of a temporary upstream row for the purpose of adjusting channel parameters of a physical upstream channel row. The following restrictions apply to this object: 1. Entries with this object set to active(1) are logically linked to a defined physical interface in the interface MIB RFC 2863, no temporarily created to clone parameters. 2. A status transition from active(1) to notInService(2) or destroy(6) is not permitted. 3. ifAdminStatus from the Interface MIB RFC 2863 should be used to take an Upstream Channel offline. 4. Temporary inactive rows must be created using createAndWait(5). 5. The only possible status change of a row created using createAndWait(5) (ie notInService(2)) or notReady(3) is to destroy(6). 6. Temporary created rows must never be given the status active(1). A Mandatory procedure for adjusting an specific physical Raftus Expires April 2004 [Page 33] Internet Draft DOCSIS RF Interface MIB October 2003 Upstream channel is: 1. Create a temporary row through an SNMP SET using createAndWait(5). Use an ifIndex value outside the operational range of the system. 2. Set the docsIfUpChannelCloneFrom field to the ifIndex value of the physical row whose parameters require adjustment. 3. Adjust the parameter values using the new temporary row. Ensure all parameters contain desired values before proceeding to step 4. 4. Update the physical row by setting the object docsIfUpChannelUpdate to true(1). This operation fails with error genErr if the adjusted parameters are not compatible with each other. 5. Delete the temporary row through an SNMP SET using DELETE." ::= { docsIfUpstreamChannelEntry 18 } docsIfUpChannelPreEqEnable OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-create STATUS current DESCRIPTION "At the CMTS, used to enable or disable pre-equalization on the upstream channel represented by this table instance. At the CM, this object is read-only and reflects the status of pre-equalization as represented in the RNG-RSP. Pre-equalization is considered enabled at the CM if a RNG-RSP with pre-equalization data has been received at least once since the last mac reinit." DEFVAL {false} ::= { docsIfUpstreamChannelEntry 19 } -- The following table describes the attributes of each class of -- service. The entries in this table are referenced from the -- docsIfServiceEntries. They exist as a separate table in order to -- reduce redundant information in docsIfServiceTable. -- -- This table is implemented at both the CM and the CMTS. -- The CM need only maintain entries for the classes of service -- referenced by its docsIfServiceTable. -- docsIfQosProfileTable OBJECT-TYPE SYNTAX SEQUENCE OF DocsIfQosProfileEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Describes the attributes for each class of service." ::= { docsIfBaseObjects 3 } Raftus Expires April 2004 [Page 34] Internet Draft DOCSIS RF Interface MIB October 2003 docsIfQosProfileEntry OBJECT-TYPE SYNTAX DocsIfQosProfileEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Describes the attributes for a single class of service. If implemented as read-create in the Cable Modem Termination System, creation of entries in this table is controlled by the value of docsIfCmtsQosProfilePermissions. If implemented as read-only, entries are created based on information in REG-REQ MAC messages received from Cable Modems (Cable Modem Termination System implementation), or based on information extracted from the TFTP option file (Cable Modem implementation). In the Cable Modem Termination system, read-only entries are removed if no longer referenced by docsIfCmtsServiceTable. An entry in this table must not be removed while it is referenced by an entry in docsIfCmServiceTable (Cable Modem) or docsIfCmtsServiceTable (Cable Modem Termination System). An entry in this table should not be changeable while it is referenced by an entry in docsIfCmtsServiceTable. If this table is created automatically, there should only be a single entry for each Class of Service. Multiple entries with the same Class of Service parameters are not recommended." INDEX { docsIfQosProfIndex } ::= { docsIfQosProfileTable 1 } DocsIfQosProfileEntry ::= SEQUENCE { docsIfQosProfIndex Integer32, docsIfQosProfPriority Integer32, docsIfQosProfMaxUpBandwidth Integer32, docsIfQosProfGuarUpBandwidth Integer32, docsIfQosProfMaxDownBandwidth Integer32, docsIfQosProfMaxTxBurst Integer32, -- Deprecated docsIfQosProfBaselinePrivacy TruthValue, docsIfQosProfStatus RowStatus, docsIfQosProfMaxTransmitBurst Integer32 } docsIfQosProfIndex OBJECT-TYPE SYNTAX Integer32 (1..16383) MAX-ACCESS not-accessible STATUS current DESCRIPTION "The index value that uniquely identifies an entry in the docsIfQosProfileTable." Raftus Expires April 2004 [Page 35] Internet Draft DOCSIS RF Interface MIB October 2003 ::= { docsIfQosProfileEntry 1 } docsIfQosProfPriority OBJECT-TYPE SYNTAX Integer32 (0..7) MAX-ACCESS read-create STATUS current DESCRIPTION "A relative priority assigned to this service when allocating bandwidth. Zero indicates lowest priority and seven indicates highest priority. Interpretation of priority is device-specific. MUST NOT be changed while this row is active." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Appendix C.1.1.4." DEFVAL { 0 } ::= { docsIfQosProfileEntry 2 } docsIfQosProfMaxUpBandwidth OBJECT-TYPE SYNTAX Integer32 (0..100000000) MAX-ACCESS read-create STATUS current DESCRIPTION "The maximum upstream bandwidth, in bits per second, allowed for a service with this service class. Zero if there is no restriction of upstream bandwidth. MUST NOT be changed while this row is active." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Appendix C.1.1.4." DEFVAL { 0 } ::= { docsIfQosProfileEntry 3 } docsIfQosProfGuarUpBandwidth OBJECT-TYPE SYNTAX Integer32 (0..100000000) MAX-ACCESS read-create STATUS current DESCRIPTION "Minimum guaranteed upstream bandwidth, in bits per second, allowed for a service with this service class. MUST NOT be changed while this row is active." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Appendix C.1.1.4." DEFVAL { 0 } ::= { docsIfQosProfileEntry 4 } docsIfQosProfMaxDownBandwidth OBJECT-TYPE SYNTAX Integer32 (0..100000000) MAX-ACCESS read-create STATUS current Raftus Expires April 2004 [Page 36] Internet Draft DOCSIS RF Interface MIB October 2003 DESCRIPTION "The maximum downstream bandwidth, in bits per second, allowed for a service with this service class. Zero if there is no restriction of downstream bandwidth. MUST NOT be changed while this row is active." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Appendix C.1.1.4." DEFVAL { 0 } ::= { docsIfQosProfileEntry 5 } docsIfQosProfMaxTxBurst OBJECT-TYPE SYNTAX Integer32 (0..255) MAX-ACCESS read-create STATUS deprecated DESCRIPTION "The maximum number of mini-slots that may be requested for a single upstream transmission. A value of zero means there is no limit. MUST NOT be changed while this row is active. This object has been deprecated and replaced by docsIfQosProfMaxTransmitBurst, to fix a mismatch of the units and value range with respect to the DOCSIS Maximum Upstream Channel Transmit Burst Configuration Setting." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, C.1.1.4." DEFVAL { 0 } ::= { docsIfQosProfileEntry 6 } docsIfQosProfBaselinePrivacy OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-create STATUS current DESCRIPTION "Indicates whether Baseline Privacy is enabled for this service class. MUST NOT be changed while this row is active." DEFVAL { false } ::= { docsIfQosProfileEntry 7 } docsIfQosProfStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "This is object is to used to create or delete rows in this table. This object MUST NOT be changed from active while the row is referenced by the any entry in either docsIfCmServiceTable (on the CM), or the docsIfCmtsServiceTable (on the CMTS)." Raftus Expires April 2004 [Page 37] Internet Draft DOCSIS RF Interface MIB October 2003 ::= { docsIfQosProfileEntry 8 } docsIfQosProfMaxTransmitBurst OBJECT-TYPE SYNTAX Integer32 (0..65535) MAX-ACCESS read-create STATUS current DESCRIPTION "The maximum number of bytes that may be requested for a single upstream transmission. A value of zero means there is no limit. Note: This value does not include any physical layer overhead. MUST NOT be changed while this row is active." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Appendix C.1.1.4." DEFVAL { 0 } ::= { docsIfQosProfileEntry 9 } docsIfSignalQualityTable OBJECT-TYPE SYNTAX SEQUENCE OF DocsIfSignalQualityEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "At the CM, describes the PHY signal quality of downstream channels. At the CMTS, describes the PHY signal quality of upstream channels. At the CMTS, this table may exclude contention intervals." ::= { docsIfBaseObjects 4 } docsIfSignalQualityEntry OBJECT-TYPE SYNTAX DocsIfSignalQualityEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "At the CM, describes the PHY characteristics of a downstream channel. At the CMTS, describes the PHY signal quality of an upstream channel. An entry in this table exists for each ifEntry with an ifType of docsCableDownstream(128) for Cable Modems. For Docsis 1.1 Cable Modem Termination Systems, an entry exists for each ifEntry with an ifType of docsCableUpstream (129). For Docsis 2.0 Cable Modem Termination Systems, an entry exists for each ifEntry with an ifType of docsCableUpstreamChannel (205)." INDEX { ifIndex } ::= { docsIfSignalQualityTable 1 } DocsIfSignalQualityEntry ::= SEQUENCE { docsIfSigQIncludesContention TruthValue, docsIfSigQUnerroreds Counter32, docsIfSigQCorrecteds Counter32, docsIfSigQUncorrectables Counter32, docsIfSigQSignalNoise TenthdB, Raftus Expires April 2004 [Page 38] Internet Draft DOCSIS RF Interface MIB October 2003 docsIfSigQMicroreflections Integer32, docsIfSigQEqualizationData OCTET STRING, docsIfSigQExtUnerroreds Counter64, docsIfSigQExtCorrecteds Counter64, docsIfSigQExtUncorrectables Counter64 } docsIfSigQIncludesContention OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-only STATUS current DESCRIPTION "true(1) if this CMTS includes contention intervals in the counters in this table. Always false(2) for CMs." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 9.4.1" ::= { docsIfSignalQualityEntry 1 } docsIfSigQUnerroreds OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Codewords received on this channel without error. This includes all codewords, whether or not they were part of frames destined for this device. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 6.2.5." ::= { docsIfSignalQualityEntry 2 } docsIfSigQCorrecteds OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Codewords received on this channel with correctable errors. This includes all codewords, whether or not they were part of frames destined for this device. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 6.2.5." ::= { docsIfSignalQualityEntry 3 } Raftus Expires April 2004 [Page 39] Internet Draft DOCSIS RF Interface MIB October 2003 docsIfSigQUncorrectables OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Codewords received on this channel with uncorrectable errors. This includes all codewords, whether or not they were part of frames destined for this device. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 6.2.5." ::= { docsIfSignalQualityEntry 4 } docsIfSigQSignalNoise OBJECT-TYPE SYNTAX TenthdB UNITS "dB" MAX-ACCESS read-only STATUS current DESCRIPTION "Signal/Noise ratio as perceived for this channel. At the CM, describes the Signal/Noise of the downstream channel. At the CMTS, describes the average Signal/Noise of the upstream channel." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Tables 4-1 and 4-2" ::= { docsIfSignalQualityEntry 5 } docsIfSigQMicroreflections OBJECT-TYPE SYNTAX Integer32 (0..255) UNITS "dBc" MAX-ACCESS read-only STATUS current DESCRIPTION "Total microreflections including in-channel response as perceived on this interface, measured in dBc below the signal level. This object is not assumed to return an absolutely accurate value, but should give a rough indication of microreflections received on this interface. It is up to the implementer to provide information as accurate as possible. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Raftus Expires April 2004 [Page 40] Internet Draft DOCSIS RF Interface MIB October 2003 Frequency Interface Specification SP-RFIv2.0-I04-030730, Tables 4-1 and 4-2" ::= { docsIfSignalQualityEntry 6 } docsIfSigQEqualizationData OBJECT-TYPE SYNTAX OCTET STRING (SIZE (0..512)) MAX-ACCESS read-only STATUS current DESCRIPTION "At the CM, returns the equalization data for the downstream channel. At the CMTS, returns the average equalization data for the upstream channel. Returns an empty string if the value is unknown or if there is no equalization data available or defined." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 9.3.2." ::= { docsIfSignalQualityEntry 7 } docsIfSigQExtUnerroreds OBJECT-TYPE SYNTAX Counter64 MAX-ACCESS read-only STATUS current DESCRIPTION "Codewords received on this channel without error. This includes all codewords, whether or not they were part of frames destined for this device. This is the 64 bit version of docsIfSigQUnerroreds. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 6.2.5." ::= { docsIfSignalQualityEntry 8 } docsIfSigQExtCorrecteds OBJECT-TYPE SYNTAX Counter64 MAX-ACCESS read-only STATUS current DESCRIPTION "Codewords received on this channel with correctable errors. This includes all codewords, whether or not they were part of frames destined for this device. This is the 64 bit version of docsIfSigQCorrecteds. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Raftus Expires April 2004 [Page 41] Internet Draft DOCSIS RF Interface MIB October 2003 Section 6.2.5." ::= { docsIfSignalQualityEntry 9 } docsIfSigQExtUncorrectables OBJECT-TYPE SYNTAX Counter64 MAX-ACCESS read-only STATUS current DESCRIPTION "Codewords received on this channel with uncorrectable errors. This includes all codewords, whether or not they were part of frames destined for this device. This is the 64 bit version of docsIfSigQUncorrectables. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 6.2.5." ::= { docsIfSignalQualityEntry 10 } -- -- DOCSIS Version of the device -- docsIfDocsisBaseCapability OBJECT-TYPE SYNTAX DocsisVersion MAX-ACCESS read-only STATUS current DESCRIPTION "Indication of the DOCSIS capability of the device. This object mirrors docsIfDocsisCapability from the DocsIfExt mib." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Annex G." ::= { docsIfBaseObjects 5 } -- -- CABLE MODEM GROUP -- -- ####### -- -- The CM MAC Table -- docsIfCmMacTable OBJECT-TYPE SYNTAX SEQUENCE OF DocsIfCmMacEntry Raftus Expires April 2004 [Page 42] Internet Draft DOCSIS RF Interface MIB October 2003 MAX-ACCESS not-accessible STATUS current DESCRIPTION "Describes the attributes of each CM MAC interface, extending the information available from ifEntry." ::= { docsIfCmObjects 1 } docsIfCmMacEntry OBJECT-TYPE SYNTAX DocsIfCmMacEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "An entry containing objects describing attributes of each MAC entry, extending the information in ifEntry. An entry in this table exists for each ifEntry with an ifType of docsCableMaclayer(127)." INDEX { ifIndex } ::= { docsIfCmMacTable 1 } DocsIfCmMacEntry ::= SEQUENCE { docsIfCmCmtsAddress MacAddress, docsIfCmCapabilities BITS, docsIfCmRangingRespTimeout TimeTicks, docsIfCmRangingTimeout TimeInterval } docsIfCmCmtsAddress OBJECT-TYPE SYNTAX MacAddress MAX-ACCESS read-only STATUS current DESCRIPTION "Identifies the CMTS that is believed to control this MAC domain. At the CM, this will be the source address from SYNC, MAP, and other MAC-layer messages. If the CMTS is unknown, returns 00-00-00-00-00-00." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 8.2.2." ::= { docsIfCmMacEntry 1 } docsIfCmCapabilities OBJECT-TYPE SYNTAX BITS { atmCells(0), concatenation(1) } MAX-ACCESS read-only STATUS current DESCRIPTION "Identifies the capabilities of the MAC implementation at this interface. Note that packet transmission is always supported. Therefore, there is no specific bit required to explicitly indicate this capability. Note that BITS objects are encoded most significant bit first. For example, if bit 1 is set, the value of this Raftus Expires April 2004 [Page 43] Internet Draft DOCSIS RF Interface MIB October 2003 object is the octet string '40'H." ::= { docsIfCmMacEntry 2 } -- This object has been obsoleted and replaced by -- docsIfCmRangingTimeout to correct the typing to TimeInterval. New -- implementations of the MIB should use docsIfCmRangingTimeout -- instead. docsIfCmRangingRespTimeout OBJECT-TYPE SYNTAX TimeTicks MAX-ACCESS read-write STATUS obsolete DESCRIPTION "Waiting time for a Ranging Response packet." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 9.1.6." DEFVAL { 20 } ::= { docsIfCmMacEntry 3 } docsIfCmRangingTimeout OBJECT-TYPE SYNTAX TimeInterval MAX-ACCESS read-write STATUS current DESCRIPTION "Waiting time for a Ranging Response packet." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 9.1.6, timer T3." DEFVAL { 20 } ::= { docsIfCmMacEntry 4 } -- -- CM status table. -- This table is implemented only at the CM. -- docsIfCmStatusTable OBJECT-TYPE SYNTAX SEQUENCE OF DocsIfCmStatusEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table maintains a number of status objects and counters for Cable Modems." ::= { docsIfCmObjects 2 } docsIfCmStatusEntry OBJECT-TYPE SYNTAX DocsIfCmStatusEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A set of status objects and counters for a single MAC Raftus Expires April 2004 [Page 44] Internet Draft DOCSIS RF Interface MIB October 2003 layer instance in a Cable Modem. An entry in this table exists for each ifEntry with an ifType of docsCableMaclayer(127)." INDEX { ifIndex } ::= { docsIfCmStatusTable 1 } DocsIfCmStatusEntry ::= SEQUENCE { docsIfCmStatusValue INTEGER, docsIfCmStatusCode OCTET STRING, docsIfCmStatusTxPower TenthdBmV, docsIfCmStatusResets Counter32, docsIfCmStatusLostSyncs Counter32, docsIfCmStatusInvalidMaps Counter32, docsIfCmStatusInvalidUcds Counter32, docsIfCmStatusInvalidRangingResponses Counter32, docsIfCmStatusInvalidRegistrationResponses Counter32, docsIfCmStatusT1Timeouts Counter32, docsIfCmStatusT2Timeouts Counter32, docsIfCmStatusT3Timeouts Counter32, docsIfCmStatusT4Timeouts Counter32, docsIfCmStatusRangingAborteds Counter32, docsIfCmStatusDocsisOperMode DocsisQosVersion, docsIfCmStatusModulationType DocsisUpstreamTypeStatus, docsIfCmStatusEqualizationData OCTET STRING, docsIfCmStatusUCCs Counter32, docsIfCmStatusUCCFails Counter32 } docsIfCmStatusValue OBJECT-TYPE SYNTAX INTEGER { other(1), notReady(2), notSynchronized(3), phySynchronized(4), usParametersAcquired(5), rangingComplete(6), ipComplete(7), todEstablished(8), securityEstablished(9), paramTransferComplete(10), registrationComplete(11), operational(12), accessDenied(13) } MAX-ACCESS read-only STATUS current DESCRIPTION "Current Cable Modem connectivity state, as specified in the RF Interface Specification. Interpretations for state values 1-12 are clearly outlined in the SP-RFI reference given below. As stated in the description for object docsIfCmtsCmStatusValue, accessDenied(13)indicates the CMTS has sent a Registration Aborted message to the CM." Raftus Expires April 2004 [Page 45] Internet Draft DOCSIS RF Interface MIB October 2003 REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 11.2. Data-Over-Cable Service Interface Specifications: Operations Support System Interface Specification SP-OSSIv2.0-IO4-030730, Section 6.3.4.2." ::= { docsIfCmStatusEntry 1 } docsIfCmStatusCode OBJECT-TYPE SYNTAX OCTET STRING (SIZE (0..16)) MAX-ACCESS read-only STATUS current DESCRIPTION "Status code for this Cable Modem as defined in the OSSI Specification. The status code consists of a single character indicating error groups, followed by a two- or three-digit number indicating the status condition, followed by a decimal." REFERENCE "Data-Over-Cable Service Interface Specifications: Operations Support System Interface Specification SP-OSSIv2.0-I04-030730, Annex D." ::= { docsIfCmStatusEntry 2 } docsIfCmStatusTxPower OBJECT-TYPE SYNTAX TenthdBmV UNITS "dBmV" MAX-ACCESS read-only STATUS current DESCRIPTION "The operational transmit power for the attached upstream channel." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 6.2.18." ::= { docsIfCmStatusEntry 3 } docsIfCmStatusResets OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of times the CM reset or initialized this interface." ::= { docsIfCmStatusEntry 4 } docsIfCmStatusLostSyncs OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of times the CM lost synchronization with the downstream channel. Raftus Expires April 2004 [Page 46] Internet Draft DOCSIS RF Interface MIB October 2003 Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 8.3.2." ::= { docsIfCmStatusEntry 5 } docsIfCmStatusInvalidMaps OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of times the CM received invalid MAP messages. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 8.3.4." ::= { docsIfCmStatusEntry 6 } docsIfCmStatusInvalidUcds OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of times the CM received invalid UCD messages. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 8.3.3." ::= { docsIfCmStatusEntry 7 } docsIfCmStatusInvalidRangingResponses OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of times the CM received invalid ranging response messages. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE Raftus Expires April 2004 [Page 47] Internet Draft DOCSIS RF Interface MIB October 2003 "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 8.3.6." ::= { docsIfCmStatusEntry 8 } docsIfCmStatusInvalidRegistrationResponses OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of times the CM received invalid registration response messages. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 8.3.8." ::= { docsIfCmStatusEntry 9 } docsIfCmStatusT1Timeouts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of times counter T1 expired in the CM. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Figure 9-2." ::= { docsIfCmStatusEntry 10 } docsIfCmStatusT2Timeouts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of times counter T2 expired in the CM. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Figure 9-2." ::= { docsIfCmStatusEntry 11 } docsIfCmStatusT3Timeouts OBJECT-TYPE Raftus Expires April 2004 [Page 48] Internet Draft DOCSIS RF Interface MIB October 2003 SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of times counter T3 expired in the CM. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Figure 9-2." ::= { docsIfCmStatusEntry 12 } docsIfCmStatusT4Timeouts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of times counter T4 expired in the CM. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Figure 9-2." ::= { docsIfCmStatusEntry 13 } docsIfCmStatusRangingAborteds OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "Number of times the ranging process was aborted by the CMTS. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 9.3.3." ::= { docsIfCmStatusEntry 14 } docsIfCmStatusDocsisOperMode OBJECT-TYPE SYNTAX DocsisQosVersion MAX-ACCESS read-only STATUS current DESCRIPTION "Indication whether the device has registered using 1.0 Class of Service or 1.1 Quality of Service. Raftus Expires April 2004 [Page 49] Internet Draft DOCSIS RF Interface MIB October 2003 An unregistered CM should indicate 1.1 QOS for a docsIfDocsisBaseCapability value of Docsis 1.1/2.0. An unregistered CM should indicate 1.0 COS for a docsIfDocsisBaseCapability value of Docsis 1.0. This object mirrors docsIfCmDocsisOperMode from the docsIfExt mib." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Annex G." ::= { docsIfCmStatusEntry 15 } docsIfCmStatusModulationType OBJECT-TYPE SYNTAX DocsisUpstreamTypeStatus MAX-ACCESS read-only STATUS current DESCRIPTION "Indicates modulation type status currently used by the CM. Since this object specifically identifies PHY mode, the shared upstream channel type is not permitted." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 6.2.1." ::= { docsIfCmStatusEntry 16 } docsIfCmStatusEqualizationData OBJECT-TYPE SYNTAX OCTET STRING (SIZE (0..512)) MAX-ACCESS read-only STATUS current DESCRIPTION "Pre-equalization data for this CM after convolution with data indicated in the RNG-RSP. This data is valid when docsIfUpChannelPreEqEnable is set to true. The value should be formatted as defined in the following REFERENCE, beginning with the main tap location field. The type and length fields shown in the referenced figure must not be included. Returns an empty string if the value is unknown or if there is no equalization data available or defined." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Figure 8-23." ::= { docsIfCmStatusEntry 17 } docsIfCmStatusUCCs OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of successful Upstream Channel Change transactions. Discontinuities in the value of this counter can occur Raftus Expires April 2004 [Page 50] Internet Draft DOCSIS RF Interface MIB October 2003 at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." ::= { docsIfCmStatusEntry 18 } docsIfCmStatusUCCFails OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of failed Upstream Channel Change transactions. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." ::= { docsIfCmStatusEntry 19 } -- -- The Cable Modem Service Table -- docsIfCmServiceTable OBJECT-TYPE SYNTAX SEQUENCE OF DocsIfCmServiceEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Describes the attributes of each upstream service queue on a CM." ::= { docsIfCmObjects 3 } docsIfCmServiceEntry OBJECT-TYPE SYNTAX DocsIfCmServiceEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Describes the attributes of an upstream bandwidth service queue. An entry in this table exists for each Service ID. The primary index is an ifIndex with an ifType of docsCableMaclayer(127)." INDEX { ifIndex, docsIfCmServiceId } ::= { docsIfCmServiceTable 1 } DocsIfCmServiceEntry ::= SEQUENCE { docsIfCmServiceId Integer32, docsIfCmServiceQosProfile Integer32, docsIfCmServiceTxSlotsImmed Counter32, docsIfCmServiceTxSlotsDed Counter32, docsIfCmServiceTxRetries Counter32, docsIfCmServiceTxExceededs Counter32, Raftus Expires April 2004 [Page 51] Internet Draft DOCSIS RF Interface MIB October 2003 docsIfCmServiceRqRetries Counter32, docsIfCmServiceRqExceededs Counter32, docsIfCmServiceExtTxSlotsImmed Counter64, docsIfCmServiceExtTxSlotsDed Counter64 } docsIfCmServiceId OBJECT-TYPE SYNTAX Integer32 (1..16383) MAX-ACCESS not-accessible STATUS current DESCRIPTION "Identifies a service queue for upstream bandwidth. The attributes of this service queue are shared between the CM and the CMTS. The CMTS allocates upstream bandwidth to this service queue based on requests from the CM and on the class of service associated with this queue." ::= { docsIfCmServiceEntry 1 } docsIfCmServiceQosProfile OBJECT-TYPE SYNTAX Integer32 (0..16383) MAX-ACCESS read-only STATUS current DESCRIPTION "The index in docsIfQosProfileTable describing the quality of service attributes associated with this particular service. If no associated entry in docsIfQosProfileTable exists, this object returns a value of zero." ::= { docsIfCmServiceEntry 2 } docsIfCmServiceTxSlotsImmed OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of upstream mini-slots which have been used to transmit data PDUs in immediate (contention) mode. This includes only those PDUs that are presumed to have arrived at the headend (i.e., those which were explicitly acknowledged.) It does not include retransmission attempts or mini-slots used by Requests. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 9.4." ::= { docsIfCmServiceEntry 3 } docsIfCmServiceTxSlotsDed OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION Raftus Expires April 2004 [Page 52] Internet Draft DOCSIS RF Interface MIB October 2003 "The number of upstream mini-slots which have been used to transmit data PDUs in dedicated mode (i.e., as a result of a unicast Data Grant). Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 9.4." ::= { docsIfCmServiceEntry 4 } docsIfCmServiceTxRetries OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of attempts to transmit data PDUs containing requests for acknowledgment that did not result in acknowledgment. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 9.4." ::= { docsIfCmServiceEntry 5 } docsIfCmServiceTxExceededs OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of data PDUs transmission failures due to excessive retries without acknowledgment. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex." REFERENCE "Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I04-030730, Section 9.4." ::= { docsIfCmServiceEntry 6 } docsIfCmServiceRqRetries OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS r