CISCO-CABLE-QOS-MONITOR-MIB Table View

This table contains the attributes of the QoS enforce rules
present on the CMTS. 
          
These enforce rules define the criteria for identifying 
subscribers who over consume resources. This could be as 
simple as bytes transmitted over the last monitoring 
duration and checked at a rate equal to the sample rate.
          
In the sliding window concept used, the monitoring duration
is the size of the window. This window slides by an amount
that is equal to the sample rate. At every sample rate the 
bytes transmitted in the time equal to a monitoring duration 
is  checked. If this is found to be larger than the threshold
limit which is calculated by multiplying the defined average
rate by the monitoring duration per monitoring duration, 
the subscriber is flagged as over consuming.  Else the 
monitoring will continue.
          
For example let the monitoring duration be 360 minutes and
sample rate be 30 minutes. If the average rate is 2kbits/sec 
then every 30 minutes we check if the bytes transmitted in 
the last 360 minutes exceeded 5.4Mbytes bytes. If so, the 
subscriber is over consuming.
          
The enforce rule has a one to one mapping to QoS profiles 
in case of DOCSIS1.0 (and DOCSIS1.0+ modems) and to 
service class names in case of DOCSIS1.1 and 
DOCSIS2.0 modems.
          
It defines the registered QoS parameter set and an enforced 
QoS parameter set be applied if found to be violating the 
registered QoS parameter set.
The enforce rule also defines a penalty period for which
the enforced QoS parameter set will be applied. The 
registered QoS parameter set will be restored when the 
penalty period expires.
          
The monitoring can be of two types:
1) Legacy/Basic monitoring: There is only one threshold and 
   one monitoring-duration and the monitoring-duration
   can be more than one day and within a day there is no
   distinction among hours as peak or offpeak hours. An
   example would be: 
   monitoring duration   : 2 days
   Average rate          : 2kbits/sec
          
2) Peak-offPeak monitoring: A maximum of two peak durations 
   can be defined with in a day and the remaining hours are 
   treated as off-peak and the monitoring will happen during
   these offpeak hours if the offpeak duration and threhold
   are defined. The monitoring-duration and threshold for 
   all three, first peak, second peak and offpeak can be 
   different. Here, the monitoring duration for any of the 
   peaks or offpeak cannot be more than a day. An
   example when both peaks and offpeak are defined is:
   First peak:
         monitoring duration: Between 6am to 9am i.e., 3hours
         Average rate       : 2kbits/sec
   Second peak:
         monitoring duration: Between 6pm to 10pm i.e., 4hrs
         Average rate       : 3kbits/sec
   Off peak:
         Remaining hours in the day i.e.,
         12 midnight to 6:00am,
         9am to 6pm and 10pm to 12mignight.
         monitoring duration: 2 hours
         Average rate       : 1kbits/sec.

ccqmCmtsEnforceRuleEntry row .1.3.6.1.4.1.9.9.341.1.1.1.1

A set of attributes of a enforce rule on the CMTS.
One entry exists for each QoS enforce rule. It is
indexed by ccqmCmtsEnfRuleName as each enforce rule
is associated with a unique name. The user can define
the legacy…

Indexes

ccqmCmtsEnfRuleName

Column	Syntax	OID
ccqmCmtsEnfRuleName The name of the enforce rule.	OctetString Constraints: range: 1-15	.1.3.6.1.4.1.9.9.341.1.1.1.1.1
ccqmCmtsEnfRuleRegQoS This object represents a pointer to the object describing the quality of service attributes associated with the registered service of the subscriber. For DOCSIS1.0 (DOCSIS1.0+) subscribers it is the index in the docs…	Unsigned32r/w Constraints: range: 0-16383	.1.3.6.1.4.1.9.9.341.1.1.1.1.2
ccqmCmtsEnfRuleEnfQos This object represents a pointer to the object describing the quality of service attributes associated with the registered service of the subscriber. For DOCSIS1.0 (and DOCSIS1.0+) subscribers it is the index in the d…	Unsigned32r/w Constraints: range: 0-16383	.1.3.6.1.4.1.9.9.341.1.1.1.1.3
ccqmCmtsEnfRuleMonDuration This object represents the duration for which subscribers would be monitored to determine if they were over consuming resources. This object can be set only when ccqmCmtsEnfRuleMonType is set to basic(1). If peak-offp…	minutesUnsigned32r/w Constraints: range: 10-44640	.1.3.6.1.4.1.9.9.341.1.1.1.1.4
ccqmCmtsEnfRuleSampleRate This object represents the interval at which a decision would be made to check if the subscriber over consumed his resources based on the subscriber usage in the past duration. Since the duration can range between 10 …	minutesSNMPv2-SMIUnsigned32r/w Type Constraints: range: 0..4294967295	.1.3.6.1.4.1.9.9.341.1.1.1.1.5
ccqmCmtsEnfRulePenaltyPeriod This object represents the period in which the enforced QoS parameter set will be in effect from the time of detection. When the time as defined by this object expires, the registered QoS parameter set would be restor…	minutesUnsigned32r/w Constraints: range: 1-10080	.1.3.6.1.4.1.9.9.341.1.1.1.1.6
ccqmCmtsEnfRuleByteCountobsolete The number of kbytes that the subscriber can transmit in the monitoring duration as indicated by ccqmCmtsEnfRuleMonDuration before being flagged as over consuming. This object cannot be changed when ccqmCmtsEnfRuleR…	1000 bytesSNMPv2-SMIUnsigned32r/w Type Constraints: range: 0..4294967295	.1.3.6.1.4.1.9.9.341.1.1.1.1.7
ccqmCmtsEnfRuleDirection Specifies if the average rate specified by ccqmCmtsEnfRuleAvgRate is for the upstream/downstream direction. Setting to bidirection(3) is not permitted. This object cannot be changed when ccqmCmtsEnfRuleRowStatus is …	CCQMRuleDirectionr/w Type Values: 1 upstream 2 downstream 3 bidirection	.1.3.6.1.4.1.9.9.341.1.1.1.1.8
ccqmCmtsEnfRuleAutoEnforce If the ccqmCmtsEnfRuleAutoEnforce is TRUE, the enforced QoS parameter set as specified by ccqmCmtsEnfRuleEnfQos for DOCSIS1.0 (and DOCSIS1.0+) modems or ccqmCmtsEnfRuleEnfSerClassName for DOCSIS1.1 and DOCSIS2.0 modems …	SNMPv2-TCTruthValuer/w Type Values: 1 true 2 false Description: Represents a boolean value.	.1.3.6.1.4.1.9.9.341.1.1.1.1.9
ccqmCmtsEnfRuleRowStatus The object controls and reflects the status of rows in this table. All row status values are supported. The status of the row needs to be changed from active(1) to notInService(2) in cases when any of the enforce rule…	SNMPv2-TCRowStatusr/w Type Values: 1 active 2 notInService 3 notReady 4 createAndGo 5 createAndWait 6 destroy Description: The RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of …	.1.3.6.1.4.1.9.9.341.1.1.1.1.10
ccqmCmtsEnfRuleAvgRate This object defines the rate at which the subscriber is allowed to consume for the monitoring duration. So, if this rate is defined to be 2kbits/sec and the monitoring duration is set to be 120 minutes, then every samp…	kbits/secSNMPv2-SMIUnsigned32r/w Type Constraints: range: 0..4294967295	.1.3.6.1.4.1.9.9.341.1.1.1.1.11
ccqmCmtsEnfRuleDocsVer This defines the DOCSIS version of the modems that the enforce rule would be applicable to. If it is set to docsis10(2) then only ccqmCmtsEnfRuleRegQoS and ccqmCmtsEnfRuleEnfQoS can be set and if previously ccqmCmtsEn…	Enumerationr/w Enumerated Values: 1 others 2 docsis10	.1.3.6.1.4.1.9.9.341.1.1.1.1.12
ccqmCmtsEnfRuleRegSerClassName This object represents a pointer to the object describing the quality of service attributes associated with the registered service of the subscriber. For DOCSIS1.1 and DOCSIS2.0 subscribers it is same as docsQosParamSet…	OctetStringr/w Constraints: range: 1-16	.1.3.6.1.4.1.9.9.341.1.1.1.1.13
ccqmCmtsEnfRuleEnfSerClassName This object represents a pointer to the object describing the quality of service attributes associated with the registered service of the subscriber. For DOCSIS1.1 and DOCSIS2.0 subscribers it is same as docsQosParamSet…	OctetStringr/w Constraints: range: 1-16	.1.3.6.1.4.1.9.9.341.1.1.1.1.14
ccqmCmtsEnfRuleMonType This object defines the monitoring type. If it is set to basic(1), then ccqmCmtsEnfRuleMonDuration and ccqmCmtsEnfRuleAvgRate are used to define the monitoring and if the peak-offpeak objects were set before, they will…	Enumerationr/w Enumerated Values: 1 basic 2 peakOffPeak	.1.3.6.1.4.1.9.9.341.1.1.1.1.15
ccqmCmtsEnfRuleFirstPeakTime The user can define two peak times and the remaining hours will be treated as offpeak and the monitoring will happen for these offpeak hours if ccqmCmtsEnfRuleOffPeakDuration and ccqmCmtsEnfRuleOffPeakAvgRate are defi…	Unsigned32r/w Constraints: range: 0-23	.1.3.6.1.4.1.9.9.341.1.1.1.1.16
ccqmCmtsEnfRuleFirstDuration This object defines the duration for which the first peak time would be applicable. When ccqmCmtsEnfRuleMonDuration is polled during first peak, it will return this value. The ccqmCmtsEnfRuleFirstPeakTime has to be def…	minutesUnsigned32r/w Constraints: range: 60-1440	.1.3.6.1.4.1.9.9.341.1.1.1.1.17
ccqmCmtsEnfRuleFirstAvgRate This object defines the rate at which the subscriber is allowed to consume during the first peak duration. The ccqmCmtsEnfRuleFirstDuration has to be defined before defining this value. This object cannot be changed wh…	kbits/secSNMPv2-SMIUnsigned32r/w Type Constraints: range: 0..4294967295	.1.3.6.1.4.1.9.9.341.1.1.1.1.18
ccqmCmtsEnfRuleSecondPeakTime The user can define two peak times in a day. The second peak is defined using ccqmCmtsEnfRuleSecondPeakTime, ccqmCmtsEnfRuleSecondDuration and ccqmCmtsEnfRuleSecondThreshold objects while the first peak is defined u…	Unsigned32r/w Constraints: range: 0-23	.1.3.6.1.4.1.9.9.341.1.1.1.1.19
ccqmCmtsEnfRuleSecondDuration This object defines the duration for which the second peak time would be applicable. When ccqmCmtsEnfRuleMonDuration is polled during second peak, it will return this value. It can be set to 0 to indicate that the sec…	minutesUnsigned32r/w Constraints: range: 0-1380	.1.3.6.1.4.1.9.9.341.1.1.1.1.20
ccqmCmtsEnfRuleSecondAvgRate This object defines the rate at which the subscriber is allowed to consume during the second peak duration. The ccqmCmtsEnfRuleSecondDuration has to be defined before defining this value. This object cannot be changed …	kbits/secSNMPv2-SMIUnsigned32r/w Type Constraints: range: 0..4294967295	.1.3.6.1.4.1.9.9.341.1.1.1.1.21
ccqmCmtsEnfRuleOffPeakDuration This object defines the monitoring-duration that would be applicable for the offpeak times of the day. The off peak times are the times during the day when none of the first peak and second peak times are defined. If t…	minutesUnsigned32r/w Constraints: range: 0-1380	.1.3.6.1.4.1.9.9.341.1.1.1.1.22
ccqmCmtsEnfRuleOffPeakAvgRate This object defines the rate at which the subscriber is allowed to consume during the off-peak duration. The ccqmCmtsEnfRuleOffPeakDuration has to be defined before defining this value. This object cannot be changed wh…	kbits/secSNMPv2-SMIUnsigned32r/w Type Constraints: range: 0..4294967295	.1.3.6.1.4.1.9.9.341.1.1.1.1.23

This table contains information of the subscribers 
who violated their enforce rule over the monitoring 
duration.
In the sliding window concept used, the monitoring duration
is the size of the window. This window slides by an amount
that is equal to the sample rate. At every sample rate 
the bytes transmitted in the time equal to a monitoring 
duration is checked. If this is found to be larger than 
the defined byte count limit per monitoring duration, the 
subscriber is flagged as over consuming or to have violated
his enforce rule. 
This table has entries for each of these violating 
subscribers. In case the violating subscriber has
a enforced QoS parameter set, the QoS parameter set for 
such subscribers will be changed to the enforced QoS 
parameter set for the penalty time. When the penalty time
expires, the subscriber gets his registered QoS parameter
set restored and will no longer appear in this table but
will be monitored.

ccqmEnfRuleViolateEntry row .1.3.6.1.4.1.9.9.341.1.2.2.1

A set of attributes of a subscriber who violated
his enforce rule in the monitoring period.
An entry in this table exists for each subscriber
who over-consumed resources based on his configured
QoS parameter set. Howev…

Indexes

IF-MIBifIndex ccqmEnfRuleViolateID

Column	Syntax	OID
ccqmEnfRuleViolateID An index assigned to the service flow by the CMTS. This represents an internal service flow ID.	SNMPv2-SMIUnsigned32 Type Constraints: range: 0..4294967295	.1.3.6.1.4.1.9.9.341.1.2.2.1.1
ccqmEnfRuleViolateMacAddr MAC address of this subscriber. If the subscriber has multiple MAC addresses, this is the MAC address associated with the Cable interface.	SNMPv2-TCMacAddress Type Constraints: range: 6 Description: Represents an 802 MAC address represented in the `canonical' order defined by IEEE 802.1a, i.e., as if it were transmitted least significant bit first, even though 802.5 (in contrast to other 802.x protocols) requires M…	.1.3.6.1.4.1.9.9.341.1.2.2.1.2
ccqmEnfRuleViolateRuleName A pointer to the enforce rule associated with this subscriber. It provides for referencing the enforce rule to determine the QoS monitoring parameters. This is same as ccqmCmtsEnfRuleName for the corresponding enforce…	OctetString Constraints: range: 1-15	.1.3.6.1.4.1.9.9.341.1.2.2.1.3
ccqmEnfRuleViolateByteCount The total kbytes consumed by the subscriber in the monitoring duration as specified in the corresponding enforce rule object ccqmCmtsEnfRuleMonDuration. If the monitoring is restarted due to change in enforce rule or a…	kbytesSNMPv2-SMIUnsigned32 Type Constraints: range: 0..4294967295	.1.3.6.1.4.1.9.9.341.1.2.2.1.4
ccqmEnfRuleViolateLastDetectTime The time at which the subscriber was found to have violated his enforce rule and the time from which the enforced QoS parameter set, if any, was in effect.	SNMPv2-TCDateAndTime Type Constraints: range: 8 range: 11 Description: A date-time specification. field octets contents range ----- ------ -------- ----- 1 1-2 year* 0..65536 2 3 month …	.1.3.6.1.4.1.9.9.341.1.2.2.1.5
ccqmEnfRuleViolatePenaltyExpTime The time when the original QoS parameter set will be restored for this violating subscriber. If there was no enforced QoS parameter set configured for this subscriber this object returns 0.	SNMPv2-TCDateAndTime Type Constraints: range: 8 range: 11 Description: A date-time specification. field octets contents range ----- ------ -------- ----- 1 1-2 year* 0..65536 2 3 month …	.1.3.6.1.4.1.9.9.341.1.2.2.1.6

This table contains the attributes which define the 
bandwidth utilization thresholds for the upstream and 
downstream interfaces and when the load on these interfaces
exceeds the upper threshold, the monitoring of the
associated modems service flows starts, and it stops when
the interface utilization drops below the lower threshold.
For the monitoring to start, there should be appropriate
enforce-rules defined. In case no thresholds are defined,
by default the monitoring of modems would take place if
the appropriate enforce-rules are present.

ccqmCmtsIfBwUtilEntry row .1.3.6.1.4.1.9.9.341.1.3.1.1

A set of attributes to provide additional level of
control for monitoring modems. It is indexed by the
ifIndex of upstream/downstream interface, thus, only
docsCableDownstreamInterface(128) and
docsCableUpstreamInterf…

Indexes

IF-MIBifIndex

Column	Syntax	OID
ccqmCmtsIfBwUtilUpThreshold This object defines the upper threshold for the interface bandwidth utilization and when interface bandwidth utilization exceeds this threshold, monitoring of the appropriate modem's service flow will start if there is…	percentUnsigned32r/w Constraints: range: 1-99	.1.3.6.1.4.1.9.9.341.1.3.1.1.1
ccqmCmtsIfBwUtilLoThreshold This object defines the lower threshold for the interface bandwidth utilization and when interface bandwidth utilization drops below this threshold, the monitoring of the appropriate modem's service flow will stop. This…	percentUnsigned32r/w Constraints: range: 1-99	.1.3.6.1.4.1.9.9.341.1.3.1.1.2
ccqmCmtsIfBwUtilRowStatus The object controls and reflects the status of rows in this table. create-and-wait is not supported. The objects can be changed even when the row status is active(1).	SNMPv2-TCRowStatusr/w Type Values: 1 active 2 notInService 3 notReady 4 createAndGo 5 createAndWait 6 destroy Description: The RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of …	.1.3.6.1.4.1.9.9.341.1.3.1.1.3