-
Cisco IOS CMTS Cable Command Reference
-
Introduction
-
Cable Commands: a through cable-modem
-
Cable Commands: cable a through cable c
-
Cable Commands: cable d
-
Cable Commands: cable e through cable i
-
Cable Commands: cable l
-
Cable Commands: cable m to n
-
Cable Commands: cable p through cable r
-
Cable Commands: cable s
-
Cable Commands: cable t
-
Cable Commands: cable u through cable w
-
Cable Commands: ca through cr
-
Cable Commands: d through h
-
Cable Commands: i through p
-
Cable Commands: q through sg
-
Cable Commands: show a through show cable l
-
Cable Commands: show cable m to show cable u
-
Cable Commands: show ch through show cr
-
Cable Commands: show d through show i
-
Cable Commands: show m through show z
-
Cable Commands: snmp through w
-
Appendix A: Cable Debug Commands
-
Appendix B: Cisco CMTS Router ROM Monitor Commands
-
Feedback
Table Of Contents
Cable Commands: cable a through cable c
cable acfe max-bonus-bandwidth
cable admission-control ds-bandwidth
cable admission-control max-reserved-bandwidth
cable admission-control preempt priority-voice
cable admission-control us-bandwidth
cable application-type include
cable clock dti clear-counters
Cable Commands: cable a through cable c
Revised: August 12, 2013, OL-15510-17
New Commands
Modified Commands
cable acfe enable
To enable Fairness Across DOCSIS Interfaces feature on the integrated-cable (IC), modular-cable (MC), or wideband-cable (WB) interfaces, use the cable acfe enable command in global configuration mode. To disable Fairness Across DOCSIS Interfaces feature, use the no form of this command.
cable acfe enable
no cable acfe enable
Syntax Description
This command has no arguments or keywords.
Command Default
Fairness Across DOCSIS Interfaces feature is disabled.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
Configure the Fairness Across DOCSIS Interfaces feature on the MC, IC, or WB interfaces.
It is recommended that you clear the CIR reservation above the legacy "reservable" bandwidth before disabling Fairness Across DOCSIS Interfaces feature. This is to prevent any CIR over-subscription after disabling Fairness Across DOCSIS Interfaces feature.
Examples
The following example shows how to enable Fairness Across DOCSIS Interfaces feature in cable interfaces.
Router(config)# cable acfe enableRelated Commands
cable acfe max-bonus-bandwidth
To configure the maximum usable bonus bandwidth for a bonding group (BG), use the cable acfe max-bonus-bandwidth command in interface configuration mode. To revert to the default values, use the no form of this command.
cable acfe max-bonus-bandwidth bonus-bandwidth
no cable acfe max-bonus-bandwidth
Syntax Description
bonus-bandwidth
Maximum usable bonus bandwidth for a BG. There is no valid range, and the bonus bandwidth can use the entire bandwidth of an interface.
Command Default
The bonus bandwidth can use the entire bandwidth of an interface.
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
The cable acfe max-bonus-bandwidth command configures the maximum usable bonus bandwidth. After disabling Fairness Across DOCSIS Interfaces feature, this configuration is retained. However, it will not be used.
Examples
The following example shows how to configure the maximum usable bonus bandwidth for a BG:
Router(config-if)# cable acfe max-bonus-bandwidth 1000000Related Commands
cable acfe max-eir-ratio
To configure the maximum EIR ratio between the BE bandwidth among adjacent bonding groups (BGs), use the cable acfe max-eir-ratio command in global configuration mode. To return to the default values, use the no form of this command.
cable acfe max-eir-ratio eir-ratio
no cable acfe max-eir-ratio
Syntax Description
eir-ratio
EIR rebalance ratio between two adjacent BGs. The valid range is from 1 to 100 with a default value of 10.
Command Default
The default value for EIR rebalance ratio is 10.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The cable acfe max-eir-ratio command configures the maximum EIR ratio between the BE bandwidth among adjacent BGs.
The failure to maintain the maximum EIR ratio may reduce the guaranteed bandwidth rate for the BE traffic to zero. This may lead to rejection of unicast CIR flows.
Examples
The following example shows how to configure the EIR rebalance ratio between two adjacent BGs:
Router(config)# cable acfe max-eir-ratio 20Related Commands
cable admission-control
To configure the CPU and memory thresholds for a Cisco CMTS router supporting broadband processing engines (BPEs), use the cable admission-control command in global configuration mode. This command sets the CPU averaging method and memory thresholds. To remove thresholds from a Cisco CMTS router, use the no form of this command.
cable admission-control {cpu-5sec | cpu-avg } {[ io-mem] [proc-mem] [total-memory] } minor num1 major num2 critical num3
no cable admission control {cpu-5sec | cpu-avg } {[ io-mem] [proc-mem] [total-memory] } minor num1 major num2 critical num3
Syntax Description
Command Default
By default, admission control is disabled with no CPU or memory resource threshold settings on the Cisco CMTS router.
Command Modes
Global configuration mode
Command History
Usage Guidelines
The threshold counters are set to zero when the resource is reconfigured.
An important concept for system resources that are set with this command (CPU and memory) is the concept of dampening. Without dampening, and when admission control is configured for the first time, the system resource check is unsuccessful if the current value exceeds the critical threshold. When this happens, the system resource check subsequently succeeds only if the current value drops below the major threshold.
Note
When the minor threshold value set with Num1 or a major threshold value set with Num2 is crossed, the Cisco CMTS router sends an alarm (SNMP trap, when supported). When the critical threshold value set with Num3 is crossed, the Cisco CMTS router drops the call request.
This dampening approach helps prevent significant fluctuations in the outcome of resource checks. For example, if the critical threshold were 80 percent and the current values fluctuated between 79 and 81 percent, this scenario would lead to an alternate success then failure event without dampening. The first check would succeed, the second check would fail, and so forth.
For additional Admission Control feature information, refer to the Admission Control for the Cisco Cable Modem Termination System document on Cisco.com.
Examples
The following example configures the Cisco CMTS router with a Quality of Service (QoS) policy that includes admission control dampening. This example illustrates the following conditions:
•
•
•
Router(config)# cable admission-control cpu-avg minor 60 major 70 critical 80Related Commands
cable admission-control ds-bandwidth
To set the minor, major, and exclusive thresholds for downstream voice or data bandwidth for all interfaces on a Cisco CMTS router, use the cable admission-control ds-bandwidth command in global configuration mode or interface configuration mode. To remove this setting from a Cisco CMTS router or from a specified interface, use the no form of this command.
cable admission-control ds-bandwidth traffic-type minor minor-threshold major major-threshold exclusive exclusive-percentage non-exclusive non-exclusive-percentage
no cable admission-control ds-bandwidth traffic-type minor minor-threshold major major-threshold exclusive exclusive-percentage non-exclusive non-exclusive-percentage
Syntax Description
Command Default
Admission control is disabled by default on the Cisco CMTS router.
Command Modes
Global configuration (config)
Interface configuration (config-if)
Command History
Usage Guidelines
Downstream bandwidth settings support all interfaces on the Cisco CMTS router through global configuration.
Downstream bandwidth settings can be further refined per-interface or per-upstream, the latter of which provides optimal downstream Admission Control granularity on the Cisco CMTS router.
When interface-level downstream configuration is used in combination with global configuration, then the interface configuration supersedes global configuration.
Note
Note
Examples
The following example configures downstream bandwidth in the global configuration mode, with 30% of downstream bandwidth reserved exclusively for voice traffic. Minor and major alarms for voice traffic are also set to be generated at 15% and 25% respectively.
Router(config)# cable admission-control ds-bandwidth voice minor 15 major 25 exclusive 30Related Commands
cable admission-control event
To configure admission control event types on a Cisco CMTS router, and to enable admission control for all previously configured resources on a Cisco CMTS router, use the cable admission-control event command in global configuration mode. To disable admission control event types on a Cisco CMTS router, use the no form of this command.
cable admission-control event {cm-registration | dynamic-service}
no cable admission-control event event_type
Syntax Description
Command Default
Admission control event types are not defined on the Cisco CMTS router.
Command Modes
Global configuration
Command History
Usage Guidelines
At least one event type must be configured in order to enable admission control on the Cisco CMTS router.
For additional Admission Control feature information, refer to the Admission Control for the Cisco Cable Modem Termination System document on Cisco.com.
Examples
The following example configures each available option for the cable admission-control event command on the Cisco CMTS router.
Router(config)# cable admission-control event cm-registrationRouter(config)# cable admission-control dynamic-serviceRelated Commands
cable admission-control max-reserved-bandwidth
To define the maximum reserved bandwidth per bonding group for all service flows that are allowed by the Cisco CMTS, use the cable admission-control max-reserved-bandwidth command in the interface configuration mode. To reset or disable the maximum reserved bandwidth value, use the no form of this command.
cable admission-control max-reserved-bandwidth bw-in-kbps
no cable admission-control max-reserved-bandwidth
Syntax Description
bw-in-kbps
Maximum admission control reserved bandwidth. The value is in kbps and is based on the RF bandwidth percent defined for the bonding group. Valid range is from 0 to 14762.
Command Default
The max-reserved-bandwidth value is 80 percent of the aggregate bandwidth of the RF channels configured in the US or DS bonding group.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
This command allows the user to define the maximum reserved bandwidth per bonding group. The default maximum reserved bandwidth value is 80 percent. However the user can choose to configure a higher (up to 96 percent) or lower reserved bandwidth so that there is bandwidth allocated for zero committed information rate (CIR) best effort traffic.
Examples
The following example shows a sample definition of the maximum reserved bandwidth value.
Router> enableRouter# configure terminalRouter(config)# interface c5/0/1
Router(config-if)# cable admission-control max-reserved-bandwidth 6344Related Commands
cable admission-control preempt priority-voice
To change the default PacketCable emergency 911 call preemption functions on a Cisco CMTS router to support throughput and bandwidth requirements for emergency 911 calls above all other buckets on the Cisco CMTS router, use the cable admission-control preempt priority-voice command in global configuration mode. To disable preemption and return the bucket that supports PacketCable emergency 911 calls to its default configuration, use the no form of this command.
cable admission-control preempt priority-voice
no cable admission-control preempt priority-voice
Defaults
Emergency 911 call preemption and service flow admission control is enabled on the Cisco CMTS router.
Command Modes
Global configuration
Command History
Usage Guidelines
By default, PacketCable Emergency 911 calls are given priority on the Cisco CMTS. This priority may be preempted or removed from the Cisco CMTS router with non-standard configuration of the Service Flow Admission Control feature.
For additional information for Service Flow Admission Control beginning in Cisco IOS Release 12.3(21)BC, refer to the Service Flow Admission Control for the Cisco Cable Modem Termination System document on Cisco.com.
Examples
The following example disables and then restores emergency 911 call preemption on the Cisco CMTS router.
Router(config)# no cable admission-control preempt priority-voiceRouter(config)# cable admission-control preempt priority-voicecable admission-control us-bandwidth
To configure upstream bandwidth thresholds for admission control on a Cisco CMTS router, use the cable upstream admission-control us-bandwidth command in global configuration or interface configuration mode. To disable or to remove this configuration from a Cisco CMTS router or the specified port, use the no form of this command.
cable admission-control us-bandwidth [sched scheduling-type | service service-class-name] minor minor-threshold major major-threshold exclusive exclusive-percentage non-exclusive non-exclusive-percentage
no cable admission-control us bandwidth [sched scheduling-type | service service-class-name] minor minor-threshold major major-threshold exclusive exclusive-percentage non-exclusive non-exclusive-percentage
Syntax Description
Command Default
Admission control is disabled by default on a Cisco CMTS router.
Command Modes
Global configuration (config)
Interface configuration (config-if)
Command History
Usage Guidelines
Upstream bandwidth settings support all interfaces on a Cisco CMTS router through global configuration.
Upstream bandwidth settings can be further refined on a per-interface or per-upstream basis using interface configuration mode. Per-upstream settings provide the optimal upstream admission control granularity on the Cisco CMTS router.
When interface or per-upstream configuration is used in combination with global configuration, then interface or per-upstream configuration supersedes global configuration. Per-upstream configuration also supersedes per-interface configuration.
Note
Note
Examples
For additional Admission Control feature information and examples, refer to the Admission Control for the Cisco Cable Modem Termination System document on Cisco.com.
Related Commands
cable application-type include
To associate an application type with a specific and prioritized bucket on a Cisco CMTS router, use the cable application-type include command in global configuration mode. To remove the application type settings, use the no form of this command.
cable application-type bucket-number include {Best-effort | multicast application-id | packetcable {normal | priority} | pcmm {app-id gate-app-id | priority gate-priority} | sched-type type | service-class service-class-name}
no cable application-type bucket-number include {Best-effort | multicast application-id | packetcable {normal | priority} | pcmm {app-id gate-app-id | priority gate-priority} | sched-type type | service-class service-class-name}
Syntax Description
Command Default
Service flow admission control is enabled without the application types.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The details of this command vary according to the bucket number and application type being mapped to a service flow on the Cisco CMTS router. This command overrides default service flow admission control settings on the Cisco CMTS.
Best Effort
The best effort CIR service flow rule may be applicable to both upstream and downstream. However, in the case of upstream service flows, in most cases, the same service flow may map both the rules.
For best effort, there is also the sched-type keyword option that applies to upstream service flows. This best effort scheduling type rule is applicable only for upstream service flows.
Service Classes
DOCSIS 1.1 introduced the concept of service classes. A service class is identified by a service class name. A service class name is a string the CMTS router associates with a QoS parameter set. One of the objectives of using a service class is to allow the high-level protocols to create the service flows with the desired QoS parameter set. Using a service class is a convenient way to bind the application with the service flows. The rules provide a mechanism to implement such binding.
Note the following factors when using the service-class keyword:
•
•
•
For additional information, refer to the Service Flow Admission Control feature documentation on Cisco.com.
Examples
The following example maps high-priority PacketCable service flows into application bucket 5:
Router(config)# cable application-type 5 include packetcable priorityThe following example maps normal PacketCable service flows into application bucket 1:
Router(config)# cable application-type 1 include packetcable normalThe following example maps the specified bucket number with PCMM service flow with a priority of 7, then maps an application identifier of 152 for the same bucket number:
Router(config)# cable application-type 2 include pcmm priority 7Router(config)# cable application-type 2 include pcmm app-id 152The following example maps both UGS and UGS-AD into bucket number 1:
Router(config)# cable application-type 1 include sched-type ugsRouter(config)# cable application-type 1 include sched-type ugs-adThe following example maps the best effort CIR flows to bucket 3:
Router(config)# cable application-type 3 include Best-effortThe following example maps the service class name with a value of service-name1 into application bucket 3:
Router(config)# cable application-type 3 include service-class service-name1The following example maps the multicast application type with a value of 18 into application bucket 3:
Router(config)# cable application-type 3 include multicast 18
Related Commands
cable application-type name
To assign an alphanumeric name for the specified bucket, use the cable application-type name command in global configuration mode. To remove this configuration, use the no form of this command.
cable application-type bucket-number name bucket-name
no cable application-type bucket-number name bucket-name
Syntax Description
Command Default
Service flow admission control and the default configuration of this command is enabled.
Command Modes
Global configuration
Command History
Usage Guidelines
This bucket name appears in supporting show and debug commands along with the default bucket number.
For additional information, refer to the Service Flow Admission Control feature documentation on Cisco.com.
Examples
The following example illustrates the use of descriptive names for the associated buckets:
Router(config)# cable application-type 2 name videoRouter(config)# cable application-type 3 name gamingRelated Commands
cable arp
To activate cable Address Resolution Protocol (ARP), use the cable arp command in cable interface or subinterface configuration mode. To block ARP requests for cable modems (CMs), use the no form of this command.
cable arp
no cable arp
Syntax Description
This command has no arguments or keywords.
Command Default
ARP is enabled.
Command Modes
Cable interface and subinterface configuration
Command History
Usage Guidelines
ARP is an Internet protocol used to map IP addresses to MAC addresses on computers and other equipment installed in a network. You must activate ARP requests so that the Cisco CMTS router can perform IP address resolution on the downstream path.
Occasionally, you might want to use the no cable arp and clear arp-cache commands to block out new ARP requests and clear the existing ARP table. In this situation, the Cisco CMTS router will retain the ARP addresses of currently online CMs (CMs with a known IP address) and will continue to send ARP requests for those CMs when those ARP entries time out or are cleared, so that those CMs can continue to remain online. ARP requests for CMs that are currently offline and for any other unknown IP addresses, however, will remain blocked until ARP requests are reenabled on the downstream using the cable arp command.
Note
Tip
Examples
The following example shows how to activate cable ARP requests for port 0 on the cable interface line card installed in slot 6 of a Cisco CMTS router:
router(config)# interface cable 6/0router(config-if)# cable arpThe following example shows how to activate cable ARP requests for port 0 on the cable interface line card installed in slot 6, subinterface 1, of a Cisco CMTS router:
router(config)# interface cable 6/0.1router(config-subif)# cable arpRelated Commands
clear arp-cache
Clears the ARP table on the router.
cable proxy-arp
Activates cable proxy ARP on the cable interface.
cable arp filter
To control the number of Address Resolution Protocol (ARP) packets that are allowable for each Service ID (SID) on a cable interface, use the cable arp filter command in cable interface configuration mode. To stop the filtering of ARP broadcasts for CMs, use the no form of this command.
cable arp filter {reply-accept | request-send} number window-size
no cable arp filter {reply-accept | request-send}
default cable arp filter {reply-accept | request-send}
Syntax Description
Command Default
ARP packets are not filtered, which means the Cisco CMTS router accepts all ARP reply packets and sends all ARP request packets.
Command Modes
Cable interface configuration (config-if)
Command History
Usage Guidelines
Viruses, worms, and theft-of-service attacks can generate a large volume of ARP requests on a cable interface. In some situations, the volume of ARP traffic can become so large that it throttles all other traffic.
To control the number of ARP replies and ARP requests that are allowed for each SID on a cable interface, use the cable arp filter command. This command configures the interface so that it accepts only a certain number of ARP reply or request packets per a specified time period. If a SID generates more ARP packets than what is allowed, the cable interface drops the excessive traffic.
By default, no ARP filtering is done. ARP filtering is enabled on individual cable interfaces, and you can choose to filter ARP packets only on the specific cable interfaces that require it. You can further choose to filter only ARP request packets, only ARP reply packets, or both. You can configure different threshold values on each interface, allowing you to customize the feature for each interface's traffic patterns.
If using bundled cable interfaces, the Cable ARP Filtering feature is configured separately on the master and slave interfaces. This allows you to configure the feature only on the particular interfaces that require it.
Note
Note
Linksys Wireless-B BEFW11S4 Router
The Linksys Wireless-B Broadband Router BEFW11S4 version 4 with 1.44.2 firmware incorrectly sends its own ARP reply packet for every ARP request packet it receives, instead of replying only to the ARP requests that are specifically for itself. Customers with these routers should upgrade the firmware to the latest revision to fix this bug. To upgrade the firmware, go to the download section on the Linksys web site.
The following example shows how to filter cable ARP reply packets, so that the cable interface accepts a maximum of 15 ARP replies every three seconds per SID:
Router(config)# interface cable 5/1/0Router(config-if)# cable arp filter reply-accept 15 3The following example shows how to filter cable ARP request packets, so that the cable interface sends a maximum of 10 requests per second per SID:
Router(config)# interface cable 6/0Router(config-if)# cable arp filter request-send 10 1The following example shows how to enable the filtering of cable ARP request and reply packets on a cable interface, using the default values of 4 packets per CPE per every 2 seconds:
Router(config)# interface cable 3/0Router(config-if)# default cable arp filter reply-acceptRouter(config-if)# default cable arp filter request-sendRouter(config-if)# endRouter# show running-config | include filtercable arp filter reply-accept 4 2cable arp filter request-send 4 2The following example shows how to disable the filtering of cable ARP request and reply packets on a cable interface:
Router(config)# interface cable 1/0Router(config-if)# no cable arp filter reply-acceptRouter(config-if)# no cable arp filter request-sendRelated Commands
cable attribute-mask
To configure an attribute for a modular cable interface, use the cable attribute-mask command in interface configuration mode. To disable this configuration, use the no form of this command.
cable attribute-mask mask
no cable attribute-mask mask
Syntax Description
Command Default
If this command is not used, the default attribute will be used for the modular cable interface. The default attribute for a modular cable interface is zero.
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
The attribute mask comprises 32 attributes and each attribute represents a single bit in the mask. You can configure a provisioned attribute mask for each channel and provisioned bonding group to assign values to the operator-defined binary attributes, or to override the default values of the specification-defined attributes. The operator may configure, in the CM configuration file, a required attribute mask and a forbidden attribute mask for a service flow. Additionally, in a CM-initiated dynamic service request, the CM can include a required attribute mask and a forbidden attribute mask for a service flow.
Examples
The following example shows how to configure an attribute for a modular cable interface:
Router# configure terminalRouter(config)# interface modular-cable 1/0/0:0Router(config-if)# cable attribute-mask 2000ff00Related Commands
cable bgsync
To set the data intervals for the background synchronization of SNMP MIB data on the Cisco CMTS, use the cable bgsync command in global configuration mode. To disable background synchronization, use the no form of this command.
cable bgsync {itime i-interval | ptime p-interval}
no cable bgsync
Syntax Description
Command Default
This command is enabled by default.
Command Modes
Global configuration mode (config)
Command History
Usage Guidelines
Use the cable bgsyc command to set the data intervals for background synchronization.
For more information about MIB objects that are synchronized during background synchronization, see the Cisco CMTS Universal Broadband Router Series MIB Specifications Guide 12.2SC.
Examples
The following example shows how to set the data intervals for background synchronization on the Cisco uBR10012 router:
Router# configure terminalRouter(config)# cable bgsync itime 3600Router(config)# cable bgsync ptime 6Router(config)#Related Commands
cable bgsync active
To activate the background synchronization process on the Cisco CMTS, use the cable bgsync active command in global configuration mode. To deactivate the background synchronization process, use the no form of this command.
cable bgsync active
no cable bgsync active
Syntax Description
This command has no arguments or keywords.
Command Default
This command is enabled by default.
Command Modes
Global configuration mode (config)
Command History
Usage Guidelines
Use the cable bgsync active command to activate the background synchronization process.
SNMP objects use interprocess communication (IPC) to access data between the line card and the route processor (RP). When SNMP queries are sent to a Cisco CMTS with large number of modems configured, IPC takes a long time to retrieve the information from the line card and pass it on to the RP. This resulted in an increase in the SNMP response time.
The background synchronization process slowly synchronizes the data between the line card and the RP. Therefore, when SNMP queries are sent to the Cisco CMTS, the Cisco CMTS returns the SNMP data from the RP. IPC requests are not sent to retrieve the data, thereby improving the SNMP performance.
The background synchronization process is enabled by default on the Cisco uBR10012, and Cisco 7200 Series routers.
For more information about the MIB objects that are synchronized during background synchronization, see the Cisco CMTS Universal Broadband Router Series MIB Specifications Guide 12.2SC.
Examples
The following example shows how to deactivate the background synchronization process on the Cisco uBR10012 router:
Router# configure terminalRouter(config)# no cable bgsync activeRouter(config)#Related Commands
cable bonding-group-id
Note
To specify a Bonding Group ID and indicate whether the bonding group is a primary or secondary bonded channel, use the cable bonding-group-id command in wideband-cable interface configuration mode. To remove a bonding group configuration and revert to the default bonding group (a primary bonding group), use the no form of this command.
cable bonding-group-id id_num [secondary]
no cable bonding-group-id id_num [secondary]
Syntax Description
Command Default
If the cable bonding-group-id command is not issued, Cisco IOS software assigns a default ID to the bonding group and configures the wideband-channel cable interface as a primary bonding group.
Command Modes
Interface configuration mode for a wideband-cable interface (config-if)
Command History
Usage Guidelines
The cable bonding-group-id command is not needed for the wideband channels that will be received by the Scientific Atlanta DPC2505 or EPC2505 wideband cable modems.
The cable bonding-group-id command is used only for wideband channels that will be received by the Linksys WCM300-NA, WCM300-EURO, or WCM300-JP wideband cable modems.
Linksys WCM300 Cable Modem
For wideband channels that will be received by the Linksys WCM300-NA, WCM300-EURO, and WCM300-JP cable modems, the cable bonding-group-id command assigns a Bonding Group ID to a wideband-channel cable interface and configures the bonding group as a primary bonding group if the secondary keyword is not specified, or as a secondary bonding group if the secondary keyword is specified.
•
•
The primary bonded channel is the wideband channel on which the Linksys WCM300 modem receives all of its unicast traffic and some of its multicast traffic. The cable modem may identify the primary bonded channel and any secondary bonded channels to the CMTS at cable modem registration time. The DOCSIS configuration file may define the primary bonded channel for the CMTS to assign to the cable modem.
In addition to joining one primary bonded channel, the Linksys WCM300 may join up to two secondary bonded channels simultaneously in order to receive additional data streams. The DOCSIS configuration file may define the secondary bonded channels for the modem to pass to the CMTS. Secondary bonded channels are intended to receive multicast traffic such as broadcast video that is not available on the primary bonded channel.
For information on the TLV encodings that can be used in the DOCSIS configuration file to identify primary and secondary bonded channels, see the Cisco Cable Wideband Solution Design and Implementation Guide, Release 1.0.
Note
•
•
Note
If you specify a non-unique Bonding Group ID for the id_num argument, cable bonding-group-id displays an error message and does not modify the ID.
Scientific Atlanta DPC2505 Cable Modem
The cable bonding-group-id command is not needed for the wideband channels that will be received by the Scientific Atlanta DPC2505 or EPC2505 cable modems.
Examples
The following examples show how to use the cable bonding-group-id command for a variety of purposes. The following cable bonding-group-id command specifies that wideband channel 10 on the Wideband SPA in slot/subslot/bay 1/0/1 will be a secondary bonding group (secondary bonded channel) having the bonding group ID 20.
Router# configure terminalRouter(config)# interface wideband-cable 1/0/1:10Router(config-if)# cable bonding-group-id 20 secondaryThe following example shows how to change a bonding group with an ID of 20 from a secondary to a primary bonding group by omitting the secondary keyword:
Router(config-if)# cable bonding-group-id 20The no form of the cable bonding-group-id removes the configured bonding group and reverts the configuration to the default bonding group. For a secondary bonding group with the ID of 20, the following no forms of the command are equivalent:
Router(config-if)# no cable bonding-group-id 20or
Router(config-if)# no cable bonding-group-id 20 secondaryWhen either of the preceding commands are issued, the wideband-channel cable interface is configured to use a default bonding group, which has a default bonding group ID assigned by Cisco IOS software and is a primary bonding group.Related Commands
cable bonding-group-secondary
To specify a bonding group as a secondary bonded channel, use the cable bonding-group-secondary command in wideband-cable interface configuration mode. To remove the bonding group configuration and revert to the default bonding group (a primary bonding group), use the no form of this command.
cable bonding-group-secondary
no cable bonding-group-secondary
Command Default
If the cable bonding-group-secondary command is not issued, Cisco IOS software configures the wideband-channel cable interface as the primary bonding group.
Command Modes
Interface configuration mode (config-if) for a wideband-cable interface
Command History
12.2(33)SCE
This command was introduced for the Cisco uBR-MC3GX60V cable interface line card.
Usage Guidelines
Starting with Cisco IOS Release 12.2(33)SCE, the cable bonding-group-secondary command replaces the cable bonding-group-id command. If you upgrade from an earlier Cisco IOS Release to Cisco IOS Release 12.2(33)SCE and later, the cable bonding-group-id command will no longer change the bonding-group ID.
The cable bonding-group-secondary command is used only for wideband channels that are received by the Linksys WCM300-NA, WCM300-EURO, or WCM300-JP wideband cable modems.
Linksys WCM300 Cable Modem
For wideband channels that are received by the Linksys WCM300-NA, WCM300-EURO, and WCM300-JP cable modems, the show controllers Modular-Cable slot/subslot/controller wideband command displays the bonding group ID of a wideband-channel cable interface and the cable bonding-group-secondary command configures the bonding group as a secondary bonding group.
The primary bonded channel is the wideband channel on which the Linksys WCM300 modem receives all of its unicast traffic and some of its multicast traffic. The cable modem identifies the primary bonded channel and any secondary bonded channels to the CMTS at cable modem registration time. The DOCSIS configuration file defines the primary bonded channel for the CMTS to assign to the cable modem.
In addition to joining one primary bonded channel, the Linksys WCM300 joins up to two secondary bonded channels simultaneously in order to receive additional data streams. The DOCSIS configuration file defines the secondary bonded channels for the modem to pass to the CMTS. Secondary bonded channels are intended to receive multicast traffic such as broadcast video that is not available on the primary bonded channel.
For information on the TLV encodings that can be used in the DOCSIS configuration file to identify primary and secondary bonded channels, see Cisco Cable Wideband Solution Design and Implementation Guide, Release 1.0.
Note
The following points list the restrictions for configuring the wideband channel with the cable bonding-group-secondary command:
•
•
Note
Examples
The following example shows how to use the cable bonding-group-secondary command:
Router# configure terminalRouter(config)# interface wideband-cable 1/0/1:10Router(config-if)# cable bonding-group-secondaryRelated Commands
cable bundle
To configure a cable interface to belong to an interface bundle, use the cable bundle command in cable interface configuration mode. To delete a cable interface bundle definition, use the no form of this command.
cable bundle n [master]
no cable bundle n [master]
Syntax Description
n
Specifies the bundle identifier. Valid range is from 1 to 255.
master
(Optional) Defines the specified interface as the master.
Defaults
No default behavior or values
Command Modes
Interface configuration—cable interface only (config-if)
Command History
Usage Guidelines
You can configure a maximum of four interface bundles. In each bundle, specify one interface as the master interface by using the optional master keyword. The cable interface that is designated as master is configured with Layer 3 configuration such as primary and secondary IP addresses and other Layer 3 specific configuration commands such as the cable arp command.
The following guidelines are required when using bundled cable interfaces:
•
•
•
•
•
Specify generic (that is, not downstream or upstream) cable interface configurations, such as source-verify or Address Resolution Protocol (ARP) handling, on the master interface. Do not specify generic configuration on nonmaster interfaces.
If you configure an interface as part of a bundle and it is not the master interface, all generic cable configuration for this interface is removed. This includes the IP address, access groups, PIM configuration, and any other IP Layer 3 configurations. The master interface configuration then applies to all interfaces in the bundle.
Tip
When creating subinterfaces over the bundle master, the bundle master is not assigned any IP address and only the subinterfaces are assigned IP addresses, helper addresses, and other Layer 3 configurations. The reason the bundle master is not assigned an IP address is because CMs are associated with subinterfaces rather than with a bundle master.
Note
If you shut down or remove the master interface in a bundle, no data packets is sent to any of the interfaces in this bundle. Packets are still physically received from nonmaster interfaces that have not been shut down, but those packets are discarded. This means that CMs connected to those interfaces are not disconnected immediately, but CMs coming online are not able to obtain an IP address, download their configuration file, or renew their IP address assignment if the DHCP lease expires.
If you shut down a slave interface, only this shutdown interface is affected.
Note
Examples
See the following example to configure interface 25 to be the master interface:
Router(config)# interface cable 3/0Router(config-if)# cable bundle 25 masterRouter(config-if)#07:28:17: %UBR7200-5-UPDOWN: Interface Cable3/0 Port U0, changed state to down07:28:18: %UBR7200-5-UPDOWN: Interface Cable3/0 Port U0, changed state to upThe following example shows the error message you get if you try to configure an interface with an IP address that is not the master interface:
Router(config)# interface cable 3/0Router(config-if)# cable bundle 5Please remove ip address config first then reenter this commandRouter(config-if)#The following example shows how to remove a cable interface from a bundle:
Router(config)# interface cable 5/1/0Router(config-if)# no cable bundle 5Router(config-if)#
Note
Related Commands
show cable bundle
Displays the forwarding table for the specified interface bundle.
cable clock clear-counters
To reset the counters that are displayed with the show controllers clock-reference command, use the cable clock clear-counters command in privileged EXEC mode.
cable clock clear-counters
Syntax Description
This command has no keywords or arguments.
Command Default
No default behavior or values
Command Modes
Privileged EXEC (#)
Command History
Usage Guidelines
This command resets any counters that were displayed from the last time the show controllers clock-reference command was used.
Note
This command supports the Cisco CMTS clock feature set, which provides a synchronized clock for improved Voice-over-IP (VoIP) operations. The clock feature set requires one of the following configurations:
•
Note
•
Only these cable interface cards support the external clock card reference from a clock card to distribute that signal to CMs or set-top boxes (STBs) attached to the specific network segments. You can use other cable interface cards, such as the Cisco uBR-MC16C, with the clock card, but these other cable interfaces will not synchronize their downstream SYNC messages with the external clock source.
Each CM or STB must also support VoIP applications and the clock feature set. For example, the Cisco uBR924, running Cisco IOS Release 12.0(7)T or later releases, supports the clock card feature automatically.
Note
Examples
The following example shows how to reset all counters that are displayed for the clock card:
Router# cable clock clear-countersRelated Commands
show controllers clock-reference
Displays the cable clock card's hardware information.
cable clock dti
To configure the DOCSIS Timing Interface (DTI) clock reference mode, use the cable clock dti command in global configuration mode. To terminate the DTI clock referemce mode and restart the standalone mode, use the no form of the command.
cable clock dti
no cable clock dti
Syntax Description
This command has no keywords or arguments.
Command Default
Standalone mode
Command Modes
Global configuration
Command History
Usage Guidelines
Use this command to configure DTI clocking mode. This command may be stored in NVRAM as part of the DOCSIS Timing and Control Card (DTCC) configuration.
Examples
Router# config terminalRouter(config)# cable clock dtiRelated Commands
cable clock dti clear-counters
To reset the counters that are displayed with the show cable clock dti counters command in DOCSIS Timing Interface (DTI) mode, use the cable clock dti clear-counters command in privileged EXEC mode.
cable clock dti clear-counters slot/subslot
Syntax Description
slot/subslot
Specifies the slot and subslot location of the DTCC ports. Valid values are 1/1 or 2/1.
Command Default
No default behavior or values
Command Modes
Privileged EXEC
Command History
Usage Guidelines
This command resets any counters that were displayed from the last time the show cable clock dti client command was used in DTI mode.
This command supports the Cisco CMTS clock feature set, which provides a synchronized clock for improved Voice-over-IP (VoIP) operations.
Examples
The following example shows how to reset all counters that are displayed for the clock card:
Router# cable clock dti clear-countersRelated Commands
show cable clock dti counters
Displays the cable clock card's hardware information.
cable clock force
To select the external timing source when the clock card is in holdover mode, use the cable clock force command in global configuration mode. To disable the selection and return to the default, use the no form of this command.
cable clock force {primary | secondary}
no cable clock force
Syntax Description
primary
Forces the primary source to act as the clock reference.
secondary
Forces the secondary source to act as the clock reference.
Command Default
The clock card automatically uses the primary external source, if available. If the primary source fails, the clock card enters holdover mode and, after a few seconds, switches to the secondary external source. The clock card switches back to the primary source when it becomes available.
Command Modes
Global configuration (config)
Command History
12.1(1a)T1
This command was introduced.
12.1(2)EC1
This command was integrated into Cisco IOS Release 12.1(2)EC1.
Usage Guidelines
This command overrides the default behavior of the clock card when the clock card is in holdover mode. If the clock card is not in holdover mode, this command is ignored. You cannot force the reference to a port if the clock card is in free-running mode.
Note
Note
To support the clock feature set in VoIP configurations, a Cisco uBR7246 VXR chassis, equipped with a clock card; and a Cisco uBR-MC16S, a Cisco uBR-MC16E, or a Cisco uBR-MC28C cable interface line card must be used running Cisco IOS Release 12.1(1a)T1 or later releases. Only these cable interface line cards support the external clock card reference from a clock card to distribute that signal to CMs or set-top boxes (STBs) attached to the specific network segments. You can use other cable interface cards, such as the Cisco uBR-MC16C, with the clock card, but these other cable interfaces will not synchronize their downstream SYNC messages with the external clock source.
Each CM or STB must also support VoIP applications and the clock feature set. For example, the Cisco uBR924, running Cisco IOS Release 12.0(7)T or later releases, supports the clock card feature automatically.
Examples
The following example shows how to force the timing reference for the cable clock card to come from the secondary external source, when the clock card is in holdover mode:
Router(config)# cable clock force secondaryRelated Commands
cable clock source-midplane
To make the midplane time-division multiplexing (TDM) clock the primary timing reference for the clock card, use the cable clock source-midplane command in global configuration mode. To disable the selection and return to the default, use the no form of this command.
cable clock source-midplane
no cable clock source-midplane
Syntax Description
This command has no keywords or arguments.
Command Default
The clock card does not get its timing reference from the midplane TDM clock.
Command Modes
Global configuration (config)
Command History
12.1(1a)T1
This command was introduced.
12.1(2)EC1
This command was integrated into Cisco IOS Release 12.1(2)EC1.
12.3BC
This command was integrated into Cisco OS Release 12.3BC.
Usage Guidelines
Because the clock card automatically provides the timing reference to the midplane TDM clock, the midplane cannot in turn act as the reference for the clock card. This means that the cable clock source-midplane command does not take effect unless a port adapter is configured as the primary clock reference source for the midplane.
Note
To support the clock feature set in VoIP configurations, a Cisco uBR7246 VXR chassis, equipped with a clock card; and a Cisco uBR-MC16S, a Cisco uBR-MC16E, or a Cisco uBR-MC28C cable interface line card must be used running Cisco IOS Release 12.1(1a)T1 or higher releases. Only these cable interface line cards support the external clock card reference from a clock card to distribute that signal to CMs or set-top boxes (STBs) attached to the specific network segments. You can use other cable interface cards, such as the Cisco uBR-MC16C, with the clock card, but these other cable interfaces will not synchronize their downstream SYNC messages with the external clock source.
Each CM or STB must also support VoIP applications and the clock feature set. The Cisco uBR924, running Cisco IOS Release 12.0(7)T or later releases, supports the clock card feature automatically.
Examples
The following example shows how to set the primary clock reference to the midplane TDM clock:
Router(config)# cable clock source-midplaneRelated Commands
cable clock upgrade
To upgrade the Field-Programmable Gate Array (FPGA) image manually on the DOCSIS Timing & Control Card (DTCC), use the cable clock upgrade command in privileged EXEC mode.
cable clock upgrade slot/subslot
Syntax Description
slot
Chassis slot number of the DTCC card. The valid slot is 1.
subslot
Secondary slot number of the DTCC card. Valid subslots are 1 or 2.
Command Default
None
Command Modes
Privileged EXEC (#)
Command History
Usage Guidelines
In Cisco IOS Release 12.2(33) SCC and later, you can manually upgrade the FPGA image only if a single DTCC card is installed on the Cisco uBR 10012 router. If the manual upgrade fails or is interrupted, the DTCC card may become unusable. Do not reset or unplug the DTCC card during the manual upgrade. We recommend that you take precaution against extended downtime if the FPGA upgrade fails unexpectedly by having a standby DTCC card installed on the Cisco uBR10012 router.
Note
Examples
The following example shows how to start the manual FPGA upgrade process on the DTCC card:
Router# cable clock upgrade 1/1Related Commands
cable clock dti
Configures the DOCSIS Timing Interface (DTI) clock reference mode.
cable cmcpe-list valid-time
To set the length of time that a CMTS router will consider the current list of CM and CPE devices to be valid, use the cable cmcpe-list valid-time command in global configuration mode. To reset the time period to its default value of 3 minutes, use the no form of this command.
cable cmcpe-list valid-time time
no cable cmcpe-list valid-time
Syntax Description
Command Default
180 seconds (3 minutes)—Cisco IOS Release 12.2(15)BC1 and earlier releases
900 seconds (15 minutes)—Cisco IOS Release 12.2(15)BC2 and later releases
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The Cisco CMTS router maintains an internal list of cable modems and CPE devices that were connected on its cable interfaces in the last 24 hours. This list does not capture cable modems and CPE devices that were connected before the last 24 hours.
The CMTS router uses this list to provide the data for various show commands and to respond to SNMP requests that query the entries in the cdxCmCpeTable table in the CISCO-DOCS-EXT-MIB MIB.
By default, the Cisco CMTS router uses the current list if it is less than 3 minutes old. If the current list is older than 3 minutes, the Cisco CMTS router considers it invalid and rebuilds a new list. This prevents the CMTS router from having to build a new list for every query, which could impact system performance.
You can use the cable cmcpe-list valid-time command to change the length of time that the CMTS router considers the current CM and CPE device list to be valid. This allows you to find the optimum time value that provides the most current information without affecting the number of CPU cycles that are available for network processing.
A smaller time period ensures that the CM and CPE device list is more current but it requires more processing time to maintain the list. A longer time period reduces the load on the processor but the CM/CPE list might not be current.
If CPU usage dramatically increases when performing SNMP queries of the cdxCmCpeTable table, use this command to increase the valid list time so that the Cisco CMTS router does not have to rebuild the CM/CPE list more often than needed to respond to the queries.
Note
Examples
The following example shows how to set the valid list time to 60 seconds (1 minute):
Router(config)# cable cmcpe-list valid-time 60The following example shows how to find the current valid list time setting:
Router# show running-config | include cmcpe-listcable cmcpe-list valid-time 60Related Commands
cable cm-status
To configure the values of the "Event Holdoff Timer" and "Number of Reports per Event" parameters for the cable modem (CM) status events, use the cable cm-status command in global configuration mode. To revert to the default values, use the no form of this command.
cable cm-status {all | event} [holdoff {timer | default} | reports {reportvalue | default}]
no cable cm-status
Syntax Description
Command Default
Default values are used for the "Event Holdoff Timer" and "Number of Reports per Event" parameters.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The cable cm-status command updates the event table for the MAC Domain Descriptor (MDD) belonging to a primary channel. The help text of the command provides a mapping of an event type to the corresponding integer.
The ten CM status events are:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
Note
Examples
The following example shows how to configure an event holdoff timer of 100 milliseconds and four reports per event for all CM-STATUS events:
Router# configure terminalRouter(config)# cable cm-status all holdoff 100 reports 4The following example shows how to configure the CM status event "MDD recovery" with an event holdoff timer of 150 milliseconds and three reports for the event:
Router# configure terminalRouter(config)# cable cm-status 4 holdoff 150 reports 3Associated FeaturesThe cable cm-status command is used to configure the following feature:
Related Commands
cable cm-status enable
Enables a CM status event or a group of CM status events on a primary cable interface.
cable cm-status enable
To enable a CM status event or a group of CM status events on a primary cable interface, use the cable cm-status enable command in interface configuration mode. To disable a particular event on a primary cable interface, use the no form of this command.
cable cm-status enable range
no cable cm-status
Syntax Description
Command Default
The downstream related events such as secondary channel MDD time-out, QAM/FEC lock failure, Sequence out of range, MDD recovery, and QAM/FEC lock recovery are enabled.
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
This command applies to all non-primary RF channels on a CMTS.
The ten CM status events per interface are:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
Note
Examples
The following example shows how to enable all CM status events on a primary cable interface:
Router# configure terminalRouter(config)# interface cable 8/0/0Router(config-if)# cable cm-status enable 1-10The following example shows the no cable cm-status enable command being configured and the corresponding example shows show running-config interface command output:
Router(config)# interface cable 8/0/0Router(config-if)# cable cm-status enable 1-10Router(config-if)# no cable cm-status enable 1-2 4-5Router(config-if) exitRouter# show running-config interface cable 8/0/0Building configuration...Current configuration : 1557 bytes!interface Cable8/0/0shutdowncable cm-status enable 3 6-10no cable packet-cachecable default-phy-burst 0cable map-advance dynamic 300 500cable bundle 1cable downstream channel-id 145The following example shows the show running-config interface cable command output when no events are enabled on the CMTS:
Router#show running-config interface cable 8/0/0Building configuration...Current configuration : 1558 bytes!interface Cable8/0/0shutdownno cable cm-status enable 1-10no cable packet-cachecable default-phy-burst 0cable map-advance dynamic 300 500cable bundle 1cable downstream channel-id 145cable downstream annex Bcable downstream modulation 256qamcable downstream interleave-depth 32cable downstream frequency 555000000cable downstream rf-shutdowncable upstream max-ports 4no cable upstream 0 connectorcable upstream 0 frequency 40000000cable upstream 0 channel-width 3200000 3200000cable upstream 0 power-level 26cable upstream 0 docsis-mode tdma-atdmacable upstream 0 minislot-size 4--More--Related Commands
cable config-file
To create a configuration filename for a Cisco CMTS router internal CM configuration file, use the cable config-file command in global configuration mode. To delete the configuration filename, use the no form of this command.
cable config-file filename
no cable config-file filename
Syntax Description
Command Default
No default behaviors or values
Command Modes
Global configuration (config)
Command History
Usage Guidelines
A DOCSIS CMTS router automatically downloads a DOCSIS configuration file to a CM during its initial registration procedure. The DOCSIS configuration file configures the CM for its network operations and includes information such as the maximum number of CPE devices that are supported, the quality of service (QoS) options provided for the CM, and whether the CM should upgrade to a new software image.
The DOCSIS specification defines the format of the DOCSIS configuration files, which can be created by any number of tools. In addition to the other tools that Cisco provides for this purpose, the cable config-file command can be used to create the DOCSIS configuration files needed for your network. These configuration files are stored in the Flash memory on the Cisco CMTS router and can be automatically downloaded to the CM as needed.
The cable config-file command creates the DOCSIS configuration file if it does not already exist and then enters config-file configuration mode. You can then give one of the following subcommands to create the configuration file:
•
•
•
•
•
•
•
•
•
•
Note
After using the cable config-file subcommands, enter the exit command to leave config-file mode and to save the configuration file in the Flash memory. After a configuration file is created, it also appears in the running-configuration file. To delete a configuration file and remove it from Flash memory, use the no cable config-file command.
To allow CMs to download the configuration files, you must also enable the router's onboard TFTP server, using the tftp-server configuration command. Unless you are running on a small lab network, you should also remove the default limit of 10 TFTP sessions by using the service udp-small-serves max-servers no limit command.
In addition, the following commands are also recommended:
•
•
•
Note
Examples
The following example shows two DOCSIS configuration files being configured. The first configuration file allows each CM to have up to four CPE devices and configures the QoS parameters for its traffic. The second configuration file denies network access to the CM and its CPE devices.
Router# configure terminalRouter(config)# cable config-file test.cmRouter(config-file)# cpe max 4Router(config-file)# service-class 1 priority 2Router(config-file)# service-class 1 max-upstream 128Router(config-file)# service-class 1 max-downstream 1000Router(config-file)# timestampRouter(config-file)# exitRouter(config)# cable config-file denied.cmRouter(config-file)# access-deniedRouter(config-file)# exitRouter(config)#The following is a portion of a typical Cisco IOS configuration file that shows the above two DOCSIS configuration files, as well as a typical DHCP server configuration:
Router# show running-config...service udp-small-servers max-servers no-limit!cable time-server!cable config-file test.cmcpe max 4service-class 1 priority 2service-class 1 max-upstream 128service-class 1 max-downstream 1000timestampcable config-file disable.cmaccess-denied!ip dhcp pool modems-c3network 10.30.128.0 255.255.240.0bootfile test.cmnext-server 10.30.128.1default-router 10.30.128.1option 7 ip 10.30.128.1option 4 ip 10.30.128.1option 2 hex 0000.0000!...Related Commands
