DOCS-QOS3-MIB: View SNMP OID List / Download MIB

This MIB module contains the management objects for the management of DOCSIS 3.0 and 3.1 features, primarily for the management of QOS for channel bonding. Copyright 1999-2016 Cable Television Laboratories, Inc. All rights reserved.

This object 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 an instance of this object. A matching rule provides a Service Flow ID to which the packet is classified. All rules need to match for a packet to match a classifier. The attributes in this row correspond to a set of Classifier Encoding parameters in a DOCSIS MAC management message. The BitMap attribute 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 Classifier, the corresponding attribute in this instance reports a value as specified by that attribute description.

The conceptual row of docsQosPktClassTable. The ifIndex key corresponds to the MAC Domain interface of the service flow of this classifier.

This key indicates the assigned identifier to the packet classifier instance by the CMTS, which is unique per Service Flow. For UDCs this corresponds to the Service Flow Reference of the classifier.

This attribute indicates the direction to which the classifier is applied.

This attribute 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 attribute reports the default value as defined above.

This attribute indicates the low value of a range of TOS byte values. If the referenced parameter is not present in a classifier, this attribute reports the value of 0. The IP TOS octet, as originally defined in RFC 791, has been superseded by the 6-bit Differentiated Services Field (DSField, RFC 3260) and the 2-bit Explicit Congestion Notification Field (ECN field, RFC 3168). This object is defined as an 8-bit octet as per the DOCSIS Specification for packet classification.

This attribute indicates the 8-bit high value of a range of TOS byte values. If the referenced parameter is not present in a classifier, this attribute reports the value of 0. The IP TOS octet as originally defined in RFC 791 has been superseded by the 6-bit Differentiated Services Field (DSField, RFC 3260) and the 2-bit Explicit Congestion Notification Field (ECN field, RFC 3168). This object is defined as an 8-bit octet as defined by the DOCSIS Specification for packet classification.

This attribute indicates the mask value is bitwise ANDed with TOS byte in an IP packet, and this value is used for range checking of TosLow and TosHigh. If the referenced parameter is not present in a classifier, this attribute reports the value of 0. The IP TOS octet as originally defined in RFC 791 has been superseded by the 6-bit Differentiated Services Field (DSField, RFC 3260) and the 2-bit Explicit Congestion Notification Field (ECN field, RFC 3168). This object is defined as an 8-bit octet per the DOCSIS Specification for packet classification.

This attribute 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 attribute reports the value of 258.

This attribute 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 InetSourceMask value equals the InetSourceAddr value. The address type of this object is specified by InetAddressType. If the referenced parameter is not present in a classifier, this object reports the value of '00000000'H.

This attribute specifies which bits of a packet's IP Source Address are compared to match this rule. An IP packet matches the rule when the packet source address bitwise ANDed with the InetSourceMask value equals the docsIetfQosIpPktClassInetSourceAddr value. The address type of this attribute is specified by InetAddressType. If the referenced parameter is not present in a classifier, this attribute reports the value of 'FFFFFFFF'H.

This attribute 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 InetDestMask value equals the InetDestAddr value. The address type of this attribute is specified by InetAddressType. If the referenced parameter is not present in a classifier, this attribute reports the value of '00000000'H.

This attribute specifies which bits of a packet's IP Destination Address are compared to match this rule. An IP packet matches the rule when the packet destination address bitwise ANDed with the InetDestMask value equals the docsIetfQosIpPktClassInetDestAddr value. The address type of this attribute is specified by InetAddressType. If the referenced parameter is not present in a classifier, this attribute reports the value of 'FFFFFFFF'H.

This attribute specifies the low-end inclusive range of TCP/UDP source port numbers to which a packet is compared. This attribute is irrelevant for non-TCP/UDP IP packets. If the referenced parameter is not present in a classifier, this attribute reports the value of 0.

This attribute specifies the high-end inclusive range of TCP/UDP source port numbers to which a packet is compared. This attribute is irrelevant for non-TCP/UDP IP packets. If the referenced parameter is not present in a classifier, this attribute reports the value of 65535.

This attribute 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 attribute reports the value of 0.

This attribute 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 attribute reports the value of 65535.

An Ethernet packet matches an entry when its destination MAC address bitwise ANDed with DestMacMask equals the value of DestMacAddr. If the referenced parameter is not present in a classifier, this attribute reports the value of '000000000000'H.

An Ethernet packet matches an entry when its destination MAC address bitwise ANDed with DestMacMask equals the value of DestMacAddr. If the referenced parameter is not present in a classifier, this attribute reports the value of '000000000000'H.

An Ethernet packet matches this entry when its source MAC address equals the value of this attribute. If the referenced parameter is not present in a classifier, this attribute reports the value of 'FFFFFFFFFFFF'

This attribute indicates the format of the layer 3 protocol ID in the Ethernet packet. A value of 'none' means that the rule does not use the layer 3 protocol type as a matching criteria. A value of 'ethertype' means that the rule applies only to frames that contain 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' 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). A value of 'mac' means that the rule applies only to MAC management messages for MAC management messages. A value of 'all' means that the rule matches all Ethernet packets. If the Ethernet frame contains an 802.1P/Q Tag header (i.e., EtherType 0x8100), this attribute applies to the embedded EtherType field within the 802.1P/Q header. If the referenced parameter is not present in a classifier, this attribute reports the value of 0. Enumeration: 'dsap': 2, 'ethertype': 1, 'none': 0, 'mac': 3, 'all': 4.

If EnetProtocolType is 'none', this attribute is ignored when considering whether a packet matches the current rule. If EnetProtocolType is 'ethertype', this attribute gives the 16-bit value of the EtherType that the packet must match in order to match the rule. If EnetProtocolType is 'dsap', the lower 8 bits of this attribute's value must match the DSAP byte of the packet in order to match the rule. If EnetProtocolType is 'mac', the lower 8 bits of this attribute's value represent a lower bound (inclusive) of MAC management message type codes matched, and the upper 8 bits 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 attribute applies to the embedded EtherType field within the 802.1P/Q header. If the referenced parameter is not present in the classifier, the value of this attribute is reported as 0.

This attribute 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 PriLow to PriHigh in order to match this rule. If the referenced parameter is not present in the classifier, the value of this attribute is reported as 0.

This attribute 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 PriLow to PriHigh in order to match this rule. If the referenced parameter is not present in the classifier, the value of this attribute is reported as 7.

This attribute applies only to Ethernet frames using the 802.1P/Q tag header. Tagged packets must have a VLAN Identifier that matches the value in order to match the rule. If the referenced parameter is not present in the classifier, the value of this attribute is reported as 0.

This attribute 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 attribute is reported as 'true'. Enumeration: 'active': 1, 'inactive': 2.

This attribute counts the number of packets that have been classified using this entry. This includes all packets delivered to a Service Flow maximum rate policing function, whether or not that function drops the packets. This counter's last discontinuity is the ifCounterDiscontinuityTime for the same ifIndex that indexes this attribute.

This attribute 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 this attribute is set to 1 if the parameter indicated by the comment was present in the classifier encoding, and to 0 otherwise. Note that BITS are encoded most significant bit first, so that if, for example, bits 6 and 7 are set, this attribute is encoded as the octet string '030000'H. Bits: 'sourceMac': 13, 'cmInterfaceMask': 18, 'ipTos': 2, 'ipSourceMask': 5, 'ipSourceAddr': 4, 'rulePriority': 0, 'flowLabel': 17, 'sourcePortEnd': 9, 'ipDestMask': 7, 'vlanId': 16, 'destPortEnd': 11, 'icmpTypeLow': 19, 'ipDestAddr': 6, 'icmpTypeHigh': 20, 'ethertype': 14, 'activationState': 1, 'ipProtocol': 3, 'destPortStart': 10, 'destMac': 12, 'sourcePortStart': 8, 'userPri': 15.

This attribute indicates the type of the Internet address for InetSourceAddr, InetSourceMask, InetDestAddr, and InetDestMask. If the referenced parameter is not present in a classifier, this object reports the value of 'ipv4'.

This attribute represents the Flow Label field in the IPv6 header to be matched by the classifier. The value zero indicates that the Flow Label is not specified as part of the classifier and is not matched against the packets.

This attribute represents a bit-mask of the CM in-bound interfaces to which this classifier applies. This attribute only applies to QOS upstream Classifiers and upstream Drop Classifiers. For QOS downstream classifiers this object reports the zero-length string.

This attribute specifies the low-end inclusive range of the ICMP type numbers to which a packet is compared. If the referenced parameter is not present in a classifier, this attribute reports the value of 0.

This attribute specifies the high-end inclusive range of the ICMP type numbers to which a packet is compared. If the referenced parameter is not present in a classifier, this attribute reports the value of 255.

This object describes the set of QOS parameters defined in a managed device. DOCSIS 1.0 COS service profiles are not represented in this object. Each row corresponds to a DOCSIS QOS Parameter Set as signaled via DOCSIS MAC management messages. Each attribute of an instance of this object corresponds to one or part of one Service Flow Encoding. The BitMap attribute 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 for a default value to be used. That default value is reported as the value of the corresponding attribute in this object instance. Many attributes are not applicable, depending on the Service Flow direction, upstream scheduling type or Service Flow bonding configuration. The attribute value reported in this case is specified by those attributes descriptions.

The conceptual row of docsQosParamSetTable. The ifIndex key corresponds to the MAC Domain interface of the service flow of this Qos Param Set.

This attribute represents the Service Class Name from which the parameter set values were derived. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, this attribute returns the zero-length string.

This attribute represents the relative priority of a Service Flow. Higher numbers indicate higher priority. This priority should only be used to differentiate Service Flow from identical parameter sets. This attribute returns 0 if the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set or if the parameter is not applicable.

This attribute represents the maximum sustained traffic rate allowed for this Service Flow in bits/sec. It represents all MAC frame data PDUs 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 attribute applies to both upstream and downstream Service Flows. This attribute returns 0 if the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, or if the parameter is not applicable. This attribute will also return 0 if DataRateUnitSetting is enabled and the resulting value cannot be represented in 32 bits. In which case, docsQosParamSetHCMaxTrafficRate should be utilized.

This attribute 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 MaxTrafficRate to calculate maximum sustained traffic rate. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, this attribute returns 3044 for scheduling types 'bestEffort', 'nonRealTimePollingService' and 'realTimePollingService'. If this parameter is not applicable, it is reported as 0.

This attribute 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 value of 0 indicates that no bandwidth is reserved. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, this attribute returns 0. If the parameter is not applicable, it is reported as 0. This attribute will also return 0 if DataRateUnitSetting is enabled and the resulting value cannot be represented in 32 bits. In which case, docsQosParamSetHCMinReservedRate should be utilized.

This attribute specifies an assumed minimum packet size in bytes for which the MinReservedRate will be provided. The value is calculated from the byte following the MAC header HCS to the end of the CRC. If the referenced parameter is omitted from a DOCSIS QOS parameter set, the used and reported value is CMTS implementation 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 the value 0.

This attribute specifies the maximum duration in seconds that resources remain unused on an active service flow before the CMTS signals that both the active and admitted parameter sets are null. The value 0 signifies an infinite amount of time. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, this attribute returns 0.

This attribute 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, this attribute returns 200.

This attribute specifies the maximum concatenated burst in bytes that an upstream Service Flow is allowed. The value is calculated from the FC byte of the Concatenation MAC Header to the last CRC byte 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, this attribute returns the value of 1522 for scheduling types 'bestEffort', 'nonRealTimePollingService', and 'realTimePollingService'. If the parameter is not applicable, it is reported as 0.

This attribute 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, this attribute returns the value of 'bestEffort'. For QOS parameter sets of downstream Service Flows, this attribute's value is reported as 'undefined'.

This attribute specifies the nominal interval in microseconds between successive unicast request opportunities on an upstream Service Flow. This attribute applies only to upstream Service Flows with SchedulingType of value 'nonRealTimePollingService', 'realTimePollingService', and 'unsolictedGrantServiceWithAD'. The parameter is mandatory for 'realTimePollingService'. If the parameter is omitted with 'nonRealTimePollingService', the CMTS uses an implementation-dependent value. If the parameter is omitted with 'unsolictedGrantServiceWithAD(5)' the CMTS uses 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. Otherwise, it returns 0. 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 attribute's value as 0.

This attribute 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' or 'unsolictedGrantServiceWithAD'. 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 attribute's value as 0.

This attribute specifies the unsolicited grant size in bytes. The grant size includes the entire MAC frame data PDU from the Frame Control byte to the end of the MAC frame. The referenced parameter is applicable only for upstream flows with a SchedulingType of 'unsolicitedGrantServicewithAD' or 'unsolicitedGrantService', and it 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 attribute's value as 0.

This attribute 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 'unsolicitedGrantServicewithAD' or 'unsolicitedGrantService(6)', and it 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 attribute's value as 0.

This attribute 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 'unsolicitedGrantServicewithAD' or 'unsolicitedGrantService(6)', and it 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 attribute's value as 0.

This attribute specifies the number of data grants per Nominal Grant Interval (NomGrantInterval). The referenced parameter is applicable only for upstream flows with a SchedulingType of 'unsolicitedGrantServicewithAD' or 'unsolicitedGrantService', and it 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 attribute's value as 0.

This attribute specifies the AND mask for the IP TOS byte for overwriting an IPv4 packet's TOS value or IPv6 packet's Traffic Class value. The IP packet TOS byte is bitwise ANDed with TosAndMask, then the result is bitwise ORed with TosORMask and the result is written to the IP packet TOS byte. A value of 'FF'H for TosAndMask and a value of '00'H for TosOrMask means that the IP Packet TOS byte is not overwritten. This combination is reported if the referenced parameter is not present in a QOS Parameter Set. The IP TOS octet as originally defined in RFC 791 has been superseded by the 6-bit Differentiated Services Field (DSField, RFC 3260) and the 2-bit Explicit Congestion Notification Field (ECN field, RFC 3168). The IPv6 Traffic Class octet RFC 2460 is consistent with that new definition. Network operators SHOULD avoid specifying values of TosAndMask and TosORMask that would result in the modification of the ECN bits. In particular, operators should not use values of TosAndMask that have either of the least-significant two bits set to 0. Similarly, operators should not use values of TosORMask that have either of the least-significant two bits set to 1. Even though this attribute is only enforced by the CMTS, the CM reports the value as signaled in the referenced parameter.

This attribute specifies the OR mask for the IPv4 TOS value or IPv6 Traffic Class value. See the description of TosAndMask for further details. The IP TOS octet, as originally defined in RFC 791 has been superseded by the 6-bit Differentiated Services Field (DSField, RFC 3260) and the 2-bit Explicit Congestion Notification Field (ECN field, RFC 3168). The IPv6 Traffic Class octet RFC 2460 is consistent with that new definition. Network operators SHOULD avoid specifying values of TosAndMask and TosORMask that would result in the modification of the ECN bits.

This attribute 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 is enforced. This attribute only applies to downstream Service Flows. If the referenced parameter is not present in the corresponding downstream DOCSIS QOS Parameter Set, this attribute returns 0. This parameter is not applicable to upstream DOCSIS QOS Parameter Sets, so its value is reported as 0 in that case.

This key represents the QoS Parameter Set Type of the Service Flow. The following values are defined: 'active' Indicates the Active QOS parameter set, describing the service currently being provided by the DOCSIS MAC domain to the service flow. 'admitted' Indicates the Admitted QOS Parameter Set, describing services reserved by the DOCSIS MAC domain for use by the service flow. 'provisioned' Indicates the QOS Parameter Set defined in the DOCSIS CM Configuration file for the service flow. Enumeration: 'active': 1, 'provisioned': 3, 'admitted': 2.

This attribute 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. The format of this string enumerated the bits from 0 to 31 from left to right, for example bit 0 corresponds to the left most bit of the fourth octet. (octets numbered from right to left). The bit positions are defined as follows: 'broadcastReqOpp' all CMs broadcast request opportunities 'priorityReqMulticastReq' priority request multicast request opportunities 'reqDataForReq' request/data opportunities for requests 'reqDataForData' request/data opportunities for data 'piggybackReqWithData' piggyback requests with data 'concatenateData' concatenate data 'fragmentData' fragment data 'suppressPayloadHeaders' suppress payload headers 'dropPktsExceedUGSize' A value of 1 means that the service flow must drop packets 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.

This attribute 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 associated parameter is present in the original request as follows: 'trafficPriority' Traffic Priority 'maxTrafficRate' Maximum Sustained Traffic Rate 'maxTrafficBurst' Maximum Traffic Burst 'minReservedRate' Minimum Reserved Traffic Rate 'minReservedPkt' Assumed Minimum Reserved Rate Packet Size 'activeTimeout' Timeout for Active QoS Parameters 'admittedTimeout' Timeout for Admitted QoS Parameters 'maxConcatBurst' Maximum Concatenated Burst 'schedulingType' Service Flow Scheduling Type 'requestPolicy' Request/Transmission Policy 'nomPollInterval' Nominal Polling Interval 'tolPollJitter' Tolerated Poll Jitter 'unsolicitGrantSize' Unsolicited Grant Size 'nomGrantInterval' Nominal Grant Interval 'tolGrantJitter' Tolerated Grant Jitter 'grantsPerInterval' Grants per Interval 'tosOverwrite' IP Type of Service (DSCP) Overwrite 'maxLatency' Maximum Downstream Latency 'requiredAttrMask' Service Flow Required Attribute Mask 'forbiddenAttrMask Service Flow Forbidden Attribute Mask 'attrAggrMask' Service Flow Attribute Aggregation Mask 'applicationId' Application Identifier 'multipCntnReqWindow' Multiplier to Contention Request Backoff Window 'multipBytesReq' Multiplier to Number of Bytes Requested 'maxReqPerSidCluster' Maximum Requests per SID Cluster 'maxOutstandingBytesPerSidCluster' Maximum Outstanding Bytes per SID Cluster 'maxTotalBytesReqPerSidCluster' Maximum Total Bytes Requested per SID Cluster 'maximumTimeInSidCluster' Maximum Time in the SID Cluster 'peakTrafficRate' Peak Traffic Rate 'dsResequencing' Downstream Resequencing 'minimumBuffer' Minimum Buffer 'targetBuffer' Target Buffer 'maximumBuffer' Maximum Buffer -- XXX IATC stuff here?!? 'aqmDisabled' SF AQM Disabled 'aqmLatencyTarget' SF AQM Latency Target 'dataRateUnit' Data Rate Unit Setting Note that when Service Class names are expanded, the registration or dynamic response message may contain parameters expanded by the CMTS based on a stored service class. These expanded parameters are not indicated by a 1 bit in this attribute. Note that even though some QOS Parameter Set parameters may not be signaled in a message (so that the parameter's bit in this object is 0), the DOCSIS specification requires that default values be used. These default values are reported as the corresponding attribute. Bits: 'activeTimeout': 5, 'minReservedPkt': 4, 'maximumBuffer': 32, 'nomPollInterval': 10, 'unsolicitGrantSize': 12, 'requestPolicy': 9, 'maxTrafficRate': 1, 'maxReqPerSidCluster': 24, 'admittedTimeout': 6, 'minimumBuffer': 30, 'applicationId': 21, 'aqmLatencyTarget': 34, 'tolGrantJitter': 14, 'requiredAttrMask': 18, 'aqmEnabled': 33, 'maxLatency': 17, 'nomGrantInterval': 13, 'peakTrafficRate': 28, 'schedulingType': 8, 'multipCntnReqWindow': 22, 'attrAggrMask': 20, 'trafficPriority': 0, 'forbiddenAttrMask': 19, 'dataRateUnit': 35, 'targetBuffer': 31, 'maxTrafficBurst': 2, 'tosOverwrite': 16, 'dsResequencing': 29, 'minReservedRate': 3, 'grantsPerInterval': 15, 'tolPollJitter': 11, 'maxTotalBytesReqPerSidCluster': 26, 'multipBytesReq': 23, 'maxConcatBurst': 7, 'maximumTimeInSidCluster': 27, 'maxOutstandingBytesPerSidCluster': 25.

This key represents the Service Flow ID for the service flow.

This attribute specifies the Required Attribute Mask to compare with the Provisioned Required Attributes when selecting the bonding groups for the service flow. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, this attribute returns '00000000'H.

This attribute specifies the Forbidden Attribute Mask to compare with the Provisioned Forbidden Attributes when selecting the bonding groups for the service flow. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, this attribute returns '00000000'H.

This attribute specifies the Attribute Aggregation Mask to compare the Service Flow Required and Forbidden Attributes with the CMTS dynamically-created bonding group when selecting the bonding groups for the service flow. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, this attribute returns '00000000'H.

This attribute represents the Application Identifier associated with the service flow for purposes beyond the scope of this specification. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, this attribute returns 0.

This attribute specifies the multiplier to be applied by a CM when performing contention request backoff for data requests. This attribute only applies to upstream Service Flows in 3.0 operation. If the referenced parameter is not present in the upstream DOCSIS QOS Parameter Set or is not applicable, this attribute returns 8.

This attribute specifies the assumed bandwidth request multiplier. This attribute only applies to upstream Service Flows in 3.0 operation. If the referenced parameter is not present in the upstream DOCSIS QOS Parameter Set, or is not applicable, this attribute returns 4.

This attribute specifies the maximum number of requests that a CM can make within a given SID Cluster before it must switch to a different SID Cluster to make further requests. A value of 0 indicates there is no limit. This attribute only applies to upstream Service Flows in 3.0 operation, in other cases it is reported as 0. If the referenced parameter is not present in the DOCSIS QOS Parameter Set, this attribute returns 0. This attribute has been deprecated and replaced with docsQosServiceFlowMaxReqPerSidCluster in the docsQosServiceFlowTable.

This attribute specifies the maximum number of bytes for which a CM can have requests outstanding on a given SID Cluster. If defined number of bytes are outstanding and further requests are required, the CM must switch to a different SID Cluster if one is available. A value of 0 indicates there is no limit. This attribute only applies to upstream Service Flows in 3.0 operation, in other cases it is reported as 0. If the referenced parameter is not present in the DOCSIS QOS Parameter Set, this attribute returns 0. This attribute has been deprecated and replaced with docsQosServiceFlowMaxOutstandingBytesPerSidCluster in the docsQosServiceFlowTable.

This attribute specifies the maximum total number of bytes a CM can have requested using a given SID Cluster before it must switch to a different SID Cluster to make further requests. A value of 0 indicates there is no limit. This attribute only applies to upstream Service Flows in 3.0 operation, in other cases it is reported as 0. If the referenced parameter is not present in the DOCSIS QOS Parameter Set, this attribute returns 0. This attribute has been deprecated and replaced with docsQosServiceFlowMaxTotBytesReqPerSidCluster in the docsQosServiceFlowTable.

This attribute specifies the maximum time in milliseconds that a CM may use a particular SID Cluster before it must switch to a different SID Cluster to make further requests. A value of 0 indicates there is no limit. This attribute only applies to upstream Service Flows in 3.0 operation, in other cases it is reported as 0. If the referenced parameter is not present in the DOCSIS QOS Parameter Set, this attribute returns 0. This attribute has been deprecated and replaced with docsQosServiceFlowMaxTimeInSidCluster in the docsQosServiceFlowTable.

This attribute specifies the rate parameter 'P' of a token-bucket-based peak rate limiter for packets of a service flow. A value of 0 signifies no Peak Traffic Rate is enforced. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, this attribute returns 0. This attribute will also return 0 if DataRateUnitSetting is enabled and the resulting value cannot be represented in 32 bits. In which case, docsQosParamSetHCPeakTrafficRate should be utilized.

This attribute specifies if a resequencing DSID need to be allocated to the service flow. The value 'resequencingDsidIfBonded' indicates that a resequencing DSID is required if the service flow is assigned to a downstream bonding group. The value 'noResequencingDsid' indicates no resequencing DSID is associated with the service flow. The value 'notApplicable' indicates the value of this attribute is not applicable. This attribute only applies to downstream Service Flows in 3.0 operation. If the referenced parameter is not present in the corresponding downstream DOCSIS QOS Parameter Set, this attribute returns 'resequencingDsidIfBonded'. This parameter is not applicable to upstream DOCSIS QOS Parameter Sets, so the value 'notApplicable' is reported in that case. Enumeration: 'resequencingDsidIfBonded': 0, 'notApplicable': 2, 'noResequencingDsid': 1.

This attribute represents the configured minimum buffer size for the service flow.

This attribute represents the configured target buffer size for the service flow. The value 0 indicates that no target buffer size was configured, and the device will use a vendor specific value.

This attribute represents the configured maximum buffer size for the service flow. The value 4294967295 indicates that no maximum buffer size was configured, and thus there is no limit to the buffer size.

If this attribute returns 'true', AQM is disabled on the upstream or downstream service flow specified by docsQosParamSetServiceFlowId.

This attribute provides the latency target to be used for the AQM algorithm for the upstream or downstream Service Flow specified by docsQosParamSetServiceFlowId. For downstream service flows, the value 256 indicates an unknown latency target.

This attribute is a 64-bit representation of the maximum sustained traffic rate allowed for this Service Flow in bits/sec. It counts all MAC frame data PDUs 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 attribute applies to both upstream and downstream Service Flows. This attribute returns 0 if the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, or if the parameter is not applicable.

This attribute is a 64-bit representation of 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 value of 0 indicates that no bandwidth is reserved. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, this attribute returns 0. If the parameter is not applicable, it is reported as 0.

This attribute specifies the rate parameter 'P' of a token-bucket-based peak rate limiter for packets of a service flow. A value of 0 signifies no Peak Traffic Rate is enforced. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, this attribute returns 0.

This attribute specifies the AQM algorithm in use for this service flow. If AQM is disabled on the service flow specified by ServiceFlowId, this attribute returns unknown(1). The value unknown(1) is reported for downstream service flows or when AQM is disabled. The value other(2) indicates a vendor proprietary algorithm for upstream queue management. The value docsisPIE(3) indicates the upstream queue management Proportional Integral controller Enhanced (PIE) algorithm. Enumeration: 'unknown': 1, 'other': 2, 'docsisPIE': 3.

This object describes the set of DOCSIS-QOS Service Flows in a managed device.

The conceptual row of docsQosServiceFlowTable. The ifIndex key corresponds to the MAC Domain interface of this service flow.

This key represents an identifier assigned to a Service Flow by CMTS within a MAC Domain. The value 0 is used only for the purpose of reporting instances of the PktClass object pertaining UDCs and not used for association of QOS classifiers to service flows.

Service Identifier (SID) assigned to an admitted or active Service Flow. This attribute 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).

This attribute represents the direction of the Service Flow.

This attribute reflects whether Service Flow is the primary or a secondary Service Flow.

This attribute represents the status of the service flow based on the admission state. 'active' bit set to '1' indicates that the service flow is active and that the corresponding QOS ParamSet is stored in the CMTS. 'admitted' bit set to '1' indicates that the service flow resources were reserved and that the corresponding QOS ParamSet is stored in the CMTS. 'provisioned' bit set to '1' indicates that the service flow was defined in the CM config file and that the corresponding QOS ParamSet is stored in the CMTS. Bits: 'active': 0, 'provisioned': 2, 'admitted': 1.

This attribute represents the Channel Set Id associated with the service flow.

If set to 'true', this attribute indicates that the current channel set associated with the service flow meets the Required and Forbidden Attribute Mask encodings. Since this attribute is not applicable for a CM, the CM always returns 'false'.

This attribute indicates the DSID associated with the downstream service flow. downstream service flows without a DSID or upstream Service Flows report the value zero.

This attribute specifies the maximum number of requests that a CM can make within a given SID Cluster before it must switch to a different SID Cluster to make further requests. A value of 0 indicates there is no limit. This attribute only applies to upstream Service Flows in 3.0 operation, in other cases it is reported as 0.

This attribute specifies the maximum number of bytes for which a CM can have requests outstanding on a given SID Cluster. If defined number of bytes are outstanding and further requests are required, the CM must switch to a different SID Cluster if one is available. A value of 0 indicates there is no limit. This attribute only applies to upstream Service Flows in 3.0 operation, in other cases it is reported as 0.

This attribute specifies the maximum total number of bytes a CM can have requested using a given SID Cluster before it must switch to a different SID Cluster to make further requests. A value of 0 indicates there is no limit. This attribute only applies to upstream Service Flows in 3.0 operation, in other cases it is reported as 0.

This attribute specifies the maximum time in milliseconds that a CM may use a particular SID Cluster before it must switch to a different SID Cluster to make further requests. A value of 0 indicates there is no limit. This attribute only applies to upstream Service Flows in 3.0 operation, in other cases it is reported as 0.

This attribute specifies the buffer size for the service flow. For the CM this attribute only applies to upstream Service Flows, for the CMTS this attribute only applies to downstream Service Flows, in other cases it is reported as 0.

This attribute indicates the name of the IATC Profile for which this Service Flow belongs. If this Service Flow is not part of an IATC Profile, this attribute returns an empty string. For the CM this attribute does not apply. This attribute is only applicable for the CCAP.

This object describes statistics associated with the Service Flows in a managed device.

The conceptual row of docsQosServiceFlowStatsTable. The ifIndex key corresponds to the MAC Domain interface of the service flow.

For outgoing Service Flows, this attribute counts the number of Packet Data PDUs forwarded to this Service Flow. For incoming upstream CMTS service flows, this attribute counts the number of Packet Data PDUs actually received on the Service Flow identified by the SID for which the packet was scheduled. CMs not classifying downstream packets may report this attribute's value as 0 for downstream Service Flows. This attribute does not count MAC-specific management messages. Particularly for UGS flows, packets sent on the primary Service Flow in violation of the UGS grant size should be counted only by the instance of this attribute that is associated with the primary service flow. Unclassified upstream user data packets (i.e., non- MAC-management) forwarded to the primary upstream Service Flow should be counted by the instance of this attribute that is associated with the primary service flow. This attribute does include packets counted by ServiceFlowPolicedDelayPkts, but does not include packets counted by ServiceFlowPolicedDropPkts and ServiceFlowPHSUnknowns. This counter's last discontinuity is the ifCounterDiscontinuityTime for of the associated MAC Domain interface index.

This attribute indicates the count of the number of octets from the byte after the MAC header HCS to the end of the CRC for all packets counted in the ServiceFlowPkts attribute for this row. Note that this counts the octets after payload header suppression and before payload header expansion have been applied. This counter's last discontinuity is the ifCounterDiscontinuityTime for of the associated MAC Domain interface index.

This attribute indicates the value of sysUpTime when the service flow was created.

This attribute indicates the number of seconds that the service flow has been active. This counter's last discontinuity is the ifCounterDiscontinuityTime for of the associated MAC Domain interface index.

For incoming upstream CMTS service flows, this attribute counts the number of packets received with an unknown payload header suppression index. The service flow is identified by the SID for which the packet was scheduled. On a CM, only this attribute's instance for the primary downstream service flow counts packets received with an unknown payload header suppression index. All other downstream service flows on CM report this attributes value as 0. All outgoing service flows report this attribute's value as 0. This counter's last discontinuity is the ifCounterDiscontinuityTime for of the associated MAC Domain interface index.

For outgoing service flows, this attribute counts the number of Packet Data PDUs classified to this service flow dropped due to: (1) exceeding the selected Buffer Size for the service flow; or (2) UGS packets dropped due to exceeding the Unsolicited Grant Size with a Request/Transmission policy that requires such packets to be dropped. Classified packets dropped due to other reasons must be counted in either AqmDroppedPkts or ifOutDiscards for the interface of this service flow (depending on the reason for the discard). This attribute reports 0 for incoming service flows. This counter's last discontinuity is the ifCounterDiscontinuityTime for of the associated MAC Domain interface index.

This attribute counts only outgoing packets delayed in order to maintain the Maximum Sustained Traffic Rate. This attribute will always report a value of 0 for UGS flows because the Maximum Sustained Traffic Rate does not apply. This attribute is 0 for incoming service flows. This counter's last discontinuity is the ifCounterDiscontinuityTime for of the associated MAC Domain interface index.

For upstream service flows on which AQM is enabled, this attribute counts the number of Packet Data PDUs classified to this service flow dropped due to Active Queue Management drop decisions. Classified packets dropped due to other reasons are counted in either PolicedDropPkts or ifOutDiscards for the interface of this service flow (depending on the reason for the discard). This attribute reports zero for downstream service flows. This counter's last discontinuity is the ifCounterDiscontinuityTime of the associated MAC Domain interface index.

This object describes statistics associated with upstream service flows. All counted frames must be received without a Frame Check Sequence (FCS) error.

The conceptual row of docsQosUpstreamStatsTable. The ifIndex key corresponds to the upstream logical channel interface of the service flow. A DOCSIS 3.0 CMTS populates entries in the docsQosUpstreamStatsTable with information for Pre-3.0 DOCSIS devices. Devices operating in Multiple Transmit Channel mode will not be recorded in the docsQosUpstreamStatsTable and will instead be recorded in the docsQosServiceFlowCcfStatsTable.

This key identifies a service ID for an admitted or active upstream service flow.

This attribute indicates the number of fragmentation headers received on an upstream service flow, regardless of whether the fragment was correctly reassembled into a valid packet. This counter's last discontinuity is the ifCounterDiscontinuityTime for of the associated MAC Domain interface index.

This attribute indicates the number of upstream fragments discarded and not assembled into a valid upstream packet. This counter's last discontinuity is the ifCounterDiscontinuityTime for of the associated MAC Domain interface index.

This attribute indicates the number of concatenation headers received on an upstream service flow. This counter's last discontinuity is the ifCounterDiscontinuityTime for of the associated MAC Domain interface index.

This object describes statistics associated with the Dynamic Service Flows, Dynamic Channel Changes and Dynamic Bonding Changes in a managed device within a MAC Domain. For each MAC Domain there are two instances for the for the upstream and downstream direction. On the CMTS, the downstream direction instance indicates messages transmitted or transactions originated by the CMTS. The upstream direction instance indicates messages received or transaction originated by the CM. On the CM, the downstream direction instance indicates messages received or transactions originated by the CMTS. The upstream direction instance indicates messages transmitted by the CM or transactions originated by the CM.

The conceptual row of docsQosDynamicServiceStatsTable. The ifIndex key corresponds to the MAC Domain interface of the service flow.

This attribute indicates the interface direction for the instance the statistics are collected.

This attribute indicates the number of Dynamic Service Addition Requests, including retries. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

The number of Dynamic Service Addition Responses, including retries. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

The number of Dynamic Service Addition Acknowledgements, including retries. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

The number of Dynamic Service Change Requests, including retries. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

The number of Dynamic Service Change Responses, including retries. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

The number of Dynamic Service Change Acknowledgements, including retries. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

The number of Dynamic Service Delete Requests, including retries. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

The number of Dynamic Service Delete Responses, including retries. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

The number of successful Dynamic Service Addition transactions. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

The number of failed Dynamic Service Addition transactions. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

The number of successful Dynamic Service Change transactions. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

The number of failed Dynamic Service Change transactions. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

The number of successful Dynamic Service Delete transactions. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

The number of failed Dynamic Service Delete transactions. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

The number of Dynamic Channel Change Request messages traversing an interface. This count is nonzero only on downstream direction rows. This count should include the number of retries. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

The number of Dynamic Channel Change Response messages traversing an interface. This count is nonzero only on upstream direction rows. This count should include the number of retries. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

The number of Dynamic Channel Change Acknowledgement messages traversing an interface. This count is nonzero only on downstream direction rows. This count should include the number of retries. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

The number of successful Dynamic Channel Change transactions. This count is nonzero only on downstream direction rows. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

The number of failed Dynamic Channel Change transactions. This count is nonzero only on downstream direction rows. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

This attribute contains the number of Dynamic Channel Change Response (depart) messages. It only applies to upstream direction. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

This attribute contains the number of Dynamic Channel Change Response (arrive) messages and should include retries. It only applies to the upstream direction. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

This attribute contains the number of Dynamic Bonding Change Requests, including retries. It only applies to the upstream direction. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

This attribute contains the number of Dynamic Bonding Change Responses, including retries. It only applies to the upstream direction. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

This attribute contains the number of Dynamic Bonding Change Acknowledgements, including retries. It only applies to the downstream direction. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

This attribute contains the number of fully successful Dynamic Bonding Change transactions. It only applies to the downstream direction and does not include DBC transactions that result in Partial Service. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

This attribute contains the number of failed Dynamic Bonding Change transactions. It only applies to the downstream direction. Note that Partial Service is not considered a failed transaction. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

This attribute contains the number of unsuccessful Dynamic Bonding Change transactions that result in Partial Service. IT only applies to the downstream direction. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

This object contains a log of the disconnected Service Flows in a managed device.

The conceptual row of docsQosServiceFlowLogTable.

This key indicates an unique index for a logged service flow.

This attribute indicates the MAC Domain Interface index where the service flow was present.

This attribute indicates the identifier assigned to the service flow.

This attribute indicates the MAC address of the cable modem associated with the service flow.

This attribute indicates the final value of the Pkts attribute in the ServiceFlowStats object for the service flow.

This attribute indicates the final value of the Pkts attribute in the ServiceFlowStats object for the service flow.

This attribute indicates the value of sysUpTime when the service flow was deleted.

This attribute indicates the value of sysUpTime when the service flow was created.

This attribute indicates the total time that the service flow was active.

This attribute indicates the value of Service Flow direction for the service flow.

If set to 'true', this attribute indicates that the Service Flow in the log was a Primary Service Flow, otherwise, a Secondary Service Flow.

This attribute indicates the value of ServiceClassName for the provisioned QOS Parameter Set of the service flow.

This attribute indicates the final value of PolicedDropPkts attribute of the ServiceFlowStats object for the service flow.

This attribute indicates the final value of PolicedDelayPkts attribute of the ServiceFlowStats object for the service flow.

This attribute when set to 'destroy' removes this instance from the object. Reading this attribute returns the value 'active'. Enumeration: 'active': 1, 'destroy': 6.

This object describes a provisioned service class on a CMTS. Each object instance defines a template for certain DOCSIS QOS Parameter Set values. When a CM creates or modifies an Admitted QOS Parameter Set for a Service Flow, it may reference a Service Class Name instead of providing explicit QOS Parameter Set values. In this case, the CMTS populates the QOS Parameter Set with the applicable corresponding values from the named Service Class. Subsequent changes to a Service Class row do not affect the QOS Parameter Set values of any service flows already admitted. A service class template applies to only a single direction, as indicated in the ServiceClassDirection attribute.

The conceptual row of docsQosServiceClassTable.

This key indicates the Service Class Name associated with this object instance. DOCSIS specifies that the maximum size is 16 ASCII characters including a terminating zero. The terminating zero is not represented in this SnmpAdminString syntax attribute.

The conceptual row status of this object.

This attribute is the template for the Priority attribute of the QoS Parameter Set.

This attribute is the template for the MaxTrafficRate attribute of the QoS Parameter Set. This attribute will also return 0 if DataRateUnitSetting is enabled for this Service Class and the resulting value cannot be represented in 32-bits. In which case, docsQosServiceClassHCMaxTrafficRate should be utilized.

This attribute is the template for the MaxTrafficBurst attribute of the QoS Parameter Set.

This attribute is the template for the MinReservedRate attribute of the QoS Parameter Set. This attribute will also return 0 if DataRateUnitSetting is enabled for this Service Class and the resulting value cannot be represented in 32-bits. In which case, docsQosServiceClassHCMinReservedRate should be utilized.

This attribute is the template for the MinReservedPkt attribute of the QoS Parameter Set.

This attribute is the template for the MaxConcatBurst attribute of the QoS Parameter Set.

This attribute is the template for the NomPollInterval attribute of the QoS Parameter Set.

This attribute is the template for the TolPolJitter attribute of the QoS Parameter Set.

This attribute is the template for the UnsolicitGrantSize attribute of the QoS Parameter Set.

This attribute is the template for the NomGrantInterval attribute of the QoS Parameter Set.

This attribute is the template for the TolGrantJitter attribute of the QoS Parameter Set.

This attribute is the template for the GrantsPerInterval attribute of the QoS Parameter Set.

This attribute is the template for the MaxLatency attribute of the QoS Parameter Set.

This attribute is the template for the ActiveTimeout attribute of the QoS Parameter Set.

This attribute is the template for the AddmitedTimeout attribute of the QoS Parameter Set.

This attribute is the template for the SchedulingType attribute of the QoS Parameter Set.

This attribute is the template for the ReqPolicyOct attribute of the QoS Parameter Set.

This attribute is the template for the TosAndMask attribute of the QoS Parameter Set.

This attribute is the template for the TosOrMask attribute of the QoS Parameter Set.

This attribute is the template for the Direction attribute of the QoS Parameter Set.

This attribute defines whether this row is kept in volatile storage and lost upon reboot or whether it is backed up by non-volatile or permanent storage. 'permanent' entries need not allow writable access to any instance attribute.

This attribute allows the overwrite of the DSCP field per RFC 3260. If this attribute is -1, then the corresponding TosAndMask value is set to be 'FF'H and TosOrMask is set to '00'H. Otherwise, this attribute is in the range of 0..63, and the corresponding TosAndMask value is '03'H and TosOrMaskvalue is this attribute value shifted left by two bit positions.

This attribute is the template for the RequiredAttrMask attribute of the QoS Parameter Set.

This attribute is the template for the ForbiddenAttrMask attribute of the QoS Parameter Set.

This attribute is the template for the AttrAggregationMask attribute of the QoS Parameter Set.

This attribute is the template for the AppId attribute of the QoS Parameter Set.

This attribute is the template for the MultiplierContentionReqWindow attribute of the QoS Parameter Set.

This attribute is the template for the MultiplierBytesReq attribute of the QoS Parameter Set.

This attribute is the template for the MaxReqPerSidCluster attribute of the QoS Parameter Set. This attribute has been deprecated and replaced with docsQosServiceFlowMaxReqPerSidCluster in the docsQosServiceFlowTable.

This attribute is the template for the MaxOutstandingBytesPerSidCluster attribute of the QoS Parameter Set. This attribute has been deprecated and replaced with docsQosServiceFlowMaxOutstandingBytesPerSidCluster in the docsQosServiceFlowTable.

This attribute is the template for the MaxTotBytesReqPerSidCluster attribute of the QoS Parameter Set. This attribute has been deprecated and replaced with docsQosServiceFlowMaxTotBytesReqPerSidCluster in the docsQosServiceFlowTable.

This attribute is the template for the MaxTimeInSidCluster attribute of the QoS Parameter Set. This attribute has been deprecated and replaced with docsQosServiceFlowMaxTimeInSidCluster in the docsQosServiceFlowTable.

This attribute is the template for the PeakTrafficRate attribute of the QoS Parameter Set. This attribute will also return 0 if DataRateUnitSetting is enabled for this Service Class and the resulting value cannot be represented in 32-bits. In which case, docsQosServiceClassHCPeakTrafficRate should be utilized.

This attribute is the template for the DsResequencing attribute of the QoS Parameter Set. Enumeration: 'resequencingDsid': 0, 'noResequencingDsid': 1.

This attribute is the template for the MinimumBuffer attribute of the QoS Parameter Set.

This attribute is the template for the TargetBuffer attribute of the QoS Parameter Set.

This attribute is the template for the MaximumBuffer attribute of the QoS Parameter Set.

If this attribute returns 'true', AQM is disabled for Service Flows in this Service Class.

This attribute provides the latency target to be used for the AQM algorithm for the upstream or downstream Service Flow specified by docsQosParamSetServiceFlowId. For downstream service flows, the value 256 indicates an unknown latency target.

This attribute is a 64-bit representation of the maximum sustained traffic rate allowed for this Service Flow in bits/sec. It counts all MAC frame data PDUs 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 attribute applies to both upstream and downstream Service Flows. This attribute returns 0 if the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, or if the parameter is not applicable.

This attribute is a 64-bit representation of 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 value of 0 indicates that no bandwidth is reserved. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, this attribute returns 0. If the parameter is not applicable, it is reported as 0.

This attribute specifies the rate parameter 'P' of a token-bucket-based peak rate limiter for packets of a service flow. A value of 0 signifies no Peak Traffic Rate is enforced. If the referenced parameter is not present in the corresponding DOCSIS QOS Parameter Set, this attribute returns 0.

This object describes the set of payload header suppression of Service Flows.

The conceptual row of docsQosPHSTable. The ifIndex key corresponds to the MAC Domain interface of the service flow of the classifier that includes this PHS rule.

This attribute indicates the Payload Header suppression field defines the bytes of the header that must be suppressed/restored by the sending/receiving device. The number of octets in this attribute should be the same as the value of PHSSize.

This attribute defines the bit mask that is used in combination with the PHSField. It defines which bytes in the header must be suppressed/restored by the sending or receiving device. Each bit of this bit mask corresponds to a byte in the PHSField, with the least significant bit corresponding to the first byte of the PHSField. Each bit of the bit mask specifies whether the corresponding byte should be suppressed 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 PHSField, then the bit mask is extended with bit values of '1' to be the necessary length.

This attribute specifies the number of bytes in the header to be suppressed and restored. The value of this attribute matches the number of bytes in the Field attribute.

If 'true', this attribute indicates that the sender must verify that the PHS Field is the same as the content in the packet to be suppressed.

This attribute uniquely references the PHS rule for a given service flow.

This object provides the mapping of unicast service flows with the cable modem the service flows belongs to.

The conceptual row of docsQosCmtsMacToSrvFlowTable.

This key represents the MAC address for the referenced CM.

This key represents the identifier of the Service Flow.

This attribute represents the interface index of the MAC domain of the Service Flow and where the CableModem is registered.

This object defines the SID clusters associated with an upstream service flow.

The conceptual row of docsQosServiceFlowSidClusterTable. The ifIndex key corresponds to the MAC Domain interface of the service flow.

This key represents the SID Cluster ID of the SID Cluster.

This key represents the upstream Channel ID mapped to the corresponding SID.

This attribute represents the SID assigned to the upstream channel in this SID Cluster.

This object provides extensions to the service flow information for Group Service Flows (GSFs).

The conceptual row of docsQosGrpServiceFlowTable. The ifIndex key corresponds to the MAC Domain interface of the group service flow.

This attribute indicates whether the GSF QOS Parameter Set corresponds to the Default Group Service Flow.

This attribute indicates the Group QoS Configuration (GQC) identifier used of the creation of this GSF. The value zero indicates that the Service Flow is using the default service flow.

This attribute indicates the number of sessions that are configured in an aggregated Service Flow. If this is a single session replication, the value of this attribute is 1.

This attribute specifies the specific multicast Source Address that is configured in a single session Service Flow. If this is an aggregate Service Flow (NumSess attribute reports a value greater than 1) this attribute returns one of the multicast source addresses for the session. For the case of Any Source Multicast (ASM), this attribute reports a value of 0.0.0.0 for IPv4 or 0::/0 for IPv6.

This attribute specifies the specific Multicast Group Address that is configured in a single session Service Flow. If this is an aggregate Service Flow (NumSess attribute reports a value greater than 1) this attribute returns the multicast group address associated with the SrcAddr for the session.

This attribute indicates the type of the Internet address for ServiceFlowSrcAddr and ServiceFlowGrpAddr.

This object provides additional packet classification information for Group Classifier References (GCRs) in a Group Service Flow (GSF).

The conceptual row of docsQosGrpPktClassTable. The ifIndex key corresponds to the MAC Domain interface of the service flow of this group classifier.

This attribute indicates the GC identifier used of the creation of this GSF.

This object provides extensions for service flow statistics for fragmentation for channel bonding.

The conceptual row of docsQosUpChCounterExtTable. The ifIndex key corresponds to the upstream Channel Interface of the service flow.

This attribute represents the total number segments processed on this channel. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

This attribute represents the total number of discarded segments on this channel due to segment HCS problems. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

This object provides upstream service flow statistics for Continuous Concatenation and Fragmentation (CCF). The CMTS may choose to not instantiate this object for service flows that do not use CCF or return a zero value for the individual counter statistics.

The conceptual row of docsQosServiceFlowCcfStatsTable. The ifIndex key corresponds to the MAC Domain interface of the service flow.

This attribute contains the number of segments counted on this service flow regardless of whether the fragment was correctly reassembled into valid packets. This attribute only gathers information for Segment Header On service flows. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

This attribute counts the number of segments which the CMTS segment reassembly function determines were lost. This attribute only gathers information for Segment Header On service flows. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

This object defines DOCSIS MAC services primitive statistics of upstream service flows. In pre-3.0 DOCSIS devices this statistics exists per SID for either Cos or Qos services in the SNMP table docsIfCmServiceTable. A 3.0 CM with CoS configuration (DOCSIS 1.0 mode) reports the statistics defined in the SNMP table docsIfCmServiceTable. A 3.0 CM with QoS configuration reports this object regardless of whether Multiple Transmit Channel is enabled or disabled.

The conceptual row of docsQosCmServiceUsStatsTable. The ifIndex key corresponds to the MAC Domain interface of the service flow.

This attribute contains the number of upstream mini-slots which have been used to transmit data PDUs in immediate (contention) mode. This includes only those PDUs that are presumed to have arrived at the head-end (i.e., those which were explicitly acknowledged.) It does not include retransmission attempts or mini-slots used by Requests. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

This attribute contains the number of upstream mini-slots which have been used to transmit data PDUs in dedicated mode (i.e., as a result of a unicast Data Grant). Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

This attribute contains the number of attempts to transmit data PDUs containing requests for acknowledgment that did not result in acknowledgment. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated MAC Domain interface index.

This attribute contains the number of attempts to transmit bandwidth requests which did not result in acknowledgment. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

This attribute contains the number of attempts to transmit bandwidth requests which did not result in acknowledgment. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

This attribute contains the number of requests for bandwidth which failed due to excessive retries without acknowledgment. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

This attribute contains the number of segments sent on this service flow. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime of the associated MAC Domain interface index.

This object describes DSID information stored in the CMTS. The CMTS reports the current status of existing DSIDs. When a DSID is created during the registration process or a DBC transaction, a corresponding object instance is created. If a DSID is deleted or changed via a DBC message the corresponding object instance is deleted or updated respectively.

The conceptual row of docsQosCmtsDsidTable. The ifIndex key corresponds to the MAC Domain interface of the DSID.

This key represents the DSID.

This attribute indicates the properties of the DSID. The bits are defined as follows: 'resequencing' This bit is set to 1 for a Resequencing DSID. 'multicastCapable' This bit is set to 1 for a DSID that is capable of transporting multicast traffic (i.e., the DSID has multicast forwarding attributes). 'multicastReplication' This bit is set to 1 for a DSID that is used for transporting a multicast replication (i.e., there is a corresponding instance of the MulticastRepl object). 'bonding' This bit is set to a 1 for a DSID that is associated with a bonding group. Bits: 'resequencing': 0, 'bonding': 3, 'multicastReplication': 2, 'multicastCapable': 1.

This attribute represents the Downstream Channel Set over which the DSID is being resequenced.

This attribute represents the DSID Resequencing Wait Time that is used for this DSID. This attribute is only valid when the Usage attribute has the resequencing bit set to 1. This attribute returns a value of 0 when the Usage attribute has the resequencing bit set to 0.

This attribute represents the DSID Resequencing Warning Threshold that is used for this DSID. The value of 0 indicates that the threshold warnings are disabled. This attribute is only valid when the Usage attribute has the resequencing bit set to 1. This attribute returns a value of 0 when the Usage attribute has the resequencing bit set to 0.

This attribute represents the hold-off timer for reporting Out-of-Range Events via the CM-STATUS MAC Management message. This attribute is only valid when the Usage attribute has the resequencing bit set to 1. This attribute returns a value of 0 when the Usage attribute has the resequencing bit set to 0.

This attribute reports the value of the most recent sequence number assigned by the CMTS for this DSID. This attribute is only valid when the Usage attribute has the resequencing bit set to 1. This attribute returns a value of 0 when the Usage attribute has the resequencing bit set to 0.

The CMTS Debug DSID object contains the control of DSID debug statistics reporting An instance in this object defines the DSID and MAC domain to which the CmtsDebugDsidStats collects statistics for the downstream channel associated with that DSID and MAC Domain. The deletion of an instance stops the reporting of statistics for the specified DSID. This object supports instance creation and deletion. The CMTS MUST support at least one instance of this object.

The conceptual row of docsQosCmtsDebugDsidTable. The ifIndex key corresponds to the MAC Domain interface of the DSID.

This attribute represents the DSID value to be debugged, identified by the IfIndex attribute of this object.

The conceptual row status of this object.

The CMTS Debug DSID Stats object describes statistics at the CMTS for the forwarding of DSID-labeled downstream packets. The CMTS creates an instance for every combination of MAC Domain, DSID value, and downstream channel on which packets labeled with that DSID are transmitted. The CMTS does not delete such instances while the corresponding CmtsDebug object control instance exists.

The conceptual row of docsQosCmtsDebugDsidStatsTable. The ifIndex key corresponds to the MAC Domain interface of the DSID.

This key represents an interface index of a downstream channel that belongs to the DSID

This attribute is a counter which contains the number of packets transmitted by the CMTS which are labeled with the DSID on the downstream channel. Discontinuities in the value of this counter can occur as indicated by the value of ifCounterDiscontinuityTime of the associated Downstream interface index.

This attribute counts the number of bytes transmitted by the CMTS which are labeled with the DSID on the downstream interface. Discontinuities in the value of this counter can occur as indicated by the value of ifCounterDiscontinuityTime of the associated Downstream interface index.

When a DSID is created, during the registration process or a DBC transaction,. The CM reports the current status of existing DSID, for example, if a DSID is deleted or changed via DBC messages the corresponding object instance is deleted or updated respectively.

The conceptual row of docsQosCmDsidTable The ifIndex key corresponds to the MAC Domain interface of the DSID.

This key represents the DSID.

This attribute indicates the properties of the DSID. The bits are defined as follows: 'resequencing' : This bit is set to 1 for a Resequencing DSID. 'multicastCapable' : This bit is set to 1 for a DSID that is capable of transporting multicast traffic (e.g., the DSID has multicast forwarding attributes). Bits: 'resequencing': 0, 'multicastCapable': 1.

This attribute represents the number of channels in the downstream resequencing channel list for this DSID. When a DSID is used only for a non-bonded Multicast replication, this object returns a value of 0.

This attribute represents the Downstream Channel Set over which the DSID is being resequenced.

This attribute represents the DSID Resequencing Wait Time that is used for this DSID. This attribute is only valid when the Usage attribute has the resequencing bit set to 1. This attribute returns a value of 0 when the Usage attribute has the resequencing bit set to 0.

This attribute represents the DSID Resequencing Warning Threshold that is used for this DSID. The value of 0 indicates that the threshold warnings are disabled. This attribute is only valid when the Usage attribute has the resequencing bit set to 1. This attribute returns a value of 0 when the Usage attribute has the resequencing bit set to 0.

This attribute represents the hold-off timer for reporting Out-of-Range Events via the CM-STATUS MAC Management message. This attribute is only valid when the Usage attribute has the resequencing bit set to 1. This attribute returns a value of 0 when the Usage attribute has the resequencing bit set to 0.

This attribute represents the current count of out-of-range packets discarded by the CM for a given resequencing context since an in-range packet was received. When this count exceeds 1000 and more than two minutes have elapsed since an in-range packet was received, the CM will reacquire sequence numbers for this resequencing context.

This attribute represents the Next Expected Packet Sequence Number for a given resequencing context. This attribute is only valid when the Usage attribute has the resequencing bit set to 1. This attribute returns a value of 0 when the Usage attribute has the resequencing bit set to 0.

This attribute represents the bitmap of the interfaces communicated to the CM in a Multicast DSID encoding.

This attribute represents the bitmap of the interfaces to which the CM forwards multicast traffic: a logical OR of interfaces identified in CmInterfaceMask and interfaces associated with the client MAC addresses identified in the instances for this DSID.

This object defines a set of statistics the CM collects per Dsid.

The conceptual row of docsQosCmDsidStatsTable.

This key represents the interface index of the MAC Domain associated with the DSID.

This attribute counts the number of times the Next Expected Packet Sequence Number is declared lost. In this case one or more data packets are lost. This is generally caused by downstream packet loss.

This attribute counts in-range sequenced packets which were successfully received by the CM after a wait time longer than the Resequencing Warning Threshold.

This attribute counts the number of packets Counter received in a DSID reassembly context where the sequence number which is out of range.

This attribute counts the total number of data packets of a DSID context forwarded for further processing.

This object contains the client MAC addresses that the CMTS requests that the CM uses to replicate Multicast DSIDs during registration or during a DBC transaction. When a DSID is created that includes client MAC addresses, or when client MAC addresses are added to a DSID, new rows are created to indicate the added client MAC addresses. When a Client MAC address is deleted from a DSID, the corresponding row is deleted. When a DSID is deleted, all corresponding rows are deleted, too.

The conceptual row of docsQosCmDsidClientTable.

This key defines the DSID that the client MAC addresses are associated with.

This key defines a uniquely identified Client Mac Addresses associated with the DSID.

This attribute defines a client MAC address to which Multicast traffic labeled with this DSID should be forwarded.

If this attribute is set to 'false', the CM disables Active Queue Management (AQM) on all upstream service flows.

This attribute specifies the default upstream service flow target buffer size, in milliseconds, when not specified otherwise in service flow TLV encodings.

This object provides IATC statistics on a per profile basis. The IATC Profile statistics are associated with a DOCSIS channel or bonding group and one or more Service Flows. The CMTS is not required to persist instances of this object across reinitializations.

The conceptual row of docsQosCmtsIatcProfileStatsTable.

This key represents the IATC Profile to which this instance applies.

This attribute represents the index, such as the ifIndex, of the DOCSIS channel or the index of the bonding group to which this instance applies.

This attribute indicates the direction to which the IATC Profile is applied.

This attribute counts the number of Packet Data PDUs forwarded to this IATC Profile.

This attribute counts the number of octets forwarded to this IATC Profile.

This attribute counts the number of dropped Packet Data PDUs classified to this IATC Profile.

This attribute counts the number of delayed Packet Data PDUs classified to this IATC Profile.

The compliance statement of managed objects common for Cable Modem Termination Systems (CMTS) and Cable Modems (CM).

The compliance statement for deprecated objects.

Group of objects implemented in both CM and CMTS.

Group of objects implemented in the CMTS only.

Group of objects implemented in the CM only.

Group of deprecated objects no longer required to be supported by conformant devices as they have been replaced by other objects.

Group of obsolete objects no longer required to be supported by conformant devices.