To specify the
time period that an enforced quality of service (QoS) profile should be in
force for subscribers that violate their registered QoS profile, use the
penalty-period
command in enforce-rule configuration mode. To reset an
enforce-rule to its default penalty period, use the
no form of
this command.
penalty-period minutes [time-of-day hour]
no penalty-period minutes [time-of-day hour]
Cisco cBR Series Converged Broadband Routers
penalty-period
minutes
[time-of-day {hour | hour:minutes} monitoring-on]
no
penalty-period
minutes
[time-of-day {hour | hour:minutes} monitoring-on]
Syntax Description
|
minutes
|
Specifies a time period (in minutes) during which a cable modem (CM) can be
under penalty. The range is 1 to 10080, with a default value of 10080 (7 days).
|
|
time-of-day
{hour
|
hour:minutes}
|
(Optional) Specifies the time of day (in hh or hh:mm format) when:
- A CM that is under penalty
is released from the penalty period.
- A CM that is not under
penalty has its subscriber monitoring counters reset.
If the
time of day is specified in hour (hh), the valid range is 1 to 23 using a
24-hour clock.
If the
time of day is specified in hour:minutes (hh:mm), the valid range for hour is 1
to 23 using a 24-hour clock, and the valid range for minutes is 0 to 59.
|
|
monitoring-on
|
(Optional) Specifies that monitoring should be turned on after the penalty
release time. If this keyword is not specified, by default, monitoring is
turned off after the release time, until the end of the day, that is 00:00 hrs.
|
Command Default
The default time
period is 10080 minutes (7 days).
Command Modes
Enforce-rule configuration (enforce-rule)
Command History
|
Release
|
Modification
|
|
12.2(15)BC1
|
This
command was introduced.
|
|
12.3(9a)BC
|
This
command was integrated into Cisco IOS Release 12.3(9a)BC.
|
|
12.2(33)SCA
|
This
command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the
Cisco uBR7225VXR router was added.
|
|
12.3(23)BC2
|
The
time-of-day
keyword option was added.
|
|
12.2(33)SCB
|
The
time-of-day
keyword option was integrated into Cisco IOS Release 12.2(33)SCB.
|
|
12.3(23)SCD2
|
The
minute-level
granuality
for
the
time-of-day duration, and the
monitoring-on
keyword option were added.
|
|
IOS-XE 3.15.0S
|
This
command is not supported on the
Cisco cBR Series Converged Broadband Routers.
|
|
IOS-XE 3.17.0S
|
This command was implemented on the Cisco cBR Series
Converged Broadband Routers.
|
Usage Guidelines
When a
subscriber overconsumes the maximum bandwidth that is specified in the
enforce-rule, the Cisco CMTS router can automatically switch the subscriber to
an enforced QoS profile for the time duration configured with the
penalty-period
command. When the penalty period expires, the Cisco CMTS router
restores the subscriber to their registered QoS profile.
The penalty
duration specified in the
penalty-period command is a global configuration.
This penalty duration is overridden if the individual penalty duration is
already configured using the
duration ,
weekend
duration,
peaktime1
or
weekend
peaktime1 commands. Similarly, if the individual
penalty duration is not configured, the global penalty duration is used. The
table below explains in detail the criteria for choosing the penalty duration:
Table 1. Criteria for
Choosing Penalty Duration
|
Global
Penalty- Period Configured
|
Weekday
Penalty-Period Configuration
(CLI:
duration or peaktime1)
|
Weekend
Penalty-Period Configuration
(CLI:
weekend duration, or weekend peaktime1)
|
Applied
Penalty Duration for Weekdays
|
Applied
Penalty Duration for Weekends
|
|
Yes
|
Yes
|
Yes
|
Weekday
Penalty Configuration
|
Weekend
Penalty Configuration
|
|
Yes
|
Yes
|
No
|
Weekday
Penalty Configuration
|
Global
Penalty Configuration
|
|
Yes
|
No
|
Yes
|
Global
Penalty Configuration
|
Weekend
Penalty Configuration
|
|
Yes
|
No
|
No
|
Global
Penalty Configuration
|
Global
Penalty Configuration
|
If the keyword
monitoring-on is specified, monitoring starts immediately after the cable
modems are released from penalty. However if this keyword is not specified, by
default, all the cable modems using the enforce-rule are not monitored until
the end of day, that is, 00:00 hrs.
The penalty
period continues across reboots of the cable modem, so a user cannot avoid the
enforced QoS profile by trying to reset their modem and reregister on the cable
network. This allows service providers to set an appropriate penalty for users
who consistently exceed the allocated maximum bandwidth.
Note
|
To manually
move a DOCSIS 1.0 cable modem back to its registered profile before the end of
the penalty period, use the
cable
modem
qos
profile
command. To manually move a DOCSIS 1.1(or later) cable modem
back to its registered profile before the end of the penalty period, use the
cable
modem
{ip-address
|
mac-address }
service-class-name
command.
|
When you change
the configuration of a currently active enforce-rule, that rule begins using
the new configuration immediately to manage the cable modems tracked by this
enforce-rule.
Note
|
Before
making any changes to an active enforce-rule, we recommend that you first
disable the enforce rule using the no enabled command.
|
A cable modem
consists of two service flows, Primary upstream and Primary downstream. If a
DOCSIS 1.0 cable modem enters the penalty period because one of its service
flows has exceeded its allowed bandwidth, the QoS profile of the entire modem
is changed. However, if a DOCSIS 1.1 or later cable modem enters the penalty
period because its upstream or downstream service flow has exceeded the allowed
bandwidth threshold, the service class name is changed only for the upstream or
downstream service flow.
Examples
The following
example shows an enforce-rule named “test”, which is configured with a penalty
period of 1440 minutes (1 day):
Router# configure terminal
Router(config)# cable qos enforce-rule test
Router(enforce-rule)# penalty-period 1440
The following
example shows an enforce-rule named “test”, which is configured with a penalty
period of 1440 minutes (1 day), but allowing the removal of the cable modems in
penalty at 23:00. Monitoring will be turned off by default at 23:00, to 00:00
(1 hour):
Router# configure terminal
Router(config)# cable qos enforce-rule test
Router(enforce-rule)# penalty-period 1440 time-of-day 23
The following
example shows an enforce-rule named “test”, which is configured with a penalty
period of 1440 minutes (1 day), allowing the removal of the cable modems in
penalty at 23:00. However, after the cable modems are released from penalty,
fresh monitoring starts, with all the subscriber monitoring counters reset to
0:
Router# configure terminal
Router(config)# cable qos enforce-rule test
Router(enforce-rule)# penalty-period 1440 time-of-day 23 monitoring-on
The following example shows an enforce-rule being configured with a
penalty period on a Cisco cBR Series Converged Broadband Router:
Router(enforce-rule)# penalty-period 1 time-of-day 1 monitoring-on
Feedback