-
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 docsis30-voice downstream req-attr-mask
cable downstream attribute-mask
cable downstream-channel-id automatic
cable downstream dsg chan-list
cable downstream dsg dcd-enable
cable downstream dsg tg channel
cable downstream dsg vendor-param
cable downstream interleave-depth
cable downstream qos wfq weight
cable dsg name-update-interval
cable dsg tg channel vendor-param
cable dynamic-secret tftp insert-upgrade-server
Cable Commands: cable d
Revised: August 12, 2013, OL-15510-17
New Commands
Modified Commands
Obsolete Commands
The following commands have been removed from certain Cisco IOS software releases:
cable downstream dsg rule
12.3(17a)BC2
cable dsg
12.3(13a)BC
cable dsg keepalive
12.3(13a)BC
cable dci-response
To configure how a cable interface responds to DCI-REQ messages for CMs on that interface, use the cable dci-response command in cable interface configuration mode.
cable dci-response [success | ignore | reject permanent | reject temporary]
Syntax Description
Command Default
The Cisco CMTS router responds to DCI-REQ messages from all CMs by sending a DCI-RSP response with the confirmation code of Success (0).
Command Modes
Interface configuration—cable interface only (config-if)
Command History
Usage Guidelines
The Device Class Identification (DCI) messages are part of the Media Access Control Specification section of the DOCSIS 1.1 specification (revision SP-RFIv1.1-I05-000714 and above). A CM can optionally use the DCI-REQ message to inform the CMTS router of certain capabilities, such as whether it is a CPE-controlled cable modem (CCCM).
The CMTS router then responds with one of the following confirmation codes:
•
Success—Allows the CM to continue with the registration process.
•
•
Note
Examples
The following example shows how to configure the CMTS router so that it ignores all DCI-REQ messages from CMs on the cable interface at slot 6:
Router# configure terminalRouter(config)# interface c6/0Router(config-if)# cable dci-response ignoreThe following example shows how to configure the CMTS router so that it returns to its default behavior for the cable interface on slot 6, which is to respond to all DCI-REQ messages from CMs by sending a DCI-RSP with a Success confirmation code:
Router# configure terminalRouter(config)# interface c6/0Router(config-if)# cable dci-response success
Note
Related Commands
cable dci-upstream-disable
To configure a cable interface so that it transmits a DOCSIS 1.1 Upstream Transmitter Disable (UP-DIS) message to a particular CM, use the cable dci-upstream-disable command in cable interface configuration mode. To remove that configuration and return to the default configuration, use the no form of this command.
cable dci-upstream-disable mac-address [enable | disable]
no cable dci-upstream-disable mac-address [enable | disable]
Syntax Description
Command Default
The Cisco CMTS router does not transmit UP-DIS messages to any CMs.
Command Modes
Interface configuration—cable interface only (config-if)
Command History
Usage Guidelines
The DOCSIS 1.1 specification (revision SP-RFIv1.1-I05-000714 and above) allows a CMTS router to transmit an Upstream Transmitter Disable (UP-DIS) message to a CM. If the CM supports the UP-DIS message, it responds by immediately disabling its upstream transmitter circuitry. The CM must be power-cycled before it can begin transmitting on the upstream again.
Examples
The following example shows the cable dci-upstream-disable command being used to enable the UP-DIS message for the CM with the MAC address of 0123.4567.89ab.
Router# configure terminalRouter(config)# interface c6/0Router(config-if)# cable dci-upstream-disable 0123.4567.89ab enableRouter(config-if)# exitRouter(config)# exitRelated Commands
cable default-phy-burst
To specify a value for the upstream Maximum Traffic Burst parameter for CMs that do not specify their own value, use the cable default-phy-burst command in cable interface configuration mode. To reset the maximum burst size to its default, use the no form of this command.
cable default-phy-burst burst-size
no cable default-phy-burst
Syntax Description
Command Default
2000 bytes
Command Modes
Interface configuration—cable interface only (config-if)
Command History
Usage Guidelines
Note
The DOCSIS 1.0 specification allows CMs to register without specifying a maximum upstream burst size, or to register with a value of 0, which means an unlimited burst size. This behavior can interfere with DOCSIS 1.1 networks because excessively large bursts on an upstream will generate unpredictable jitter and delay in voice calls. DOCSIS 1.1 CMs can also cause this problem if they register without enabling fragmentation of packets at the DOCSIS MAC layer.
This command allows you to specify a default burst size for CMs that register without specifying a burst size or that register with a burst size of 0. It also specifies the maximum size of long data grants if a CM specifies a size of 0 (unlimited) in the Upstream Channel Descriptor (UCD) packet. If a CM specifies a long data grant that would exceed the maximum burst size, and the CM is not using DOCSIS concatenation, the DOCSIS scheduler drops the bandwidth request.
To prevent CMs from registering without defining a burst profile, use this command with a burst-size of zero. CMs that do not define a burst profile will not be allowed to register and come online.
Note
The default PHY burst parameter interacts with two other parameters that are configured in the DOCSIS configuration file:
•
•
Examples
The following example shows the default maximum burst size to 1522 bytes, which is the minimum size required by the DOCSIS 1.1 specification:
Router(config)# interface cable 5/1Router(config-if)# cable default-phy-burst 1522The following example shows the default maximum burst size to 0, which means that a CM must specify a valid burst profile before the Cisco CMTS allows it to register and come online:
Router(config)# interface cable 5/1Router(config-if)# cable default-phy-burst 0The following example shows the default maximum burst size being reset to its default of 2000 bytes:
Router(config)# interface cable 5/1Router(config-if)# no cable default-phy-burstRelated Commands
cable device
To configure an access list for a cable modem (CM) device or host on the Cisco CMTS router, use the cable device command in privileged EXEC mode. To remove an access group, use the no access-group option of this command.
cable device {ip-address | mac-address} [no] access-group {access-list | access-name} |
{[vrf vrf-name] ip-address [no] access-group [access-list | access-name]}Syntax Description
Command Default
None
Command Modes
Privileged EXEC (#)
Command History
Usage Guidelines
For the vrf keyword of this command, only the ip-address option is supported.
An access list can be configured to deny access to any IP address other than the ones previously configured, using the access-list access-list deny any any command. Starting with Cisco IOS Release 12.2(33)SCD, when a CM is added to such an access list on the Cisco uBR7200 series universal broadband routers, the ping fails. If the CM is reset, removed, or powered off, the ping succeeds after the CM comes online. However, the show cable modem access-group command displays that the CM does not belong to the access-group.
Note
Note
Examples
The following example shows how to assign an access list to the MAC address of a cable device:
Router# configure terminalRouter(config)# cable device 0010.7b6b.77ed acc 1Router(config)# exitRelated Commands
cable dfo-retry-count
To configure the Downstream Frequency Override (DFO) retry count, use the cable dfo-retry-count command in global configuration mode. To reset the DFO retry count to its default value, use the no form of this command.
cable dfo-retry-count n
no cable dfo-retry-count n
Syntax Description
Command Default
The cable dfo-retry-count command is configured with a default value of 20.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The Downstream Frequency Override (DFO) feature enables cable modems to register on a specific primary RF channel. Because of RF failure conditions and some cable modem types, the cable modem takes more time to register on a specific primary RF channel. You can configure the DFO retry count to reduce the cable modem registration time using the cable dfo-retry-count command.
Examples
The following example shows how to configure the DFO retry count as 10:
Router# configure terminalRouter(config)# cable dfo-retry-count 10Related Commands
cable dhcp-giaddr
To modify the GIADDR field for the DHCPDISCOVER and DHCPREQUEST packets with a relay IP address before they are forwarded to the DHCP server, use the cable dhcp-giaddr command in cable interface or subinterface configuration mode. To set the GIADDR field to its default, use the no form of this command.
cable dhcp-giaddr {policy [strict | host | mta | ps | stb] giaddr | primary}
no cable dhcp-giaddr
Syntax Description
Command Default
None
Command Modes
Interface configuration (config-if)
Subinterface configuration (config-subif)
Command History
Usage Guidelines
You can use this command to modify the GIADDR field of DHCPDISCOVER and DHCPREQUEST packets to provide a relay IP address before packets are forwarded to the DHCP servers. Use this command to set a policy option such that primary addresses are used for CMs and secondary addresses are used for hosts (such as PCs) behind the CMs.
When using multiple secondary subnets, the Cisco CMTS router uses the first secondary IP address as the GIADDR field when forwarding a DHCPDISCOVER request to the DHCP server. If no DHCP server responds with a DHCPOFFER message after three attempts, the Cisco CMTS router uses the next secondary IP address, up to a maximum of 16 secondary addresses.
Note
Caution
Examples
The following example shows how to set the primary address to be used always for GIADDR:
Router# configure terminalRouter(config)# interface cable 3/0Router(config-if)# cable dhcp-giaddr primaryThe following example shows how to set the primary address to be used always for GIADDR in the cable subinterface mode:
Router# configure terminalRouter(config)# interface cable 6/0.1Router(config-subif)# cable dhcp-giaddr primaryThe following example shows how to configure the router so that the primary address is used for CMs and the secondary addresses are used for hosts. In addition, the GIADDR is used as the source IP address in forwarded DHCPOFFER packets.
Router# configure terminalRouter(config)# interface cable 5/1/0Router(config-if)# cable dhcp-giaddr policy strictThe following example shows how to configure the router so that the CPE device (in this case, the MTA) uses a specific secondary interface:
Router# configure terminalRouter(config)# interface bundle 25Router(config-if)# cable dhcp-giaddr mta 172.10.10.1Related Commands
cable dhcp-insert
To configure the Cisco CMTS router to insert descriptors into DHCP packets using option 82, use the cable dhcp-insert command in global configuration mode. To remove this configuration, use the no form of this command.
cable dhcp-insert {downstream-description | hostname | service-class | upstream-description}
Syntax Description
Defaults
This configuration is disabled by default.
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
This feature enhances the DHCP security potential and the Cable Duplicate MAC Address Feature on the Cisco CMTS router.
The cable dhcp-insert command command specifies which descriptors to append to DHCP packets. The DHCP servers can then detect cable modem clones and extract geographical information.
Note
The Cisco CMTS router can use the DHCP Relay Agent Information option (DHCP option 82) to send particular information about a cable modem, such as its MAC address and the cable interface to which it is connected. If the DHCP server cannot match the information with that belonging to a cable modem in its database, the Cisco CMTS router identifies that the device is a CPE device. This allows the Cisco CMTS router and DHCP server to retain accurate information about which CPE devices are using which cable modems and whether the devices should be allowed network access.
The DHCP Relay Agent can also be used to identify cloned modems or gather geographical information for E911 and other applications. Using the cable dhcp-insert command, configure the Cisco CMTS router to insert downstream, upstream, hostname, or service class descriptors into DHCP packets. A DHCP server can utilize such information to determine service levels available to the host specific to the provisioned subscriber.
Note
Examples
The following example shows how to insert descriptors into DHCP packets. The DHCP server can then use these descriptors to identify cable modem clones and extract geographical information.
Router(dhcp-config)# cable dhcp-insert service-classAssociated FeaturesThe cable dhcp-insert command is used to configure the following feature:
DHCP, ToD, and TFTP Services for the CMTS Routers
Related Commands
ip dhcp relay information option-insert
Enables the system to insert a DHCP Relay Agent option in forwarded BOOTREQUEST messages to a DHCP server.
cable dhcp-parse option
To enable parsing of Dynamic Host Configuration Protocol (DHCP) options, use the cable dhcp-parse option command in cable interface configuration mode. To disable parsing, use the no form of this command.
cable dhcp-parse option-optnum
no cable dhcp-parse option-optnum
Syntax Description
Command Default
The CMTS does not parse the specified DHCP options.`
Command Modes
Cable interface configuration (config-if)
Command History
Usage Guidelines
To determine specific device and system information, configure cable dhcp-parse option-43 command on the CMTS. The CMTS parses option-43 of the CPE DHCP message to determine the device and system information of the CPE.
To determine the CPE device type, configure cable dhcp-parse option-60 command on the CMTS. The CMTS parses option-60 of the CPE DHCP message to determine the device type of the CPE.
Examples
The following example shows DHCP option 43 enabled on the CMTS:
Router(config-if)# cable dhcp-parse option-43Router(config-if)#Related Commands
cable helper address
Specifies a destination IP address for User Datagram Protocol (UDP) broadcast Dynamic Host Configuration Protocol (DHCP) packets.
cable divert-rate-limit
To set Cable-side DRL rate and limit, use the cable divert-rate-limit command in interface configuration mode. To reset the rate and limit to the default values, use the no form of this command.
cable divert-rate-limit rate rate limit limit
no cable divert-rate-limit
Syntax Description
Command Default
The default DRL configuration for every physical cable interface is 2000 packets per second and the default limit is 2000 packets
Command Modes
Interface configuration—cable interface only (config-if)
Command History
Usage Guidelines
Cable-side DRL is configured on the physical cable interface. It cannot be configured on a cable bundle interface.
Examples
The following example shows how to configure the rate and limit values for a cable interface.:
Router(config-if)# cable divert-rate-limit rate 1 limit 4Related Commands
cable docsis30-voice downstream req-attr-mask
To configure downstream DOCSIS 3.0 QoS parameters of the required attribute-mask and forbidden attribute-mask number for all DS voice flows, use the cable docsis30-voice downstream req-attr-mask command in global configuration mode. To disable the required attribute-mask and forbidden attribute-mask number, use the no form of this command.
cable docsis30-voice downstream req-attr-mask req-attr-mask forb-attr-mask forb-attr-mask
no cable docsis30-voice
Syntax Description
Command Default
The default config is req-attr-mask 0 forb-attr-mask 0. Use the no form of this command to return to default. It will set the values for docsis30 voice downstream req-attr-mask and forb-attr-mask to 0.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
This command is used to configure docsis 3.0 voice related downstream service-flow attribute-mask number.
Examples
The following example shows how to configure the downstream attribute mask for the interface cable:
Router# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# cable docsis30-voice downstream req-attr-mask ?<0-FFFFFFFF> The attribute bitmap in hexRouter(config)# cable docsis30-voice downstream req-attr-mask aa00 ?forb-attr-mask SF Forbidden Attribute MaskRouter(config)# cable docsis30-voice downstream req-attr-mask aa00 forb-attr-mask ?<0-FFFFFFFF> The attribute bitmap in hexRouter(config)# cable docsis30-voice downstream req-attr-mask aa00 forb-attr-mask bbccRouter(config)# do show run | include docsis30cable docsis30-voice downstream req-attr-mask AA00 forb-attr-mask BBCCRouter(config)# no cable docsis30-voice downRouter(config)# no cable docsis30-voiceRouter(config)# do show run | include docsis30Related Commands
cable dot1q-vc-map
To map a cable modem to a particular Virtual Local Area Network (VLAN) on a local outbound Ethernet interface, use the cable dot1q-vc-map command in global configuration mode. To remove this mapping, or to remove a particular customer's name from the internal tables, use the no form of this command.
cable dot1q-vc-map mac-address ethernet-interface vlan-id [cust-name]
no cable dot1q-vc-map mac-address
no cable dot1q-vc-map customer cust-name
Syntax Description
Defaults
No default behavior or values
Command Modes
Global configuration (config)
Command History
Usage Guidelines
This command maps a cable modem, on the basis of its hardware (MAC) address, to a particular IEEE 802.1Q VLAN on a particular outbound Ethernet interface. This enables the cable modem's traffic to be part of a virtual LAN at the Layer-2 level.
Note
Examples
The following example shows how to enable the use of Layer 2 tunnels and then map specific CMs to VLANs on a specific interface:
Router# config terminalRouter(config)# cable l2-vpn-service dot1qRouter(config)# cable dot1q-vc-map 000C.0e03.69f9 GigabitEthernet 1/0 4Router(config)# cable dot1q-vc-map 0010.7bed.9c95 GigabitEthernet 1/0 5Router(config)# exitThe following example shows the same command as above, but this time each VLAN is identified by the customer that is using it:
Router# config terminalRouter(config)# cable l2-vpn-service dot1qRouter(config)# cable dot1q-vc-map 000C.0e03.69f9 GigabitEthernet 1/0 4 ENTERPRISE-CO1Router(config)# cable dot1q-vc-map 0010.7bed.9c95 GigabitEthernet 1/0 5 ENTERPRISE-CO2Router(config)# exitThe following example shows how to remove the Layer 2 mapping for a specific cable modem. This particular cable modem's traffic is then routed using the normal Layer 3 routing processes.
Router# config terminalRouter(config)# no cable dot1q-vc-map 000C.0e03.69f9 GigabitEthernet 1/0 4Router(config)# exitRelated Commands
cable downstream annex
To set the Motion Picture Experts Group (MPEG) framing format for a downstream port on a cable interface line card to either Annex A (Europe) or Annex B (North America), use the cable downstream annex command in cable interface configuration mode.
cable downstream annex {A | B}
Syntax Description
A
Annex A. The downstream uses the EuroDOCSIS J.112 standard.
B
Annex B. The DOCSIS-compliant cable plants that support North American channel plans use ITU J.83 Annex B downstream radio frequency.
Command Default
Annex B for all Cisco cable interface cards other than the Cisco uBR-MC16E. Annex A, if using the Cisco uBR-MC16E cable interface line card and the Cisco uBR7111E and Cisco uBR7114E universal broadband routers.
Command Modes
Interface configuration—cable interface only (config-if)
Command History
Usage Guidelines
The MPEG framing format must be compatible with the downstream symbol rate you set. Annex B is the North America (DOCSIS) standard and Annex A is the European (EuroDOCSIS) standard. You should review your local standards and specifications for downstream MPEG framing to determine which format you should use.
The Cisco uBR-MC16U/X, Cisco uBR-MC28U/X, and Cisco uBR-MC5X20U cable interface line cards support both Annex A and Annex B operation. However, on the Cisco uBR-MC28U/X, both downstreams must be configured for the same mode (either both Annex A or both Annex B).
On the Cisco uBR-MC16U and Cisco uBR-MC28U (with integrated upconverter), the IF frequency is fixed at 44 MHz for both Annex A and Annex B modes of operation. On the Cisco uBR-MC16X and Cisco uBR-MC28X (without integrated upconverter), the IF frequency is set to 36.125 MHz in Annex A mode and 44 MHz in Annex B mode.
Note
Note
Caution
Tip
Examples
The following example shows how to set the MPEG framing format to Annex A:
Router# configure terminalRouter(config)# interface cable 1/0Router(config-if)# cable downstream annex AThe following example shows how to set the MPEG framing format to Annex B:
Router# configure terminalRouter(config)# interface cable 4/0Router(config-if)# cable downstream annex BRelated Commands
show controllers cable
Displays the downstream MPEG framing format (Annex A or Annex B) setting.
cable downstream attribute-mask
To configure an attribute for a cable interface or a wideband cable interface, use the cable downstream attribute-mask command in interface configuration mode. To disable this configuration, use the no form of this command.
cable downstream attribute-mask mask
no cable downstream attribute-mask mask
Syntax Description
Command Default
If this command is not used, the default attribute will be used for the cable interface and the wideband cable interface. The default attribute for the wideband cable interface is 0x80000000 (31-bit) and for the cable interface is zero. For a wideband cable interface, 31-bit mask is always set to 1.
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 wideband cable interface:
Router# configure terminalRouter(config)# interface wideband-cable 1/0/0:0Router(config-if)# cable downstream attribute-mask 800000ffRelated Commands
interface wideband-cable
Specifies a wideband cable interface.
interface cable
Specifies a cable interface.
cable downstream channel-id
To configure the downstream channel ID, use the cable downstream channel-id command in cable interface configuration mode. To set the downstream channel ID to its default value, use the no form of this command.
cable downstream channel-id id
no cable downstream channel-id
Syntax Description
Command Default
The unit number of the downstream device, starting with a value of 1.
Command Modes
Interface configuration—cable interface only (config-if)
Command History
Usage Guidelines
Use this command to make sure that each downstream channel has a unique ID when there are multiple Cisco CMTS routers at a headend facility.
Cisco IOS assigns the default ID number of each downstream channel in the order in which devices connected to the downstream channels appear to the CMTS router. The downstream channel connected to the first device that appears to the CMTS router is configured with a default ID of 1, the downstream channel connected to the second device that appears is configured with an ID of 2, and so on.
The local downstream channel channel ID is unique across all SPA channels. When you add a channel to the MAC domain using the downstream modular-cable rf-channel command, the channel IDs in the MAC domain are unique. This also facilitates channel ID uniqueness when the channels are added to a fiber node.
Table 6 shows the 12.2(33)SCB1 downstream channel ID scheme and Table 7 shows the 12.3(23)BCx scheme. This applies to rf-channel rf-port cable downstream channel-id channel-id command also.
Table 6
Downstream Channel ID Scheme for 12.2(33)SCB1
Table 7 Downstream Channel ID Scheme for 12.3(23)BCx
SPA Bay 0
24-47
24-47
SPA Bay 1
48-71
48-71
5x20
188-192
180-184
168-172
160-164
148-152
140-144
128-132
120-124
Caution
Examples
The following example shows how to configure the downstream channel on the cable interface line card in slot 6 of a Cisco CMTS router with a channel ID of 44:
Router(config-if)# cable downstream channel-id 44The following example shows how to restore the downstream channel ID configuration to the default configuration:
Router(config-if)# cable downstream channel-idcable downstream-channel-id automatic
To automatically configure the downstream channel IDs, use the cable downstream-channel-id automatic command in global configuration mode. To set the downstream channel ID (DCID) to its default value, use the no form of this command.
cable downstream-channel-id automatic
no cable downstream-channel-id automatic
Syntax Description
Command Default
No default behavior or values
Command Modes
Global configuration mode—(config)
Command History
Usage Guidelines
Use this command to automatically assign unique channel IDs for all downstream channels in a fiber node. Automatic DCIDs are not assigned to downstreams that are not in any fiber node.
Examples
This example shows how to automatically configure the downstream channel IDs:
Router(config)# cable downstream-channel-id automaticRelated Commands
show cable fibernode
Displays channel ID information for downstreams in a fiber node.
cable downstream dsg chan-list
To associate an Advanced-mode DOCSIS Set-Top Gateway (A-DSG) channel list entry to a downstream channel and include it in the Downstream Channel Descriptor (DCD) message on a Cisco CMTS router, use the cable downstream dsg chan-list command in interface configuration mode. To remove the configuration, use the no form of this command.
cable downstream dsg chan-list list-index
no cable downstream dsg chan-list list-index
Syntax Description
Command Default
Channel lists are not defined by default.
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
Global configuration for A-DSG must be complete before configuring interface definitions.
Examples
The following example shows configuration of inclusion of DSG channel list entries in DCD messages on a downstream cable interface on a Cisco CMTS router:
interface Cable6/0cable downstream dsg chan-list 2Related Commands
cable downstream dsg dcd-enable
To enable Downstream Channel Descriptor (DCD) messages to be sent on a downstream channel on a Cisco CMTS router, use the cable downstream dsg dcd-enable command in interface configuration mode. To disable DCD messages, use the no form of this command.
cable downstream dsg dcd-enable
no cable downstream dsg dcd-enable
Syntax Description
This command has no arguments or keywords.
Command Default
DCD messages are disabled.
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
Global configuration for Advanced-mode DOCSIS Set-top Gateway (A-DSG) must be complete before configuring interface definitions. This command is used when there are no enabled rules or tunnels for A-DSG on a Cisco CMTS router.
Examples
The following example shows how to enable DCD messages on a downstream interface on a Cisco CMTS router along with several other A-DSG interface configuration commands:
interface Cable6/0cable downstream dsg dcd-enablecable downstream dsg chan-list 2cable downstream dsg timer 3cable downstream dsg vendor-param 2cable downstream dsg rule 1 priority 1 clients 1 tunnel 1cable downstream dsg rule 1 vendor-param 1cable downstream dsg rule 1 classifiers 1 5cable downstream dsg rule 2 priority 1 clients 2 tunnel 2Related Commands
cable downstream dsg disable
To exclude the primary capable interface from DOCSIS Set-Top Gateway DSG forwarding, use the cable downstream dsg disable command in cable interface configuration mode. To remove the configuration, use the no form of this command.
cable downstream dsg disable
no cable downstream dsg disable
Syntax Description
This command has no arguments or keywords.
Command Default
None
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
When DSG is enabled on the MAC domain interface and DSG forwarding is disabled on the primary capable interface, the Cisco CMTS router does not create multicast service flows on the primary capable interface.
If DSG forwarding is already enabled on the primary capable interface, the Cisco CMTS router removes multicast service flows from the interface.
Examples
The following example shows how to disable A-DSG forwarding on a primary capable modular interface on the Cisco CMTS router:
Router# configure terminalRouter(config)# interface modular-cable 1/0/0:0Router(config-if)# cable downstream dsg disableRouter(config-if)# endAssociated FeaturesThe cable downstream dsg disable command is associated with the Advanced Mode DOCSIS Set-Top Gateway 1.2 for the Cisco CMTS Routers feature.
Related Commands
cable dsg cfr
Defines and enables A-DSG classifiers on the Cisco CMTS router.
show cable dsg cfr
Displays DSG classifier details.
cable downstream dsg rule
Note
To define and associate an Advanced-mode DOCSIS Set-top Gateway (A-DSG) rule to the downstream channel on a Cisco CMTS router, use the cable downstream dsg rule command in interface configuration mode. To remove the DSG rule configuration, use the no form of this command.
cable downstream dsg rule rule-id [clients clnt-list-id tunnel tun-id | priority priority | vendor-param vsif-grp-id | ucid ucid1 | [ucid1 ucid2...ucidn] | cfr cfr-index [cfr-index...] | disable]
no cable downstream dsg rule rule-id [clients clnt-list-id tunnel tun-id | priority priority | vendor-param vsif-grp-id | ucid ucid1 | [ucid1 ucid2...ucidn] | cfr cfr-index [cfr-index...] | disable]
Syntax Description
Command Default
DSG rules are disabled by default when they are created.
Command Modes
Interface configuration (config-if)
Command History
12.3(13a)BC
This command was introduced to support A-DSG 1.1 on the Cisco uBR10012 router and Cisco uBR7200 series routers.
12.3(17a)BC2
This command was removed.
Usage Guidelines
Global configuration for A-DSG must be complete before configuring interface definitions.
Because rules are disabled when they are created, you must enable the configuration using the no cable downstream dsg rule disable form of the command. To disable a DSG rule configuration, use the cable downstream dsg rule disable form of this command.
You can associate DSG clients, vendor specific parameters, classifiers, DSG tunnel address, upstream channel identifier range, and rule priority to a downstream channel. You can apply more than one rule to a downstream channel. All configured rules that are enabled are included in the Downstream Channel Descriptor (DCD) message.
Examples
The following example shows configuration and association of DSG rules on a downstream cable interface on a Cisco CMTS router, followed by an example of enabling the configured DSG rules:
interface Cable6/0cable downstream dsg rule 1 clients 1 tunnel 1cable downstream dsg rule 1 priority 1cable downstream dsg rule 1 vendor-param 1cable downstream dsg rule 1 classifiers 1 5cable downstream dsg rule 2 clients 2 tunnel 2cable downstream dsg rule 2 priority 1!! Enable the DSG rule configuration!no cable downstream dsg rule 1 disableno cable downstream dsg rule 2 disableThe following example shows how to disable DSG rules that were previously enabled:
interface cable6/0cable downstream dsg rule 1 disablecable downstream dsg rule 2 disableRelated Commands
cable downstream dsg tg
To associate an Advanced-Mode DOCSIS Set-Top Gateway (A-DSG) tunnel group to a MAC domain interface on a Cisco CMTS router, use the cable downstream dsg tg command in cable interface configuration mode. To remove this association, use the no form of this command.
cable downstream dsg tg tgid [channel channel_ID | priority DSG-rule-priority [enable | disable] | ucid ID1 [ID2 ID3 ID4] | vendor-param vendor-group-ID]
no cable downstream dsg tg tgid
Syntax Description
Command Default
The DSG traffic is not forwarded to the MAC domain.
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
If you do not specify a downstream channel ID using the channel keyword, the Cisco CMTS router automatically assigns a free channel to associate the MAC domain interface with the DSG tunnel group. This channel is created with default parameters.
If you specify the channel keyword in the no form of the command, only the MAC domain to DSG tunnel group association is removed from the configuration. If the no form of the command is used without the channel keyword, both the tunnel group association and the channel are removed.
Examples
The following example shows how to associate an A-DSG tunnel group to a MAC domain interface on a Cisco CMTS router:
Router(config)# interface cable 5/1/0Router(config-if)# cable downstream dsg tg 1Router(config-if)# cable downstream dsg tg 1 channel 22Router(config-if)# cable downstream dsg tg 1 priority 2 enableRouter(config-if)# cable downstream dsg tg 1 ucid 1 2 3 4Router(config-if)# cable downstream dsg tg 1 vendor-param 20Associated FeaturesThe cable downstream dsg tg command is used to configure the Advanced Mode DOCSIS Set-Top Gateway 1.2 for the Cisco CMTS Routers feature.
Related Commands
cable downstream dsg disable
Excludes the primary capable interface from A-DSG forwarding.
cable downstream dsg tg channel
To associate an Advanced-mode DOCSIS Set-Top Gateway (A-DSG) tunnel group to a downstream interface on a Cisco CMTS router, use the cable downstream dsg tg channel command in interface configuration mode. To remove this configuration, use the no form of this command.
cable downstream dsg tg group-id channel channel-id
no cable downstream dsg tg group-id channel channel-id
Syntax Description
group-id
Specifies the A-DSG tunnel group identifier as a number from 1 to 65535.
channel-id
Specifies the downstream channel identifier as a number from 1 to 65535.
Command Default
The A-DSG tunnel group is not associated to a downstream interface.
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
The cable dsg tg channel global configuration command establishes the configuration of tunnels in a tunnel group. Tunnel groups are enabled by default.
Then, you can associate the tunnel group to a downstream cable interface using the cable downstream dsg tg channel interface configuration command.
Examples
The following example shows the configuration and activation of a tunnel group with ID of 1 and channel ID of 2 in global configuration, followed by association of the tunnel group to a downstream interface on a Cisco CMTS router:
cable dsg tg 1 channel 2interface cable 8/1/2cable downstream dsg tg 1 channel 2Related Commands
cable downstream dsg timer
To associate an Advanced-mode DOCSIS Set-Top Gateway (A-DSG) timer entry to a downstream channel and include it in the Downstream Channel Descriptor (DCD) message on a Cisco CMTS router, use the cable downstream dsg timer command in interface configuration mode. To remove this setting, use the no form of this command.
cable downstream dsg timer timer-index
no cable downstream dsg timer timer-index
Syntax Description
Command Default
The downstream DSG timer is not configured by default.
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
Global configuration for A-DSG must be complete before configuring interface definitions.
Examples
The following example shows the configuration DSG timers for inclusion in DCD messages on a downstream cable interface on a Cisco CMTS router:
interface Cable6/0cable downstream dsg timer 3Related Commands
cable downstream dsg vendor-param
To associate Advanced-mode DOCSIS Set-Top Gateway (A-DSG) vendor parameters to a downstream, to be included in the Downstream Channel Descriptor (DCD) message on a Cisco CMTS router, use the cable downstream dsg vendor-param command in interface configuration mode. To remove this configuration from a Cisco CMTS router, use the no form of this command.
cable downstream dsg vendor-param vsif-grp-id
no cable downstream dsg vendor-param vsif-grp-id
Syntax Description
Command Default
This command is not configured by default.
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
Global configuration for A-DSG must be complete before configuring interface definitions.
Examples
The following example shows configuration of A-DSG vendor parameters on a downstream interfac, along with several other downstream interface commands on a Cisco CMTS router:
interface Cable6/0cable downstream dsg dcd-enablecable downstream dsg chan-list 2cable downstream dsg timer 3cable downstream dsg vendor-param 2cable downstream dsg rule 1 priority 1 clients 1 tunnel 1cable downstream dsg rule 1 vendor-param 1cable downstream dsg rule 1 classifiers 1 5cable downstream dsg rule 2 priority 1 clients 2 tunnel 2Related Commands
cable downstream frequency
To note the downstream center frequency for the cable interface line card to reflect the digital carrier frequency of the downstream radio frequency carrier (the channel) for that downstream port, use the cable downstream frequency command in cable interface configuration mode. On cable interfaces with an integrated upconverter, to unset the downstream frequency and to disable the RF output from the integrated upconverter, use the no form of this command.
cable downstream frequency down-freq-hz
no cable downstream frequency
Syntax Description
Command Default
Disabled. On the Cisco uBR7100 series routers, the default downstream center frequency for the integrated upconverter is 500 MHz.
Command Modes
Interface configuration—cable interface only (config-if)
Command History
Usage Guidelines
This command is either optional or required, depending on the cable interface line card being used.
•
•
Note
Note
The downstream frequency of your RF output must be set to match the expected input frequency of your upconverter. To do this, you enter the fixed center frequency of the downstream channel for the downstream port. (You can also select a default that does not set a specific fixed value.) The valid range for a fixed center frequency is 54,000,000 to 858,000,000 Hz. The center frequency is also used to configure an IF-to-RF upconverter that must be installed in your downstream path.
The digital carrier frequency is specified to be the center of a 6.0 MHz channel. For example, EIA channel 95 spans 90.000 to 96.000 MHz. The center frequency is 93.000 MHz, which is the digital carrier frequency that should be configured as the downstream frequency. The typical range for current CATV headends is 88,000,000 to 860,000,000 Hz.
In Cisco IOS software releases before Cisco IOS Release 12.2(15)BC2, the cable downstream frequency command allowed the center frequency to be specified in 125 KHz increments. In Cisco IOS Release 12.2(15)BC2 and later releases, this was changed to allow only 250 KHz increments, because of the requirements of the Broadband Processing Engine cable interface line cards that use an internal upconverter (Cisco uBR-MC16U, Cisco uBR-MC28U, and Cisco uBR-MC5X20S/U).
Note
Examples
The following example shows how to set the downstream center frequency display value:
Router(config)# interface c6/0Router(config-if)# cable downstream frequency 96000000Related Commands
cable downstream if-output
To activate a downstream port on a cable interface and to generate either a standard modulated signal or a test signal, use the cable downstream if-output command in cable interface configuration mode. To disable all signal output on the intermediate frequency (IF) carrier and to shut down the interface, use the no form of this command.
cable downstream if-output [continuous-wave | prbs]
no cable downstream if-output
Syntax Description
Command Default
The downstream interface is enabled for normal data use (cable downstream if-output).
Command Modes
Interface configuration—cable interface only (config-if)
Command History
Usage Guidelines
Typically, a downstream is configured to output a modulated signal, using the cable downstream if-output command, allowing data transmissions to be sent over the HFC cable network. However, this command can also be used to test the cable plant or to shut down the interface completely:
•
•
•
Note
Examples
The following example shows how to enable downstream port 0 on a cable interface:
Router# configure terminalRouter# interface c6/0Router(config-if)# cable downstream if-outputThe following example shows a PRBS test signal being generated on a downstream for a period of time. The downstream is then shut down so that the test engineer can verify that no signal is being sent on the downstream. After the tests have been run, the downstream is reactivated for normal modulated data use:
Router# configure terminalRouter# interface c6/0Router(config-if)# cable downstream if-output prbs(the signals are verified by a spectrum analyzer...)Router#(config-if)# no cable downstream if-output(the downstream is checked to verify no signals are being sent on it...)Router#(config-if)# cable downstream if-outputRouter#(config-if)# exitcable downstream interleave-depth
To set the downstream interleave depth, use the cable downstream interleave-depth command in cable interface configuration mode. To restore the default setting, use the no form of this command.
cable downstream interleave-depth {8 | 16 | 32 | 64 | 128}
no cable downstream interleave-depth
Syntax Description
Command Default
32
Command Modes
Interface configuration—cable interface only (config-if)
Command History
Usage Guidelines
Note
This command sets the minimum latency of the system. A higher interleave depth provides more protection from bursts of noise on the HFC network by spreading out the bits for each codeword over a greater transmission time.
Interleave transmissions do not transmit each codeword by itself, but instead send bits from multiple codewords at the same time, so that a noise burst affects the minimum number of bits per codeword, which allows the Forward Error Correction (FEC) algorithm a greater chance of detecting and correcting any transmission errors.
A higher interleave depth transmits bits from a greater number of codewords, increasing the efficacy of the FEC algorithm. However, a higher depth also increases downstream latency, which might slow TCP/IP throughput for some configurations, so you need to choose an interleave depth that is appropriate both for your plant's noise levels and application needs.
If your cable plant is experiencing high noise levels, consider increasing the interleave from the default of 32 to 64. For plants with exceptionally high noise levels, increase the interleave to 128 to provide the maximum protection from noise bursts.
Low interleave depth values typically cause some packet loss on typical HFC networks, because burst noise lasts beyond the error correction block correctable length. However, on cable plants with exceptionally low noise levels, Cisco recommends initially using the default value of 32, and then trying an interleave of either 16 or 8 to see if this increases performance without increasing the number of errors that result from noise.
Table 8 shows interleave characteristics and their relation to each other.
Note
Tip
Examples
The following example shows how to configure the downstream interleave depth to 128 microseconds:
Router# configure terminalRouter(config)# interface cable 3/0Router(config-if)# cable downstream interleave-depth 128cable downstream modulation
To set the modulation format for a downstream port on a cable interface line card, use the cable downstream modulation command in cable interface configuration mode.
cable downstream modulation {64qam | 256qam}
Syntax Description
64qam
Modulation rate is 6 bits per downstream symbol.
256qam
Modulation rate is 8 bits per downstream symbol.
Command Default
64qam
Command Modes
Interface configuration—cable interface only (config-if)
Command History
Usage Guidelines
Downstream modulation defines the speed in bits per second at which data travels downstream to the subscriber's CM. A symbol is the basic unit of modulation. QPSK encodes 2 bits per symbol, 16-QAM encodes 4 bits per symbol, 64-QAM encodes 6 bits per symbol, and 256-QAM encodes 8 bits per symbol.
Note
Tip
Examples
The following example shows how to set the downstream modulation to 256-QAM:
Router# configure terminalRouter(config)# interface cable 3/0Router(config-if)# cable downstream modulation 256qamcable downstream override
To enable cable downstream frequency override, use the cable downstream override command in cable interface configuration mode. To disable the override feature, use the no form of this command.
cable downstream override
no cable downstream override
Syntax Description
This command has no keywords or arguments.
Command Default
Cable downstream frequency override is enabled by default.
Command Modes
Interface configuration (cable interface only)
Command History
Usage Guidelines
This command is never needed for normal operations, because downstream frequency override is enabled by default for DOCSIS operations. However, this command can be used to disable the frequency override feature for test and lab use, so as to force the CMs on that interface to use a particular downstream frequency, regardless of the signal quality.
Note
Examples
The following example shows how to disable the downstream frequency override feature on a particular cable interface:
Router# configure terminalRouter(config)# interface cable 6/0Router(config-if)# no cable downstream overrideRouter(config-if)# exitcable downstream qos wfq weight
To specify custom DOCSIS priority to excess ratio mappings for downstream service flows, use the cable downstream qos wfq weight command in cable interface configuration mode. Use the no form of this command to revert to the default mappings.
cable downstream qos wfq weights weight1...weight8
no cable downstream qos wfq weights
Syntax Description
weights weight
Specifies the custom excess ratios for 8 priorites.
•
Command Default
DOCSIS priority to excess ratio mapping is used.
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
This command configures custom DOCSIS priority to excess ratio mappings for downstream service flows.
Examples
The following example shows how to configure custom DOCSIS priority to excess ratio mappings for downstream service flows:
Router# configure terminalRouter(config)# interface cable 8/0/0Router(config-if)# cable downstream qos wfq weights 10 20 30 40 50 60 70 80Related Commands
cable downstream rate-limit
Note
To enable DOCSIS rate limiting on downstream traffic, use the cable downstream rate-limit command in cable interface configuration mode. To disable DOCSIS rate limiting on downstream traffic, use the no form of this command.
cable downstream rate-limit [token-bucket [[shaping [granularity msec | max-delay msec]] | weighted-discard] [exp-weight]
no cable downstream rate-limit
Syntax Description
Command Default
In Cisco IOS Release 12.1 EC and earlier releases, the system defaults to monitoring the traffic to and from each CM over each 1-second period, and if the CM exceeds its bandwidth quota for that second, the CMTS router drops packets for the rest of the second (no cable downstream rate-limit).
In Cisco IOS Release 12.2 BC and later releases, the token-bucket and shaping keywords are on by default, and the max-delay option is set to 128 milliseconds (cable downstream rate-limit token-bucket shaping max-delay 128).
Note
Command Modes
Interface configuration (cable interface only)
Command History
Usage Guidelines
The cable downstream rate-limit command specifies the type of DOCSIS rate limiting that the CMTS router imposes on downstream traffic that is sent to the CMs. When rate-limiting is enabled, traffic to the CM is examined to ensure it will not exceed the limit set for the CM.
For DOCSIS networks, the best rate limiting algorithm combines the token-bucket and shaping to use keywords, which is optimized for relatively steady data rates, such as are used for web browser, without allowing the user to exceed the maximum allowable download rate that is specified in the DOCSIS configuration file.
Note
If a packet would exceed the traffic limits for a CM, the CMTS router will buffer the packet, up to the maximum delay time given by the max-delay option, so that the traffic can be sent at a later time when it would not violate the maximum downstream traffic limits. If the packet is still too large, or if the volume of traffic consistently exceeds the traffic limits, even after the delay, the CMTS router begins dropping packets.
The default behavior of the cable downstream rate-limit command was changed in Cisco IOS Release 12.2 BC to accommodate the different requirements of DOCSIS 1.1 operation (which requires the use of the token-bucket rate-limiting algorithm). This default is optimized for downstream traffic rates that are higher than 84 kbps.
If you are using a 64 kbps downstream traffic rate on a Cisco CMTS router that is running Cisco IOS Release 12.2 BC, you should set the max-delay option to 256 milliseconds to avoid a performance impact on TCP/IP traffic that uses packets larger than 1024 bytes (such as FTP or HTTP web traffic). Alternatively, you can set the max-burst option on the cable service class command to 3044, which is two packets of the minimum size for DOCSIS 1.1 networks.
Understanding the max-delay and granularity Options
The Cisco CMTS router uses a calendar-queuing system to process the packets being shaped. The calendar queue is a time wheel that is as big as the value specified by the max-delay option (128, 256, 512, or 1028 milliseconds), and is divided into "buckets" of the size specified by the granularity option (1, 2, 4, 8, or 16 milliseconds).
The number of buckets depends on both the max-delay and granularity options. For example, if the max-delay option is set to 256 milliseconds, and the granularity option is set to 4 milliseconds, the calendar queue contains 256/4, or 64, buckets, where a new bucket is processed every 4 milliseconds.
When the Cisco CMTS router adds a shaped packet to the queue, it adds the packet into the bucket that corresponds to the deadline by which the packet must be processed. At the end of every granularity time period, the Cisco CMTS router processes the packets that are in the corresponding bucket.
Decreasing the max-delay value increases how often the packets in the entire queue are processed, while decreasing the granularity value increases the accuracy of the shaping mechanism. Decreasing these values, however, could result in a possible increase in CPU processor usage. In most circumstances, this increase in processor usage is negligible, but it should be monitored whenever fine-tuning the max-delay or granularity values.
Tip
Examples
The following example shows how to apply the token-bucket filter algorithm on a Cisco uBR7200 series router running Cisco IOS Release 12.1 EC:
Router(config)# interface cable 6/0Router(config-if)# cable downstream rate-limit token-bucketThe following example shows how to apply the token-bucket filter algorithm on a Cisco uBR10012 router running Cisco IOS Release 12.2 BC:
Router(config)# interface cable 5/1/0Router(config-if)# cable downstream rate-limit token-bucket shapingThe following example shows how to use token-bucket shaping with a max-delay of 256 milliseconds on a Cisco uBR7100 series router:
Router(config)# interface cable 1/0Router(config-if)# cable downstream rate-limit token-bucket shaping max-delay 256Related Commands
cable downstream rf-power
To set the RF power output level on an integrated upconverter on the Cisco uBR7100 series router, Cisco uBR-MC16U, Cisco uBR-MC28U, or Cisco uBR10-MC5X20S/U cable interface line card, or Cisco RF Gateway 10, use the cable downstream rf-power command in cable interface configuration mode. To reset the RF output power level to its default value, use the no form of this command.
cable downstream rf-power {power-level | hccp-delta diff-pwr | hccp-override override-pwr}
no cable downstream rf-power {power-level | hccp-delta diff-pwr | hccp-override override-pwr}
Syntax Description
Command Default
50 dBmV for the Cisco uBR7100 series router
55 dBmV for the Cisco uBR-MC5X20S cable interface line card on the Cisco uBR10012 router
55 dBmV for the Cisco uBR-MC16U and Cisco uBR-MC28U cable interface line cards
55 dBmV for the Cisco uBR10-MC5X20U-D cable interface line card on the Cisco uBR10012 router
Cisco RF Gateway10
The default values set are as follows for the different stacking levels:
1:1 stacking—44 dBmV
2:1 stacking—47 dBmV
4:1 stacking—40 dBmV
Command Modes
Interface configuration (config-if).
QAM interface and subinterface configuration (config-if and config-subif)
Command History
Usage Guidelines
Note
The hccp-delta and hccp-override options can be configured only on a protect interface (an interface that has been configured with the hccp protect command). However, it is possible to manually edit a configuration file on a TFTP server to include these options on a working interface configuration, and then download that configuration to the router from the TFTP server.
If you manually edit the Cisco IOS configuration files, ensure that you specify these options only on protect interfaces. If you specify the hccp-delta or hccp-override option on a working interface, the router will modify the configured downstream power with the given power delta or override value.
Cisco RF Gateway 10
The stacking level on Cisco RFGW-10 are as follows:
1:1 stacking—30 dBmV ~ 61 dBmV, default is 44 dBmV
2:1 stacking—30 dBmV ~ 57 dBmV, default is 47 dBmV
4:1 stacking—30 dBmV ~ 53 dBmV, default is 40 dBmV
The official range for acceptable power levels in the DOCSIS standard depends on the stacking level. The DOCSIS levels are as follows:
1:1 stacking—52 dBmV ~ 60 dBmV
2:1 stacking—48 dBmV ~ 56 dBmV
4:1 stacking—44 dBmV ~ 52 dBmV
Note
Executing port level commands such as cable downstream annex, cable downstream modulation, cable downstream stacking, cable downstream frequency, and cable downstream rf-power at the QAM channel level modifies all the QAM channels on that port.
Examples
The following example shows how to configure the integrated upconverter on a Cisco uBR7100 series router for an RF output power level of 45 dBmV:
Router(config)# cable interface 1/0Router(config-if)# cable downstream rf-power 45The following example shows how to configure the first integrated upconverter on a Cisco uBR10012 router for an RF output power level of 53 dBmV:
Router(config)# cable interface 5/1/0Router(config-if)# cable downstream rf-power 53The following commands shows how to configure the first integrated upconverter to the default power level of 55 dBmV on the Cisco uBR10012 router:
Router(config)# cable interface 5/1/0Router(config-if)# no cable downstream rf-powerRouter(config-if)# exitThe following example shows how to configure a protect interface to add 3 dBmV to the current working RF power level when a switchover occurs:
Router(config)# cable interface 6/0/0Router(config-if)# cable downstream rf-power hccp-delta 3Router(config-if)# exitThe following example shows how to configure a protect interface to use an RF power level of 48 dBmV instead of the current working RF power level when a switchover occurs:
Router(config)# cable interface 6/0/0Router(config-if)# cable downstream rf-power hccp-override 48Router(config-if)# exit
Note
Cisco RF Gateway 10
The following example shows how to configure the integrated upconverter on a Cisco RFGW-10 for an RF output power level of 50 dBmV:
Router(config)# interface qam 3/1.1Router(config-subif)# cable downstream rf-power 50Related Commands
cable downstream rf-shutdown
To disable the RF output from an integrated upconverter on the Cisco uBR7100 series router, Cisco uBR-MC16U, Cisco uBR-MC28U or the Cisco uBR10-MC5X20S/U cable interface line card, use the cable downstream rf-shutdown command in cable interface configuration mode. To enable the RF output on the integrated upconverter, use the no form of this command.
cable downstream rf-shutdown
no cable downstream rf-shutdown
Syntax Description
This command has no arguments or keywords.
Command Default
RF output is disabled.
Command Modes
Interface configuration—cable interface only (config-if)
Command History
Usage Guidelines
By default, the integrated upconverter on the Cisco uBR7100 series router, Cisco uBR-MC16U, Cisco uBR-MC28U, and the Cisco uBR10-MC5X20S/U cable interface line cards is disabled, and the downstream port does not output any signal. The no form of this command enables the integrated upconverter, allowing it to output an RF signal through the downstream port.
However, before a valid DOCSIS downstream signal can be output, the following must also be done:
•
•
Note
Examples
The following example enables the integrated upconverter on the Cisco uBR7100 series router:
Router(config)# cable interface 1/0Router(config-if)# no cable downstream rf-shutdownThe following example enables the second integrated upconverter on a Cisco uBR-MC5X20S cable interface line card in the Cisco uBR10012 router:
Router(config)# cable interface 7/0/1Router(config-if)# no cable downstream rf-shutdownThe following commands must also be given before the DS0 RF port can transmit a valid RF signal:
Router(config-if)# cable downstream frequency center-frequencyRouter(config-if)# no shutdownRouter(config-if)# exitrouter(config)#Related Commands
cable dsg
Note
To enable the DOCSIS Set-Top Gateway (DSG) on a cable interface on a Cisco CMTS router, and to configure its tunnel-mapping parameters, use the cable dsg command in interface or subinterface configuration mode. To remove the DSG tunnel from the interface, use the no form of this command.
cable dsg tunnel-MAC-address group-ip-address CA-vendor-name
no cable dsg tunnel-MAC-address group-ip-address CA-vendor-name
Syntax Description
Command Default
No DSG tunnels are defined.
Command Modes
Interface (config-if) and subinterface configuration (config-subif) for cable interfaces only
Command History
Usage Guidelines
This command enables DSG operations on the cable interface, creating a DSG tunnel that uses the specified IGMP multicast address and well-known MAC address.
The tunnel-MAC-address could optionally be an Internet Group Management Protocol (IGMP) multicast address, using the algorithm for converting host group IP address to an Ethernet MAC address that is given in RFC 1112. If the MAC address is 0000.0000.0000, the DSG tunnel uses the algorithm given in RFC 1112 to derive the multicast address for the tunnel as follows:
An IP host group address is mapped to an Ethernet multicast address by placing the low-order 23-bits of the IP address into the low-order 23 bits of the Ethernet multicast address 01-00-5E-xx-xx-xx (hex). Because there are 28 significant bits in an IP host group address, more than one host group address may map to the same Ethernet multicast address.
For example, if you specify the command cable dsg 0.0.0 228.9.9.9 AAA, the command uses the IGMP IP address of 228.9.9.9 to generate the MAC address of 0100.5E09.0909 for the DSG tunnel. If the IGMP address were 228.129.9.9, the resulting MAC address would be 0100.5E01.0909.
You can specify only Global Scope (224.0.1.0 through 238.255.255.255) and Administratively Scoped (239.0.0.0 through 239.255.255.255) addresses. You cannot use Local Scope addresses (224.0.0.0 through 224.0.0.255).
Entering the cable dsg command also automatically configures the interface for the appropriate IGMP static group, using the ip igmp static-group command. Do not manually enter another ip igmp static-group command for this interface, because the system assumes that this IGMP configuration is for a separate configuration that cannot be used by the DSG subsystem.
Note
The no cable dsg command automatically removes the IGMP static group from the interface by issuing the no ip igmp static-group command. Do not manually remove this static group yourself.
In addition, you must have enabled Protocol Independent Multicast (PIM) on the cable interface, using the ip pim interface configuration command, before enabling and configuring DSG operations. The DOCSIS Set-Top Gateway feature supports the following PIM modes:
•
•
•
Limitations and Restrictions
The DOCSIS Set-Top Gateway feature also has the following limitations:
•
•
We also recommend putting all DSG configurations on the same, single subinterface. Although you can configure DSG tunnels on multiple subinterfaces, this is not guaranteed to be supported in future software releases.
•
•
•
•
•
•
•
•
•
•
•
Note
Examples
The following example shows how to configure a cable interface on a Cisco uBR7246VXR router to enable the DSG feature on cable interface 3/0, using a well-known MAC address of 0001.0002.0003 and a destination IP address of 225.2.3.4:
interface cable 3/0ip pim dense-modeip multicast rate-limit out group-list 123 1024cable dsg 1.2.3 225.2.3.4 CCC
Note
The following example shows the error message that appears if you specify a broadcast IP address that has already been added to the router's IGMP database. This entry typically would have been created manually on the router or dynamically by a customer premise equipment (CPE) device that is attached to a cable modem on the cable network.
interface cable 3/0cable dsg 1.1.1 224.3.3.10 ciscoMulticast group 224.3.3.10 is already in use on the interface Cable3/0, please retry.The following example shows how to delete a DSG tunnel on a cable interface:
interface cable 4/0no cable dsg 0020.0020.0020 230.8.8.8 abc4d17h: DSG: interface Cable5/0 left the igmp static group 230.8.8.8.4d17h: DSG: tunnel 0020.0020.0020 is removed4d17h: DSG: the specified DSG entry has been removed.The following example shows the error message that appears when a unicast IP address is specified instead of a multicast IP address:
interface cable 4/0cable dsg 1.1.1 192.168.13.10 ciscoOnly multicast is supported for current version.Related Commands
cable dsg cfr
To define and enable Advanced-Mode DOCSIS Set-Top Gateway (A-DSG) classifiers on a Cisco CMTS router, use the cable dsg cfr command in global configuration mode. To remove one or more specified A-DSG classifiers from a Cisco CMTS router, use the no form of this command. To disable one or more specified A-DSG classifiers but retain their configuration, use the disable form of this command.
cable dsg cfr index [dest-ip {ipaddr | hostname}] [tunnel index] [dest-ports start end] [priority priority] [src-ip {ipaddr | hostname} [src-prefix-len length]] [disable | enable] [in-dcd {yes | no | ignore}]
no cable dsg cfr index
Syntax Description
Command Default
The A-DSG classifiers are undefined by default on a Cisco CMTS router. When configured, A-DSG classifiers are enabled by default.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The cable dsg cfr command creates an index to which one or several A-DSG classifiers apply. The A-DSG classifiers can only be mapped to one DSG tunnel. The Cisco CMTS router applies the classifier parameters to the packets received from the DSG server in order to assign the packet to the appropriate DSG tunnel.
When you use the in-dcd yes option, the classifiers are also included in the DSG rules as part of the DCD message.
When you use the in-dcd ignore option, the DSG rule is enabled after bypassing the RFC-1112 MAC address check, and the DSG classifier is not included in the DCD message.
The no form of the cable dsg cfr command disables the DSG rule if the tunnel MAC address is derived from the RFC-1112.
During the software downgrade process, if the software does not support the in-dcd ignore option then the in-dcd yes option is used.
Examples
The following example shows how to configure an A-DSG classifier on a Cisco CMTS router:
Router(config)# cable dsg cfr 1Router(config)# cable dsg cfr 2 dest-ip 224.10.10.101 tunnel 1 dest-port 0 65535 priority 1Router(config)# cable dsg cfr 2 dest-ip 224.10.10.102 dest-ports 22 777 enable in-dcd yesRouter(config)# cable dsg cfr 3 dest-ip 224.10.10.103 dest-ports 22 777 src-ip ciscovideo.comAssociated FeaturesThe cable dsg cfr command is used to configure the Advanced Mode DOCSIS Set-Top Gateway 1.2 for the Cisco CMTS Routers feature.
Related Commands
cable dsg chan-list
To configure the Advanced-mode DOCSIS Set-Top Gateway (A-DSG) downstream channel list on a CMTS router, use the cable dsg chan-list command in global configuration mode. To remove the A-DSG channel list, use the no form of this command.
cable dsg chan-list list-index index entry-index freq freq
no cable dsg chan-list list-index index entry-index freq freq
Syntax Description
Command Default
A-DSG channel lists are disabled and undefined by default.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The channel list entry created with this command can be associated to a downstream interface and be included in the Downstream Channel Descriptor (DCD) message by using the cable downstream dsg chan-list command.
Examples
The following example shows A-DSG channel list global configurations on a Cisco CMTS router:
cable dsg chan-list 1 index 1 freq 47000000cable dsg chan-list 1 index 2 freq 125000000cable dsg chan-list 1 index 3 freq 55500000cable dsg chan-list 2 index 1 freq 47000000cable dsg chan-list 2 index 2 freq 125000000cable dsg chan-list 2 index 3 freq 55500000Related Commands
cable dsg client-list
To configure client parameters for Advanced-mode DOCSIS Set-Top Gateway (A-DSG) on a Cisco CMTS router, use the cable dsg client-list command in global configuration mode. This command configures the client parameters and the associated DSG rule. To remove this configuration, use the no form of the command.
cable dsg client-list client-list-id id-index id {application-id app-id | broadcast [broadcast-id] | ca-system-id sys-id | mac-addr mac-addr}
no cable dsg client-list client-list-id id-index id {application-id app-id | broadcast [broadcast-id] | ca-system-id sys-id | mac-addr mac-addr}
Syntax Description
Command Default
Client lists for A-DSG are not configured by default.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
Beginning in Cisco IOS Release 12.3(17a)BC2, the same DSG client identifer can be associated with multiple DSG tunnels.
Examples
The following example shows global configuration for four A-DSG client lists:
cable dsg client-list 1 id-index 1 broadcastcable dsg client-list 2 id-index 2 application-id FFFFcable dsg client-list 3 id-index 3 ca-system-id EEEEcable dsg client-list 4 id-index 4 mac-addr 0100.5e0a.0a04Related Commands
cable dsg keepalive
Note
To enable keepalive messages over DOCSIS Set-Top Gateway (DSG) tunnels on all cable interfaces, use the cable dsg keepalive command in global configuration mode. To disable DSG keepalives, use the no form of this command.
cable dsg keepalive
no cable dsg keepalive
Syntax Description
This command has no arguments or keywords.
Command Default
Keepalive messages are disabled (no cable dsg keepalive).
Command Modes
Global configuration (config)
Command History
Usage Guidelines
By default, a Cisco CMTS router does not send keepalive messages on any DSG tunnels. When keepalives are enabled using the cable dsg keepalive command, the Cisco CMTS router sends one keepalive message each second on each DSG tunnel on each downstream. In Cisco IOS Release 12.2(15)BC2, the keepalive packet is a null packet.
Note
Tip
Examples
The following example shows how to enable DSG keepalives on all cable interfaces on the router:
cable dsg keepaliveThe following example shows how to disable DSG keepalives on all cable interfaces, which is the default configuration:
no cable dsg keepaliveRelated Commands
cable dsg name-update-interval
To update fully-qualified domain name (FQDN) classifiers on a Cisco CMTS router based on the DNS server record, use the cable dsg name-update-interval command in global configuration mode. To remove this configuration, use the no form of this command.
cable dsg name-update-interval minutes
no cable dsg name-update-interval minutes
Syntax Description
minutes
Interval in minutes to check the DNS server for any FQDN classifier changes. The valid range is from 1 to 60. The default value is 5.
Command Default
The default value of 5 minutes is configured.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
Use the cable dsg name-update-interval command to configure the DSG name process feature. This feature supersedes the Time to Live (TTL) value associated with the DNS server while obtaining the latest DNS server record.
Examples
The following example shows how to specify the DSG name interval on the Cisco CMTS router:
Router(config)# cable dsg name-update-interval 3Associated FeaturesThe cable dsg-name-update-interval command is used to configure the Advanced Mode DOCSIS Set-Top Gateway 1.2 for the Cisco CMTS Routers feature.
Related Commands
cable dsg cfr
Defines and enables A-DSG classifiers on a Cisco CMTS router.
show cable dsg cfr
Displays DSG classifier details.
cable dsg tg
To associate a group of Advanced-Mode DOCSIS Set-Top Gateway (A-DSG) tunnels to one or more downstream interfaces on a Cisco CMTS router, use the cable dsg tg command in global configuration mode. To remove this configuration, use the no form of this command.
cable dsg tg group-id [channel channel_ID | priority DSG-rule-priority [enable | disable] | ucid ID1 [ID2 ID3 ID4] | vendor-param vendor-group-ID]
no cable dsg tg group-id
Syntax Description
Defaults
The A-DSG tunnel group configuration is enabled by default.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The cable dsg tg command establishes the configuration of the tunnel group. You can use the disable and enable keyword forms of the command to deactivate and activate the tunnel group configuration.
Examples
The following example shows configuration and activation of a DSG tunnel group with channel ID, A-DSG rule priority, upstream channel ID, and vendor parameter group ID:
Router(config)# cable dsg tg 1Router(config)# cable dsg tg 1 channel 2Router(config)# cable dsg tg 1 channel 2 enableRouter(config)# cable dsg tg 1 channel 2 priority 3Router(config)# cable dsg tg 1 channel 2 priority 3 enableRouter(config)# cable dsg tg 1 channel 2 ucid 1Router(config)# cable dsg tg 1 channel 2 vendor-param 30Related Commands
cable dsg tg channel
To associate a group of Advanced-mode DOCSIS Set-top Gateway (A-DSG) tunnels to one or more downstream interfaces on a Cisco CMTS router, use the cable dsg tg channel command in global configuration mode. To remove this configuration, use the no form of this command.
cable dsg tg group-id channel channel-id [priority rule-priority] [enable | disable]
no cable dsg tg group-id channel channel-id [priority rule-priority]
Syntax Description
Defaults
The A-DSG tunnel group configuration is enabled by default.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The cable dsg tg channel command establishes the configuration of the tunnel group. You can use the disable and enable keyword forms of the command to deactivate and activate the tunnel group configuration. To remove the configuration, use the no form of the command.
Examples
The following example shows configuration and activation of a tunnel group with ID of 1 and channel ID of 2:
Router(config)# cable dsg tg 1 channel 2Related Commands
cable dsg tg channel ucid
To configure the upstream channel IDs for an Advanced-mode DOCSIS Set-top Gateway (A-DSG) tunnel group on a Cisco CMTS router, use the cable dsg tg channel ucid command in global configuration mode. To remove this configuration, use the no form of this command.
cable dsg tg group-id channel channel-id ucid upstream-id [upstream-id. . .]
no cable dsg tg group-id channel channel-id ucid upstream-id [upstream-id. . .]
Syntax Description
Defaults
Upstream channel IDs are not defined by default.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The cable dsg tg channel command must be configured before this command is made available.
Examples
The following example shows configuration of a tunnel group with ID of 1 and channel ID of 2, followed by configuration of the upstream channel IDs associated with the tunnel group:
Router(config)# cable dsg tg 1 channel 2Router(config)# cable dsg tg 1 channel 2 ucid 1 2 3 4 5 6 7 8Related Commands
cable dsg tg channel vendor-param
To associate a vendor-specific group with an Advanced-mode DOCSIS Set-top Gateway (A-DSG) tunnel group on a Cisco CMTS router, use the cable dsg tg channel vendor-param command in global configuration mode. To remove this configuration, use the no form of this command.
cable dsg tg group-id channel channel-id vendor-param vendor-group
no cable dsg tg group-id channel channel-id vendor-param vendor-group
Syntax Description
Defaults
The A-DSG vendor-specific group is not associated by default.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The cable dsg tg channel command must be configured before this command is made available. You also need to configure the vendor-specific parameter list using the cable dsg vendor-param command before you can associate it with the tunnel group.
Examples
The following example shows configuration of the vendor-specific parameter list, followed by configuration of a tunnel group and ssociation with the defined vendor group 3:
! Configure the vendor-specific parameter listcable dsg vendor-param 3 vendor 1 oui ABCDEC value 0101AB!! Configure the tunnel group and associate the vendor group to the tunnel!cable dsg tg 1 channel 2cable dsg tg 1 channel 2 vendor-param 3Related Commands
cable dsg tg default-priority
To change the default channel priority for a tunnel group on the Cisco CMTS router, use the cable dsg tg default-priority command in global configuration mode. To set the channel priority back to the default value of zero, use the no form this command.
cable dsg tg group-id default-priority DSG-rule-priority
no cable dsg tg group-id priority DSG-rule-priority
Syntax Description
Command Default
The default value of 0 is used as the channel priority for a tunnel group.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
All channels that are configured after setting the default priority use the same priority value.
Examples
The following example shows how to specify the default channel priority for a tunnel group on the Cisco CMTS router:
Router(config)# cable dsg tg 1 default-priority 20Associated FeaturesThe cable dsg tg default-priority command is associated with the Advanced Mode DOCSIS Set-Top Gateway 1.2 for the Cisco CMTS Routers feature.Related Commands
cable dsg tg priority
To change the priority of existing Advanced-Mode DOCSIS Set-Top Gateway (A-DSG) channels in a tunnel group on a Cisco CMTS router, use the cable dsg tg priority command in global configuration mode. To set the DSG rule priority of all existing channels in a tunnel group to the default value of zero, use the no form of this command.
cable dsg tg group-id priority DSG-rule-priority
no cable dsg tg group-id priority DSG-rule-priority
Syntax Description
Command Default
None
Command Modes
Global configuration (config)
Command History
Usage Guidelines
This command does not impact the downstream channels configured after setting the priority. The no form of the cable dsg tg priority command sets the DSG rule priority of all existing channels in a tunnel group to the default value of 0.
Examples
The following example shows how to specify the DSG rule priority for all existing A-DSG channels in a tunnel group on a Cisco CMTS router:
Router(config)# cable dsg tg 1 priority 20Associated FeaturesThe cable dsg tg priority command is used to configure the Advanced Mode DOCSIS Set-Top Gateway 1.2 for the Cisco CMTS Routers feature.
Related Commands
cable dsg cfr
Defines and enables A-DSG classifiers on a Cisco CMTS router.
show cable dsg cfr
Displays DSG classifier details.
cable dsg timer
To configure the Advanced-mode DOCSIS Set-Top Gateway (A-DSG) timer entry to be associated to the downstream channel, and encoded into the downstream channel descriptor (DCD) message on a Cisco CMTS router, use the cable dsg timer command in global configuration mode. To remove the cable A-DSG timer, use the no form of this command.
cable dsg timer index [Tdsg1 Tdsg1] [Tdsg2 Tdsg2] [Tdsg3 Tdsg3] [Tdsg4 Tdsg4]
no cable dsg timer index [Tdsg1 Tdsg1] [Tdsg2 Tdsg2] [Tdsg3 Tdsg3] [Tdsg4 Tdsg4]
Syntax Description
Defaults
The A-DSG timer is not defined by default.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The A-DSG timer entry can associated to the downstream to encode into the DCD message.
Examples
The following example shows global configuration of three A-DSG timers:
cable dsg timer 1 Tdsg1 1 Tdsg2 2 Tdsg3 3 Tdsg4 4cable dsg timer 2 Tdsg1 2 Tdsg2 22 Tdsg3 33 Tdsg4 44cable dsg timer 3 Tdsg1 2 Tdsg2 600 Tdsg3 300 Tdsg4 1800Related Commands
cable dsg tunnel
To create Advanced-mode DOCSIS Set-top Gateway (A-DSG) tunnels on a Cisco CMTS router, use the cable dsg tunnel command in global configuration mode. To remove this configuration, use the no form of this command. To disable A-DSG tunnels, use the disable form of this command.
cable dsg tunnel tunnel-id mac-addr mac-addr tg tunnel-group-id clients number [disable | enable]
no cable dsg tunnel tunnel-id mac-addr mac-addr tg tunnel-group-id clients number
Syntax Description
Syntax Descriptioncable dsg tunnel tunnel-id mac-addr mac-addr tg tunnel-group-id clients number
Defaults
A-DSG tunnels are not configured by default, but are enabled by default once configured.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The cable dsg tunnel command establishes the configuration of the tunnel. You can use the disable and enable keyword forms of the command to deactivate and activate the tunnel configuration. To remove the configuration, use the no form of the command.
Each tunnel is mapped to the destination MAC address and once defined, can be associated with a configured QoS service class name using the cable dsg tunnel srv-class command.
Examples
The following example shows configuration of four A-DSG tunnels on a Cisco CMTS router:
cable dsg tunnel 1 mac-addr 0100.5e0a.0a01cable dsg tunnel 2 mac-addr 0100.5e0a.0a02cable dsg tunnel 3 mac-addr 0100.5e0a.0a03cable dsg tunnel 4 mac-addr 0100.5e0a.0a04Related Commands
cable dsg tunnel srv-class
To associate a cable service class with an Advanced-mode DOCSIS Set-top Gateway (A-DSG) tunnel on a Cisco CMTS router, use the cable dsg tunnel srv-class command in global configuration mode. To remove this configuration, use the no form of this command.
cable dsg tunnel tunnel-id srv-class class-name
no cable dsg tunnel tunnel-id srv-class class-name
Syntax Description
Syntax Descriptioncable dsg tunnel tunnel-id mac-addr mac-addr tg tunnel-group-id clients number
tunnel-id
Identifies the DSG tunnel with an identifier as a number from 1-65535.
class-name
Specifies the name of a configured cable service class.
Defaults
Cable service classes are not configured by default or associated with a DSG tunnel.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The A-DSG tunnel and tunnel group must be created first before the cable dsg tunnel srv-class command becomes available to associate the tunnel with a configured QoS service class.
Examples
The following example shows the configuration of a cable service class named "test" on a Cisco CMTS router, followed by the association of that test cable service class with a DSG tunnel:
Router(config)# cable service class 1 name testRouter(config)# cable service class 1 downstreamRouter(config)# cable service class 1 max-rate 20000Router(config)# cable service class 1 min-rate 3000Router(config)# cable dsg client-list 1 id-index 1 mac-addr 0050.4d00.0007Router(config)# cable dsg tg 1 channel 1Router(config)# cable dsg tunnel 1 mac-addr 0050.4d00.0007 tg 1 clients 1Router(config)# cable dsg tunnel 1 srv-class testWhen the service class name is configured without the default MQoS configuration, the following error message is displayed and the configuration is rejected prompting the user to configure the default MQoS.
Router(config)# cable dsg tunnel 1 srv-class testThe default mqos doesn't exist, please, create one and then reconfigure service class name to tunnel 1Router(config)#When the last service class name is not configured, the following error message is displayed prompting the user to remove the default MQoS (if not needed.)
Router(config)# no cable dsg tunnel 1 srv-class testThere is no DSG tunnel associated with a service class name, so, remove the default mqos if not neededRouter(config)#Related Commands
cable dsg vendor param
To configure Advanced-mode DOCSIS Set-top Gateway (A-DSG) vendor-specific parameters on a Cisco CMTS router, use the cable dsg vendor-param command in global configuration mode. To remove this configuration, use the no form of this command.
cable dsg vendor-param group-id vendor vendor-index oui oui value value-in-TLV
no cable dsg vendor-param group-id vendor vendor-index oui oui value value-in-TLV
Syntax Description
Defaults
The A-DSG vendor-specific parameters are not defined by default.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The vendor-specific parameters can be associated to the downstream to encode into the Downstream Channel Descriptor (DCD) message.
To associate a vendor parameter list with a tunnel group, use the cable dsg tg channel vendor-param command. The same vendor parameter list can be associated with multiple tunnel groups.
Examples
The following sample configuration illustrates global vendor parameters for A-DSG:
cable dsg vendor-param 1 vendor 1 oui ABCDEA value 0101ABcable dsg vendor-param 2 vendor 1 oui ABCDEB value 0101ABcable dsg vendor-param 3 vendor 1 oui ABCDEC value 0101ABRelated Commands
cable ds-max-burst
To enable a specialized Enhanced-Rate Bandwidth Allocation (ERBA) feature on the Cisco uBR10012 router with Performance Routing Engine 2 (PRE2) or Performance Routing Engine 4 (PRE4) modules, use the cable ds-max-burst command in global configuration mode. To remove this configuration, use the no form of this command.
cable ds-max-burst [burst-threshold threshold peak-rate peak-rate]
no cable ds-max-burst
Syntax Description
Defaults
This configuration is disabled by default on the Cisco uBR10012 router. This command is not required nor supported on the Cisco uBR7100 Series, Cisco uBR7225VXR and Cisco uBR7246VXR router.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
Cisco IOS Release 12.3(21)BC introduces the ERBA feature on the Cisco uBR10012 CMTS with Performance Routing Engine 2 (PRE2) modules. The ERBA feature in Cisco IOS release 12.3(21)BC is characterized by the following enhancements:
•
•
Note
To displays service flows on the Cisco uBR10012 router with PRE2 or PRE4, and identifies which service flows have maximum burst enabled, use the following command in privileged EXEC mode:
show cr10k-rp cable slot/subslot/port sid service-flow ds
–
–
–
For additional information about the cable qos profile command and configuring QoS profiles, refer to the following documents on Cisco.com:
•
http://www.cisco.com/en/US/docs/cable/cmts/feature/guide/ufg_docs.html
Examples
The following example illustrates typical command sequence when using this command to configure ERBA on the Cisco uBR10012 router, with a sample burst threshold setting:
Router> enableRouter# configure terminalRouter(config)# cable ds-max-burst burst-threshold 2048 peak-rate 1000Router(config)# Ctrl^ZRouter# show cr10k-rp cable 7/0/0 sid service-flow dsWhen this feature is enabled, new service flows with burst size larger than the burst threshold are supported. However, the existing service flows are not affected.
When this feature is disabled, no new service flows are configured with the Downstream Maximum Transmit Burst parameter—the cable ds-max-burst command settings. However, the existing service flows are not affected.
The following example illustrates configuration of the ERBA maximum burst for the specified service flow:
Router# sh cr10k-rp c7/0/0 1 service-flow dsRP SFID LC SFID Conform Exceed Conform Exceed Total QIDXmit Pkts Xmit Pkts Drop Pkts Drop Pkts Pkts32930 10 41 0 0 0 41 131349Forwarding interface: Modular-Cable1/0/0:032931 13 0 0 0 0 0 131350Forwarding interface: Modular-Cable1/0/0:0Related Commands
cable ds-resiliency
To reserve a resiliency bonding group or wideband (WB) interface for a line card on the Cisco CMTS, use the cable ds-resiliency command in interface configuration mode. To remove this setting, use the no form of this command.
cable ds-resiliency
no cable ds-resiliency
Command Default
None
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
Remove all existing configuration commands from the WB interface when setting aside that interface as a WB resiliency bonding group.
The cable ds-resiliency command is used in conjunction with the cable resiliency ds-bonding command to configure the Downstream Resiliency Bonding Group feature.
Examples
The following example shows how to reserve a wideband cable interface in slot 5, subslot 1, and port 2 for a resiliency bonding group:
Router(config) interface wideband-cable 5/1/2:0Router(config-if)# cable ds-resiliencyAssociated FeaturesThe cable ds-resiliency command is used to configure the following feature:
Downstream Resiliency Bonding Group
Related Commands
cable dynamic-bw-sharing
To enable dynamic bandwidth sharing (DBS) on a specific modular cable or wideband cable interface, use the cable dynamic-bw-sharing command in interface configuration mode. To disable DBS on the interface and revert to static bandwidth sharing, use the no form of this command.
cable dynamic-bw-sharing
no cable dynamic-bw-sharing
Syntax Description
This command has no arguments or keywords.
Command Default
Dynamic bandwidth sharing is disabled and static bandwidth sharing is enabled.
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
DBS may be configured on a modular cable or wideband cable interface only when the interface is administratively down. Additionally, the interface must be administrative down when using the no form of this command to disable dynamic bandwidth sharing.
Note
Examples
The following example enables dynamic bandwidth sharing on a modular cable interface using the cable dynamic-bw-sharing command:
Router(config)# interface modular-cable 1/0/0:1Router(config-if)# shutdownRouter(config-if)# cable dynamic-bw-sharingRouter(config-if)# no shutdownThe following example enables dynamic bandwidth sharing on a wideband cable interface using the cable dynamic-bw-sharing command:
Router(config)# interface wideband-cable 1/0/0:0Router(config-if)# shutdownRouter(config-if)# cable dynamic-bw-sharingRouter(config-if)# no shutdownRelated Commands
cable dynamic-qos trace
To enable the call trace functionality on the Cisco CMTS router for the PacketCable or PacketCable Multimedia (PCMM) service subscribers, use the cable dynamic-qos trace command in global configuration mode. To disable this configuration, use the no form of this command.
cable dynamic-qos trace subscriber-number
no cable dynamic-qos trace
Syntax Description
subscriber-number
Number of subscribers for a PacketCable or PCMM service. The valid range is from 1 to 20.
Command Default
None
Command Modes
Global configuration (config)
Command History
Examples
The following example shows how to configure the call trace functionality on the Cisco uBR10012 router for the PacketCable or PCMM service subscribers:
Router# configure terminalRouter(config)# cable dynamic-qos trace 12Related Commands
cable dynamic-secret
To enable the Dynamic Shared Secret feature, so that Data-over-Cable Service Interface Specifications (DOCSIS) configuration files are verified with a Message Integrity Check (MIC) that has been created with a dynamically generated shared secret, use the cable dynamic-secret command in cable interface configuration mode. To disable this feature, use the no form of this command.
cable dynamic-secret {lock [lock-qos] | mark | reject} [nocrypt]
no cable dynamic-secret
Syntax Description
Defaults
The Dynamic Shared Secret feature is disabled. When enabled, the filenames for DOCSIS configuration files are encrypted.
Command Modes
Interface configuration—cable interface only (config-if)
Note
Command History
Usage Guidelines
The cable dynamic-secret configuration command automatically creates a unique DOCSIS shared secret on a per-modem basis, creating a one-time-use DOCSIS configuration file that is valid only for the current session. This ensures that a DOCSIS configuration file that has been downloaded for one cable modem can never be used by any other modem, nor can the same modem reuse this configuration file at a later time. This patent-pending feature is designed to guarantee that all registered modems are using only the QOS parameters that have been specified by the DOCSIS provisioning system for that particular modem at the time of its registration.
The cable dynamic-secret configuration command enhances the existing shared secret support on the Cisco CMTS by using a one-time, dynamically generated shared secret each time a cable modem registers. This prevents theft-of-service attacks in which users are able to substitute a DOCSIS configuration file that provides a higher-level of service during the registration phase.
The DOCSIS specification allows cable service providers to use a shared secret to create the CMTS MIC value that is stored in a DOCSIS configuration file. If a user attempts to register with the CMTS using a different or modified DOCSIS configuration file, the CMTS can compare the CMTS MIC value sent by the cable modem with the CMTS MIC it has calculated. If the two MIC values are different, the file has been modified.
The cable dynamic-secret command allows the CMTS to dynamically create the shared secret at the time that the cable modem is registering, and that shared secret is valid only for that particular session with that particular cable modem. A new dynamically generated shared secret is used each time each cable modem registers, which prevents users from guessing the shared secret and using it again to register with a modified DOCSIS configuration file.
If the cable modem's DOCSIS configuration file fails the CMTS MIC verification check, one of the following messages is displayed on the console:
%UBR7200-4-BADCFGFILE: Modem config file platinum.cm at C3/0: CMTS MIC Invalid%UBR7200-4-BADCFGFILE: Modem config file platinum.cm at C3/0: No CMTS MICIf the error message specifies that the reason for the failure is "CMTS MIC Invalid," the CMTS MIC was not encoded with the proper dynamically generated shared secret. If the reason is "No CMTS MIC," the DOCSIS configuration file did not contain any value for the CMTS MIC, which could indicate that the customer has attempted to bypass the DOCSIS security checks by creating the user's own DOCSIS configuration file without any MIC values.
Note
Note
The original filename for the DOCSIS configuration file is automatically encrypted by default to prevent unauthorized parties from obtaining any useful information from the filename, or from attempting to replace the original file with their own. This encryption can be disabled, using the nocrypt option, so that DOCSIS configuration files are sent using their original filenames.
Note
Modes of Operation
The cable dynamic-secret command offers three different possible responses to cable modems that fail the CMTS MIC verification check:
•
06:53:57: %UBR7200-4-CMMARKED: Cable Modem 00ff.ffee.ddcc in C3/0 attempted theft of service•
If the lock-qos profile is not specified, the CMTS uses a special QoS configuration that limits the network access for these CMs by restricting their downstream and upstream service flows to a maximum rate of 10 kbps. (If you do not specify the lock-qos profile, you must also allow cable modems to create QoS profiles, using the cable qos permission command. If you do not do this and use the lock option without specifying a particular QoS profile, locked cable modems will not be allowed to register until the lock clears or expires.)
If a customer resets their CM, the CM will reregister but still uses the restricted QoS profile. A locked CM continues with the restricted QoS profile until it goes offline and remains offline for at least 24 hours, at which point it is allowed to reregister with a valid DOCSIS configuration file. This option frustrates users who are repeatedly registering with the CMTS in an attempt to guess the shared secret, or to determine the details of the Dynamic Shared Secret security system.
In addition, the following message is displayed on the console when a CM is locked.
06:53:57: %UBR7200-4-CMLOCKED: Cable Modem 00ff.ffee.ddcc in C3/0 attempted theft of serviceLocked cable modems are shown with an exclamation point (!) in the show cable modem displays:
Router# show cable modemMAC Address IP Address I/F MAC Prim RxPwr Timing Num BPIState Sid (db) Offset CPE Enb0010.9507.01db 144.205.151.130 C5/1/0/U5 online(pt) 1 0.25 938 1 N0080.37b8.e99b 144.205.151.131 C5/1/0/U5 online 2 -0.25 1268 0 N0002.fdfa.12ef 144.205.151.232 C6/1/0/U0 online(pt) 13 -0.25 1920 1 N0002.fdfa.137d 144.205.151.160 C6/1/0/U0 !online 16 -0.50 1920 1 N0003.e38f.e9ab 144.205.151.237 C6/1/0/U0 !online 3 -0.50 1926 1 NRouter#
Tip
•
Tip
Note
Filename Encryption
By default, the cable dynamic-secret command encrypts the original filename for a DOCSIS configuration file when the Cisco CMTS transmits the file to the CM. This filename changes in a semi-random manner, making it difficult for users to predict the filename for the file that should be downloaded to the CM.
This does mean, however, that the filenames specified in the DHCP HELLO and ACK messages are different, and that the filenames on the CM and on the TFTP server are different. This could interfere with custom network management applications and scripts. If this is the case, you can disable the automatic filename encryption by adding the nocrypt option to the command.
The nocrypt option does slightly decrease the security provided by this feature, so this possibility should be weighed against the ability to more conveniently manage the network.
Interaction with the TFTP Enforce Feature
The cable tftp-enforce command provides another layer of protection against theft-of-service attacks by requiring cable modems to download a DOCSIS configuration file through the CMTS cable interface before being allowed to register. When the cable tftp-enforce command is used with the cable dynamic-secret command, the TFTP enforce checks are done before the dynamic shared-secret checks. If a cable modem fails to download a DOCSIS configuration file through the CMTS, it is not allowed to register, regardless of the dynamic shared-secret checks.
Displaying Rogue Cable Modems
Use the show cable modem rogue command to display the cable modems that have failed the dynamic shared-secret authentication checks:
Router# show cable modem rogueSpoof TFTPMAC Address Vendor Interface Count Dnld Dynamic SecretAAAA.7b43.aa7f Vendor1 C4/0/U5 2 Yes 45494DC933F8F47A398F69EE6361B017AAAA.7b43.aa7f Vendor1 C4/0/U5 2 Yes D47BCBB5494E9936D51CB0EB66EF0B0ABBBB.7b43.aa7f Vendor2 C4/0/U5 2 No 8EB196423170B26684BF6730C099D271AAAA.7b43.aa7f Vendor1 C4/0/U5 2 No DF8FE30203010001A326302430120603BBBB.7b43.aa7f Vendor2 C4/0/U5 2 No 300E0603551D0F0101FF040403020106AAAA.7b43.aa7f Vendor1 C4/0/U5 2 Yes 820101002D1A264CE212A1BB6C1728B3DDDD.7b43.aa7f Vendor4 C4/0/U5 2 Yes 7935B694DCA90BC624AC92A519C214B9AAAA.7b43.aa7f Vendor1 C4/0/U5 2 No 3AB096D00D56ECD07D9B7AB662451CFFRouter#If the CMTS cannot obtain the DOCSIS configuration file from the TFTP server, a message similar to the following is displayed on the console:
%UBR7200-4-NOCFGFILE: Cannot read modem config file platinum.cm from C3/0: <reason>where the reason can be one of the following, depending on the error that the TFTP server reported:
•
•
•
•
•
•
Examples
The following example shows how to configure a cable interface on a Cisco uBR7200 series router with the mark option, so that CMs that fail the MIC verification are allowed to register but are marked in the show cable modem displays so that their situation can be further investigated:
Router# configure terminalRouter(config)# interface cable 4/0Router(config-if)# cable dynamic-secret markRouter(config-if)# exitRouter(config)# exitRouter#The following example shows how to configure the cable interface on a Cisco uBR7100 series router, so that CMs that fail the MIC verification are locked with a QoS profile that limits upstream and downstream service flows to 10 kbps:
Router# configure terminalRouter(config)# cable qos permission createRouter(config)# cable qos permission updateRouter(config)# interface cable 1/0Router(config-if)# cable dynamic-secret lockRouter(config-if)# exitRouter(config)# exitRouter#
Note
%Need permission for modems to create QoS profile
The following example shows how to configure a cable interface so that CMs that fail the MIC verification are locked with a specific QoS profile:
Router# configure terminalRouter(config)# interface cable 1/0Router(config-if)# cable dynamic-secret lock 31Router(config-if)# exitRouter(config)# exitRouter#
Note
%Profileqos-id to lock modem does not exist
The following example shows how to configure a cable interface on a Cisco uBR7200 series router, so that CMs that fail the MIC verification are not allowed to register and must reregister with a valid DOCSIS configuration file before being allowed to come online:
Router# configure terminalRouter(config)# interface cable 3/0Router(config-if)# cable dynamic-secret rejectRouter(config-if)# exitRouter(config)# exitRouter#The following example shows how to disable the Dynamic Shared Secret feature on a cable interface on the Cisco uBR10012 router:
Router# configure terminalRouter(config)# interface cable 6/1/0Router(config-if)# no cable dynamic-secretRouter(config-if)# exitRouter(config)# exitRouter#Related Commands
cable dynamic-secret exclude
To exclude one or more specific cable modems from being processed by the Dynamic Shared Secret feature, use the cable dynamic-secret exclude command in global configuration mode. To disable this feature, use the no form of this command.
cable dynamic-secret exclude {modem mac-address | oui oui-id}
no cable dynamic-secret {modem mac-address | oui oui-id}
Syntax Description
Command Default
All modems are processed by the Dynamic Shared Secret feature when the feature is enabled.
Command Modes
Global configuration (config)
Command History
12.3(9a)BC
This command was introduced.
12.2(33)SCA
This command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the Cisco uBR7225VXR router was added.
Usage Guidelines
When the cable dynamic-secret configuration command is configured on a cable interface, it automatically includes all cable modems that register on that interface. To exclude one or more cable modems from being processed by the Dynamic Shared Secret security checks, use the cable dynamic-secret exclude command in global configuration mode.
You might want to exclude cable modems from the Dynamic Shared Secret security checks if they need to download additional files from the TFTP server at registration time. For example, Cisco cable CPE devices, such as the Cisco uBR925 cable access router, can be instructed to download a Cisco IOS configuration file after downloading the DOCSIS configuration file.
However, when Dynamic Shared Secret checks are being used, the Cisco CMTS refuses to allow the cable modem to download any other files after the first successful download of the DOCSIS configuration file. To allow these cable modems to download their Cisco IOS configuration files, use the cable dynamic-secret-exclude command to exclude them from the Dynamic Shared Secret checks.
You can exclude either a specific cable modem by its MAC address, or all of a vendor's cable modems by their OUI value. Excluded cable modems must still register according to the normal DOCSIS provisioning procedures, but their DOCSIS configuration files are no longer verified by the Dynamic Shared Secret security checks.
Tip
Examples
The following example shows how to exclude a specific cable modem, with the MAC address of 00d0.45ba.b34b, from being processed by the Dynamic Shared Secret feature:
Router# configure terminalRouter(config)# cable dynamic-secret exclude modem 00d0.45ba.b34bRouter(config)# exitRouter#The following example shows how to exclude all cable modems with a vendor OUI value 00.01.B4 from being processed by the Dynamic Shared Secret feature:
Router# configure terminalRouter(config)# cable dynamic-secret exclude oui 00.01.B4Router(config)# exitRelated Commands
cable dynamic-secret tftp insert-upgrade-server
To dynamically insert the IPv4 or IPv6 TLV values in the Data-over-Cable Service Interface Specifications (DOCSIS) configuration file to complete firmware upgrade on cable modems, use the cable dynamic-secret tftp insert-upgrade-server command in the global configuration mode.
cable dynamic-secret tftp insert-upgrade-server
no cable dynamic-secret tftp insert-upgrade-server
Syntax Description
This command has no arguments or keywords.
Command Default
Disabled
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The Dynamic Shared Secret feature must be configured first before you can upgrade the firmware on cable modems. To enable this feature, execute the cable dynamic-secret command in the cable interface configuration mode.
Examples
The following example dynamically inserts the correct IPv4 or IPv6 TLV values from the DOCSIS configuration file to upgrade firmware on the cable modems.
Router(config)# cable dynamic-secret tftp insert-upgrade-serverRouter(config)# endRelated Commands
