IPCDN Working Group Michael Patrick William Murwin Motorola BCS Data Over Cable System Quality of Service Management Information Base (DOCSIS-QOS MIB) November 9, 2001 Status of this Memo This document is an Internet-Draft and is in full conformance with all the provisions of Section 10 of RFC2026. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its Areas, and its Working Groups. Note that other groups may also distribute working documents as Internet-Drafts. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as a "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 (c) The Internet Society 2001. All Rights Reserved. Abstract This document defines a basic set of managed objects for SNMP-based management of extended QOS features of Cable Modems (CMs) and Cable Modem Termination Systems (CMTSs) conforming to the Data over Cable System (DOCSIS) standard version 1.1. Expires May 2002 [Page 1] INTERNET-DRAFTNovember 2001 Table of Contents Status of this Memo............................... 1 Abstract.......................................... 1 Revision History.................................. 3 1. Introduction...................................... 5 1.1 Management Framework......................... 5 1.2 Glossary..................................... 6 2. Overview.......................................... 8 2.1 Textual Conventions.......................... 8 2.2 MIB Organization............................ 8 2.2.1 docsQosPktClassTable................. 12 2.2.1.1 InetAddress Transition............... 13 2.2.2 docsQosParamSetTable................. 14 2.2.2.1 Interoperation with DOCSIS 1.0....... 15 2.2.3 docsQosServiceFlowTable.............. 16 2.2.4 docsQosServiceFlowStatsTable......... 17 2.2.5 docsQosUpstreamStatsTable............ 17 2.2.6 docsQosDynamicServiceStatsTable...... 17 2.2.7 docsQosServiceFlowLogTable........... 18 2.2.8 docsQosServiceClassTable............. 18 2.2.9 docsQosServiceClassPolicyTable....... 18 2.2.10 docsQosPHSTable...................... 19 2.2.11 docsQosCmtsMacToSrvFlowTable......... 19 3. Externally Administered Classification............ 20 4. Definitions....................................... 23 5. Security Considerations........................... 83 6. Intellectual Property............................. 83 7. Acknowledgement................................... 84 8. References........................................ 84 9. Author's Address.................................. 86 10. Full Copyright Statement.......................... 87 Expires May 2002 [Page 2] INTERNET-DRAFTNovember 2001 Revision History Rev Date Description --- -------- ----------- -06 11/8/01 Functional Changes: - Deprecated objects that were of type IpAddress and added new objects that were of type InetAddressType and InetAddress, to support both IPv4 and IPv6 in the docsQosPktClassTable. - Clarified the default value of the docsQosPktClassIpDestMask and docsQosPktClassIpSourceMask. - Clarified that some of counters from the docsQosDynamicServiceStatsTable, include retries. - Added objects that were removed from earlier revisions of the mib, as obsolete. - In section 2.2.2.1, in bullet item (1) removed requirement of adding row to docsIfQosProfileTable. - Clarified the Cable Modem's implementation of the docsQosParamSetTosAndMask. Editorial Changes: - Corrected the description of the individual bits that make up docsQosParamsSetRequestPolicyOct. - Corrected the spelling of docsCableMaclayer in the description of the docsQosServiceFlowLogIfIndex. - In section 2.2.1, clarified the definition of classifiers in the docsQosPktClassTable. - In section 2.2.2.1, in bullet item (3) flexibility was given to implementing docsIfQosProfileTable. - In section 2.2.2.1, added bullet item (6). - Changed references to the latest Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification. - Added section 2.2.1.1 InetAddress Transition, to discuss the change from IpAddress objects to InetAddressType and InetAddress objects. - Changed the description of objects within the docsQosServiceClassTable, so that they were no longer templates for obsolete objects. - Changed section 5 to "Security Considerations". - Changed section 6 to "Intellectual Property". - "References" where moved to section 8. - "Author's Address" where moved to section 9. - Added section 7, "Acknowledgement". - Added section 10, "Full Copyright Statement". - Section 1.1 was updated to reflect the most recent MIB boilerplate. - Updated references to refer to current RFCs. Expires May 2002 [Page 3] INTERNET-DRAFTNovember 2001 -05 03/01/01 Functional Changes: - Changed default values of dosQosPktClassIpSourceMask and docsQosPktClassIpDestMask to 255.255.255.255. Editorial Changes: - Corrected ifDirection values in 2.1. - In section 2.2.2.1, clarified which packets/bytes are counted in docsIfCmtsService- InPkts and docsIfCmtsServiceInOctets. - Clarified description of dosQosServiceFlowPkts to avoid requiring CMs to classify downstream packets. - Clarified that docsQosServiceFlowPHSUnknowns only applies to received packets. - Clarified that docsQosPktClassBitMap and docsQosParamSetBitMap indicate all parameters for both adds and changes. -04 10/18/00 - Updated descriptions of UGS applicable QOS param set objects. - Added two new docsQosPktClassBitMap bits and *renumbered* the bits. - Added docsQosServiceClassDirection -04 10/10/00 - Updated Overview to not mention restriction to SnmpV1. - Updated most docsQosParamSet objects to clarify default and "not applicable" values. - Add docsQosPktClassBitMap, docsQosParamSetBitMap - Restore docsQosParamSetServiceClassName - Add 5 objects to docsQosServiceFlowLogTable -04 10/01/00 - Move six objects from docsQosServiceFlowTable back to docsQosParamSetTable. - Add DCC statistics - Removed notApplicable(256) from docsQosParamSetSchedulingType -03 08/11/00 Reorganize docsQosParamSetTable. -02 12/08/99 Add docsQosServiceFlowStatsTable, docsQosUpstreamStatsTable, docsQosDynamicServiceStatsTable, docsQosServiceFlowLogTable -01 06/25/99 Complete rewrite based on -I01 draft -00 08/07/98 Initial draft posted for discussion. Expires May 2002 [Page 4] INTERNET-DRAFTNovember 2001 1. Introduction This memo specifies a MIB module in a manner that is compliant to the SNMP SMIv2[5][6][7]. The set of objects is consistent with the SNMP framework and existing SNMP standards. 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 author. 1.1 Management Framework The SNMP Management Framework presently consists of five major components: o An overall architecture, described in RFC 2571 [1]. o Mechanisms for describing and naming objects and events for the purpose of management. The first version of this Structure of Management Information (SMI) is called SMIv1 and described in STD 16, RFC 1155 [2], STD 16, RFC 1212 [3] and RFC 1215 [4]. The second version, called SMIv2, is described in STD 58, RFC 2578 [5], STD 58, RFC 2579 [6] and STD 58, RFC 2580 [7]. o Message protocols for transferring management information. The first version of the SNMP message protocol is called SNMPv1 and described in STD 15, RFC 1157 [8]. A second version of the SNMP message protocol, which is not an Internet standards track protocol, is called SNMPv2c and described in RFC 1901 [9] and RFC 1906 [10]. The third version of the message protocol is called SNMPv3 and described in RFC 1906 [10], RFC 2572 [11] and RFC 2574 [12]. o Protocol operations for accessing management information. The first set of protocol operations and associated PDU formats is described in STD 15, RFC 1157 [8]. A second set of protocol operations and associated PDU formats is described in RFC 1905 [13]. o A set of fundamental applications described in RFC 2573 [14] and the view-based access control mechanism described in RFC 2575 [15]. A more detailed introduction to the current SNMP Management Framework can be found in RFC 2570 [24]. Managed objects are accessed via a virtual information store, termed Expires May 2002 [Page 5] INTERNET-DRAFTNovember 2001 the Management Information Base or MIB. Objects in the MIB are defined using the mechanisms defined in the SMI. This memo specifies a MIB module that is compliant to the SMIv2. A MIB conforming to the SMIv1 can be produced through the appropriate translations. The resulting translated MIB must be semantically equivalent, except where objects or events are omitted because no translation is possible (use of Counter64). Some machine readable information in SMIv2 will be converted into textual descriptions in SMIv1 during the translation process. However, this loss of machine readable information is not considered to change the semantics of the MIB. 1.2 Glossary Active QPS Active Qos Parameter Set. The set of QOS parameters that describe the current level service provided to a Service Flow. Active SF Active Service Flow. An SF with a non-empty Active QPS. Admitted QPS Admitted Qos Parameter Set. The set of QOS parameters that describe a level of service which the Service Flow is not currently using, but which it is guaranteed to receive upon the SF's request to make the set Active. Admitted SF A Service Flow with a non-empty Admitted QPS. CATV Cable TV CM Cable Modem, a modem connecting a subscriber's LAN the CATF RF network. DOCSIS CMs operate as a MAC layer bridge between the home LAN and the RF network. CMTS Cable Modem Termination System, the "head-end" device providing connectivity between the RF network and the Internet. Downstream The direction from the head end towards the subscriber. DSA Dynamic Service Addition, a DOCSIS MAC management message requesting the dynamic creation of a new Service Flow. New SFs are created with a three- message exchange of a DSA-REQ, DSA-RSP, and DSA-ACK. Expires May 2002 [Page 6] INTERNET-DRAFTNovember 2001 DSC Dynamic Service Change, a DOCSIS MAC management message requesting a change to the attributes of a Service Flow. SFs are changed with a three-message exchange of a DSC-REQ, DSC-RSP, and DSC-ACK. DSD Dynamic Service Delete, a DOCSIS MAC management message requesting the deletion of a Service Flow. SFs are deleted with a two-message exchange of a DSD-REQ and DSD-ACK. Head-end The origination point in most cable systems of the subsriber video signals. It is generally also the location of the CMTS. PHS Payload Header Suppression, a feature of DOCSIS 1.1 in which header bytes that are common in a sequence of packets of a Service Flow are replaced by a one-byte PHSI Index (PHSI) when transmitting the packet on the RF network. Provisioned QPS A QOS Parameter Set describing an envelope of service within which a Service Flow is authorized to request admission. All existing service flows must have a non-empty Provisioned QPS, hence all SFs are considered to be "Provisioned". SCN Service Class Name -- a named set of QOS parameters. A Service Flow may or may not be associated with a single named Service Class. A Service Class has as an attribute a Qos Parameter Set that is used as the default set of values for all Service Flows belonging to the Service Class. SID Service ID. A 16-bit integer assigned by the CMTS for an Upstream Service Flow with a non-empty Active QOS Parameter Set. SF Service Flow. A unidirectional stream of packets between the CM and CMTS. SFs are characterized as upstream or downstream. The SF is the fundamental unit of service provided on a DOCSIS CATV network. SFID Service Flow ID. A 32-bit unsigned integer assigned by the CMTS to each Service Flows Upstream The direction from a subscriber CM to the head-end CMTS. Expires May 2002 [Page 7] INTERNET-DRAFTNovember 2001 2. Overview This MIB provides a set of objects required for the management of DOCSIS 1.1 compliant Cable Modems (CM) and Cable Modem Termination Systems (CMTS). The specification is derived from the DOCSIS 1.1 Radio Frequency Interface specification [16]. Please note that the referenced DOCSIS standard only requires Cable Modems to process IPv4 customer traffic. Design choices in this MIB reflect those requirements. Future versions of the DOCSIS standard are expected to require support for IPv6 as well. 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 [19]. 2.1 Textual Conventions The textual convention "IfDirection" is defined to indicate the direction of a packet classifier relative to an interface. It takes the values of either downstream(1) or upstream(2). The textual convention "BitRate" corresponds to the bits per second as defined for QOS Parameter Sets in DOCSIS1.1. This definition includes all bits of the Ethernet MAC frame as transmitted on the RF network, starting with the Destination Address and ending with the Ethernet FCS. It does NOT includes bits in the DOCSIS MAC header. 2.2 MIB Organization The structure of the MIB is summarized below: Expires May 2002 [Page 8] INTERNET-DRAFTNovember 2001 docsQosMIB docsQosMIBObjects docsQosPktClassTable docsQosPktClassEntry docsQosPktClassId docsQosPktClassDirection docsQosPktClassPriority docsQosPktClassIpTosLow docsQosPktClassIpTosHigh docsQosPktClassIpTosMask docsQosPktClassIpProtocol docsQosPktClassIpSourceAddr docsQosPktClassIpSourceMask docsQosPktClassIpDestAddr docsQosPktClassIpDestMask docsQosPktClassSourcePortStart docsQosPktClassSourcePortEnd docsQosPktClassDestPortStart docsQosPktClassDestPortEnd docsQosPktClassDestMacAddr docsQosPktClassDestMacMask docsQosPktClassSourceMacAddr docsQosPktClassEnetProtocolType docsQosPktClassEnetProtocol docsQosPktClassUserPriApplies docsQosPktClassUserPriLow docsQosPktClassUserPriHigh docsQosPktClassVlanId docsQosPktClassState docsQosPktClassPkts docsQosPktClassBitMap docsQosPktClassInetSourceAddrType docsQosPktClassInetSourceAddr docsQosPktClassInetSourceMaskType docsQosPktClassInetSourceMask docsQosPktClassInetDestAddrType docsQosPktClassInetDestAddr docsQosPktClassInetDestMaskType docsQosPktClassInetDestMask docsQosParamSetTable docsQosParamSetEntry docsQosParamSetServiceClassName docsQosParamSetPriority docsQosParamSetMaxTrafficRate docsQosParamSetMaxTrafficBurst docsQosParamSetMinReservedRate docsQosParamSetMinReservedPkt docsQosParamSetActiveTimeout docsQosParamSetAdmittedTimeout docsQosParamSetMaxConcatBurst docsQosParamSetSchedulingType Expires May 2002 [Page 9] INTERNET-DRAFTNovember 2001 docsQosParamSetNomPollInterval docsQosParamSetTolPollJitter docsQosParamSetUnsolicitGrantSize docsQosParamSetNomGrantInterval docsQosParamSetTolGrantJitter docsQosParamSetGrantsPerInterval docsQosParamSetTosAndMask docsQosParamSetTosOrMask docsQosParamSetMaxLatency docsQosParamSetType docsQosParamSetRequestPolicyOct docsQosParamSetBitMap docsQosServiceFlowTable docsQosServiceFlowEntry docsQosServiceFlowId docsQosServiceFlowProvisionedParamSetIndex docsQosServiceFlowAdmittedParamSetIndex docsQosServiceFlowActiveParamSetIndex docsQosServiceFlowSID docsQosServiceFlowDirection docsQosServiceFlowPrimary docsQosServiceFlowActiveTimeout docsQosServiceFlowAdmittedTimeout docsQosServiceFlowSchedulingType docsQosServiceFlowRequestPolicy docsQosServiceFlowTosAndMask docsQosServiceFlowTosOrMask docsQosServiceFlowStatsTable docsQosServiceFlowStatsEntry docsQosServiceFlowPkts docsQosServiceFlowOctets docsQosServiceFlowTimeCreated docsQosServiceFlowTimeActive docsQosServiceFlowPHSUnknowns docsQosServiceFlowPolicedDropPkts docsQosServiceFlowPolicedDelayPkts docsQosUpstreamStatsTable docsQosUpstreamStatsEntry docsQosSID docsQosUpstreamFragments docsQosUpstreamFragDiscards docsQosUpstreamConcatBursts docsQosDynamicServiceStatsTable docsQosDynamicServiceStatsEntry docsQosIfDirection docsQosDSAReqs docsQosDSARsps docsQosDSAAcks docsQosDSCReqs docsQosDSCRsps docsQosDSCAcks Expires May 2002 [Page 10] INTERNET-DRAFTNovember 2001 docsQosDSDReqs docsQosDSDRsps docsQosDynamicAdds docsQosDynamicAddFails docsQosDynamicChanges docsQosDynamicChangeFails docsQosDynamicDeletes docsQosDynamicDeleteFails docsQosDCCReqs docsQosDCCRsps docsQosDCCAcks docsQosDCCs docsQosDCCFails docsQosServiceFlowLogTable docsQosServiceFlowLogEntry docsQosServiceFlowLogIndex docsQosServiceFlowLogIfIndex docsQosServiceFlowLogSFID docsQosServiceFlowLogCmMac docsQosServiceFlowLogPkts docsQosServiceFlowLogOctets docsQosServiceFlowLogTimeDeleted docsQosServiceFlowLogTimeCreated docsQosServiceFlowLogTimeActive docsQosServiceFlowLogDirection docsQosServiceFlowLogPrimary docsQosServiceFlowLogServiceClassName docsQosServiceFlowLogPolicedDropPkts docsQosServiceFlowLogPolicedDelayPkts docsQosServiceFlowLogControl docsQosServiceClassTable docsQosServiceClassEntry docsQosServiceClassName docsQosServiceClassParamSetIndex docsQosServiceClassStatus docsQosServiceClassMaxTrafficRate docsQosServiceClassMaxTrafficBurst docsQosServiceClassMinReservedRate docsQosServiceClassMinReservedPkt docsQosServiceClassMaxConcatBurst docsQosServiceClassNomPollInterval docsQosServiceClassTolPollJitter docsQosServiceClassUnsolicitGrantSize docsQosServiceClassNomGrantInterval docsQosServiceClassTolGrantJitter docsQosServiceClassGrantsPerInterval docsQosServiceClassMaxLatency docsQosServiceClassActiveTimeout docsQosServiceClassAdmittedTimeout docsQosServiceClassSchedulingType docsQosServiceClassRequestPolicy Expires May 2002 [Page 11] INTERNET-DRAFTNovember 2001 docsQosServiceClassTosAndMask docsQosServiceClassTosOrMask docsQosServiceClassDirection docsQosServiceClassPolicyTable docsQosServiceClassPolicyEntry docsQosServiceClassPolicyIndex docsQosServiceClassPolicyName docsQosServiceClassPolicyRulePriority docsQosServiceClassPolicyStatus docsQosPHSTable docsQosPHSEntry docsQosPHSField docsQosPHSMask docsQosPHSSize docsQosPHSVerify docsQosPHSClassifierIndex docsQosPHSIndex docsQosCMtsMacToSrvFlowTable docsQosCmtsMacToSrvFlowEntry docsQosCmtsCmMac docsQosCmtsServiceFlowId docsQosCmtsIfIndex The MIB is organized as 11 tables. Most tables are implemented in both the CM and CMTS; the docsQosUpstreamStatsTable and docsQosServiceFlowLogTable are implemented on the CMTS only. 2.2.1 docsQosPktClassTable The docsQosPktClassTable reports the Service Flow Classifiers implemented by the managed device. The table is indexed by the tuple { ifIndex, docsQosServiceFlowId, docsQosPktClassId }. The ifIndex corresponds to an CATV MAC interface. Each CATV MAC interfaces has a set of Service Flows, identified with a docsQosServiceFlowId value that is unique for that interface. Each service flow may have a number of packet classifiers that map packets to the flow. The ClassifierId for the classifier is unique only within a particular service flow. The semantics of packet classification are provided in [16]. Briefly, the DOCSIS MAC interface calls for matching packets based on values within the 802.2 (LLC), 802.3, IP, and/or UDP/TCP headers. Packets which map more than one classifier are prioritized according to their docsQosPktClassPriority value. The docsQosServiceFlowId (an index object) indicates to which service flow the packet is classified. The docsQosPktClassTable is distinct from the docsDevIpFilterTable of [21] in that docsQosPktClassTable is intended only to reflect the Expires May 2002 [Page 12] INTERNET-DRAFTNovember 2001 state of the Service Flow Classifiers. Service Flow Classifiers may be created only via a CM configuration file or from the Dynamic Service Addition (DSA) messages. For this reason, docsQosPktClassTable is read-only. The docsDevIpFilterTable is intended for external policy-based administration of packet classifiers. See the section "Externally Administered Classification", below. 2.2.1.1 InetAddress_Transition Earlier and widely implemented versions of the DOCS-QOS-MIB used the IPv4-only "IpAddress" syntax for the four IP address object in the docsQosPktClassTable. The MIB now requires the use of InetAddress syntax as per [23], which supports both IPv4 and IPv6 addresses. The four objects that have the IpAddress syntax are deprecated in favor of eight equivalent new objects, as shown by the following table: +-----------------------------+-----------------------------------+ | IpAddress | InetAddressType & InetAddress | | syntax | syntax | +-----------------------------+-----------------------------------+ | | docsQosPktClassInetSourceAddrType | | docsQosPktClassIpSourceAddr | & | | | docsQosPktClassInetSourceAddr | +-----------------------------+-----------------------------------+ | | docsQosPktClassInetSourceMaskType | | docsQosPktClassIpSourceMask | & | | | docsQosPktClassInetSourceMask | +-----------------------------+-----------------------------------+ | | docsQosPktClassInetDestAddrType | | docsQosPktClassIpDestAddr | & | | | docsQosPktClassInetDestAddr | +-----------------------------+-----------------------------------+ | | docsQosPktClassInetDestMaskType | | docsQosPktClassIpDestMask | & | | | docsQosPktClassInetDestMask | +-----------------------------+-----------------------------------+ Agents that choose to implement the deprecated IpAddress syntax objects MUST report values that match the values read from the corresponding InetAddress syntax objects with InetAddressType of ipv4(1). If future versions of the DOCSIS protocol permit the use of IPv6 addresses for packet classifiers, the value read from the deprecated (IPv4-only) IpAddress syntax objects for an IPv6 address shall be as if the referenced packet classifier parameter is not present. Expires May 2002 [Page 13] INTERNET-DRAFTNovember 2001 2.2.2 docsQosParamSetTable The docsQosParamSetTable reports the values of Qos Parameter Set as defined in Section C.2.2 of [16]. In general, a Service Flow is associated with three different Qos Parameter Sets (QPSs): an "active" QPS, an "admitted" QPS, and a "provisioned" or "authorized" QPS. The relationship of these three sets is represented below: +---------------------+ | Provisioned | | | | +---------------+ | | | Admitted | | | | | | | | +---------+ | | | | | Active | | | | | | | | | | | +---------+ | | | | | | | +---------------+ | | | +---------------------+ Figure 1: Qos Parameter Sets The Provisioned QPS describes the maximum service envelope for which the SF is authorized. The Admitted QPS is the set of services for which a service flow has requested admission to the DOCSIS RF network, but which is not yet active. The Admitted QPS is used during the two-phase process of IP Telephony service flow admission to admit the bandwidth for a bidirectional voice call when the far end is ringing. Since ringing may occur for up to four minutes, this permits the bandwidth to be reserved but not actually consumed during this interval. The Active QPS is the set of services actually being used by the Service Flow. The DOCSIS v1.1 specification [16] defines what it means for a QPS envelope to be "within" another. In general, an inner QPS is considered to be "within" an outer QPS when all QOS parameters represent demands of equal or fewer resources of the network. In addition to their use as attributes of a Service Flow, a QPS is also an attribute of a Service Class. A DOCSIS CM configuration file or DSA message may request the creation of a new SF and give only the Expires May 2002 [Page 14] INTERNET-DRAFTNovember 2001 Service Class Name. The CMTS "expands the macro" of a Service Class Name creation by populating the Provisioned, Admitted, and/or Active QPSs of the Service Flow with the QPS of the Service Class Name. All of the QPSs of a Service Flow must be expansions of the same Service Class, and in this case the SF is said to "belong" to the Service Class. Changing the contents of a Service Class' QPS does not affect the QPS of any Service Flow earlier expanded from that Service Class name. Only the CMTS implements docsQosServiceClassTable. See [16] section 8 for a full description and the theory of operation of Docsis 1.1 QOS operation. The docsQosParamSetTable sets are indexed by { ifIndex, docsQosServiceFlowId, docsQosParamSetType}. ifIndex indicates a particular "DOCSIS MAC Domain". docsQosServiceFlowId uniquely identifies a service flow on that MAC domain. The docsQosParamSetType indicates whether the row describes an active, admitted, or provisioned Qos Parameter Set. The docsQosParamSetTable is read-only, because it indicates the Qos Parameter Set contents as defined by DOCSIS signaling. The docsQosServiceClassTable is read-create to permit managers to define a template of Qos Parameters that can be referenced by DOCSIS modems when creating their Qos Parameter Sets. 2.2.2.1 Interoperation_with_DOCSIS_1.0 The DOCSIS 1.0 DOCS-IF-MIB [22] specifies a docsIfQosProfileTable to describe the set of Class Of Service (COS) parameters associated with a COS "profile". The docsIfCmServiceTable, which contains one entry per SID, references this table with a docsIfCmServiceQosProfile number. The DOCSIS 1.1 CM registration process allows a modem to register as operating either with DOCSIS 1.0 or DOCSIS 1.1 functionality. For ease of expression, we call a modem registering with DOCSIS 1.0 functionality a "DOCSIS 1.0 modem", regardless of the modem's capabilities. A CMTS or CM supporting both DOCSIS 1.0 and DOCSIS 1.1 implements both the tables of [22] and the tables of this MIB. The interoperation goal is that before modem registration, the DOCSIS 1.0 MIB [22] applies. After registration, either the DOCSIS 1.0 or DOCSIS 1.1 MIB applies, depending on the mode with which the modem registered. The specific interoperation rules are: Expires May 2002 [Page 15] INTERNET-DRAFTNovember 2001 1. When a CM initially ranges, both the CM and CMTS implement a row in DOCS-IF-MIB docsIfCmServiceTable corresponding to the default upstream Service ID (SID) used for pre-registration upstream traffic. For historical compatibility a row may be created for the docsIfQosProfileTable with default values, which may be referenced by the docsIfCmServiceTable entries. 2. Both a CMTS and CM implementing this MIB MUST NOT implement docsQosParamSetTable or docsQosServiceFlowTable rows until after the CM registers with DOCSIS 1.1 modem operation. 3. When a modem registers with the CMTS as a "DOCSIS 1.1" modem, any exclusively-referenced row in DOCS-IF-MIB docsQosProfileTable representing the modems upstream Qos profile for pre-registration traffic MUST be removed. Multiply-referenced rows may remain. The docsQosIfCmServiceQosProfile object in the CM's row of docsIfCmServiceTable MUST be set to zero. The docsIfCmServiceTable row for the DOCSIS 1.1 modem continues to exist, and the various statistic objects in that row are incremented. 4. When a DOCSIS 1.1 modem registers, both the CMTS and CM represent all service flows described in the modem configuration file in docsQosParamSetTable and docsQosServiceFlowTable. 5. At the CMTS, the Docsis 1.0 MIB objects docsIfCmtsServiceInPackets and docsIfCmtsServiceInOctets for a SID assigned to a Docsis 1.1 modem count only the pre- registration packets/bytes of those modems. 6. DOCSIS 1.0 modems do not have entries in the DOCS-QOS-MIB. 2.2.3 docsQosServiceFlowTable The docsQosServiceFlowTable provides read-only information about all of the service flows known by the device. It is indexed by the combination of { ifIndex, dosQosServiceFlowId }, where ifIndex corresponds to a CATV MAC interface and docsQosServiceFlowId is the 32- bit integer assigned by the CMTS controlling the MAC domain. A CM typically has only a single CATV MAC interface, while a CMTS may have several. See [22] for a description of the ifIndex numbering for DOCSIS devices. Expires May 2002 [Page 16] INTERNET-DRAFTNovember 2001 The table indicates whether a given SF is in the upstream or downstream direction, and whether it is the "primary" SF in that direction. The primary SF carries traffic that is not otherwise classified to any other SF in that direction. 2.2.4 docsQosServiceFlowStatsTable The docsQosServiceFlowStatsTable provides statistics for all currently existing SFs known by the managed device. It provides basic packet and octet counters, as well as certain other SF-specific stats such as the time at which the flow was created and how many seconds it has been active. The table also provides objects which can be used to fine-tune admission control decisions, namely the number of packets dropped or delayed due to QOS policing decisions enforced by the managed device. 2.2.5 docsQosUpstreamStatsTable This table provides statistics that are measured only at the CMTS in the upstream direction. These include a count of the number of fragmentation headers received, fragments discarded, and the number of concatenation headers received. 2.2.6 docsQosDynamicServiceStatsTable This table provides read-only stats on the operation of the Dynamic Service state machines as specified in section 9.4 of [16]. It provides a set of 14 counters *in each direction* for a Docsis MAC layer interface. That is, each Docsis MAC layer interface has one row for downstream stats, and a second row for upstream stats. Eight of the counters are DSx packet type counts, one counter for each of the eight DSx packet types. For example, the docsQosDSAReqs object in the upstream row at the CMTS counts the number of DSA-REQ messages received by the CMTS from that interface. The docsQosDSAReqs object in the downstream row at the CMTS counts the number of DSA-REQ messages transmitted by the CMTS on that interface. The remaining six counters per (interface, direction) combination count the number of successful and unsuccessful *transactions* that were initiated on the interface and direction. For example, the upstream docsQosDynamicAdds on a CMTS is the number of successfully completed CM-initiated dynamic additions, because at the CMTS a CM- initiated DSA starts in the upstream direction. The downstream docsQosDynamicAdds at a CMTS is the number of successful CMTS- initiated DSA transactions. Expires May 2002 [Page 17] INTERNET-DRAFTNovember 2001 Dynamic service transactions can fail for a number of reasons, as listed in the state machines of section 9.4. Rather than include still more counters for each different failure reason, they are grouped into a single count, e.g docsQosDynamicAddFails. Again, this object exists in both directions, so that locally originated vs remotely originated transaction failures are counted separately. Further troubleshooting of transaction failures will require vendor- specific queries and operation. 2.2.7 docsQosServiceFlowLogTable This table contains a log of the Service Flows no longer existing in the docsQosServiceFlowTable. It is intended to be periodically polled by traffic monitoring and billing agents. It is implemented only at the CMTS. It contains a chronological log of SF session statistics, including a total count of packets and octets transferred on the SF. It includes time stamps of the SF creation and deletion time, as well as its number of active seconds. The active second count is the count of seconds that the SF had a non-empty Active Qos Parameter Set, i.e. it was eligible to pass data. For unicast SFs, it includes the CM MAC address associated with the flow for billing reference purposes. The maximum number of log records kept by a CMTS, and the duration that a log record is maintained in the table is vendor-specific. An explicit control object is provided so that the monitoring application can explicitly delete records it has read. 2.2.8 docsQosServiceClassTable This table defines the Service Class Name and references a Qos Parameter Set for each Service Class defined in a CMTS. It is indexed by the Service Class Name string itself. The table is read- create on a CMTS, and is not implemented in a CM. Each entry of the docsQosServiceClassTable should define a template for flows in a given direction (upstream or downstream). Some parameters of the docsQosServiceClassTable are specific to a particular direction, and so their values are not-applicable when used as a template for flows in the other direction. 2.2.9 docsQosServiceClassPolicyTable The docsQosServiceClassPolicyTable can be referenced by the docsDevFilterPolicyTable of [21] in order to have a "policy" that classifies packets to a named Service Class. This is one mechanism by Expires May 2002 [Page 18] INTERNET-DRAFTNovember 2001 which "external" entities (like an SNMP manager) may control the classification of packet for QOS purposes. Entries are indexed by a small integer docsQosServiceClassPolicyIndex. They provide a Service Class Name and a Rule Priority. A policy referencing a row of this table intends the packet to be forwarded on a Service Flow "belonging" to the named Service Class. See the section "Externally Administered Classification", below. This table is implemented on both the CM and CMTS, and is read-create on both. 2.2.10 docsQosPHSTable The Payload Header Suppression (PHS) feature of DOCSIS 1.1 permits packets to replace the unchanging bytes of the Ethernet, IP, and UDP headers with a one-byte index when transmitting on the cable network. This is especially useful for IP Telephony packets, where such suppression can result in almost twice the number of calls supported within the same upstream channel. Each entry of the table corresponds to a PHS Rule as described in section 8.4 of [16]. The rules are identified by their corresponding service flow ID and docsQosPktClassId. A PHS rule is associated with exactly one classifier. The table is therefore indexed by the tuple { ifIndex, docsQosServiceFlowId, docsQosPktClassId}. This table is read-only, and MUST be implemented on both the CM and CMTS when PHS is supported. 2.2.11 docsQosCmtsMacToSrvFlowTable The docsQosCmtsMacToSrvFlowTable provides describes the mapping of CM mac addresses to the Service Flow Ids that are uniquely identified with that CM. External applications may collect statistics on all packets flowing through a CM by determining the SFID of all of its flows, and then collecting the statistics of packets and bytes for each flow. Downstream multicast service flows are not indicated in the docsQosCmtsMacToSrvFlowTable because they are not associated with only one CM. Expires May 2002 [Page 19] INTERNET-DRAFTNovember 2001 3. Externally Administered Classification Docsis 1.1 provides rich semantics for the classification of packets to service flows with it Service Flow Classifier table. Service Flow Classifiers may be created statically in the DOCSIS CM configuration file, or may be created dynamically with Dynamic Service Addition (DSA) and Dynamic Service Change (DSC) DOCSIS MAC messages. Several major issues arose with the concept of externally administered classification, i.e. should an external SNMP manager be permitted to create classification rows? One problem was the co- ordination of classifier IDs, since such an approach would require either separate classifier ID number spaces or objects to co-ordinate both internal and external classifier ID assignments. A more serious problem, however, was the requirement that external creation of SF Classifiers would require "knowledge" of the individual Service Flow ID for service flows by external applications. It was strongly felt by the committee that SFIDs should remain an internal Docsis object, and not be transmitted as part of protocol flows, e.g. for IP packet telephony signaling. Docsis 1.1 introduced the concept of named Service Classes for ease of administration within a domain of CMs and CMTSs. What was desired was to permit external classification of packets to a Service Class, not a particular Service Flow. The DOCSIS committee therefore decided to use the already-defined IP Packet Filter Table [21] for the external classification of packets for QOS purposes. The docsDevIpPacketFilterTable defines similar packet matching criteria as docsQosPktClassTable, but it matches a packet to an arbitrary "policy set" instead of a particular Service Flow. One of the policies in the policy set then selects the Service Class of the SF on which to forward the packet. The docsQosServiceClassPolicyTable of this MIB defines the Service Class Name to which a packet is classified. Expires May 2002 [Page 20] INTERNET-DRAFTNovember 2001 The interaction of external and internal packet classification is depicted below. | | Outbound Pkt V docsDevIpFilterTable------> docsDevFilterPolicyTable | | | V | docsQosServiceClassPolicyTable | | | Pkt | ServiceClassName, | | ServiceClassPolicyRulePriority V V +--------------------------------------------------------+ | | DOCSIS MAC LAYER ENTITY | | | | | Select any | | V | SFID Y in SCN| | docsQosPktClassTable <---------------| | | | | | | | docsQosPktClassPriority, | | | | SFID X | | | V V | | ----------------------------------------+ | | | Select the SFID associated with the | | | | higher of docsQosPktClassPriority or | | | | docsQosServiceClassPolicyRulePriority | | | +---------------------------------------+ | | | | | V | | | | | | | | | | ... | | Service Flows | | +----+ +----+ | | SFID X SFID Y | +--------------------------------------------------------+ Figure 2: Docsis Packet Classification The processing of an outgoing packet proceeds as follows: 1. The packet is first checked for matches with rows of the docsDevIpFilterTable. If it matches, the matching row provides a docsDevFilterPolicyId integer. 2. The docsDevFilterPolicyId indexes into one (or more) rows of docsDevFilterPolicyTable. Each row provides an arbitrary RowPointer (docsDevFilterPolicyPtr), Expires May 2002 [Page 21] INTERNET-DRAFTNovember 2001 corresponding to a policy to be applied to the packet. 3. This MIB defines a docsQosServiceClassPolicyTable whose entries may be pointed to by docsDevFilterPolicyPtr in order to administratively classify packets to a named DOCSIS Service Class. The docsQosServiceClassPolicyEntry provides a Service Class Name (SCN) as docsQosServiceClassPolicyName and a classification rule priority as docsQosServiceClassPolicyRulePriority. These are submitted to the device's Docsis MAC Layer entity as a special form of the MAC_DATA.request primitive, as described in Section E.2.1 of [16]. 4. The MAC Layer selects an SFID ("Y") of an active Service Flow belonging to the named class, choosing an SF arbitrarily if there is more than one. 5. The packet is then classified according to the docsQosPktClassTable, which may classify the packet to a different SFID "X". Associated with the classifier is a docsQosPktClassPriority. 6. In the event of a conflict between the SCN-determined SFID and the classified SFID, the greater of docsQosPktClassPriority and docsQosServiceClassPolicyRulePriority determines which SFID is selected to forward the packet. A packet which does not match a docsQosServiceClassPolicyEntry is directly submitted to the Docsis MAC layer, where the docsQosPktClassTable selects the SID on which it is to be forwarded. By convention (in [16]), the "internal" docsQosPktClassPriority values should be in the range of 64-191, while the "external" priorities may be either in the range 192-255 to override the internal classification or the range 0-63 to be overridden by internal classification. This classification mechanism applies both upstream from the CM and downstream from the CMTS. Expires May 2002 [Page 22] INTERNET-DRAFTNovember 2001 4. Definitions -- -- Docsis QOS Extensions MIB -- DOCS-QOS-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, Integer32, Counter32, IpAddress, Unsigned32 FROM SNMPv2-SMI TEXTUAL-CONVENTION, MacAddress, RowStatus, TruthValue, DisplayString, TimeStamp FROM SNMPv2-TC OBJECT-GROUP, MODULE-COMPLIANCE FROM SNMPv2-CONF ifIndex, InterfaceIndex FROM IF-MIB docsIfMib FROM DOCS-IF-MIB InetAddressType, InetAddress FROM INET-ADDRESS-MIB; docsQosMIB MODULE-IDENTITY LAST-UPDATED "200111090000Z" -- November 9, 2001 ORGANIZATION "IETF IPCDN Working Group" CONTACT-INFO " Co-Author: Michael Patrick Postal: Motorola ISG 20 Cabot Blvd, MS M4-30 Mansfield, MA 02048-1193 U.S.A. Phone: +1 508 261 5707 Expires May 2002 [Page 23] INTERNET-DRAFTNovember 2001 E-mail: michael.patrick@motorola.com Co-Author: William Murwin Postal: Motorola BCS 20 Cabot Blvd, MS M4-25 Mansfield, MA 02048-1193 U.S.A. Phone: +1 508 261 5578 E-mail: w.murwin@motorola.com" DESCRIPTION "This is the management information for Quality Of Service (QOS) for DOCSIS 1.1." REVISION "200111090000Z" -- November 9, 2001 DESCRIPTION "Published as draft-ietf-ipcdn-qos-mib-06.txt. Changes from qos-mib-05 include: -Deprecated objects that were of type IpAddress and added new objects that were of type InetAddressType and InetAddress, to support both IPv4 and IPv6 in the docsQosPktClassTable. -Clarified the default value of the docsQosPktClassIpDestMask and docsQosPktClassIpSourceMask. -Corrected the description of the individual bits that make up the docsQosParamsSetRequestPolicyOct. -Corrected the spelling of docsCableMaclayer in the description of the docsQosServiceFlowLogIfIndex. -Clarified that some of counters from the docsQosDynamicServiceStatsTable, include retries. -Changed references to the latest Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification. -Added objects that were removed from earlier revisions of the mib, as obsolete. -Clarified the Cable Modem's implementation of the docsQosParamSetTosAndMask. -Change the description of objects within the docsQosServiceClassTable, so that they were no longer templates for obsolete objects. " ::= { docsIfMib 7 } -- BPIPlus mib is docsIfMIb 6 docsQosMIBObjects OBJECT IDENTIFIER ::= { docsQosMIB 1 } -- Textual Conventions IfDirection ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "Indicates a direction on an RF MAC interface. Expires May 2002 [Page 24] INTERNET-DRAFTNovember 2001 The value downstream(1) is from Cable Modem Termination System to Cable Modem. The value upstream(2) is from Cable Modem to Cable Modem Termination System." SYNTAX INTEGER { downstream(1), upstream(2) } BitRate ::= TEXTUAL-CONVENTION DISPLAY-HINT "d" STATUS current DESCRIPTION "The rate of traffic in unit of bits per second. Used to specify traffic rate for QOS." SYNTAX Unsigned32 SchedulingType ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "The scheduling service provided by a CMTS for an upstream service flow. If the parameter is omitted from an upstream QOS Parameter Set, this object takes the value of bestEffort (2). This parameter must be reported as undefined (1) for downstream QOS Parameter Sets." SYNTAX INTEGER { undefined (1), bestEffort (2), nonRealTimePollingService(3), realTimePollingService(4), unsolictedGrantServiceWithAD(5), unsolictedGrantService(6) } ----------------------------------------------------------------------- -- -- Packet Classifier Table -- docsQosPktClassTable OBJECT-TYPE SYNTAX SEQUENCE OF DocsQosPktClassEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table describes the packet classification configured on the CM or CMTS. The model is that a packet either received as input from an interface or transmitted for output on an interface may be compared against an ordered list of rules pertaining to the packet contents. Each rule is a row of this table. A matching rule provides a service flow id to to which the packet is classified. Expires May 2002 [Page 25] INTERNET-DRAFTNovember 2001 All rules need to match for a packet to match a classifier. The objects in this row correspond to a set of Classifier Encoding parameters in a DOCSIS MAC management message. The docsQosPktClassBitMap indicates which particular parameters were present in the classifier as signaled in the DOCSIS message. If the referenced parameter was not present in the signaled DOCSIS 1.1 Classifier, the corresponding object in this row reports a value as specified in the DESCRIPTION section. " ::= { docsQosMIBObjects 1 } docsQosPktClassEntry OBJECT-TYPE SYNTAX DocsQosPktClassEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "An entry in this table provides a single packet classifier rule. The index ifIndex is an ifType of docsCableMaclayer(127)." INDEX { ifIndex, docsQosServiceFlowId, docsQosPktClassId } ::= { docsQosPktClassTable 1 } DocsQosPktClassEntry ::= SEQUENCE { docsQosPktClassId Integer32, docsQosPktClassDirection IfDirection, docsQosPktClassPriority Integer32, docsQosPktClassIpTosLow OCTET STRING, docsQosPktClassIpTosHigh OCTET STRING, docsQosPktClassIpTosMask OCTET STRING, docsQosPktClassIpProtocol Integer32, docsQosPktClassIpSourceAddr IpAddress, docsQosPktClassIpSourceMask IpAddress, docsQosPktClassIpDestAddr IpAddress, docsQosPktClassIpDestMask IpAddress, docsQosPktClassSourcePortStart Integer32, docsQosPktClassSourcePortEnd Integer32, docsQosPktClassDestPortStart Integer32, docsQosPktClassDestPortEnd Integer32, docsQosPktClassDestMacAddr MacAddress, docsQosPktClassDestMacMask MacAddress, docsQosPktClassSourceMacAddr MacAddress, Expires May 2002 [Page 26] INTERNET-DRAFTNovember 2001 docsQosPktClassEnetProtocolType INTEGER, docsQosPktClassEnetProtocol Integer32, docsQosPktClassUserPriApplies TruthValue, docsQosPktClassUserPriLow Integer32, docsQosPktClassUserPriHigh Integer32, docsQosPktClassVlanId Integer32, docsQosPktClassState INTEGER, docsQosPktClassPkts Counter32, docsQosPktClassBitMap BITS, docsQosPktClassInetSourceAddrType InetAddressType, docsQosPktClassInetSourceAddr InetAddress, docsQosPktClassInetSourceMaskType InetAddressType, docsQosPktClassInetSourceMask InetAddress, docsQosPktClassInetDestAddrType InetAddressType, docsQosPktClassInetDestAddr InetAddress, docsQosPktClassInetDestMaskType InetAddressType, docsQosPktClassInetDestMask InetAddress } docsQosPktClassId OBJECT-TYPE SYNTAX Integer32 (1..65535) MAX-ACCESS not-accessible STATUS current DESCRIPTION "Index assigned to packet classifier entry by the CMTS which is unique per service flow." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.3.2" ::= { docsQosPktClassEntry 1 } docsQosPktClassDirection OBJECT-TYPE SYNTAX IfDirection MAX-ACCESS read-only STATUS current DESCRIPTION "Indicates the direction to which the classifier is applied." ::= { docsQosPktClassEntry 2 } docsQosPktClassPriority OBJECT-TYPE SYNTAX Integer32 (0..255) MAX-ACCESS read-only STATUS current DESCRIPTION "The value specifies the order of evaluation of the classifiers. The higher the value the higher the priority. The value of 0 is used as default in provisioned service flows classifiers. The default value of 64 is used for dynamic service flow classifiers. If the referenced parameter is not present in a classifier, this object reports the default value as defined above." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.3.5" Expires May 2002 [Page 27] INTERNET-DRAFTNovember 2001 ::= { docsQosPktClassEntry 3 } docsQosPktClassIpTosLow OBJECT-TYPE SYNTAX OCTET STRING (SIZE(1)) MAX-ACCESS read-only STATUS current DESCRIPTION "The low value of a range of TOS byte values. If the referenced parameter is not present in a classifier, this object reports the value of 0." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.1" ::= { docsQosPktClassEntry 4 } docsQosPktClassIpTosHigh OBJECT-TYPE SYNTAX OCTET STRING (SIZE(1)) MAX-ACCESS read-only STATUS current DESCRIPTION "The 8-bit high value of a range of TOS byte values. If the referenced parameter is not present in a classifier, this object reports the value of 0." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.1" ::= { docsQosPktClassEntry 5 } docsQosPktClassIpTosMask OBJECT-TYPE SYNTAX OCTET STRING (SIZE(1)) MAX-ACCESS read-only STATUS current DESCRIPTION "The mask value is bitwise ANDed with TOS byte in an IP packet and this value is used check range checking of TosLow and TosHigh. If the referenced parameter is not present in a classifier, this object reports the value of 0." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.1" ::= { docsQosPktClassEntry 6 } docsQosPktClassIpProtocol OBJECT-TYPE SYNTAX Integer32 (0..258) MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates the value of the IP Protocol field required for IP packets to match this rule. The value 256 matches traffic with any IP Protocol value. The value 257 by convention matches both TCP and UDP. If the referenced parameter is not present in a classifier, this object reports the value of 258." Expires May 2002 [Page 28] INTERNET-DRAFTNovember 2001 REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.2" ::= { docsQosPktClassEntry 7 } docsQosPktClassIpSourceAddr OBJECT-TYPE SYNTAX IpAddress MAX-ACCESS read-only STATUS deprecated DESCRIPTION "This object is deprecated in favor of the object pair docsQosPktClassInetSourceAddrType and docsQosPktClassInetSourceAddr. Agents that choose to implement this object MUST report an address that matches docsQosPktClassInetSourceAddr object as long as docsQosPktClassInetSourceAddrType is ipv4(1). Otherwise, the value of this object shall be 0.0.0.0." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.3" ::= { docsQosPktClassEntry 8 } docsQosPktClassIpSourceMask OBJECT-TYPE SYNTAX IpAddress MAX-ACCESS read-only STATUS deprecated DESCRIPTION "This object is deprecated in favor of the object pair docsQosPktClassInetSourceMaskType and docsQosPktClassInetSourceMask. Agents that choose to implement this object MUST report an address that matches docsQosPktClassInetSourceMask object as long as docsQosPktClassInetSourceMaskType is ipv4(1). Otherwise, the value of this object shall be 255.255.255.255. SNMP mangers should note that agent implementation of previous versions of this MIB report 0.0.0.0 as the value when the reference parameter is not present, rather than 255.255.255.255." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.4" ::= { docsQosPktClassEntry 9 } docsQosPktClassIpDestAddr OBJECT-TYPE SYNTAX IpAddress MAX-ACCESS read-only STATUS deprecated DESCRIPTION "This object is deprecated in favor of the object pair docsQosPktClassInetDestAddrType and docsQosPktClassInetDestAddr. Agents that choose to implement this object MUST report an address that matches docsQosPktClassInetDestAddr object as long as docsQosPktClassInetDestAddrType is ipv4(1). Otherwise, the value of this object shall be 0.0.0.0." Expires May 2002 [Page 29] INTERNET-DRAFTNovember 2001 REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.5" ::= { docsQosPktClassEntry 10 } docsQosPktClassIpDestMask OBJECT-TYPE SYNTAX IpAddress MAX-ACCESS read-only STATUS deprecated DESCRIPTION "This object is deprecated in favor of the object pair docsQosPktClassInetDestMaskType and docsQosPktClassInetDestMask. Agents that choose to implement this object MUST report an address that matches docsQosPktClassInetDestMask object as long as docsQosPktClassInetDestMaskType is ipv4(1). Otherwise, the value of this object shall be 255.255.255.255. SNMP mangers should note that agent implementation of previous versions of this MIB report 0.0.0.0 as the value when the reference parameter is not present, rather than 255.255.255.255." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.6" ::= { docsQosPktClassEntry 11} docsQosPktClassSourcePortStart OBJECT-TYPE SYNTAX Integer32 (0..65535) MAX-ACCESS read-only STATUS current DESCRIPTION "This object specifies the low end inclusive range of TCP/UDP source port numbers to which a packet is compared. This object is irrelevant for non-TCP/UDP IP packets. If the referenced parameter is not present in a classifier, this object reports the value of 0." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.7" ::= { docsQosPktClassEntry 12 } docsQosPktClassSourcePortEnd OBJECT-TYPE SYNTAX Integer32 (0..65535) MAX-ACCESS read-only STATUS current DESCRIPTION "This object specifies the high end inclusive range of TCP/UDP source port numbers to which a packet is compared. This object is irrelevant for non-TCP/UDP IP packets. If the referenced parameter is not present in a classifier, this object reports the value of 65535." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.8" ::= { docsQosPktClassEntry 13 } Expires May 2002 [Page 30] INTERNET-DRAFTNovember 2001 docsQosPktClassDestPortStart OBJECT-TYPE SYNTAX Integer32 (0..65535) MAX-ACCESS read-only STATUS current DESCRIPTION "This object specifies the low end inclusive range of TCP/UDP destination port numbers to which a packet is compared. If the referenced parameter is not present in a classifier, this object reports the value of 0." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.9" ::= { docsQosPktClassEntry 14 } docsQosPktClassDestPortEnd OBJECT-TYPE SYNTAX Integer32 (0..65535) MAX-ACCESS read-only STATUS current DESCRIPTION "This object specifies the high end inclusive range of TCP/UDP destination port numbers to which a packet is compared. If the referenced parameter is not present in a classifier, this object reports the value of 65535." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.10" ::= { docsQosPktClassEntry 15 } docsQosPktClassDestMacAddr OBJECT-TYPE SYNTAX MacAddress MAX-ACCESS read-only STATUS current DESCRIPTION "An Ethernet packet matches an entry when its destination MAC address bitwise ANDed with docsQosPktClassDestMacMask equals the value of docsQosPktClassDestMacAddr. If the referenced parameter is not present in a classifier, this object reports the value of '000000000000'H. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.6.1" ::= { docsQosPktClassEntry 16 } docsQosPktClassDestMacMask OBJECT-TYPE SYNTAX MacAddress MAX-ACCESS read-only STATUS current DESCRIPTION "An Ethernet packet matches an entry when its destination MAC address bitwise ANDed with docsQosPktClassDestMacMask equals the value of Expires May 2002 [Page 31] INTERNET-DRAFTNovember 2001 docsQosPktClassDestMacAddr. If the referenced parameter is not present in a classifier, this object reports the value of '000000000000'H. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.6.1" ::= { docsQosPktClassEntry 17 } docsQosPktClassSourceMacAddr OBJECT-TYPE SYNTAX MacAddress MAX-ACCESS read-only STATUS current DESCRIPTION "An Ethernet packet matches this entry when its source MAC address equals the value of this object. If the referenced parameter is not present in a classifier, this object reports the value of 'FFFFFFFFFFFF'H. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.6.2" ::= { docsQosPktClassEntry 18 } docsQosPktClassEnetProtocolType OBJECT-TYPE SYNTAX INTEGER { none(0), ethertype(1), dsap(2), mac(3), all(4) } MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates the format of the layer 3 protocol id in the Ethernet packet. A value of none(0) means that the rule does not use the layer 3 protocol type as a matching criteria. A value of ethertype(1) means that the rule applies only to frames which contains an EtherType value. Ethertype values are contained in packets using the Dec-Intel-Xerox (DIX) encapsulation or the RFC1042 Sub-Network Access Protocol (SNAP) encapsulation formats. A value of dsap(2) means that the rule applies only to frames using the IEEE802.3 encapsulation format with a Destination Service Access Point (DSAP) other than 0xAA (which is reserved for SNAP). Expires May 2002 [Page 32] INTERNET-DRAFTNovember 2001 A value of mac(3) means that the rule applies only to MAC management messages for MAC management messages. A value of all(4) means that the rule matches all Ethernet packets. If the Ethernet frame contains an 802.1P/Q Tag header (i.e. EtherType 0x8100), this object applies to the embedded EtherType field within the 802.1P/Q header. If the referenced parameter is not present in a classifier, this object reports the value of 0. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.6.3" ::= { docsQosPktClassEntry 19 } docsQosPktClassEnetProtocol OBJECT-TYPE SYNTAX Integer32 (0..65535) MAX-ACCESS read-only STATUS current DESCRIPTION "If docsQosEthPktClassProtocolType is none(0), this object is ignored when considering whether a packet matches the current rule. If dosQosPktClassEnetProtocolType is ethertype(1), this object gives the 16-bit value of the EtherType that the packet must match in order to match the rule. If docsQosPktClassEnetProtocolType is dsap(2), the lower 8 bits of this object's value must match the DSAP byte of the packet in order to match the rule. If docsQosPktClassEnetProtocolType is mac(3), the lower 8 bits of this object value represent a lower bound (inclusive) of MAC management message type codes matched, and the upper 8 bits of this object value represent the upper bound (inclusive) of matched MAC message type codes. Certain message type codes are excluded from matching, as specified in the reference. If the Ethernet frame contains an 802.1P/Q Tag header (i.e. EtherType 0x8100), this object applies to the embedded EtherType field within the 802.1P/Q header. If the referenced parameter is not present in the Expires May 2002 [Page 33] INTERNET-DRAFTNovember 2001 classifier, the value of this object is reported as 0. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.6.3" ::= { docsQosPktClassEntry 20 } docsQosPktClassUserPriApplies OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-only STATUS obsolete DESCRIPTION "This object is obsolete." ::= { docsQosPktClassEntry 21 } docsQosPktClassUserPriLow OBJECT-TYPE SYNTAX Integer32 (0..7) MAX-ACCESS read-only STATUS current DESCRIPTION "This object applies only to Ethernet frames using the 802.1P/Q tag header (indicated with EtherType 0x8100). Such frames include a 16-bit Tag that contains a 3 bit Priority field and a 12 bit VLAN number. Tagged Ethernet packets must have a 3-bit Priority field within the range of docsQosPktClassPriLow and docsQosPktClassPriHigh in order to match this rule. If the referenced parameter is not present in the classifier, the value of this object is reported as 0. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.7.1" ::= { docsQosPktClassEntry 22 } docsQosPktClassUserPriHigh OBJECT-TYPE SYNTAX Integer32 (0..7) MAX-ACCESS read-only STATUS current DESCRIPTION "This object applies only to Ethernet frames using the 802.1P/Qtag header (indicated with EtherType 0x8100). Such frames include a 16-bit Tag that contains a 3 bit Priority field and a 12 bit VLAN number. Tagged Ethernet packets must have a 3-bit Priority field within the range of docsQosPktClassPriLow and docsQosPktClassPriHigh in order to match this rule. If the referenced parameter is not present in the classifier, the value of this object is reported Expires May 2002 [Page 34] INTERNET-DRAFTNovember 2001 as 7. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.7.1" ::= { docsQosPktClassEntry 23 } docsQosPktClassVlanId OBJECT-TYPE SYNTAX Integer32 (0..4095) MAX-ACCESS read-only STATUS current DESCRIPTION "This object applies only to Ethernet frames using the 802.1P/Q tag header. If this object's value is nonzero, tagged packets must have a VLAN Identifier that matches the value in order to match the rule. Only the least significant 12 bits of this object's value are valid. If the referenced parameter is not present in the classifier, the value of this object is reported as 0. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.7.2" ::= { docsQosPktClassEntry 24 } docsQosPktClassState OBJECT-TYPE SYNTAX INTEGER { active(1), inactive(2) } MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates whether or not the classifier is enabled to classify packets to a Service Flow. If the referenced parameter is not present in the classifier, the value of this object is reported as active(1). " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.3.6" ::= { docsQosPktClassEntry 25 } docsQosPktClassPkts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "This object counts the number of packets that have been classified using this entry." ::= { docsQosPktClassEntry 26 } Expires May 2002 [Page 35] INTERNET-DRAFTNovember 2001 docsQosPktClassBitMap OBJECT-TYPE SYNTAX BITS { -- Reference SP-RFIv1.1-I07-010829 rulePriority(0), -- Appendix C.2.1.3.4 activationState(1), -- Appendix C.2.1.3.6 ipTos(2), -- Appendix C.2.1.5.1 ipProtocol(3), -- Appendix C.2.1.5.2 ipSourceAddr(4), -- Appendix C.2.1.5.3 ipSourceMask(5), -- Appendix C.2.1.5.4 ipDestAddr(6), -- Appendix C.2.1.5.5 ipDestMask(7), -- Appendix C.2.1.5.6 sourcePortStart(8), -- Appendix C.2.1.5.7 sourcePortEnd(9), -- Appendix C.2.1.5.8 destPortStart(10), -- Appendix C.2.1.5.9 destPortEnd(11), -- Appendix C.2.1.5.10 destMac(12), -- Appendix C.2.1.6.1 sourceMac(13), -- Appendix C.2.1.6.2 ethertype(14), -- Appendix C.2.1.6.3 userPri(15), -- Appendix C.2.1.7.1 vlanId(16) -- Appendix C.2.1.7.2 } MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates which parameter encodings were actually present in the DOCSIS packet classifier encoding signaled in the DOCSIS message that created or modified the classifier. Note that Dynamic Service Change messages have replace semantics, so that all non-default parameters must be present whether the classifier is being created or changed. A bit of of this object is set to 1 if the parameter indicated by the comment was present in the classifier encoding, and 0 otherwise. Note that BITS are encoded most significant bit first, so that if e.g. bits 6 and 7 are set, this object is encoded as the octet string '030000'H. " ::= { docsQosPktClassEntry 27 } docsQosPktClassInetSourceAddrType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-only STATUS current DESCRIPTION "The type of the internet address for docsQosPktClassInetSourceAddr. This type must be the same as the docsQosPktClassInetSourceMaskType. If the referenced parameter is not present Expires May 2002 [Page 36] INTERNET-DRAFTNovember 2001 in a classifier, this object reports the value of ipv4(1)." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.3" ::= { docsQosPktClassEntry 28 } docsQosPktClassInetSourceAddr OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-only STATUS current DESCRIPTION "This object specifies the value of the IP Source Address required for packets to match this rule. An IP packet matches the rule when the packet ip source address bitwise ANDed with the docsQosPktClassInetSourceMask value equals the docsQosPktClassInetSourceAddr value. If the referenced parameter is not present in a classifier, this object reports the value of '00000000'H." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.3" ::= { docsQosPktClassEntry 29 } docsQosPktClassInetSourceMaskType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-only STATUS current DESCRIPTION "The type of the internet address for docsQosPktClassInetSourceMask. This type must be the same as the docsQosPktClassInetSourceAddrType. If the referenced parameter is not present in a classifier, this object reports the value of ipv4(1)." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.4" ::= { docsQosPktClassEntry 30 } docsQosPktClassInetSourceMask OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-only STATUS current DESCRIPTION "This object specifies which bits of a packet's IP Source Address that are compared to match this rule. An IP packet matches the rule when the packet source address bitwise ANDed with the docsQosPktClassInetSourceMask value equals the docsQosIpPktClassInetSourceAddr value. If the referenced parameter is not present in a classifier, this object reports the value of 'FFFFFFFF'H." Expires May 2002 [Page 37] INTERNET-DRAFTNovember 2001 REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.4" ::= { docsQosPktClassEntry 31 } docsQosPktClassInetDestAddrType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-only STATUS current DESCRIPTION "The type of the internet address for docsQosPktClassInetDestAddr. This type must be the same as the docsQosPktClassInetDestMaskType. If the referenced parameter is not present in a classifier, this object reports the value of ipv4(1)." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.5" ::= { docsQosPktClassEntry 32 } docsQosPktClassInetDestAddr OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-only STATUS current DESCRIPTION "This object specifies the value of the IP Destination Address required for packets to match this rule. An IP packet matches the rule when the packet ip destination address bitwise ANDed with the docsQosPktClassInetDestMask value equals the docsQosPktClassInetDestAddr value. If the referenced parameter is not present in a classifier, this object reports the value of '00000000'H." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.5" ::= { docsQosPktClassEntry 33 } docsQosPktClassInetDestMaskType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-only STATUS current DESCRIPTION "The type of the internet address for docsQosPktClassInetDestMask. This type must be the same as the docsQosPktClassInetDestAddrType. If the referenced parameter is not present in a classifier, this object reports the value of ipv4(1)." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.6" ::= { docsQosPktClassEntry 34 } docsQosPktClassInetDestMask OBJECT-TYPE SYNTAX InetAddress Expires May 2002 [Page 38] INTERNET-DRAFTNovember 2001 MAX-ACCESS read-only STATUS current DESCRIPTION "This object specifies which bits of a packet's IP Destination Address that are compared to match this rule. An IP packet matches the rule when the packet destination address bitwise ANDed with the docsQosPktClassInetDestMask value equals the docsQosIpPktClassInetDestAddr value. If the referenced parameter is not present in a classifier, this object reports the value of 'FFFFFFFF'H." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.6" ::= { docsQosPktClassEntry 35 } -- -- QOS Parameter Set Table -- docsQosParamSetTable OBJECT-TYPE SYNTAX SEQUENCE OF DocsQosParamSetEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table describes the set of DOCSIS 1.1 QOS parameters defined in a managed device. The ifIndex index specifies a DOCSIS MAC Domain. The docsQosServiceFlowId index specifies a particular Service Flow. The docsQosParamSetType index indicates whether the active, admitted, or provisioned QOS Parameter Set is being described by the row. Only the QOS Parameter Sets of Docsis 1.1 service flows are represented in this table. Docsis 1.0 QOS service profiles are not represented in this table. Each row corresponds to a DOCSIS QOS Parameter Set as signaled via DOCSIS MAC management messages. Each object in the row corresponds to one or part of one DOCSIS 1.1 Service Flow Encoding. The docsQosParamSetBitMap object in the row indicates which particular parameters were signaled in the original registration or dynamic service request message that created the QOS Parameter Set. In many cases, even if a QOS Parameter Set parameter was not signaled, the DOCSIS specification calls Expires May 2002 [Page 39] INTERNET-DRAFTNovember 2001 for a default value to be used. That default value is reported as the value of the corresponding object in this row. Many objects are not applicable depending on the service flow direction or upstream scheduling type. The object value reported in this case is specified in the DESCRIPTION clause. " ::= { docsQosMIBObjects 2 } -- docsQosParamSetEntry { docsQosParamSetTable 1 } was -- removed in an initial and unimplemented version of this mib. docsQosParamSetEntry OBJECT-TYPE SYNTAX DocsQosParamSetEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A unique set of QOS parameters." INDEX { ifIndex, docsQosServiceFlowId, docsQosParamSetType } ::= { docsQosParamSetTable 2 } DocsQosParamSetEntry ::= SEQUENCE { docsQosParamSetServiceClassName DisplayString, docsQosParamSetPriority Integer32, docsQosParamSetMaxTrafficRate BitRate, docsQosParamSetMaxTrafficBurst Unsigned32, docsQosParamSetMinReservedRate BitRate, docsQosParamSetMinReservedPkt Integer32, docsQosParamSetActiveTimeout Integer32, docsQosParamSetAdmittedTimeout Integer32, docsQosParamSetMaxConcatBurst Integer32, docsQosParamSetSchedulingType SchedulingType, docsQosParamSetNomPollInterval Unsigned32, docsQosParamSetTolPollJitter Unsigned32, docsQosParamSetUnsolicitGrantSize Integer32, docsQosParamSetNomGrantInterval Unsigned32, docsQosParamSetTolGrantJitter Unsigned32, docsQosParamSetGrantsPerInterval Integer32, docsQosParamSetTosAndMask OCTET STRING, docsQosParamSetTosOrMask OCTET STRING, docsQosParamSetMaxLatency Unsigned32, docsQosParamSetType INTEGER, docsQosParamSetRequestPolicyOct OCTET STRING, docsQosParamSetBitMap BITS } docsQosParamSetServiceClassName OBJECT-TYPE Expires May 2002 [Page 40] INTERNET-DRAFTNovember 2001 SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "Refers to the Service Class Name that the parameter set values were derived. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, the default value of this object is a zero length string. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.3.4" ::= { docsQosParamSetEntry 4 } docsQosParamSetPriority OBJECT-TYPE SYNTAX Integer32 (0..7) MAX-ACCESS read-only STATUS current DESCRIPTION "The relative priority of a service flow. Higher numbers indicate higher priority. This priority should only be used to differentiate service flow with identical parameter sets. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, the default value of this object is 0. If the parameter is not applicable, the reported value is 0. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.5.1" ::= { docsQosParamSetEntry 5 } docsQosParamSetMaxTrafficRate OBJECT-TYPE SYNTAX BitRate MAX-ACCESS read-only STATUS current DESCRIPTION "Maximum sustained traffic rate allowed for this service flow in bits/sec. Must count all MAC frame data PDU from the bytes following the MAC header HCS to the end of the CRC. The number of bytes forwarded is limited during any time interval. The value 0 means no maximum traffic rate is enforced. This object applies to both upstream and downstream service flows. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, the default value of this object is 0. If the parameter is not applicable, it is reported as 0. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.5.2" ::= { docsQosParamSetEntry 6 } Expires May 2002 [Page 41] INTERNET-DRAFTNovember 2001 docsQosParamSetMaxTrafficBurst OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies the token bucket size in bytes for this parameter set. The value is calculated from the byte following the MAC header HCS to the end of the CRC. This object is applied in conjunction with docsQosParamSetMaxTrafficRate to calculate maximum sustained traffic rate. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, the default value of this object for scheduling types bestEffort (2), nonRealTimePollingService(3), and realTimePollingService(4) is 1522. If this parameter is not applicable, it is reported as 0. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.5.3" ::= { docsQosParamSetEntry 7 } docsQosParamSetMinReservedRate OBJECT-TYPE SYNTAX BitRate MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies the guaranteed minimum rate in bits/sec for this parameter set. The value is calculated from the byte following the MAC header HCS to the end of the CRC. The default value of 0 has the meaning that no bandwidth is reserved. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, the default value of this object is 0. If the parameter is not applicable, it is reported as 0. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.5.4" ::= { docsQosParamSetEntry 8 } docsQosParamSetMinReservedPkt OBJECT-TYPE SYNTAX Integer32 (0..65535) MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies an assumed minimum packet size in bytes for which the docsQosParamSetMinReservedRate will be provided. The value is calculated from the byte following the MAC header HCS to the end of the CRC. Expires May 2002 [Page 42] INTERNET-DRAFTNovember 2001 If the referenced parameter is omitted from a DOCSIS QOS parameter set, the default value is CMTS implementation dependent. In this case, the CMTS reports the default value it is using and the CM reports a value of 0. If the referenced parameter is not applicable to the direction or scheduling type of the service flow, both CMTS and CM report this object's value as 0. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.5.5" ::= { docsQosParamSetEntry 9 } docsQosParamSetActiveTimeout OBJECT-TYPE SYNTAX Integer32 (0..65535) UNITS "seconds" MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies the maximum duration in seconds that resources remain unused on an active service flow before CMTS signals that both active and admitted parameters set are null. The default value of 0 signifies an infinite amount of time. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, the default value of this object is 0. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.5.6" ::= { docsQosParamSetEntry 10 } docsQosParamSetAdmittedTimeout OBJECT-TYPE SYNTAX Integer32 (0..65535) UNITS "seconds" MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies the maximum duration in seconds that resources remain in admitted state before resources must be released. The value of 0 signifies an infinite amount of time. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, the default value of this object is 200. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.5.7" DEFVAL { 200 } ::= { docsQosParamSetEntry 11 } Expires May 2002 [Page 43] INTERNET-DRAFTNovember 2001 docsQosParamSetMaxConcatBurst OBJECT-TYPE SYNTAX Integer32 (0..65535) MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies the maximum concatenated burst in bytes which an upstream service flow is allowed. The value is calculated from the FC byte of the Concatenation MAC Header to the last CRC byte in of the last concatenated MAC frame, inclusive. The value of 0 specifies no maximum burst. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, the default value of this object is 0. If the parameter is not applicable, this object's value is reported as 0. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.6.1" ::= { docsQosParamSetEntry 12 } docsQosParamSetSchedulingType OBJECT-TYPE SYNTAX SchedulingType MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies the upstream scheduling service used for upstream service flow. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set of an upstream service flow, the default value of this object is bestEffort(2). For QOS parameter sets of downstream service flows, this object's value is reported as undefined(1). " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.6.2" ::= { docsQosParamSetEntry 13 } docsQosParamSetNomPollInterval OBJECT-TYPE SYNTAX Unsigned32 UNITS "microseconds" MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies the nominal interval in microseconds between successive unicast request opportunities on an upstream service flow. This object applies only to upstream service flows with schedulingType of value nonRealTimePollingService(3), realTimePollingService(4), and Expires May 2002 [Page 44] INTERNET-DRAFTNovember 2001 unsolictedGrantServiceWithAD(5). The parameter is mandatory for realTimePollingService(4). If the parameter is omitted with nonRealTimePollingService(3), the CMTS uses an implementation dependent value. If the parameter is omitted with unsolictedGrantServiceWithAD(5), the CMTS uses as a default value the value of the Nominal Grant Interval parameter. In all cases, the CMTS reports the value it is using when the parameter is applicable. The CM reports the signaled parameter value if it was signaled, and 0 otherwise. If the referenced parameter is not applicable to the direction or scheduling type of the corresponding DOCSIS QOS Parameter Set, both CMTS and CM report this object's value as 0. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.6.4" ::= { docsQosParamSetEntry 15 } docsQosParamSetTolPollJitter OBJECT-TYPE SYNTAX Unsigned32 UNITS "microseconds" MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies the maximum amount of time in microseconds that the unicast request interval may be delayed from the nominal periodic schedule on an upstream service flow. This parameter is applicable only to upstream service flows with a Schedulingtype of realTimePollingService(4) or unsolictedGrantServiceWithAD(5). If the referenced parameter is applicable but not present in the corresponding DOCSIS QOS Parameter Set, the CMTS uses an implementation dependent value and reports the value it is using. The CM reports a value of 0 in this case. If the parameter is not applicable to the direction or upstream scheduling type of the service flow, both CMTS and CM report this object's value as 0. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.6.5" ::= { docsQosParamSetEntry 16 } docsQosParamSetUnsolicitGrantSize OBJECT-TYPE Expires May 2002 [Page 45] INTERNET-DRAFTNovember 2001 SYNTAX Integer32 (0..65535) MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies the unsolicited grant size in bytes. The grant size includes the entire MAC frame data PDU from the Frame Control byte to end of the MAC frame. The referenced parameter is applicable only for upstream flows with a SchedulingType of of unsolicitedGrantServicewithAD(5) or unsolicitedGrantService(6), and is mandatory when applicable. Both CMTS and CM report the signaled value of the parameter in this case. If the referenced parameter is not applicable to the direction or scheduling type of the corresponding DOCSIS QOS Parameter Set, both CMTS and CM report this object's value as 0. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.6.6" ::= { docsQosParamSetEntry 17 } docsQosParamSetNomGrantInterval OBJECT-TYPE SYNTAX Unsigned32 UNITS "microseconds" MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies the nominal interval in microseconds between successive data grant opportunities on an upstream service flow. The referenced parameter is applicable only for upstream flows with a SchedulingType of of unsolicitedGrantServicewithAD(5) or unsolicitedGrantService(6), and is mandatory when applicable. Both CMTS and CM report the signaled value of the parameter in this case. If the referenced parameter is not applicable to the direction or scheduling type of the corresponding DOCSIS QOS Parameter Set, both CMTS and CM report this object's value as 0. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.6.7" ::= { docsQosParamSetEntry 18 } docsQosParamSetTolGrantJitter OBJECT-TYPE SYNTAX Unsigned32 Expires May 2002 [Page 46] INTERNET-DRAFTNovember 2001 UNITS "microseconds" MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies the maximum amount of time in microseconds that the transmission opportunities may be delayed from the nominal periodic schedule. The referenced parameter is applicable only for upstream flows with a SchedulingType of of unsolicitedGrantServicewithAD(5) or unsolicitedGrantService(6), and is mandatory when applicable. Both CMTS and CM report the signaled value of the parameter in this case. If the referenced parameter is not applicable to the direction or scheduling type of the corresponding DOCSIS QOS Parameter Set, both CMTS and CM report this object's value as 0. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.6.8" ::= { docsQosParamSetEntry 19 } docsQosParamSetGrantsPerInterval OBJECT-TYPE SYNTAX Integer32 (0..127) MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies the number of data grants per Nominal Grant Interval (docsQosParamSetNomGrantInterval). The referenced parameter is applicable only for upstream flows with a SchedulingType of of unsolicitedGrantServicewithAD(5) or unsolicitedGrantService(6), and is mandatory when applicable. Both CMTS and CM report the signaled value of the parameter in this case. If the referenced parameter is not applicable to the direction or scheduling type of the corresponding DOCSIS QOS Parameter Set, both CMTS and CM report this object's value as 0. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.6.9" ::= { docsQosParamSetEntry 20 } docsQosParamSetTosAndMask OBJECT-TYPE SYNTAX OCTET STRING (SIZE(1)) MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies the AND mask for IP TOS byte for overwriting Expires May 2002 [Page 47] INTERNET-DRAFTNovember 2001 IP packets TOS value. The IP packets TOS byte is bitwise ANDed with docsQosParamSetTosAndMask and result is bitwise ORed with docsQosParamSetTosORMask and result is written to IP packet TOS byte. A value of 'FF'H for docsQosParamSetTosAndMask and a value of '00'H for docsQosParamSetTosOrMask means that IP Packet TOS byte is not overwritten. Even though the this object is only enforced by the Cable Modem Termination System (CMTS), Cable Modems must report the value as signaled in the referenced parameter. This combination is reported if the referenced parameter is not present in a QOS Parameter Set." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.6.10" ::= { docsQosParamSetEntry 21 } docsQosParamSetTosOrMask OBJECT-TYPE SYNTAX OCTET STRING (SIZE(1)) MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies the OR mask for IP TOS byte. See the description of docsQosParamSetTosAndMask for further details." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.6.10" ::= { docsQosParamSetEntry 22 } docsQosParamSetMaxLatency OBJECT-TYPE SYNTAX Unsigned32 UNITS "microseconds" MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies the maximum latency between the reception of a packet by the CMTS on its NSI and the forwarding of the packet to the RF interface. A value of 0 signifies no maximum latency enforced. This object only applies to downstream service flows. If the referenced parameter is not present in the corresponding downstream DOCSIS QOS Parameter Set, the default value is 0. This parameter is not applicable to upstream DOCSIS QOS Parameter Sets, and its value is reported as 0 in this case. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.7.1" ::= { docsQosParamSetEntry 23 } docsQosParamSetType OBJECT-TYPE Expires May 2002 [Page 48] INTERNET-DRAFTNovember 2001 SYNTAX INTEGER { active (1), admitted (2), provisioned (3) } MAX-ACCESS not-accessible STATUS current DESCRIPTION "Defines the type of the QOS parameter set defined by this row. active(1) indicates the Active QOS parameter set, describing the service currently being provided by the Docsis MAC domain to the service flow. admitted(2) indicates the Admitted QOS Parameter Set, describing services reserved by by the Docsis MAC domain for use by the service flow. provisioned (3) describes the QOS Parameter Set defined in the DOCSIS CM Configuration file for the service flow." REFERENCE "SP-RFIv1.1-I07-010829, 8.1.5" ::= { docsQosParamSetEntry 24 } docsQosParamSetRequestPolicyOct OBJECT-TYPE SYNTAX OCTET STRING (SIZE(4)) -- A 32-bit mask represented most significant byte -- first. The 32 bit integer represented in this manner -- equals the binary value of the referenced integer -- parameter of the DOCSIS RFI specification. -- The BITS syntax is not used in order to avoid -- the confusion caused by different bit numbering -- conventions. MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies which transmit interval opportunities the CM omits for upstream transmission requests and packet transmissions. This object takes its default value for downstream service flows. Unless otherwise indicated, a bit value of 1 means that a CM must *not* use that opportunity for upstream transmission. Calling bit 0 the least significant bit of the least significant (4th) octet, and increasing bit number with significance, the bit definitions are as defined below: broadcastReqOpp(0): all CMs broadcast request opportunities priorityReqMulticastReq(1): priority request multicast request opportunities Expires May 2002 [Page 49] INTERNET-DRAFTNovember 2001 reqDataForReq(2): request/data opportunities for requests reqDataForData(3): request/data opportunities for data piggybackReqWithData(4): piggyback requests with data concatenateData(5): concatenate data fragmentData(6): fragment data suppresspayloadheaders(7): suppress payload headers dropPktsExceedUGSize(8): A value of 1 mean that service flow must drop packet that do not fit in the Unsolicited Grant size If the referenced parameter is not present in a QOS Parameter Set, the value of this object is reported as '00000000'H. " REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.6.3" ::= { docsQosParamSetEntry 25 } docsQosParamSetBitMap OBJECT-TYPE -- Each bit corresponds to a parameter -- from SP-RFI-v1.1-I07-010829, Appendix C SYNTAX BITS { -- in the indicated section number. trafficPriority(0), -- C.2.2.5.1 maxTrafficRate(1), -- C.2.2.5.2 maxTrafficBurst(2), -- C.2.2.5.3 minReservedRate(3), -- C.2.2.5.4 minReservedPkt(4), -- C.2.2.5.5 activeTimeout(5), -- C.2.2.5.6 admittedTimeout(6), -- C.2.2.5.7 maxConcatBurst(7), -- C.2.2.6.1 schedulingType(8), -- C.2.2.6.2 requestPolicy(9), -- C.2.2.6.3 nomPollInterval(10), -- C.2.2.6.4 tolPollJitter(11), -- C.2.2.6.5 unsolicitGrantSize(12), -- C.2.2.6.6 nomGrantInterval(13), -- C.2.2.6.7 tolGrantJitter(14), -- C.2.2.6.8 grantsPerInterval(15), -- C.2.2.6.9 tosOverwrite(16), -- C.2.2.6.10 Expires May 2002 [Page 50] INTERNET-DRAFTNovember 2001 maxLatency(17) -- C.2.2.7.1 } MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates the set of QOS Parameter Set parameters actually signaled in the DOCSIS registration or dynamic service request message that created or modified the QOS Parameter Set. A bit is set to 1 when the parameter described by the indicated reference section is present in the original request. Note that when Service Class names are expanded, the registration or dynamic response message may contain parameters as expanded by the CMTS based on a stored service class. These expanded parameters are *not* indicated by a 1 bit in this object. Note that even though some QOS Parameter Set parameters may not be signaled in a message (so that the paramater's bit in this object is 0) the DOCSIS specification calls for default values to be used. These default values are reported as the corresponding object's value in the row. Note that BITS objects are encoded most significant bit first. For example, if bits 1 and 16 are set, the value of this object is the octet string '400080'H. " ::= { docsQosParamSetEntry 26 } -- -- Service Flow Table -- docsQosServiceFlowTable OBJECT-TYPE SYNTAX SEQUENCE OF DocsQosServiceFlowEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table describes the set of Docsis-QOS Service Flows in a managed device. " ::= { docsQosMIBObjects 3 } docsQosServiceFlowEntry OBJECT-TYPE SYNTAX DocsQosServiceFlowEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Describes a service flow. Expires May 2002 [Page 51] INTERNET-DRAFTNovember 2001 An entry in the table exists for each Service Flow ID. The ifIndex is an ifType of docsCableMaclayer(127)." INDEX { ifIndex, docsQosServiceFlowId } ::= { docsQosServiceFlowTable 1 } DocsQosServiceFlowEntry ::= SEQUENCE { docsQosServiceFlowId Unsigned32, docsQosServiceFlowProvisionedParamSetIndex Unsigned32, docsQosServiceFlowAdmittedParamSetIndex Unsigned32, docsQosServiceFlowActiveParamSetIndex Unsigned32, docsQosServiceFlowSID Unsigned32, docsQosServiceFlowDirection IfDirection, docsQosServiceFlowPrimary TruthValue, docsQosServiceFlowActiveTimeout Integer32, docsQosServiceFlowAdmittedTimeout Integer32, docsQosServiceFlowSchedulingType SchedulingType, docsQosServiceFlowRequestPolicy OCTET STRING (SIZE(4)), docsQosServiceFlowTosAndMask OCTET STRING (SIZE(1)), docsQosServiceFlowTosOrMask OCTET STRING (SIZE(1)) } docsQosServiceFlowId OBJECT-TYPE SYNTAX Unsigned32 (1..4294967295) MAX-ACCESS not-accessible STATUS current DESCRIPTION "An index assigned to a service flow by CMTS." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.3.2" ::= { docsQosServiceFlowEntry 1 } docsQosServiceFlowProvisionedParamSetIndex OBJECT-TYPE SYNTAX Unsigned32 (0..4294967295) MAX-ACCESS read-only STATUS obsolete DESCRIPTION "This object is obsolete." ::= { docsQosServiceFlowEntry 3 } docsQosServiceFlowAdmittedParamSetIndex OBJECT-TYPE SYNTAX Unsigned32 (0..4294967295) MAX-ACCESS read-only STATUS obsolete DESCRIPTION "This object is obsolete." ::= { docsQosServiceFlowEntry 4 } docsQosServiceFlowActiveParamSetIndex OBJECT-TYPE SYNTAX Unsigned32 (0..4294967295) MAX-ACCESS read-only STATUS obsolete Expires May 2002 [Page 52] INTERNET-DRAFTNovember 2001 DESCRIPTION "This object is obsolete." ::= { docsQosServiceFlowEntry 5 } docsQosServiceFlowSID OBJECT-TYPE SYNTAX Unsigned32 (0..16383) MAX-ACCESS read-only STATUS current DESCRIPTION "Service Identifier (SID) assigned to an admitted or active service flow. This object reports a value of 0 if a Service Id is not associated with the service flow. Only active or admitted upstream service flows will have a Service Id (SID)." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.2.3.3" ::= { docsQosServiceFlowEntry 6 } docsQosServiceFlowDirection OBJECT-TYPE SYNTAX IfDirection MAX-ACCESS read-only STATUS current DESCRIPTION "The direction of the service flow." REFERENCE "SP-RFIv1.1-I07-010829, Appendix C.2.1.1/2" ::= { docsQosServiceFlowEntry 7 } docsQosServiceFlowPrimary OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-only STATUS current DESCRIPTION "Object reflects whether service flow is the primary or a secondary service flow. A primary service flow is the default service flow for otherwise unclassified traffic and all MAC messages." REFERENCE "SP-RFIv1.1-I07-010829, Section 8.1 " ::= { docsQosServiceFlowEntry 8 } docsQosServiceFlowActiveTimeout OBJECT-TYPE SYNTAX Integer32 (0..65535) UNITS "seconds" MAX-ACCESS read-only STATUS obsolete DESCRIPTION "This object is obsolete." ::= { docsQosServiceFlowEntry 9 } docsQosServiceFlowAdmittedTimeout OBJECT-TYPE SYNTAX Integer32 (0..65535) UNITS "seconds" MAX-ACCESS read-only STATUS obsolete DESCRIPTION "This object is obsolete." Expires May 2002 [Page 53] INTERNET-DRAFTNovember 2001 ::= { docsQosServiceFlowEntry 10 } docsQosServiceFlowSchedulingType OBJECT-TYPE SYNTAX SchedulingType MAX-ACCESS read-only STATUS obsolete DESCRIPTION "This object is obsolete." ::= { docsQosServiceFlowEntry 11 } docsQosServiceFlowRequestPolicy OBJECT-TYPE SYNTAX OCTET STRING (SIZE(4)) MAX-ACCESS read-only STATUS obsolete DESCRIPTION "This object is obsolete." ::= { docsQosServiceFlowEntry 12 } docsQosServiceFlowTosAndMask OBJECT-TYPE SYNTAX OCTET STRING (SIZE(1)) MAX-ACCESS read-only STATUS obsolete DESCRIPTION "This object is obsolete." ::= { docsQosServiceFlowEntry 13 } docsQosServiceFlowTosOrMask OBJECT-TYPE SYNTAX OCTET STRING (SIZE(1)) MAX-ACCESS read-only STATUS obsolete DESCRIPTION "This object is obsolete." ::= { docsQosServiceFlowEntry 14 } -- -- Service Flow Stats Table -- docsQosServiceFlowStatsTable OBJECT-TYPE SYNTAX SEQUENCE OF DocsQosServiceFlowStatsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table describes statistics associated with the Service Flows in a managed device. " ::= { docsQosMIBObjects 4 } docsQosServiceFlowStatsEntry OBJECT-TYPE SYNTAX DocsQosServiceFlowStatsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Describes a set of service flow statistics. An entry in the table exists for each Service Flow ID. The ifIndex is an ifType of docsCableMaclayer(127)." INDEX { ifIndex, Expires May 2002 [Page 54] INTERNET-DRAFTNovember 2001 docsQosServiceFlowId } ::= { docsQosServiceFlowStatsTable 1 } DocsQosServiceFlowStatsEntry ::= SEQUENCE { docsQosServiceFlowPkts Counter32, docsQosServiceFlowOctets Counter32, docsQosServiceFlowTimeCreated TimeStamp, docsQosServiceFlowTimeActive Counter32, docsQosServiceFlowPHSUnknowns Counter32, docsQosServiceFlowPolicedDropPkts Counter32, docsQosServiceFlowPolicedDelayPkts Counter32 } docsQosServiceFlowPkts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of Packet Data PDUs classified to this service flow. This object does not count MAC-specific management messages. CMs not classifying downstream packets may report this object's value as 0. " ::= { docsQosServiceFlowStatsEntry 1 } docsQosServiceFlowOctets OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of octets transmitted on the Docsis RF network from the byte after the MAC header HCS to the end of the CRC for all packets counted in the docsQosServiceFlowPkts object for this row. Note that this counts the octets after payload header suppression has been applied. CMs not classifying to a downstream service flow may report this object's value as 0 for that flow. " ::= { docsQosServiceFlowStatsEntry 2 } docsQosServiceFlowTimeCreated OBJECT-TYPE SYNTAX TimeStamp MAX-ACCESS read-only STATUS current DESCRIPTION "The value of sysUpTime when the service flow was created." ::= { docsQosServiceFlowStatsEntry 3 } docsQosServiceFlowTimeActive OBJECT-TYPE SYNTAX Counter32 UNITS "seconds" MAX-ACCESS read-only Expires May 2002 [Page 55] INTERNET-DRAFTNovember 2001 STATUS current DESCRIPTION "The total time that service flow has been active." ::= { docsQosServiceFlowStatsEntry 4 } docsQosServiceFlowPHSUnknowns OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of packets received on the service flow with an unknown payload header suppression index." ::= { docsQosServiceFlowStatsEntry 5 } docsQosServiceFlowPolicedDropPkts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of packets dropped due to policing of the service flow, especially to limit the maximum rate of the flow." ::= { docsQosServiceFlowStatsEntry 6 } docsQosServiceFlowPolicedDelayPkts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of packet delayed due to policing of the service flow, especially to limit the maximum rate of the flow." ::= { docsQosServiceFlowStatsEntry 7 } -- -- Upstream Service Flow Stats Table (CMTS ONLY) -- docsQosUpstreamStatsTable OBJECT-TYPE SYNTAX SEQUENCE OF DocsQosUpstreamStatsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table describes statistics associated with upstream service flows. All counted frames must