-- extracted from draft-ietf-ipcdn-qos-mib-02.txt -- at Tue Dec 14 07:07:54 1999 DOCS-QOS-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, Integer32, Counter32, IpAddress, BITS, 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; docsQosMIB MODULE-IDENTITY LAST-UPDATED "9912082046Z" -- Dec 8, 1999 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 E-mail: lzz007@email.mot.com Co-Author: John Harvey Postal: Motorola ING 20 Cabot Blvd, MS M4-25 Mansfield, MA 02048-1193 U.S.A. Phone: +1-508-261-4579 E-mail: ljh031@dma.isg.mot.com" DESCRIPTION "This is the management information for Quality Of Service (QOS) for DOCSIS 1.1." REVISION "9909301705Z" -- Sep 30, 1999 DESCRIPTION "Published as draft-ietf-ipcdn-qos-mib-02.txt. Updated to added docsQosCmtsMacToSrvFlowTable, docsQosServiceFlowStatsTable, docsQosUpstreamStatsTable, docsQosDynamicServiceStatsTable, docsQosServiceFlowLogTable, docsQosPktClassState, conformance statements and fixed syntax errors." ::= { 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. 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 -- -- 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 transmittted 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. All rules need to match for a packet to match a classifier." ::= { 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, docsQosPktClassEnetProtocolType INTEGER, docsQosPktClassEnetProtocol Integer32, docsQosPktClassUserPriApplies TruthValue, docsQosPktClassUserPriLow Integer32, docsQosPktClassUserPriHigh Integer32, docsQosPktClassVlanId Integer32, docsQosPktClassState INTEGER, docsQosPktClassPkts Counter32 } 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 serivce flow." REFERENCE "SP-RFIv1.1-I01-990311, 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 specificies the order of evaluation of the classifiers. The higher the value the higher the priority. The value of zero is used as default in provisioned service flows classifiers. The default value of 64 is used for dynamic service flow classifiers." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.1.3.5" ::= { 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." REFERENCE "SP-RFIv1.1-I01-990311, 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." REFERENCE "SP-RFIv1.1-I01-990311, 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. A value of zero means that IP TOS byte is not used for packet classification." REFERENCE "SP-RFIv1.1-I01-990311, 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. A value of 258 means that IP protocol is not used for packet classification." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.1.5.2" ::= { docsQosPktClassEntry 7 } docsQosPktClassIpSourceAddr OBJECT-TYPE SYNTAX IpAddress 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 docsQosPktClassIpSourceMask value equals the docsQosPktClassIpSourceAddr value. A value of 0.0.0.0 means that IP source address is not used for packet classification." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.1.5.3" ::= { docsQosPktClassEntry 8 } docsQosPktClassIpSourceMask OBJECT-TYPE SYNTAX IpAddress 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 docsQosPktClassIpSourceMask value equals the docsQosIpPktClassSourceAddr value. A value of 0.0.0.0 means that IP source address is not used for packet classification." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.1.5.4" ::= { docsQosPktClassEntry 9 } docsQosPktClassIpDestAddr OBJECT-TYPE SYNTAX IpAddress 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 docsQosPktClassIpDestMask value equals the docsQosPktClassIpDestAddr value. A value of 0.0.0.0 means that IP destination address is not used for packet classification." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.1.5.5" ::= { docsQosPktClassEntry 10 } docsQosPktClassIpDestMask OBJECT-TYPE SYNTAX IpAddress 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 docsQosPktClassIpDestMask value equals the docsQosPktClassIpDestAddr value. A value of 0.0.0.0 means that IP destination address is not used for packet classification." REFERENCE "SP-RFIv1.1-I01-990311, 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. A value of 65535 for docsQosPktClassSourcePortEnd and a value of 0 for docsQosPktClassSourcePortStart means that source port number is not used for packet classification." REFERENCE "SP-RFIv1.1-I01-990311, 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. A value of 65535 for docsQosPktClassSourcePortEnd and a value of 0 for docsQosPktClassSourcePortStart means that source port number is not used for packet classification." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.1.5.9" ::= { docsQosPktClassEntry 13 } 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. A value of 65535 for docsQosPktClassDestPortEnd and a value of 0 for docsQosPktClassDestPortStart means that destination port number is not used for packet classification." REFERENCE "SP-RFIv1.1-I01-990311, 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. A value of 65535 for docsQosPktClassDestPortEnd and a value of 0 for docsQosPktClassDestPortStart means that destination port number is not used for packet classification." REFERENCE "SP-RFIv1.1-I01-990311, 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. A value of 0 means that destination mac address is not used for packet classification." REFERENCE "SP-RFIv1.1-I01-990311, 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 docsQosPktClassDestMacAddr. A value of 0 means that destination mac address is not used for packet classification." REFERENCE "SP-RFIv1.1-I01-990311, 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. A value of 0 means that source mac address is not used for packet classification." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.1.6.2" ::= { docsQosPktClassEntry 18 } docsQosPktClassEnetProtocolType OBJECT-TYPE SYNTAX INTEGER { none(0), ethertype(1), dsap(2) } 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). 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." REFERENCE "SP-RFIv1.1-I01-990311, 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 dosQosEthPktClassEncap 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 docsQosEthPktClassEncap 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 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." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.1.6.3" ::= { docsQosPktClassEntry 20 } docsQosPktClassUserPriApplies OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-only STATUS current DESCRIPTION "If this object is true(1) then user priority field in 802.1P is applied to ethernet frames. A value of false(2) signifies that user priority field does apply to this rule." ::= { 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. A value of false(2) for docsQosPktClassUserPriApplies means that priority field is not used for packet classification." REFERENCE "SP-RFIv1.1-I01-990311, 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. A value of false(2) for docsQosPktClassUserPriApplies means that priority field is not used for packet classification." REFERENCE "SP-RFIv1.1-I01-990311, 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. A value is zero for docsQosPktClassVlanId means that VLAN Id is not used for packet classification." REFERENCE "SP-RFIv1.1-I01-990311, 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 currently classifing packets to a Service Flow." REFERENCE "SP-RFIv1.1-I01-990311, 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 } -- -- 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 QoS parameters defined in a managed device. Each entry in this table is used to define one Qos Parameter Set. Only rows with a value of serviceClass(2) for docsQosParamSetRowType are read-create. Rows with value of serviceFlow(1) are read-only." ::= { docsQosMIBObjects 2 } docsQosParamSetEntry OBJECT-TYPE SYNTAX DocsQosParamSetEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A unique set of Qos parameters." INDEX { docsQosParamSetRowType, docsQosParamSetIndex } ::= { docsQosParamSetTable 1 } DocsQosParamSetEntry ::= SEQUENCE { docsQosParamSetRowType INTEGER, docsQosParamSetIndex Unsigned32, docsQosParamSetRowStatus RowStatus, docsQosParamSetServiceClassName DisplayString, docsQosParamSetPriority Integer32, docsQosParamSetMaxTrafficRate BitRate, docsQosParamSetMaxTrafficBurst Unsigned32, docsQosParamSetMinReservedRate BitRate, docsQosParamSetMinReservedPkt Integer32, docsQosParamSetActiveTimeout Integer32, docsQosParamSetAdmittedTimeout Integer32, docsQosParamSetMaxConcatBurst Integer32, docsQosParamSetSchedulingType INTEGER, docsQosParamSetRequestPolicy BITS, docsQosParamSetNomPollInterval Unsigned32, docsQosParamSetTolPollJitter Unsigned32, docsQosParamSetUnsolicitGrantSize Integer32, docsQosParamSetNomGrantInterval Unsigned32, docsQosParamSetTolGrantJitter Unsigned32, docsQosParamSetGrantsPerInterval Integer32, docsQosParamSetTosAndMask OCTET STRING, docsQosParamSetTosOrMask OCTET STRING, docsQosParamSetMaxLatency Unsigned32 } docsQosParamSetRowType OBJECT-TYPE SYNTAX INTEGER { serviceFlow (1), serviceClass (2) } MAX-ACCESS not-accessible STATUS current DESCRIPTION "Defines the type of parameter set. A serviceFlow(1) type is used to define a parameter set associated with a service flow and are read-only entries in this table. The entries are added and deleted by the device. A serviceClass(2) type is used to define a parameter set associated with a service class name and are read-create entries in this table." ::= { docsQosParamSetEntry 1 } docsQosParamSetIndex OBJECT-TYPE SYNTAX Unsigned32 (1..4294967295) MAX-ACCESS not-accessible STATUS current DESCRIPTION "Unique index for a QOS parameter set for each docsQosParamSetRowType." ::= { docsQosParamSetEntry 2 } docsQosParamSetRowStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "Used to control creation and deletion of rows of with a value of serviceClass(2) for docsQosParamSetRowType." ::= { docsQosParamSetEntry 3 } docsQosParamSetServiceClassName OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "Refers to the Service Class Name that the parameter set values were derived. If service class name was not used to specify parameter set values then use zero length DisplayString value." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.3.4" ::= { docsQosParamSetEntry 4 } docsQosParamSetPriority OBJECT-TYPE SYNTAX Integer32 (0..7) MAX-ACCESS read-create STATUS current DESCRIPTION "The relative priority of a service flow. Higher numbers indicate higher priority. This priority should only be used to diffentiate service flow with identical parameter sets." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.5.2" DEFVAL { 0 } ::= { docsQosParamSetEntry 5 } docsQosParamSetMaxTrafficRate OBJECT-TYPE SYNTAX BitRate MAX-ACCESS read-create 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 zero means no maximum traffic rate is enforced. This object applies to both upstream and downstream service flows." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.5.3" DEFVAL { 0 } ::= { docsQosParamSetEntry 6 } docsQosParamSetMaxTrafficBurst OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-create 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." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.5.4" DEFVAL { 1522 } ::= { docsQosParamSetEntry 7 } docsQosParamSetMinReservedRate OBJECT-TYPE SYNTAX BitRate MAX-ACCESS read-create 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." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.5.5" DEFVAL { 0 } ::= { docsQosParamSetEntry 8 } docsQosParamSetMinReservedPkt OBJECT-TYPE SYNTAX Integer32 (0..65535) MAX-ACCESS read-create 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. The default value is CMTS implementation dependent." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.5.6" ::= { docsQosParamSetEntry 9 } docsQosParamSetActiveTimeout OBJECT-TYPE SYNTAX Integer32 (0..65535) UNITS "seconds" MAX-ACCESS read-create 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 zero signifies an infinite amount of time." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.5.7" DEFVAL { 0 } ::= { docsQosParamSetEntry 10 } docsQosParamSetAdmittedTimeout OBJECT-TYPE SYNTAX Integer32 (0..65535) UNITS "seconds" MAX-ACCESS read-create STATUS current DESCRIPTION "Specifies the maximum duration in seconds that resources remain in admitted state before resources must be released. The value of zero signifies an infinite amount of time." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.5.9" DEFVAL { 200 } ::= { docsQosParamSetEntry 11 } docsQosParamSetMaxConcatBurst OBJECT-TYPE SYNTAX Integer32 (0..65535) MAX-ACCESS read-create 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 in concatenated MAC frame. The value of zero specifies no maximum burst." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.6.1" DEFVAL { 0 } ::= { docsQosParamSetEntry 12 } docsQosParamSetSchedulingType OBJECT-TYPE SYNTAX INTEGER { undefined (1), bestEffort (2), nonRealTimePollingService(3), realTimePollingService(4), unsolictedGrantServiceWithAD(5), unsolictedGrantService(6), notApplicable(256) } MAX-ACCESS read-create STATUS current DESCRIPTION "Specifies the upstream scheduling service used for upstream service flow. The value notApplicable(256) should be used for downstream service flows. " REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.6.2" DEFVAL { bestEffort } ::= { docsQosParamSetEntry 13 } docsQosParamSetRequestPolicy OBJECT-TYPE SYNTAX BITS { broadcastReqOpp (0), priorityReqMulticastReq (1), reqDataForReq (2), reqDataForData (3), piggybackReqWithData (4), concatenateData (5), fragmentData (6), supressPayloadHeaders (7), dropPktsExceedUGSize (8) } MAX-ACCESS read-create STATUS current DESCRIPTION "Specifies which IUC opportunities the CM uses for upstream tranmission requests and packet transmissions. A bit value of 1 mean it must not use that opportunity for upstream transmission. broadcastReqOpp(0): all CMs broadcast request opportunities priorityReqMulticastReq(1): priority request multicast request opportunities reqDataForReq(3): request/data opportunities for requests reqDataForData(4): request/data opportunities for data concatenateData(5): concatendate data fragmentData(6): fragment data supressPayloadHeaders(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 " REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.6.3" DEFVAL { { } } -- no enumerated values are set ::= { docsQosParamSetEntry 14 } docsQosParamSetNomPollInterval OBJECT-TYPE SYNTAX Unsigned32 UNITS "microseconds" MAX-ACCESS read-create STATUS current DESCRIPTION "Specifies the nominal interval in microseconds between successive unicast request opportunities on an upstream service flow. This object only applies to upstream service flows with schedulingType withg value of nonRealTimePollingService(3) or realTimePollingService(4)" REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.6.4" DEFVAL { 0 } ::= { docsQosParamSetEntry 15 } docsQosParamSetTolPollJitter OBJECT-TYPE SYNTAX Unsigned32 UNITS "microseconds" MAX-ACCESS read-create 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." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.6.5" DEFVAL { 0 } ::= { docsQosParamSetEntry 16 } docsQosParamSetUnsolicitGrantSize OBJECT-TYPE SYNTAX Integer32 (0..65535) MAX-ACCESS read-create STATUS current DESCRIPTION "Specifies the unsolicited grant size in bytes. The grant size includes the entired MAC frame data PDU from the Frame Control byte to end of the MAC frame." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.6.6" DEFVAL { 0 } ::= { docsQosParamSetEntry 17 } docsQosParamSetNomGrantInterval OBJECT-TYPE SYNTAX Unsigned32 UNITS "microseconds" MAX-ACCESS read-create STATUS current DESCRIPTION "Specifies the nominal interval in microseconds between successive data grant opportunities on an upstream service flow. This object is required to be set to not default value when docsQosParamSetScheduleType is set to either unsolictedGrantServiceWithAD(5) or unsolictedGrantService(6)." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.6.7" DEFVAL { 0 } ::= { docsQosParamSetEntry 18 } docsQosParamSetTolGrantJitter OBJECT-TYPE SYNTAX Unsigned32 UNITS "microseconds" MAX-ACCESS read-create STATUS current DESCRIPTION "Specifies the maximum amount of time in microseconds that the transmission opportunities may be delayed from the nominal periodic schedule. This object is required to be set to non-default value when docsQosParamSetSchedulingType is set to either unsolictedGrantServiceWithAD(5) or unsolictedGrantService(6)." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.6.8" DEFVAL { 0 } ::= { docsQosParamSetEntry 19 } docsQosParamSetGrantsPerInterval OBJECT-TYPE SYNTAX Integer32 (0..127) MAX-ACCESS read-create STATUS current DESCRIPTION "Specifies the number of data grants per Nominal Grant Interval (docsQosParamSetNomGrantInterval). This object is required to be set to non-default value when docsQosParamSetSchedulingType is set to either unsolictedGrantServiceWithAD(5) or unsolictedGrantService(6)." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.6.9" DEFVAL { 0 } ::= { docsQosParamSetEntry 20 } docsQosParamSetTosAndMask OBJECT-TYPE SYNTAX OCTET STRING (SIZE(1)) MAX-ACCESS read-create STATUS current DESCRIPTION "Specifies the AND mask for IP TOS byte for overwriting IP packets TOS value. The IP packets TOS byte is bitwise ANDed with docsQosParamSetTosAndMask and result is bitwise ORed with docsQosParamSetTosORMask and result is writen 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." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.6.10" DEFVAL { 'FF'H } ::= { docsQosParamSetEntry 21 } docsQosParamSetTosOrMask OBJECT-TYPE SYNTAX OCTET STRING (SIZE(1)) MAX-ACCESS read-create STATUS current DESCRIPTION "Specifies the OR mask for IP TOS byte." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.6.10" DEFVAL { '00'H } ::= { docsQosParamSetEntry 22 } -- removed docsQosParamSetMinPhsSize OBJECT-TYPE -- SYNTAX Integer32 (0..255) -- MAX-ACCESS read-create -- STATUS current -- DESCRIPTION "Specifies the minimum payload header suppression -- size in bytes to be used by CM." -- REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.6.11" -- DEFVAL { 0 } -- ::= { docsQosParamSetEntry 23 } docsQosParamSetMaxLatency OBJECT-TYPE SYNTAX Unsigned32 UNITS "microseconds" MAX-ACCESS read-create 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 zero signifies no maximum latency enforced. This object only applies to downstream service flows." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.7.1" DEFVAL { 0 } ::= { docsQosParamSetEntry 23 } -- -- 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. 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 } 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-I01-990311, Appendix C.2.2.3.2" ::= { docsQosServiceFlowEntry 1 } docsQosServiceFlowProvisionedParamSetIndex OBJECT-TYPE SYNTAX Unsigned32 (0..4294967295) MAX-ACCESS read-only STATUS current DESCRIPTION "Refers to an entry in docsQosParamSetTable with a docsQosParamSetRowType of serviceFlow(1) that contains the provisioned parameter set values for this service flow. The value is docsQosParamSetIndex for the provisioned parameters set associated with this service flow entry. This object return zero if the docsQosParamSetEntry does not exist. Dynamically created service flow would return a value of zero." ::= { docsQosServiceFlowEntry 3 } docsQosServiceFlowAdmittedParamSetIndex OBJECT-TYPE SYNTAX Unsigned32 (0..4294967295) MAX-ACCESS read-only STATUS current DESCRIPTION "Refers to an entry in docsQosParamSetTable with a docsQosParamSetRowType of serviceFlow(1) that contains the admitted parameter set values for this service flow. The value is docsQosParamSetIndex for the admitted parameters set associated with this service flow entry. This object return zero if the docsQosParamSetEntry does not exist." ::= { docsQosServiceFlowEntry 4 } docsQosServiceFlowActiveParamSetIndex OBJECT-TYPE SYNTAX Unsigned32 (0..4294967295) MAX-ACCESS read-only STATUS current DESCRIPTION "Refers to an entry in docsQosParamSetTable with a docsQosParamSetRowType of serviceFlow(1) that contains the active parameter set values for this service flow. The value is docsQosParamSetIndex for the active parameters set associated with this service flow entry. This object return zero if the docsQosParamSetEntry does not exist." ::= { docsQosServiceFlowEntry 5 } docsQosServiceFlowSID OBJECT-TYPE SYNTAX Unsigned32 (0..16383) MAX-ACCESS read-only STATUS current DESCRIPTION "Service Identifier (SID) assigned to an addmitted or active service flow. This object return a value of zero 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-I01-990311, 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-I01-990311, 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-I01-990311, Section 8.1 " ::= { docsQosServiceFlowEntry 8 } -- -- 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 statisics. An entry in the table exists for each Service Flow ID. The ifIndex is an ifType of docsCableMaclayer(127)." INDEX { ifIndex, 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 counted on this service flow." ::= { docsQosServiceFlowStatsEntry 1 } docsQosServiceFlowOctets OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of octets counted on this service flow after payload header suppression." ::= { 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 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 packet with unknown payload header suppresion index." ::= { docsQosServiceFlowStatsEntry 5 } docsQosServiceFlowPolicedDropPkts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of packet dropped due to policing of that service flow." ::= { docsQosServiceFlowStatsEntry 6 } docsQosServiceFlowPolicedDelayPkts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of packet delayed due to policing of that service 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." ::= { docsQosMIBObjects 5 } docsQosUpstreamStatsEntry OBJECT-TYPE SYNTAX DocsQosUpstreamStatsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Describes a set of upstream service flow statisics. An entry in the table exists for each upstream Service Flow in a managed device. The ifIndex is an ifType of docsCableMaclayer(127)." INDEX { ifIndex, docsQosSID } ::= { docsQosUpstreamStatsTable 1 } DocsQosUpstreamStatsEntry ::= SEQUENCE { docsQosSID Integer32, docsQosUpstreamFragPkts Counter32, docsQosUpstreamIncompletePkts Counter32, docsQosUpstreamConcatBursts Counter32 } docsQosSID OBJECT-TYPE SYNTAX Integer32 (1..16383) MAX-ACCESS not-accessible STATUS current DESCRIPTION "Identifies a service id for an admitted or active upstream service flow." ::= { docsQosUpstreamStatsEntry 1 } docsQosUpstreamFragPkts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of fragmented packets counted on an upstream service flow." ::= { docsQosUpstreamStatsEntry 2 } docsQosUpstreamIncompletePkts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of incomplete fragmented packets counted on an upstream service flow." ::= { docsQosUpstreamStatsEntry 3 } docsQosUpstreamConcatBursts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of concatenated bursts counted on an upstream service flow." ::= { docsQosUpstreamStatsEntry 4 } -- -- Dynamic Service Stats Table -- docsQosDynamicServiceStatsTable OBJECT-TYPE SYNTAX SEQUENCE OF DocsQosDynamicServiceStatsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table describes statistics associated with the Dynamic Service Flows in a managed device. " ::= { docsQosMIBObjects 6 } docsQosDynamicServiceStatsEntry OBJECT-TYPE SYNTAX DocsQosDynamicServiceStatsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Describes a set of dynamic service flow statisics. Two entries exist for each Docsis mac layer interface for upstream and downstream direction. The ifIndex is an ifType of docsCableMaclayer(127)." INDEX { ifIndex, docsQosIfDirection } ::= { docsQosDynamicServiceStatsTable 1 } DocsQosDynamicServiceStatsEntry ::= SEQUENCE { docsQosIfDirection IfDirection, docsQosDSAReqs Counter32, docsQosDSARsps Counter32, docsQosDSAAcks Counter32, docsQosDSCReqs Counter32, docsQosDSCRsps Counter32, docsQosDSCAcks Counter32, docsQosDSDReqs Counter32, docsQosDSDRsps Counter32, docsQosDynamicAdds Counter32, docsQosDynamicAddFails Counter32, docsQosDynamicChanges Counter32, docsQosDynamicChangeFails Counter32, docsQosDynamicDeletes Counter32, docsQosDynamicDeleteFails Counter32 } docsQosIfDirection OBJECT-TYPE SYNTAX IfDirection MAX-ACCESS not-accessible STATUS current DESCRIPTION "The direction of interface." ::= { docsQosDynamicServiceStatsEntry 1 } docsQosDSAReqs OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of Dynamic Service Addition Requests" ::= { docsQosDynamicServiceStatsEntry 2 } docsQosDSARsps OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of Dynamic Service Addition Responses" ::= { docsQosDynamicServiceStatsEntry 3 } docsQosDSAAcks OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of Dynamic Service Addition Acknowlegements." ::= { docsQosDynamicServiceStatsEntry 4 } docsQosDSCReqs OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of Dynamic Service Change Requests" ::= { docsQosDynamicServiceStatsEntry 5 } docsQosDSCRsps OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of Dynamic Service Change Responses" ::= { docsQosDynamicServiceStatsEntry 6 } docsQosDSCAcks OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of Dynamic Service Change Acknowlegements." ::= { docsQosDynamicServiceStatsEntry 7 } docsQosDSDReqs OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of Dynamic Service Delete Requests" ::= { docsQosDynamicServiceStatsEntry 8 } docsQosDSDRsps OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of Dynamic Service Delete Responses" ::= { docsQosDynamicServiceStatsEntry 9 } docsQosDynamicAdds OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of sucessful Dynamic Service Additions." ::= { docsQosDynamicServiceStatsEntry 10 } docsQosDynamicAddFails OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of Dynamic Service Addition failures." ::= { docsQosDynamicServiceStatsEntry 11 } docsQosDynamicChanges OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of sucessful Dynamic Service Changes." ::= { docsQosDynamicServiceStatsEntry 12 } docsQosDynamicChangeFails OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of Dynamic Service Change failures." ::= { docsQosDynamicServiceStatsEntry 13 } docsQosDynamicDeletes OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of sucessful Dynamic Service Deletes." ::= { docsQosDynamicServiceStatsEntry 14 } docsQosDynamicDeleteFails OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of Dynamic Service Delete failures." ::= { docsQosDynamicServiceStatsEntry 15 } -- -- Service Flow Log Table (CMTS ONLY) -- docsQosServiceFlowLogTable OBJECT-TYPE SYNTAX SEQUENCE OF DocsQosServiceFlowLogEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table contains a log of the disconnected Service Flows in a managed device." ::= { docsQosMIBObjects 7 } docsQosServiceFlowLogEntry OBJECT-TYPE SYNTAX DocsQosServiceFlowLogEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The information reguarding a single disconnected service flow." INDEX { docsQosServiceFlowLogIndex } ::= { docsQosServiceFlowLogTable 1 } DocsQosServiceFlowLogEntry ::= SEQUENCE { docsQosServiceFlowLogIndex Unsigned32, docsQosServiceFlowLogIfIndex InterfaceIndex, docsQosServiceFlowLogSFID Unsigned32, docsQosServiceFlowLogCmMac MacAddress, docsQosServiceFlowLogPkts Counter32, docsQosServiceFlowLogOctets Counter32, docsQosServiceFlowLogTimeDeleted TimeStamp, docsQosServiceFlowLogTimeCreated TimeStamp, docsQosServiceFlowLogTimeActive Counter32, docsQosServiceFlowLogControl INTEGER } docsQosServiceFlowLogIndex OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS not-accessible STATUS current DESCRIPTION "Unique index for a logged service flow." ::= { docsQosServiceFlowLogEntry 1 } docsQosServiceFlowLogIfIndex OBJECT-TYPE SYNTAX InterfaceIndex MAX-ACCESS read-only STATUS current DESCRIPTION "The ifIndex of ifType docsCableMacLayter(127) on the CMTS where the service flow was present." ::= { docsQosServiceFlowLogEntry 2 } docsQosServiceFlowLogSFID OBJECT-TYPE SYNTAX Unsigned32 (1..4294967295) MAX-ACCESS read-only STATUS current DESCRIPTION "The index assigned to the service flow by the CMTS." ::= { docsQosServiceFlowLogEntry 3 } docsQosServiceFlowLogCmMac OBJECT-TYPE SYNTAX MacAddress MAX-ACCESS read-only STATUS current DESCRIPTION "The MAC address for the cable modem associated with the service flow." ::= { docsQosServiceFlowLogEntry 4 } docsQosServiceFlowLogPkts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of packets counted on this service flow after payload header suppression." ::= { docsQosServiceFlowLogEntry 5 } docsQosServiceFlowLogOctets OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of octets counted on this service flow after payload header suppression." ::= { docsQosServiceFlowLogEntry 6 } docsQosServiceFlowLogTimeDeleted OBJECT-TYPE SYNTAX TimeStamp MAX-ACCESS read-only STATUS current DESCRIPTION "The value of sysUpTime when the service flow was deleted." ::= { docsQosServiceFlowLogEntry 7 } docsQosServiceFlowLogTimeCreated OBJECT-TYPE SYNTAX TimeStamp MAX-ACCESS read-only STATUS current DESCRIPTION "The value of sysUpTime when the service flow was created." ::= { docsQosServiceFlowLogEntry 8 } docsQosServiceFlowLogTimeActive OBJECT-TYPE SYNTAX Counter32 UNITS "seconds" MAX-ACCESS read-only STATUS current DESCRIPTION "The total time that service flow was active." ::= { docsQosServiceFlowLogEntry 9 } docsQosServiceFlowLogControl OBJECT-TYPE SYNTAX INTEGER { active(1), destroy(6) } MAX-ACCESS read-write STATUS current DESCRIPTION "Setting this object to the value destroy(6) removes this entry from the table. Reading this object return the value active(1)." ::= { docsQosServiceFlowLogEntry 10 } -- -- Service Class Table (CMTS ONLY) -- docsQosServiceClassTable OBJECT-TYPE SYNTAX SEQUENCE OF DocsQosServiceClassEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table describes the set of Docsis-QOS Service Classes in a CMTS. " ::= { docsQosMIBObjects 8 } docsQosServiceClassEntry OBJECT-TYPE SYNTAX DocsQosServiceClassEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A provisioned service class." INDEX { docsQosServiceClassName } ::= { docsQosServiceClassTable 1 } DocsQosServiceClassEntry ::= SEQUENCE { docsQosServiceClassName DisplayString, docsQosServiceClassParamSetIndex Unsigned32, docsQosServiceClassStatus RowStatus } docsQosServiceClassName OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS not-accessible STATUS current DESCRIPTION "Service Class Name." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.3.4" ::= { docsQosServiceClassEntry 1 } docsQosServiceClassParamSetIndex OBJECT-TYPE SYNTAX Unsigned32 (1..4294967295) MAX-ACCESS read-create STATUS current DESCRIPTION "Refers to an entry in docsQosParamSetTable with a docsQosParamSetRowType of serviceClass(2). The value is docsQosParamSetIndex for the parameters set associated with this service class entry." ::= { docsQosServiceClassEntry 2 } docsQosServiceClassStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "Used to create or delete rows in this table. This object should delete the entry in docsQosParamSetTable referenced by docsQosServiceClassParamSetIndex first before deleting this entry." ::= { docsQosServiceClassEntry 3 } -- -- Service Class PolicyTable -- docsQosServiceClassPolicyTable OBJECT-TYPE SYNTAX SEQUENCE OF DocsQosServiceClassPolicyEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table describes the set of Docsis-QOS Service Class Policies. This table is an adjunt to the docsDevFilterPolicy table. Entries in docsDevFilterPolicy table can point to specific rows in this table. This table permits mapping a packet to a service class name of an active service flow so long as a classifier does not exist at a higher priority. " REFERENCE "SP-RFIv1.1-I01-990311, Appendix E.2.1" ::= { docsQosMIBObjects 9 } docsQosServiceClassPolicyEntry OBJECT-TYPE SYNTAX DocsQosServiceClassPolicyEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A service class name policy entry." INDEX { docsQosServiceClassPolicyIndex } ::= { docsQosServiceClassPolicyTable 1 } DocsQosServiceClassPolicyEntry ::= SEQUENCE { docsQosServiceClassPolicyIndex Integer32, docsQosServiceClassPolicyName DisplayString, docsQosServiceClassPolicyRulePriority Integer32, docsQosServiceClassPolicyStatus RowStatus } docsQosServiceClassPolicyIndex OBJECT-TYPE SYNTAX Integer32 (1..2147483647) MAX-ACCESS not-accessible STATUS current DESCRIPTION "Index value to uniquely identify an entry in this table." ::= { docsQosServiceClassPolicyEntry 1 } docsQosServiceClassPolicyName OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-create STATUS current DESCRIPTION "Service Class Name to identify the name of the service class flow to which the packet should be directed." REFERENCE "SP-RFIv1.1-I01-990311, Appendix E.2.1" ::= { docsQosServiceClassPolicyEntry 2 } docsQosServiceClassPolicyRulePriority OBJECT-TYPE SYNTAX Integer32 (0..255) MAX-ACCESS read-create STATUS current DESCRIPTION "Service Class Policy rule priority for the entry." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.1.3.5" ::= { docsQosServiceClassPolicyEntry 3 } docsQosServiceClassPolicyStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "Used to create or delete rows in this table. This object should not be deleted if it is reference by an entry in docsDevFilterPolicy. The reference should be deleted first." ::= { docsQosServiceClassPolicyEntry 4 } -- -- Payload Header Suppression(PHS) Table -- docsQosPHSTable OBJECT-TYPE SYNTAX SEQUENCE OF DocsQosPHSEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table describes set of payload header suppression entries." ::= { docsQosMIBObjects 10 } docsQosPHSEntry OBJECT-TYPE SYNTAX DocsQosPHSEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A payload header supression entry. The ifIndex is an ifType of docsCableMaclayer(127)." INDEX { ifIndex, docsQosServiceFlowId, docsQosPHSIndex } ::= { docsQosPHSTable 1 } DocsQosPHSEntry ::= SEQUENCE { docsQosPHSIndex Integer32, docsQosPHSField OCTET STRING, docsQosPHSMask OCTET STRING, docsQosPHSSize Integer32, docsQosPHSVerify TruthValue, docsQosPHSClassifierIndex Integer32 } docsQosPHSIndex OBJECT-TYPE SYNTAX Integer32 (1..255) MAX-ACCESS not-accessible STATUS current DESCRIPTION "Payload header suppression index uniquely references an entry on a per docsQosServiceFlowId." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.10.2" ::= { docsQosPHSEntry 1 } docsQosPHSField OBJECT-TYPE SYNTAX OCTET STRING (SIZE(0..255)) MAX-ACCESS read-only STATUS current DESCRIPTION "Payload header suppression field defines the bytes of the header which must be supressed/restored by the sending/receiving device. The number of octets in this object should be the same as the value of docsQosPHSSize." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.10.1" ::= { docsQosPHSEntry 2 } docsQosPHSMask OBJECT-TYPE SYNTAX OCTET STRING(SIZE(0..32)) MAX-ACCESS read-only STATUS current DESCRIPTION "Payload header suppression mask defines the bit mask which used in combination with the docsQosPHSField defines which bytes in header must be supressed/restored by the sending or receiving device. Each bit of this bit mask corresponds to a byte in the docsQosPHSField, with the least significant bit corresponding to first byte of the docsQosPHSField. Each bit of the bit mask specifies whether of not the corresponding byte should be supressed in the packet. A bit value of '1' indicates that the byte should be suppressed by the sending device and restored by the receiving device. A bit value of '0' indicates that the byte should not be suppressed by the sending device or restored by the receiving device. If the bit mask does not contain a bit for each byte in the docsQosPHSField then the bit mask is extended with bit values of '1' to be the neccessary length." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.10.3" ::= { docsQosPHSEntry 3 } docsQosPHSSize OBJECT-TYPE SYNTAX Integer32 (0..255) MAX-ACCESS read-only STATUS current DESCRIPTION "Payload header suppression size specifies the number of bytes in the header to be suppressed and restored. The value of this object must match the number of bytes in the docsQosPHSField." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.10.4" ::= { docsQosPHSEntry 4 } docsQosPHSVerify OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-only STATUS current DESCRIPTION "Payload header suppression verification value of 'true' the sender must verify docsQosPHSField is the same as what is contained in the packet to be suppressed." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.10.5" ::= { docsQosPHSEntry 5 } docsQosPHSClassifierIndex OBJECT-TYPE SYNTAX Integer32 (1..65535) MAX-ACCESS read-only STATUS current DESCRIPTION "The index of the packets classfier associated with this payload header supression entry. The value of this object is same as docsQosPktClassId and refers to a particular entry in docsQosPktClassTable using ifIndex and docsQosServiceFlowId for this entry in addition to docsQosPHSClassifierIndex." REFERENCE "SP-RFIv1.1-I01-990311, Appendix C.2.2.8.2" ::= { docsQosPHSEntry 6 } -- -- docsQosCmtsMacToSrvFlowTable (CMTS Only) -- docsQosCmtsMacToSrvFlowTable OBJECT-TYPE SYNTAX SEQUENCE OF DocsQosCmtsMacToSrvFlowEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table provide for referencing the service flows associated with a particular cable modem. This allows for indexing into other docsQos tables that are indexed by docsQosServiceFlowId and ifIndex." ::= { docsQosMIBObjects 11 } docsQosCmtsMacToSrvFlowEntry OBJECT-TYPE SYNTAX DocsQosCmtsMacToSrvFlowEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "An entry is created by CMTS for each service flow connected to this CMTS." INDEX { docsQosCmtsCmMac, docsQosCmtsServiceFlowId } ::= { docsQosCmtsMacToSrvFlowTable 1 } DocsQosCmtsMacToSrvFlowEntry ::= SEQUENCE { docsQosCmtsCmMac MacAddress, docsQosCmtsServiceFlowId Unsigned32, docsQosCmtsIfIndex InterfaceIndex } docsQosCmtsCmMac OBJECT-TYPE SYNTAX MacAddress MAX-ACCESS not-accessible STATUS current DESCRIPTION "The MAC address for the referenced CM." ::= { docsQosCmtsMacToSrvFlowEntry 1 } docsQosCmtsServiceFlowId OBJECT-TYPE SYNTAX Unsigned32 (1..4294967295) MAX-ACCESS not-accessible STATUS current DESCRIPTION "An index assigned to a service flow by CMTS." ::= { docsQosCmtsMacToSrvFlowEntry 2 } docsQosCmtsIfIndex OBJECT-TYPE SYNTAX InterfaceIndex MAX-ACCESS read-only STATUS current DESCRIPTION "The ifIndex of ifType docsCableMacLayter(127) on the CMTS that is connected to the Cable Modem." ::= { docsQosCmtsMacToSrvFlowEntry 3 } -- -- Placeholder for notifications/traps. -- docsQosNotification OBJECT IDENTIFIER ::= { docsQosMIB 2 } -- -- Conformance definitions -- docsQosConformance OBJECT IDENTIFIER ::= { docsQosMIB 3 } docsQosGroups OBJECT IDENTIFIER ::= { docsQosConformance 1 } docsQosCompliances OBJECT IDENTIFIER ::= { docsQosConformance 2 } docsQosCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for MCNS Cable Modems and Cable Modem Termination Systems that implement DOCSIS Service Flows." MODULE -- docsQosMIB MANDATORY-GROUPS { docsQosBaseGroup } GROUP docsQosCmtsGroup DESCRIPTION "This group is mandatory for only Cable Modem Termination Systems (CMTS) and not implemented for Cable Modems." GROUP docsQosParamSetGroup DESCRIPTION "This group is mandatory for Cable Modem Termination Systems (CMTS) and Cable Modems. Cable modems only implement objects in this group as read-only." GROUP docsQosSrvClassPolicyGroup DESCRIPTION "This group is optional for Cable Modem Termination Systems (CMTS) and Cable Modems. This group only needs to be implement if policy based service flow classification is implemented. See docsDevPolicyTable in DOCS-CABLE-DEVICE-MIB for more details. " OBJECT docsQosPktClassPkts DESCRIPTION "This object only needs to be implemented for in entries that are classifing packet and not policing pakets." ::= { docsQosCompliances 1 } docsQosBaseGroup OBJECT-GROUP OBJECTS { 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, docsQosServiceFlowProvisionedParamSetIndex, docsQosServiceFlowAdmittedParamSetIndex, docsQosServiceFlowActiveParamSetIndex, docsQosServiceFlowSID, docsQosServiceFlowDirection, docsQosServiceFlowPrimary, docsQosServiceFlowPkts, -- not sure if CM should implement docsQosServiceFlowOctets, docsQosServiceFlowTimeCreated, docsQosServiceFlowTimeActive, docsQosServiceFlowPHSUnknowns, docsQosServiceFlowPolicedDropPkts, docsQosServiceFlowPolicedDelayPkts, docsQosDSAReqs, docsQosDSARsps, docsQosDSAAcks, docsQosDSCReqs, docsQosDSCRsps, docsQosDSCAcks, docsQosDSDReqs, docsQosDSDRsps, docsQosDynamicAdds, docsQosDynamicAddFails, docsQosDynamicChanges, docsQosDynamicChangeFails, docsQosDynamicDeletes, docsQosDynamicDeleteFails, docsQosPHSField, docsQosPHSMask, docsQosPHSSize, docsQosPHSVerify, docsQosPHSClassifierIndex } STATUS current DESCRIPTION "Group of objects implemenented in both Cable Modems and Cable Modem Termination Systems." ::= { docsQosGroups 1 } docsQosParamSetGroup OBJECT-GROUP OBJECTS { docsQosParamSetRowStatus, docsQosParamSetServiceClassName, docsQosParamSetPriority, docsQosParamSetMaxTrafficRate, docsQosParamSetMaxTrafficBurst, docsQosParamSetMinReservedRate, docsQosParamSetMinReservedPkt, docsQosParamSetActiveTimeout, docsQosParamSetAdmittedTimeout, docsQosParamSetMaxConcatBurst, docsQosParamSetSchedulingType, docsQosParamSetRequestPolicy, docsQosParamSetNomPollInterval, docsQosParamSetTolPollJitter, docsQosParamSetUnsolicitGrantSize, docsQosParamSetNomGrantInterval, docsQosParamSetTolGrantJitter, docsQosParamSetGrantsPerInterval, docsQosParamSetTosAndMask, docsQosParamSetTosOrMask, docsQosParamSetMaxLatency } STATUS current DESCRIPTION "Group of objects implemenent in both Cable Modems and Cable Modem Termination Systems for QOS parameter sets." ::= { docsQosGroups 2 } docsQosCmtsGroup OBJECT-GROUP OBJECTS { docsQosServiceClassParamSetIndex, docsQosServiceClassStatus, docsQosUpstreamFragPkts, docsQosUpstreamIncompletePkts, docsQosUpstreamConcatBursts, docsQosServiceFlowLogIfIndex, docsQosServiceFlowLogSFID, docsQosServiceFlowLogCmMac, docsQosServiceFlowLogPkts, docsQosServiceFlowLogOctets, docsQosServiceFlowLogTimeDeleted, docsQosServiceFlowLogTimeCreated, docsQosServiceFlowLogTimeActive, docsQosServiceFlowLogControl, docsQosCmtsIfIndex } STATUS current DESCRIPTION "Group of objects implemenented only in Cable Modem Termination Systems." ::= { docsQosGroups 3 } docsQosSrvClassPolicyGroup OBJECT-GROUP OBJECTS { docsQosServiceClassPolicyName, docsQosServiceClassPolicyRulePriority, docsQosServiceClassPolicyStatus } STATUS current DESCRIPTION "Group of objects implemenented in both Cable Modems and Cable Modem Termination Systems when supporting policy based service flows." ::= { docsQosGroups 4 } END