-
Cisco IOS CMTS Cable Command Reference
-
Introduction
-
Cable Commands: a through cable-modem
-
Cable Commands: cable a through cable c
-
Cable Commands: cable d
-
Cable Commands: cable e through cable i
-
Cable Commands: cable l
-
Cable Commands: cable m to n
-
Cable Commands: cable p through cable r
-
Cable Commands: cable s
-
Cable Commands: cable t
-
Cable Commands: cable u through cable w
-
Cable Commands: ca through cr
-
Cable Commands: d through h
-
Cable Commands: i through p
-
Cable Commands: q through sg
-
Cable Commands: show a through show cable l
-
Cable Commands: show cable m to show cable u
-
Cable Commands: show ch through show cr
-
Cable Commands: show d through show i
-
Cable Commands: show m through show z
-
Cable Commands: snmp through w
-
Appendix A: Cable Debug Commands
-
Appendix B: Cisco CMTS Router ROM Monitor Commands
-
Feedback
Table Of Contents
Cable Commands: cable p through cable r
cable pre-equalization exclude
cable primary-sflow-qos11 keep
cable privacy bpi-plus-enforce
cable privacy bpi-plus-exclude
cable privacy encrypt-alg-priority
cable privacy revocation crl skip-sig-check
cable privacy revocation enable
cable privacy revocation ocsp skip-sig-check
cable privacy revocation skip-cm-cert
cable privacy revocation timeout
cable rate-limit-algorithm min-plus-excess
cable redundancy node frequency
cable resiliency traps-interval
Cable Commands: cable p through cable r
Revised: July 2012, OL-15510-16
New Commands
Modified Commands
cable power
To manually power a cable interface line card on or off on a Cisco uBR10012 router, use the cable power command in privileged EXEC mode.
cable power [on | off] slot/card
Syntax Description
Defaults
Cable interface line cards are powered on by default when the card is inserted into the chassis slot.
Command Modes
Privileged EXEC (#)
Command History
Usage Guidelines
This command is typically not used during normal operations, but it can be used for lab, diagnostic, and troubleshooting purposes. For example, using this command to first power off and then power on a card is functionally equivalent to performing an online insertion and removal (OIR) of the card.
Be aware of the following points when using this command:
•
Using the cable power off command is functionally equivalent to disconnect the cables from the card's upstream and downstream connectors and then removing the card from the chassis. When you use this command to turn off power to a card, the output for the show interface cable command for that card will display the message "Hardware is not present."
Note
•
•
•
•
•
•
Note
Examples
The following example shows how to power off the first cable interface card in a Cisco uBR10012 chassis (card 5, slot 0). It also shows the output from the show interface cable command, with a line that indicates that the hardware is not present.
router# cable power off 5/0Line Card 5/0 is POWERED OFFrouter# show int c5/0/0Cable5/0/0 is down, line protocol is downHardware is not presentHardware is UBR10012 CLC, address is 0005.00e0.2f14 (bia 0005.00e0.2f14)Internet address is 10.20.42.1/24MTU 1500 bytes, BW 27000 Kbit, DLY 1000 usec,reliability 255/255, txload 1/255, rxload 1/255...router#
Note
The following example shows the error message that results when you attempt to power on or off a cable interface card that is not physically present in the chassis:
router# cable power off 6/1Line Card 6/1 is not presentrouter#
Note
Related Commands
cable pre-equalization exclude
To exclude a cable modem (CM) from pre-equalization during registration with the Cisco CMTS router, use the cable pre-equalization exclude command in global configuration mode. To remove exclusion for the specified cable modem or interface, use the no form of this command.
cable pre-equalization exclude {modem mac-addr | oui id}
no cable pre-equalization exclude {modem mac-addr | oui id}
Syntax Description
Command Default
Pre-equalization is disabled by default on a Cisco CMTS router, and for cable modems that have a valid and operational DOCSIS configuration file.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
Use the cable pre-equalization exclude command to disable pre-equalization for DOCSIS 1.1 CMs that claim pre-equalization support but do not properly implement pre-equalization functions.
To enable pre-equalization, use the cable upstream equalization-coefficient interface configuration command. Pre-equalization starts when a cable modem that supports DOCSIS 1.1 or above sends the CMTS router a ranging request message indicating that pre-equalization is possible.
The following example of output from the show cable modem verbose command shows which modems are indicating pre-equalizer support during the DOCSIS registration process. In this example, the first two modems are capable of pre-equalization support, and the last two modems support DOCSIS 1.0, which does not support pre-equalization. You do not need to use the cable pre-equalization exclude command for DOCSIS 1.0 CMs.
Router# show cable modem verbose | include MAC Address|EqualizerMAC Address : 0019.474a.c4b0Transmit Equalizer Support : {Taps/Symbol= 1, Num of Taps= 24}MAC Address : 0019.474a.c498Transmit Equalizer Support : {Taps/Symbol= 1, Num of Taps= 24}MAC Address : 0020.40dc.4ce4Transmit Equalizer Support : {Taps/Symbol= 0, Num of Taps= 0}MAC Address : 0020.4077.21a0Transmit Equalizer Support : {Taps/Symbol= 0, Num of Taps= 0}Exclusion is supported for a specified DOCSIS 1.1 cable modem, or for a specified OUI value for the entire interface. Removing the cable pre-equalization exclude configuration returns the cable modem or interface to normal pre-equalization processes during cable modem registration.
Examples
The following example configures pre-equalization to be excluded for the specified cable modem. Pre-equalization data is not sent for the corresponding cable modem:
Router(config)# cable pre-equalization exclude modem 1111.2222.3333The following example configures pre-equalization to be excluded for the specified OUI value of the entire interface. Pre-equalization data is not sent for the corresponding OUI value of the entire interface:
Router(config)# cable pre-equalization exclude oui 00.09.04The following series of commands configures pre-equalization on the Cisco uBR10012 router with MC5X20U BPEs. On the PRE Console, configure the following commands.
Router# conf tEnter configuration commands, one per line. End with CNTL/Z.Router(config)# cable pre-equalization exclude oui 00.09.04Router(config)# endRouter# show runRouter# show running-config | inc ouicable pre-equalization exclude oui 00.09.04Router#On the line card console for the same Cisco uBR10012 router, verify the configuration with the following command:
Linecard# show running-config | inc ouicable pre-equalization exclude oui 00.09.04The following series of commands configures pre-equalization on the Cisco uBR72436VXR router with MC28U cable interface line cards. On the Network Processing Engine (NPE) console, configure and verify with the following commands.
Router# conf tEnter configuration commands, one per line. End with CNTL/Z.Router(config)# cable pre-equalization exclude oui 00.09.24Router(config)# endRouter#show run02:58:10: %SYS-5-CONFIG_I: Configured from console by consolenRouter# show running-config | inc ouicable pre-equalization exclude oui 00.09.24On the line card console for the same Cisco uBR7246VXR router, verify the configuration with the following command:
Linecard# show running-config | inc ouicable pre-equalization exclude oui 00.09.24After either of these exclusion methods for pre-equalization are configured, you can verify that all ranging messages do not include pre-equalization data. Use the following debug commands in global configuration mode:
•
•
Verify the ranging message for the non-excluded cable modems include pre-equalization data, and for the excluded cable modems, the ranging messages do not include such data.
The following example removes pre-equalization exclusion for the specified OUI and interface. This results in the cable modem or OUI to return to normal pre-equalization functions. Ranging messages resume sending pre-equalization data.
Router(config)# no cable pre-equalization exclude {modem mac-addr | oui id}You can verify removal of this feature using the debug cable interface command.
Related Commands
debug cable interface
Verifies pre-equalization data and configurations.
debug cable range
Verifies ranging messages for pre-equalization.
cable primary-sflow-qos11 keep
To preserve the traffic counters for primary service flows after a CM that was provisioned for DOCSIS 1.1 quality of service (QoS) goes offline, use the cable primary-sflow-qos11 keep command in global configuration mode. To return to the default configuration and reset the counters to zero when a DOCSIS 1.1-provisioned CM goes offline, use the no form of this command.
cable primary-sflow-qos11 keep {all | snmp-only}
no cable primary-sflow-qos11 keep
Syntax Description
Command Default
Primary service flow traffic counters are not preserved after a DOCSIS 1.1-provisioned CM goes offline (no cable primary-sflow-qos11 keep). Service-flow information is always preserved for DOCSIS 1.0-provisioned CMs, regardless of the configuration of this command.
Command Modes
Global configuration
Command History
Usage Guidelines
By default, when a CM that is provisioned for DOCSIS 1.1 quality of service (QoS) service flows goes offline, the CMTS deletes all service flow information, including traffic counters, that correspond to that CM. The cable primary-sflow-qos11 keep command preserves the service flow traffic counters after a DOCSIS 1.1-provisioned CM goes offline and then comes back online. This allows service providers to track the total usage of CMs over a period of time, regardless of the number of times the CMs go offline and reboot.
Note
Examples
The following example shows how to preserve both the CLI and SNMP service flow counters when a DOCSIS 1.1-provisioned CM goes offline:
Router(config)# cable primary-sflow-qos11 keep allRouter(config)#The following example shows how to preserve only the SNMP-based service flow counters when a DOCSIS 1.1-provisioned CM goes offline. The CLI-based counters are still reset to zero when this CM goes offline.
Router(config)# cable primary-sflow-qos11 keep snmp-onlyRouter(config)#The following example shows how to disable this command and return to the default behavior, which is to reset all CLI-based and SNMP-based counters when a DOCSIS 1.1-provisioned CM goes offline.
Router(config)# no cable primary-sflow-qos11 keepRouter(config)#Related Commands
cable privacy
To enable and configure BPI or BPI+ encryption, use the cable privacy command in cable interface configuration mode. To disable privacy or to remove a particular configuration, use the no form of this command.
cable privacy [accept-self-signed-certificate | authenticate-modem | authorize-multicast | mandatory | oaep-support | dsx-support | retain-failed-certificates | skip-validity-period]
no cable privacy [accept-self-signed-certificate | authenticate-modem | authorize-multicast | mandatory | oaep-support | dsx-support | retain-failed-certificates | skip-validity-period]
Syntax Description
Command Default
The encryption priority defaults to 128bit AES, 56bit DES, 40bit DES depending on modem capability. The CMTS treats self-signed manufacturer certificates as untrusted. Untrusted certificates are not retained by the CMTS.
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
This command is applicable only on images that support BPI or BPI+ encryption.
Note
Providing Self-Signed Certificates
Cisco IOS Release 12.2(33)SCC and later releases allow self-signed CA certificates to be programmed on the file system to allow specific modems to authenticate. This is frequently used for test equipment and modems that are not DOCSIS compliant.
To provide self-signed CA certificates, perform the following steps:
1.
2.
3.
4.
5.
The router reads the new files and the self-signed cable modem comes online.
Examples
The following example shows how to force baseline privacy interface (BPI) to be used for all CMs on a particular cable interface:
Router(config)# interface cable 3/1Router(config-if)# cable privacy mandatoryThe following example shows how to turn on the BPI modem authentication for an interface:
Router(config)# interface cable 5/1/1Router(config-if)# cable privacy authenticate-modemThe following example shows how to turn on BPI multicast authorization on a particular cable interface:
Router(config)# interface cable 1/0Router(config-if) cable privacy authorize-multicastThe following example shows how to allow CMs to register with self-signed certificates on a particular cable interface:
Router(config)# interface cable 7/1/0Router(config-if) cable privacy accept-self-signed-certificateThe following example shows how to allow CMs to enable privacy DSX support on a particular cable interface:
Router(config)# interface cable 3/1Router(config-if) cable privacy dsx-supportThe following example shows how to allow CMs to enable OAEP support on a particular cable interface:
Router(config)# interface cable 3/1Router(config-if) cable privacy oaep-supportThe following example shows how to allow CMs to retain failed certificates on a particular cable interface:
Router(config)# interface cable 3/1Router(config-if) cable privacy retain-failed-certificatesThe following example shows how to allow CMs to skip certificate validity period on a particular cable interface:
Router(config)# interface cable 3/1Router(config-if) cable privacy skip-vailidity-periodRelated Commands
cable privacy bpi-plus-enforce
Note
To mandate that a cable modem provisioned in DOCSIS 1.1 or higher must register with DOCSIS Baseline Privacy Interface Plus (BPI+), and not use the earlier DOCSIS BPI, use the cable privacy bpi-plus-enforce command in global configuration mode. To remove this configuration, use the no form of this command.
cable privacy bpi-plus-enforce
no cable privacy bpi-plus-enforce
Syntax Description
This command has no arguments or keywords.
Command Default
The cable privacy bpi-plus-enforce command is not enabled by default, but must be configured for optimal DOCSIS BPI+ security.
Command Modes
Global configuration (config)
Command History
12.3(21)BC
This command was introduced.
12.2(33)SCD5
This command was replaced with the cable privacy bpi-plus-policy command.
Usage Guidelines
The cable privacy bpi-plus-enforce command enables the Cisco CMTS router to detect cloned cable modems and eliminate denial-of-service (DOS) attacks that are caused by cloned cable modems.
If the cable modem is not provisioned to use DOCSIS BPI or BPI+ security certificates, then the existing behavior of the Cisco CMTS router remains unchanged. The Cisco CMTS router does not attempt to distinguish between two cable modems if neither is provisioned for BPI+ security.
Note
Examples
The following example illustrates logging messages that are created with the detection of cloned cable modems:
SLOT 7/0: Nov 14 12:07:26: %UBR10000-6-CMMOVED: Cable modem 0007.0e03.3e71 has been moved from interface Cable7/0/1 to interface Cable7/0/0.Nov 14 12:07:57: %UBR10000-5-CLONED_CM_DETECTED: Cloned CM with MAC address 0013.7116.e726 access detected at Cable7/0/0 interfaceRelated Commands
cable privacy bpi-plus-exclude
To exclude cable modems from the Baseline Privacy Interface Plus (BPI+) enforcement policies configured on a Cisco CMTS router, use the cable privacy bpi-plus-exclude command in global configuration mode. To disable this configuration, use the no form of this command.
cable privacy bpi-plus-exclude mac-address [address-mask]
no cable privacy bpi-plus-exclude mac-address [address-mask]
Syntax Description
Command Default
None
Command Modes
Global configuration (config)
Command History
Usage Guidelines
You can exclude individual cable modems, which are compliant with DOCSIS 1.0 and later versions, from the BPI+ enforcement policy based on their MAC addresses on a per-MAC domain basis. If a cable modem is added to the exclusion list, the Cisco CMTS router does not enforce the BPI+ enforcement policy on that cable modem. You can exclude a maximum of 30 cable modems per MAC domain.
Examples
The following example shows how to exclude a cable modem from the BPI+ enforcement policy based on its MAC address:
Router# configure terminalRouter(config)# cable privacy bpi-plus-exclude 0010.9571.03abRelated Commands
cable privacy bpi-plus-policy
Configures the BPI+ enforcement policy on a Cisco CMTS router.
show interface cable privacy
Displays baseline privacy information.
cable privacy bpi-plus-policy
To configure the Baseline Privacy Interface Plus (BPI+) enforcement policies on a Cisco CMTS router, use the cable privacy bpi-plus-policy command in cable interface configuration mode. To disable this configuration, use the no form of this command.
cable privacy bpi-plus-policy {capable-enforcement | d11-enabled-enforcement | d11-enforcement | total-enforcement}
no privacy bpi-plus-policy {capable-enforcement | d11-enabled-enforcement | d11-enforcement | total-enforcement}
Syntax Description
Command Default
None
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
The cable privacy bpi-plus-policy command replaced the cable privacy bpi-plus-enforce command in Cisco IOS Relase12.2(33)SCD5. If you upgrade from an earlier Cisco IOS Release to Cisco IOS Release 12.2(33)SCD5 and later, the existing BPI+ enforcement configuration is disabled by default during the upgrade. You must reconfigure the BPI+ enforcement policy using the cable privacy bpi-plus-policy command.
You can configure only one enforcement policy at a time per MAC domain. If you configure one policy after another, the latest policy supersedes the already existing policy. For example, if you want Policy 2 to take over Policy 1, you can directly configure the former without disabling the latter.
Examples
The following example shows how to configure BPI+ enforcement policies on the cable interface 3/0 on the Cisco uBR7246VXR router:
Router# configure terminalRouter(config)# interface cable 3/0Router(config-if)# cable privacy bpi-plus-policy capable-enforcementRouter(config-if)# cable privacy bpi-plus-policy d11-enabled-enforcementRouter(config-if)# cable privacy bpi-plus-policy d11-enforcementRouter(config-if)# cable privacy bpi-plus-policy total-enforcementRelated Commands
cable privacy clone-detect
To enable the clone modem functionality for a cable modem, use the cable privacy clone-detect command in global configuration mode. To disable clone modem functionality, use the no form of this command.
cable privacy clone-detect
no cable privacy clone-detect
Syntax Description
This command has no keywords or arguments.
Command Default
The clone modem functionality is enabled.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
Use this command to enable or disable the clone modem functionality.
Examples
The following example shows how to enable the clone modem functionality, so that the cloned cable modems cannot register with the CMTS:
Router# configure terminalRouter(config)# cable privacy clone-detectRelated Commands
cable privacy eae-exclude
To force a cable modem to register without an Early Authentication and Encryption (EAE) and add it to the EAE exclusion list, use the cable privacy eae-exclude command in global configuration mode. To remove a particular CM from the exclusion list, use the no form of this command.
cable privacy eae-exclude cm-mac-address [mask]
no cable privacy eae-exclude cm-mac-address [mask]
Syntax Description
cm-mac-address
Hardware (MAC) address of a specific cable modem to be added to the EAE exclusion list.
mask
(Optional) Mask value for the cable modem.
Command Default
The EAE exclusion list does not contain any MAC address.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The exclusion list is mainly used to debug issues with specific cable modems.
Examples
The following example shows how to add a CM with the MAC address of 00C0.8345.de51 to the EAE exclusion list, so that this particular CM cannot register with the CMTS:
Router# configure terminalRouter(config)# cable privacy eae-exclude 00C0.8345.de51Router(config)#Related Commands
cable privacy eae-policy
To enable the Early Authentication and Encryption (EAE) policy, use the cable privacy eae-policy command in cable interface configuration mode. To disable the EAE policy, use the no form of this command.
cable privacy eae-policy {capability-enforcement | disable-enforcement | ranging-enforcement | total-enforcement}
no cable privacy eae-policy {capability-enforcement | disable-enforcement | ranging-enforcement | total-enforcement}
Syntax Description
Command Default
EAE policy is disabled.
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
The EAE policy is applied on a MAC domain and the policies are mutually exclusive. The CMTS enforces EAE only on CMs that initialize on a downstream channel on which the CMTS is transmitting MAC Domain Descriptor (MDD) messages.
The EAE exclusion list is a global list and is created on all line cards as part of the DOCSIS 3.0 specifications. Cable modems in the EAE exclusion list are always exempted from EAE enforcement. If the CMTS receives an authorization request before the CM is registered in the EAE exclusion list, the CMTS rejects that request.
Examples
The following example shows how to enforce EAE policy on capable modems:
Router(config)# interface cable 3/1Router(config-if)# cable privacy eae-policy capability-enforcementThe following example shows how to disable EAE policy so that the CMTS does not enforce EAE policy on any cable modem:
Router(config)# interface cable 3/1Router(config-if)# cable privacy eae-policy disable-enforcementThe following example shows how to enforce EAE policy on DOCSIS 3.0 modems only:
Router(config)# interface cable 3/1Router(config-if) cable privacy eae-policy ranging-enforcementThe following example shows how to enforce EAE policy on all cable modems:
Router(config)# interface cable 3/1Router(config-if) cable privacy eae-policy total-enforcementRelated Commands
cable privacy encrypt-alg-priority
To specify the order in which to use the Advanced Encryption Standard (AES) and Data Encryption Standard (DES) encryption algorithm, use the cable privacy encrypt-alg-priority command in global configuration mode. To remove the encryption algorithm and revert to the default priority, use the no form of this command.
cable privacy encrypt-alg-priority {aes128-des40-des56 | aes128-des56-des40 | des40-aes128-des56 | des40-des56-aes128 | des56-aes128-des40 | des56-des40-aes128}
no cable privacy encrypt-alg-priority
Syntax Description
Command Default
Default value is aes128-des56-des40.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
Use this command to specify the order of the encryption algorithm priority.
Examples
The following example shows how to assign AES the highest priority, followed by 40-bit DES, and 56-bit DES.
Router# configure terminalRouter(config)# cable privacy encrypt-alg-priority aes128-des40-des56Router(config)#Related Commands
cable privacy hotlist
To mark a manufacturer's or CM certificate as untrusted and add them to the CMTS hotlist of invalid certificates, thereby preventing those CMs from registering, use the cable privacy hotlist command in global configuration mode. To remove a particular CM or manufacturer's certificate from the hotlist, use the no form of this command.
cable privacy hotlist {cm mac-address | manufacturer cert-serial-number}
no cable privacy hotlist {cm mac-address | manufacturer cert-serial-number}
Syntax Description
Command Default
The CMTS hotlist does not contain any certificates.
Command Modes
Global configuration
Command History
Usage Guidelines
This command is applicable only on images that support BPI or BPI+ encryption.
Note
Examples
The following command adds the CM certificate with the MAC address of 00C0.8345.de51 to the hotlist, so that this particular CM cannot register with the CMTS:
Router# config tRouter(config)# cable privacy hotlist cm 00C08345de51Router(config)#The following example adds a manufacturer CA certificate into the BPI+ hotlist, so that the CMTS will reject any CM attempting to register with a certificate from that particular manufacturer:
Router# config tRouter(config)# cable privacy hotlist manufacturer 3435414631413439383335453731423733333643Associated FeaturesThe cable privacy hotlist command is used to configure the following features:
•
Related Commands
cable privacy kek
To set key encryption keys (KEKs) life-time values for baseline privacy on an HFC network, use the cable privacy kek command in cable interface configuration mode. To restore the default values, use the no form of this command.
cable privacy kek life-time [seconds]
no cable privacy kek life-time
Note
Syntax Description
life-time seconds
(Optional) Length of the key encryption life-time in seconds.Valid range is 300 to 604,8000. The default is 604,800 seconds (7 days).
Command Default
The life-time option to 604,800 seconds (7 days).
Command Modes
Interface configuration only (config-if)
Command History
11.3 XA
This command was introduced.
12.1(4)CX, 12.2(1)XF1, 12.2(4)BC1
The valid range for both options was changed to support DOCSIS 1.1 and BPI+ encryption.
Usage Guidelines
Baseline privacy on an HFC network is configured with key encryption keys (KEKs) and traffic encryption keys (TEKs). The encryption is based on 40-bit or 56-bit data encryption standard (DES) encryption algorithms.
A KEK is assigned to a CM based on the CM service identifier (SID) and permits the CM to connect to the Cisco CMTS when baseline privacy is activated. KEKs can be set to expire based a life-time value.
The life-time keyword is used to assign a more permanent key to a CM.
A CM that has a life-time key assigned by the Cisco CMTS requests a new key before the current one expires.
Examples
The following example shows how to set the KEK privacy life-time to 750,000 seconds:
Router(config)# interface cable c3/0Router(config-if)# cable privacy kek life-time 750000Router(config-if)#Related Commands
cable privacy revocation crl skip-sig-check
To allow the Cisco CMTS router to skip the certification revocation list (CRL) response signature check, use the cable privacy revocation crl skip-sig-check command in global configuration mode. To enable CRL signature check, use the no form of this command.
cable privacy revocation crl skip-sig-check
no cable privacy revocation crl skip-sig-check
Syntax Description
This command has no keywords or arguments.
Command Default
The CRL response signature check is enabled by default.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The cable privacy revocation crl skip-sig-check command allows you to use the CRL response from the CRL server without validating the signature of the response.
Examples
The following example shows how to skip the CRL response signature check:
Router(config)# cable privacy revocation crl skip-sig-checkRelated Commands
cable privacy revocation enable
To quickly enable privacy revocation checking, use the cable privacy revocation enable command in global configuration mode. To disable privacy revocation checking, use the no form of this command.
cable privacy revocation enable
no cable privacy revocation enable
Syntax Description
This command has no keywords or arguments.
Command Default
The privacy revocation checking is disabled by default.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
This command allows you to quickly enable or disable revocation checking. When you enable revocation checking, it creates the trustpoints for both the EU and US certificates.
Examples
The following example shows how to enable revocation checking:
Router(config)# cable privacy revocation enableRelated Commands
cable privacy revocation ocsp skip-sig-check
To allow the Cisco CMTS router to skip the Online Certificate Status Protocol (OCSP) response signature check, use the cable privacy revocation ocsp skip-sig-check command in global configuration mode. To enable OCSP signature check, use the no form of this command.
cable privacy revocation ocsp skip-sig-check
no cable privacy revocation ocsp skip-sig-check
Syntax Description
This command has no keywords or arguments.
Command Default
OCSP response signature check is enabled by default.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The cable privacy revocation ocsp skip-sig-check command allows you to use the OCSP response from the OCSP responder without validating the signature of the response.
Examples
The following example shows how to skip the OCSP response signature check:
Router(config)# cable privacy revocation ocsp skip-sig-checkRelated Commands
cable privacy revocation skip-cm-cert
To disable checking of the CM certificates, use the cable privacy revocation skip-cm-cert command in global configuration mode. To enable checking of CM certificates, use the no form of this command.
cable privacy revocation skip-cm-cert
no cable privacy revocation skip-cm-cert
Syntax Description
This command has no keywords or arguments.
Command Default
CM certificate checking is enabled by default.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The cable privacy revocation skip-cm-cert command allows you to disable checking of CM certificates.
Note
Examples
The following example shows how to disable checking of CM certificates:
Router(config)# cable privacy revocation skip-cm-certRelated Commands
cable privacy tek
To set traffic encryption keys (TEKs) life-time values for baseline privacy on an HFC network, use the cable privacy tek command in cable interface configuration mode. To restore the default value, use the no form of this command.
cable privacy tek life-time [seconds]
no cable privacy tek life-time
Note
Syntax Description
life-time seconds
(Optional) Length of the traffic encryption life-time in seconds. Valid range is 180 to 604,8000. Default is 43,200 seconds (12 hours).
Command Default
The life-time option to 43200 seconds (12 hours).
Command Modes
Interface configuration only (config-if)
Command History
11.3 XA
This command was introduced.
12.1(4)CX, 12.2(1)XF1, 12.2(4)BC1
The valid range for both options was changed to support DOCSIS 1.1 and BPI+ encryption.
Usage Guidelines
Baseline privacy on an HFC network is configured with key encryption keys (KEKs) and traffic encryption keys (TEKs). The encryption is based on 40-bit or 56-bit data encryption standard (DES) encryption algorithms.
The TEK is assigned to a CM when its KEK has been established. The TEK is used to encrypt data traffic between the CM and the Cisco CMTS. TEKs can be set to expire based a life-time value.
The life-time keyword is used to assign a more permanent key to a CM.
A CM that has a life-time key assigned by the Cisco CMTS requests a new key before the current one expires.
Examples
The following example shows how to set the traffic encryption key life-time to 800000 seconds:
Router(config)# interface cable c3/0Router(config-if)# cable privacy tek life-time 800000Router(config-if)#Related Commands
cable privacy revocation timeout
To set the timeout value of certification revocation list (CRL) or Online Certificate Status Protocol (OCSP) response time for authorization "reply" or "reject" messages, use the cable privacy revocation timeout command in global configuration mode. To return to the default timeout value, use the no form of this command.
cable privacy revocation timeout
no cable privacy revocation timeout
Syntax Description
This command has no keywords or arguments.
Command Default
Default timeout value is 1 second.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
This command only takes effect if cable privacy revocation enable command is configured. The timeout value for authorization "reply" or "reject" messages in the CM configuration file must be greater than the revocation timeout value.
Examples
The following example shows how to set the timeout value for CRL or OCSP response:
Router(config)# cable privacy revocation timeout 15Related Commands
cable proxy-arp
To activate cable proxy Address Resolution Protocol (ARP) on the cable interface or subinterface, use the cable proxy-arp command in cable interface or subinterface configuration mode. To disable this feature, use the no form of this command.
cable proxy-arp
no cable proxy-arp
Syntax Description
This command has no arguments or keywords.
Command Default
Proxy APR service is enabled.
Command Modes
Cable interface and subinterface configuration
Command History
11.3 XA
This command was introduced.
12.1(3a)EC
The subinterface support was added.
Usage Guidelines
This command enables or disables direct host-to-host communications over the same cable subnet. Because the downstream and upstream are separate interfaces, CMs cannot directly perform address resolution with other CMs on the cable plant. This means that the CMs must send all traffic through the CMTS, even if the destination CM is on the same subnet.
The cable proxy-arp command enables the Cisco CMTS to act as a proxy for ARP requests generated by the CMs, which allows CMs on the same cable subnet to communicate directly which each other, without the traffic having to be routed first through the CMTS. The no cable proxy-arp command disables this feature, preventing CMs on the same subnet from communicating with each other without routing the traffic through the CMTS.
Note
Examples
The following example shows how to activate proxy ARP for host-to-host communications:
Router(config-subif)# cable proxy-arpThe following example shows how to activate proxy ARP for host-to-host communications, on the cable subinterface:
Router(config)# interface cable 6/0.1Router(config-subif)# cable proxy-arpRelated Commands
cable qos enforce-rule
To create an enforce-rule to enforce a particular quality of service (QoS) profile for subscriber traffic management, and to enter enforce-rule configuration mode, use the cable qos enforce-rule command in global configuration mode. To delete an enforce-rule and to remove it from the CMTS configuration, use the no form of this command.
cable qos enforce-rule rule-name
no cable qos enforce-rule rule-name
Syntax Description
rule-name
Name of the enforce-rule to be created and configured. This name can be any arbitrary and unique string from 1 to 15 characters in length.
Command Default
No enforce-rules are created.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The cable qos enforce-rule command creates an enforce-rule with the specified name and then enters enforce-rule configuration mode. After entering enforce-rule configuration mode, use the following commands to configure the enforce-rule:
•
•
•
•
•
•
At the very minimum, you must use the activate-rule at-byte-count and registered qos-profile commands to configure an enforce-rule, and the enabled command to activate it, before it takes effect.
Note
Maximum Number of Rules
The Cisco CMTS routers support a certain maximum number of enforce-rules depending on your Cisco IOS software release. If you have created the maximum number of enforce-rules and want to create another rule, you must first delete one of the existing rules.
•
•
Note
Examples
The following example shows the creation of an enforce-rule named "residential." The system then enters the enforce-rule configuration mode.
Router# configure terminalRouter(config)# cable qos enforce-rule residentialRouter(enforce-rule)# ?Configuration commands for QoS enforce rules:activate-rule Activate rule parametersenabled Enable the enforce-ruleenforced Enforced qos-profileexit Exit from QoS enforce rule editing modemonitoring-duration Monitoring duration parametersno Negate a command or set its defaultspenalty-period Penalty-periodregistered Registered qos-profileRouter(enforce-rule)# activate-rule at-byte-count 50000000 downstream enforcedRouter(enforce-rule)# registered qos-profile 5Router(enforce-rule)# enforced qos-profile 99Router(enforce-rule)# monitoring-duration 120 sample-rate 20Router(enforce-rule)# penalty-period 1440Router(enforce-rule)# enabledRouter(enforce-rule)# exitRouter(config)# exitThe following example shows the deletion of an enforce-rule named "test":
Router# configure terminalRouter(config)# no cable qos enforce-rule testThe following example shows the error message that is displayed if you try to create more than 20 enforce-rules in Cisco IOS Release 12.3(23)BC1 and earlier:
Router# configure terminalRouter(config)# cable qos enforce-rule residentialCan't create more enforce-rules. The maximum number is 20.The following example shows the error message that is displayed when you try to name an enforce-rule with a name that is larger than 15 characters. An error message is displayed, and the name is truncated to the first 15 characters.
Router# configure terminalRouter(config)# cable qos enforce-rule reallyreallyreallylongnameOnly the first 15 characters would be takenRelated Commands
cable qos permission
To specify permission for updating the quality of service (QoS) table, use the cable qos permission command in global configuration mode. To remove a previously enabled permission, use the no form of this command.
cable qos permission {create | enforce index | modems | update}
no cable qos permission
Syntax Description
Command Default
Enable by modem and SNMP
Command Modes
Global configuration
Command History
Usage Guidelines
If the QoS profile to be enforced does not exist at the CMTS during registration, the CMTS uses the QoS profile configured for the registering CM.
If you disable the use of CM-created profiles, using the no cable qos permission command, any CMs using such a profile go offline immediately and the CM-created profiles are removed.
This no cable qos permission command is similar to the docsIfCmtsQosProfilePermissions attribute in the DOCS-IF-MIB, as both prohibit CMs from creating their own QoS profiles in the future. However, the no cable qos permission command also immediately deletes QoS profiles that have been created by the cable modems and takes those modems offline. The docsIfCmtsQosProfilePermissions method does not affect QoS profiles that are currently in use, but only unused profiles and profiles that are created in the future.
Examples
The following example shows how to enable CMs to request arbitrary QoS parameters:
Router(config)# cable qos permission modemsThe following example shows how a CM with a QoS profile 4 created by the CM is reset to use QoS profile 225 enforced by the cable router (management):
CMTS01# show cable modemInterface SID Online Timing Receive QoS IP address MAC addressState Offset PowerCable6/0/U0 1 online 2848 0.00 4 19.2.20.139 0010.7b6b.7215CMTS01# show cable qos profile 4Service Prio Max Guarantee Max Max tx TOS TOS Create Bclass upstream upstream downstream burst mask value by privbandwidth bandwidth bandwidth enab4 7 128000 64000 2048000 255 0x0 0x0 cm noCMTS01(config)# cable qos profile 225 max-upstream 256CMTS01(config)# cable qos permission enforce 225CMTS01# clear cable modem all resetCMTS01# show cable modemInterface SID Online Timing Receive QoS IP address MACaddressState Offset PowerCable6/0/U0 1 offline 2848 0.25 2 19.2.20.139 0010.7b6b.7215CMTS01# debug cable reg....00:15:59: Finished parsing REG Request00:15:59: Overriding Provisioned QoS Parameters In REG-REQ....CMTS01# show cable modemInterface SID Online Timing Receive QoS IP address MACaddressState Offset PowerCable6/0/U0 1 online 2852 0.00 225 19.2.20.139 0010.7b6b.7215CMTS01# show cable qos profile 225Service Prio Max Guarantee Max Max tx TOS TOS Create Bclass upstream upstream downstream burst mask value by privbandwidth bandwidth bandwidth enab225 0 256000 0 0 0 0x0 0x0 management noRelated Commands
cable qos pre-registration
To ensure that cable modems get online when a large number of existing online cable modems are actively transmitting data, use the cable qos pre-registration us-priority command.
cable qos pre-registration us-priority priority-value
Syntax Description
Command Default
Zero is the default QoS profile-2 priority of the initializing cable modem.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The cable qos pre-registration command allows the Cisco CMTS operators to enforce a profile on all cable modems that have not yet begun initialization. However, this command has no affect on cable modems that have already started initialization and may be having difficulties getting [w-]online.
Examples
The following example shows how to set the priority of the QoS profile-2.
Router# configure terminalRouter(config)# cable qos pre-registration us-priority 2Router(config)#Related Commands
cable qos pro max-ds-burst
To define ERBA on the downstream for DOCSIS 1.0 cable modems, use the cable qos promax-ds-burst command in global configuration mode. To remove this ERBA setting from the QoS profile, use the no form of this command.
cable qos pro max-ds-burst burst-size
no cable qos pro max-ds-burst
Syntax Description
Command Default
This DOCSIS 1.0 configuration is disabled by default.
Command Modes
Global configuration
Command History
12.3(13a)BC
This command was introduced for the Cisco uBR7100 Series and Cisco uB7246VXR router.
Usage Guidelines
To display ERBA settings as applied to DOCSIS 1.0 cable modems and QoS profiles on the Cisco CMTS, use the show cable qos profile command in Privileged EXEC mode.
The following example of the cable qos profile command in global configuration mode illustrates changes to the cable qos profile command. Fields relating to the ERBA feature are shown in bold for illustration:
Router(config)# cable qos pro 10 ?grant-interval Grant intervalgrant-size Grant sizeguaranteed-upstream Guaranteed Upstreammax-burst Max Upstream Tx Burstmax-ds-burst Max Downstream Tx burst (cisco specific)max-downstream Max Downstreammax-upstream Max Upstreamname QoS Profile name string (cisco specific)priority Priorityprivacy Cable Baseline Privacy Enabletos-overwrite Overwrite TOS byte by setting mask bits to valueThe following example of the show cable qos profile command illustrates that the maximum downstream burst has been defined, and is a management-created QoS profile:
Router# show cable qos proID Prio Max Guarantee Max Max TOS TOS Create B IP prec.upstream upstream downstream tx mask value by priv ratebandwidth bandwidth bandwidth burst enab enab1 0 0 0 0 0 0xFF 0x0 cmts(r) no no2 0 64000 0 1000000 0 0xFF 0x0 cmts(r) no no3 7 31200 31200 0 0 0xFF 0x0 cmts yes no4 7 87200 87200 0 0 0xFF 0x0 cmts yes no6 1 90000 0 90000 1522 0xFF 0x0 mgmt yes no10 1 90000 0 90000 1522 0x1 0xA0 mgmt no no50 0 0 0 96000 0 0xFF 0x0 mgmt no no51 0 0 0 97000 0 0xFF 0x0 mgmt no noThe following example illustrates the maximum downstream burst size in sample QoS profile 10 with the show cable qos prof verbose command in privileged EXEC mode:
Router# show cable qos pro 10 verProfile Index 10NameUpstream Traffic Priority 1Upstream Maximum Rate (bps) 90000Upstream Guaranteed Rate (bps) 0Unsolicited Grant Size (bytes) 0Unsolicited Grant Interval (usecs) 0Upstream Maximum Transmit Burst (bytes) 1522Downstreamam Maximum Transmit Burst (bytes) 100000IP Type of Service Overwrite Mask 0x1IP Type of Service Overwrite Value 0xA0Downstream Maximum Rate (bps) 90000Created By mgmtBaseline Privacy Enabled noUsage Guidelines
If a cable modem registers with a QoS profile that matches one of the existing QoS profiles on the Cisco CMTS, then the maximum downstream burst size, as defined for that profile, is used instead of the default DOCSIS QoS profile of 1522.
For example, a DOCSIS 1.0 configuration that matches QoS profile 10 in the previous examples would be as follows:
03 (Net Access Control) = 104 (Class of Service Encodings Block)S01 (Class ID) = 1S02 (Maximum DS rate) = 90000S03 (Maximum US rate) = 90000S06 (US burst) = 1522S04 (US Channel Priority) = 1S07 (Privacy Enable) = 0The maximum downstream burst size (as well as the ToS overwrite values) are not explicitly defined in the QoS configuration file because they are not defined in DOCSIS. However, because all other parameters are a perfect match to profile 10 in this example, then any cable modem that registers with these QoS parameters has a maximum downstream burst of 100000 bytes applied to it.
For further illustration, consider a scenario in which packets are set in lengths of 1000 bytes at 100 packets per second (pps). Therefore, the total rate is a multiplied total of 1000, 100, and 8, or 800kbps.
To change these settings, two or more traffic profiles are defined, with differing downstream QoS settings as desired. Table 0-12 provides two examples of such QoS profiles for illustration:
In this scenario, both QoS profiles are identical except for the max-ds-burst size, which is set to 5000 in QoS profile 101 and 5000 in QoS profile 102.
Optimal Settings for DOCSIS 1.0 Downstream Powerburst
DOCSIS allows the setting different token bucket parameters for each service flow, including the token bucket burst size. When burst sizes are closer to 0, QoS is enforced in a stricter manner, allowing a more predictable sharing of network resources, and as a result easier network planning.
When burst sizes are larger, individual flows can transmit information faster (lower latency), although the latency variance can be larger as well.
For individual flows, a larger burst size is likely to be better. As long as the system is not congested, a large burst size reduces the chances of two flows transmitting at the same time, because each burst is likely to take less time to transmit. However, as channel bandwidth consumption increases, it is probably that large burst traffic would exceed the thresholds of buffer depths, and latency is longer than with well shaped traffic.
For additional information about the cable qos profile command and configuring QoS profiles, refer to the following documents on Cisco.com:
•
Related Commands
cable queue-limit
To set the DOCSIS service flow queue limits to non-default values on the Cisco CMTS, use the cable queue-limit command in global configuration mode. To disable this function, use the no form of this command.
cable queue-limit queue_limit_in_ms bandwidth-threshold threshold_value
no cable queue-limit queue_limit_in_ms bandwidth-threshold threshold_value
Syntax Description
Command Default
This command is not enabled by default.
Command Modes
Global configuration (config)
Command History
12.2(33)SCG
This command was introduced.
12.2(33)SCG1
Support was added for the Cisco uBR7200 Series router.
Usage Guidelines
The queue size on the downstream interfaces can be adjusted to be different than the default settings; for example, when the application can benefit from a larger queue size on a high speed queue.
The queue size in packets is calculated as:
queue-size = bandwidth (Kbps) * queue-limit (ms) / 8 / 1518
(where 1518 B is the packet size, and bandwidth is the same as queue shape rate).
Associated FeaturesThe cable queue-limit bandwidth-threshold command is used to configure the following features:
•
Examples
The following example shows how to set the queue limit to 25 ms at max-rate when bandwidth exceeds 100000 Kbps:
Router(config)# cable queue-limit 25 bandwidth-threshold 100000Related Commands
cable rate-limit-algorithm min-plus-excess
To enable a service flow to receive not only its configured minimum reserved traffic rate bandwidth but also its expected excess traffic rate bandwidth, use the cable rate-limit-algorithm min-plus-excess command in global configuration mode. To disable this configuration, use the no form of this command.
cable rate-limit-algorithm min-plus-excess
no cable rate-limit-algorithm min-plus-excess
Syntax Description
min-plus-excess
Specifies that the service flow requires a bandwidth of the specified minimum reserved traffic rate, plus excess traffic rate.
Command Default
When the cable rate-limit-algorithm min-plus-excess command is not configured, service flows with the minimum reserved traffic rate configured are guaranteed only their minimum reserved traffic rate. Excess traffic rate bandwidth may not be shared evenly among service flows with or without the minimum rate configured.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The cable rate-limit-algorithm min-plus-excess command enables a service flow to receive its configured minimum reserved traffic rate bandwidth plus its expected excess traffic rate bandwidth.
Examples
The following example shows how to specify the min-plus-excess keyword:
Router> enableRouter# configure terminalRouter(config)# cable rate-limit-algorithm argument min-plus-excessRouter(config)#Related Commands
cable rcc-template
To define a receive channel configuration (RCC) template, use the cable rcc-template command in global configuration mode.
cable rcc-template index
Syntax Description
Command Default
If an RCC template is not assigned to a cable interface, the CMTS will use the wideband cable interface generated RCC for a receive channel profile (RCP).
Command Modes
Global configuration (config)
Command History
Usage Guidelines
A valid RCC template consists of a configured RCP ID, a receive module (RM) entry, and a receive channel (RC) entry.
First, you define an RCC template for an RCP, and then assign the template to a cable interface to generate RCCs based on the actual DS channel configuration.
Note
Examples
The following example shows how to define an RCC template:
Router# configure terminalRouter(config)# cable rcc-template 1Related Commands
cable rcp-control
To enable the receive channel profile (RCP) reporting with verbose description, use the cable rcp-control command in interface configuration mode. To revert to the default simple RCP reporting, use the no form of this command.
cable rcp-control verbose
no cable rcp-control
Syntax Description
verbose
Enables RCP reporting with verbose description that contains complete subtype encodings defined in DOCSIS 3.0.
Command Default
If this command is not used, cable modems use the default RCP reporting method that contains only the RCP identifiers.
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
Use this command to enable a CM to send detailed RCP data in the registration request. This detailed RCP data can be verified using the debug cable registration command. This verbose RCP data is useful while configuring a receive channel configuration (RCC) template.
Examples
The following example shows how to enable RCP reporting with verbose description on a cable interface on the Cisco uBR10012 router:
Router# configure terminalRouter(config)# interface cable 8/0/0Router(config-if)# cable rcp-control verboseRelated Commands
debug cable registration
Displays debug messages for the CM registration process.
cable rcc-template
Defines a Receive Channel Configuration (RCC) template.
cable redundancy hashfilter
To set the MAC address and DDC node mappings of the DDC redundancy scheme, use the cable redundancy hashfilter command in global configuration mode. This hash filter is to be shared by all DDC nodes (routers) in the redundancy scheme. To remove the hash filter from the Cisco CMTS router, use the no form of this command.
cable redundancy hashfilter hash_id {type namestring | mac-mask mac-mask | mac-map mac-address node node_id | oui-map oui node node_id}
no cable redundancy hashfilter
Syntax Description
Command Default
•
•
Command Modes
Global configuration (config)
Command History
Release 12.3(9a)BC
This command was introduced on the Cisco uBR7246 universal broadband router.
Usage Guidelines
This command is used in the early stages of configuring DDC Redundancy on all DDC nodes (routers) in the scheme. For additional information in context, refer to the "Configuring Cisco DDC Redundancy on the Cisco uBR7246VXR Universal Broadband Router" feature documentation on Cisco.com.
Note
Examples
The following example implements the cable redundancy hashfilter command in four sequential steps, completing the entire mapping information required for one DDC node in a redundancy scheme of two routers:
Router# cable redundancy hashfilter 1 type defaultRouter# cable redundancy hashfilter 1 macmask FFFF.FF00.0000Router# cable redundancy hashfilter 1 macmap 0007.0e03.68ad node 2Router# cable redundancy hashfilter 1 ouimap 00070e node 1Related Commands
cable redundancy myid
To set the total number of Cisco DDC nodes (routers) in the DDC Redundancy scheme, and to set the ID of the current DDC node, use the cable redundancy myid command in global configuration mode. To remove a DDC node ID from the router, use the no form of this command.
cable redundancy myid node_id nodes nodes
no cable redundancy myid node_id
Syntax Description
Command Default
DDC Redundancy is disabled and DDC nodes (routers) are not configured for DDC redundancy by default.
Command Modes
Global configuration (config)
Command History
Release 12.3(9a)BC
This command was introduced on the Cisco uBR7246 universal broadband router.
Usage Guidelines
This configuration must be present (identical except node_id) on all DDC nodes (routers) participating in the scheme.
This command is used in the early stages of configuring DDC Redundancy on all DDC nodes (routers) in the scheme. For additional information in context, refer to the "Configuring Cisco DDC Redundancy on the Cisco uBR7246VXR Universal Broadband Router" feature documentation on Cisco.com.
Examples
The following example configures the DDC node (router) ID to be 2 in a scheme in which there are three DDC nodes total.
Router# cable redundancy myid 2 nodes 3
Related Commands
cable redundancy node
Configures the DDC node with active or standby state.
show cable redundancy
Displays the current DDC redundancy configurations and status.
cable redundancy node
To set the DDC node (router) with which a subinterface is associated, and to set the state for that interface, use the cable redundancy node command in subinterface configuration mode. To remove this configuration from the router, use the no form of this command.
cable redundancy node node_id {active | standby} [force]
no cable redundancy node node_id {active | standby}
Syntax Description
Command Default
DDC switchover events are disabled by default and must be manually initiated on a case-by-case basis.
Command Modes
Subinterface configuration (config-subif)
Command History
Release 12.3(9a)BC
This command was introduced on the Cisco uBR7246 universal broadband router.
Usage Guidelines
This command can be used in the context of DDC configuration, testing or forced switchover events. Refer to earlier procedures in this document for additional information.
Note
Examples
The following command sequence sets the DDC node states in a scheme with two DDC nodes (routers), then forces a switchover event on DDC node 1 that puts it into
standbystate.Router(config-subif)# cable redundancy node 2 active
Router(config-subif)# cable redundancy node 1 standby
Router(config-subif)# cable redundancy node 1 standby force
Related Commands
cable redundancy node frequency
To set the downstream frequencies for each node participating in the scheme other than the current DDC node (router), use the cable redundancy node frequency command in interface configuration mode. This frequency is used to switch cable modems to the downstream frequency of the backup interface (on another DDC node) via DFO and DCC messages. To remove this setting from the router, use the no form of this command.
cable redundancy node node_id frequency frequency
no cable redundancy node node_id frequency frequency
Syntax Description
node_id
DDC target node ID for which the frequency is being set.
frequency
Downstream frequency of the target interface.
Command Default
Cable downstream frequency override is enabled by default.
Command Modes
Interface configuration mode (config-if)
Command History
Release 12.3(9a)BC
This command was introduced on the Cisco uBR7246 universal broadband router.
Usage Guidelines
This command must be present on each cable interface participating in the scheme, regardless of its bundle status.
Examples
The following example configures the downstream frequency of DDC node 1 to be 435000000.
Router(config-if)# cable redundancy node 1 frequency 435000000
Related Commands
cable redundancy target
To set the target DDC node (router) to use in a DDC switchover event, use the cable redundancy target command in interface configuration mode. To remove this configuration from the router, use the no form of this command.
cable redundancy target node_id
no cable redundancy target node_id
Syntax Description
Command Default
When this command is not present, the default target node is the next higher node in the scheme.
Command Modes
Interface configuration (config-if)
Command History
Release 12.3(9a)BC
This command was introduced on the Cisco uBR7246 universal broadband router.
Usage Guidelines
The downstream frequency that is used in a DDC switchover event is the frequency set on the respective target DDC node, as set with this command.
Note
When this command is not present, the default target node is the next higher node in the scheme (the next higher node_id value in the scheme). For example, if there are three participating nodes, the default target nodes are as follows (respectively):
•
•
•
Examples
The following example configures the target node on the current router to be DDC node 1, often referred to as CMTS A in additional sections of this document.
Router(config-if)# cable redundancy target 1
Related Commands
cable redundancy threshold
To set the active voice call threshold on the current DDC node (router), use the cable redundancy threshold command in interface configuration mode. To remove this configuration from the router, use the no form of this command.
cable redundancy threshold max-calls
no cable redundancy threshold
Syntax Description
Command Default
The threshold for maximum calls is not set by default.
Command Modes
Interface configuration (config-if)
Command History
Release 12.3(9a)BC
This command was introduced on the Cisco uBR7246 universal broadband router.
Usage Guidelines
If the number of active voice calls exceeds this value, a DDC switchover does not take place unless it is forced by using the cable redundancy node node_id standby force subinterface configuration command.
If the command is configured on a bundle master, the threshold is used to compare with the total number of voice calls in the bundle. This command is not accepted on interfaces configured as bundle slaves.
If this threshold is not configured, this check does not occur and the DDC switchover proceeds regardless of how many voice calls are active. This is subject to additional constraints described in the "Call Priority in Cisco DDC Redundancy" section of the "Configuring Cisco DDC Redundancy on the Cisco uBR7246VXR Universal Broadband Router" feature documentation on Cisco.com.
Examples
The following example configures DDC redundancy not to take place if there are more than 20 active or E911 calls at the time a DDC switchover event is attempted or requested.
Router(config-if)# cable redundancy threshold 20
Related Commands
cable registration-timeout
To set the value of the DOCSIS registration timeout timer (T9 timer) on a particular interface, use the cable registration-timeout command in cable interface configuration mode. To reset the timeout value to the default, use the no form of this command.
cable registration-timeout minutes
no cable registration-timeout
Syntax Description
minutes
Sets the value of the DOCSIS CM registration timeout timer (T9 timer). Valid range is from 2 to 60 minutes. The default is 3 minutes.
Command Default
3 minutes
Command Modes
Interface configuration (cable interface only)
Command History
Usage Guidelines
The DOCSIS 1.1 specification states that the CMTS should enforce the T9 timer, which is a registration timeout timer that specifies the maximum time allowed between the CMTS sending a successful Ranging Response (RNG-RSP) message and the CM replying with a Registration Request (REG-REQ) message. If this timer expires, the CMTS must remove the CM from its list of active CMs, and the CM must restart the registration process.
The cable registration-timeout command can be used to customize the value of the T9 timer for each cable interface, to accommodate the CMs using that interface.
Examples
The following example shows the registration timeout value being increased from 3 minutes to 10 minutes:
Router# configure terminalRouter (config)# interface c6/0Router(config-if)# cable registration-timeout 10Router(config-if)# exitRouter(config)#cable relay-agent-option
To enable the system to insert the CM MAC address into a Dynamic Host Configuration Protocol (DHCP) packet received from a CM or host and forward the packet to a DHCP server, use the cable relay-agent-option command in cable interface configuration mode. To disable MAC address insertion, use the no form of this command.
cable relay-agent-option
no cable relay-agent-option
Syntax Description
This command has no keywords or arguments.
Command Default
no cable relay-agent-option
Command Modes
Interface configuration (cable interface only)
Command History
11.3 NA
This command was introduced.
12.0 mainline, 12.1(2)EC1, 12.0(10) SC
This command was made obsolete and was replaced by the ip dhcp relay information option command.
Usage Guidelines
This functionality enables the use of DHCP Option 82 to allow a DHCP server to identify the CM sending the request and to initiate the appropriate action based on this information. On Cisco IOS Release 12.0 and later releases, use the ip dhcp relay information option command to enable Option 82 processing.
Examples
The following example shows how to enable the insertion of DHCP relay agent information into DHCP packets:
Router(config-if)# cable relay-agent-optionRelated Commands
cable resiliency ds-bonding
To enable the Downstream Resiliency Bonding Group feature and to create a resiliency bonding group (RBG) on the Cisco CMTS router, use the cable resiliency ds-bonding command in global configuration mode. To disable this feature, use the no form of this command.
cable resiliency ds-bonding
no cable resiliency ds-bonding
Command Default
None
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The cable resiliency ds-bonding command is used to configure the Downstream Resiliency Bonding Group feature.
Examples
The following example shows how to configure the Downstream Resiliency Bonding Group feature:
Router(config)# cable resiliency ds-bondingAssociated FeaturesThe cable ds-resiliency command is used to configure the following feature:
Downstream Resiliency Bonding Group
Related Commands
cable resiliency traps-interval
To set the interval at which traps must be sent for Wideband Resiliency related events for each cable modem on the Cisco CMTS, use the cable resiliency traps-interval command in global configuration mode. To disable the interval, use the no form of this command.
cable resiliency traps-interval count
no cable resiliency traps-interval
Syntax Description
count
Time interval (in seconds) at which the traps must be sent for each cable modem. The valid range is from 0 to 86400. Default value is 1.
Command Default
By default, the resiliency trap interval is enabled and set as 1 second.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
When the network has less number of cable modems with resiliency events occurring at a given time, use the default value of 1 second interval. But if the network has many cable modems with resiliency events occurring at a given time, set the interval to a higher value.
Examples
The following example shows how to set the time interval to 10 second for sending traps for each cable modem:
Router(config)# cable resiliency traps-interval 10Associated FeaturesThe cable resiliency traps-interval command is associated with the Wideband Modem Resiliency feature.
Related Commands
show cable modem resiliency
Displays resiliency status of the cable modem in resiliency mode on the Cisco CMTS router.
cable rf-adapt timer
To configure timers for RF adaptation, use the cable rf-adapt timer command in global configuration mode. To disable the timers, use the no form of this command.
cable rf-adapt timer {general time | candidate time | relocation time}
no cable rf-adapt timer
Syntax Description
Command Default
Default timer values are used.
Command Modes
Global configuration (config)
Command History
Examples
The following example shows how to set timers for cable modem upstream RF adaptation:
Router(config)# cable rf-adapt timer general 120Router(config)# cable rf-adapt timer candidate 10Router(config)# cable rf-adapt timer relocation 5Related Commands
cable rf-bandwidth-percent
To enable either static or dynamic bandwidth sharing for a modular cable (MC) interface, use the cable rf-bandwidth-percent command in interface configuration mode. To remove bandwidth sharing for the MC interface, use the no form of this command.
cable rf-bandwidth-percent percent-value [remaining ratio excess-value]
no cable rf-bandwidth-percent
Syntax Description
Command Default
The default static bandwidth percentage for a modular cable interface is 0.
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
The total percentage of the RF channel bandwidth allocated to both the modular cable (MC) and wideband interfaces must not exceed 96 percent. The remaining 4 percent of the bandwidth is reserved for minislot allocation packet (MAP) and other MAC management messages (MMM) DOCSIS traffic using this RF channel as its primary channel.
When dynamic bandwidth sharing (DBS) is enabled on the MC interface, the bandwidth percentage is converted to a committed information rate (CIR) value for the corresponding link queue. By re-interpreting the bandwidth percentage value as a CIR value for the MC interface, the interface receives, at minimum, the configured percent of bandwidth and more when the RF channel's bandwidth is not consumed by other interfaces sharing the same RF channel. The remaining ratio option is only available when DBS is enabled using the cable dynamic-bw-sharing command.
If the cable rf-bandwidth-percent command is not configured and DBS is enabled, no bandwidth is reserved for the MC interface and it is effectively in the protocol down state—the MC link queue is not created. Static bandwidth sharing (the default) or DBS can be configured on an MC interface, but you cannot have both on the same interface.
Examples
The folowing is an example of static bandwidth allocation configuration:
Router# configure terminalRouter(config)# interface modular-cable 1/0/0:0Router(config-if)# cable rf-bandwidth-percent 70The following is an example of dynamic bandwidth sharing configuration:
Router# configure terminalRouter(config)# interface modular-cable 1/0/0:0Router(config-if)# shutdownRouter(config-if)# cable dynamic-bw-sharingRouter(config-if)# no shutdownRouter(config-if)# cable rf-bandwidth-percent 70 remaining ratio 25Related Commands
cable rf-change-dampen-time
To configure the amount of time a radio frequency (RF) channel must remain in its new state (either up or down), use the cable rf-change-dampen-time command in global configuration mode. To restore the default value, use the no form of this command.
cable rf-change-dampen-time seconds
no cable rf-change-dampen-time
Syntax Description
seconds
Specifies the amount of time in seconds for a non-primary RF channel to remain in its new state. The valid range is 1 to 65535. The default value is 30.
Command Default
If this command is not used, the default value of 30 seconds will be restored.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
This command applies to all non-primary RF channels on a CMTS.
Examples
The following example shows how to specify the amount of time for a non-primary RF channel to remain in its new state:
Router# configure terminalRouter(config)# cable rf-change-dampen-time 10Related Commands
cable rf-change-trigger
Specifies the persistence thresholds for an event before the event triggers an action for the cable modem.
cable rf-channel
To associate an RF channel on the Cisco Wideband SPA with a wideband interface and allocate bandwidth, use the cable rf-channel command in interface configuration mode. To remove an association of an RF channel to a wideband interface, use the no form of this command.
cable rf-channel {rf-port | controller controller-num channel channel-num} [bandwidth-percent bw-percent] [remaining ratio excess-value]
no cable rf-channel {rf-port | controller controller-num channel channel-num}
Syntax Description
Command Default
No default RF channel association with a wideband interface is configured. If the cable rf-channel command is used without specifying bandwidth-percent, the default bandwidth value is 100 percent.
Command Modes
Interface configuration (config-if)
Command History
Usage Guidelines
The cable rf-channel command associates an RF channel (port) on a Wideband SPA with a wideband interface. Optionally, you can specify the percent of bandwidth from this RF channel that will be used for the specified wideband interface.
The Cisco uBR10012 router supports two Wideband SPAs. Each Wideband SPA supports up to 24 RF channels depending on how the SPA is configured with the annex modulation command. For annex A and 256 QAM modulation, each Wideband SPA supports up to 18 RF channels at full rate and up to 24 RF channels at less than full rate. For all other cases, the SPA supports 24 RF channels.
Note
Note
Effective with Cisco IOS Release 12.3(23)BC, the annex modulation command is obsolete and annex and modulation are included as keyword options in the rf-channel frequency command.
Each Wideband SPA supports up to 32 wideband channels. A wideband interface cannot consist of RF channels from two different Wideband SPAs. The number of RF channels that can be aggregated into a wideband interface is determined by the capability of the wideband cable modem.
•
•
An RF channel can be associated with multiple wideband interfaces as long as the wideband interfaces belong to the same virtual bundle interface (cable bundle) and the RF channel's total allocated bandwidth does not exceed 100 percent. As an example, Table 13 shows that a single RF channel can be associated with multiple wideband interfaces as long as the total allocated bandwidth for the RF channel does not exceed 100 percent.
Table 13 RF Channel Bandwidth Allocation
10
0
30 percent
10
1
30 percent
10
2
40 percent
Total Bandwidth Percent: 100 percent
Table 14 shows that a single RF channel can be associated with a narrowband and multiple wideband interfaces as long as the total allocated bandwidth for the RF channel does not exceed 100 percent.
Note
When dynamic bandwidth sharing (DBS) is enabled, the bandwidth percentage is converted to a committed information rate (CIR) value that provides the level of guaranteed bandwidth for the wideband interface. The reserved bandwidth for the wideband interface is the sum of its link queue CIR values and is used for admission control of the service flows with minimal reserved rate. With DBS enabled and the cable rf-channel command configured, the corresponding link queue can have 100 percent of the CIR value. The excess-value is the percent of excess bandwidth that can be allocated to the wideband channel.
Static bandwidth sharing (the default) or DBS can be configured on a wideband interface, but you cannot have both on the same interface.
Examples
The following example shows how to associate RF channel 10 and RF channel 11 with wideband interface 0:
Router(config)# interface wideband-cable 1/0/0:0Router(config-if)# cable rf-channel 10 bandwidth-percent 50Router(config-if)# cable rf-channel 11The following example shows how to associate a controller to the RF channel for a wideband interface:
Router(config)# interface wideband-Cable 7/1/0:0Router(config-if)# cable rf-channel controller 0 channel 1In the preceding example, because no bandwidth-percent is specified in the second cable rf-channel command, the default value (100 percent of bandwidth) applies; that is, 100 percent of RF channel 11 bandwidth is used for wideband interface 0.
The following example shows bandwidth allocation when DBS is enabled:
Router(config)# interface wideband-cable 1/0/0:0Router(config-if)# shutdownRouter(config-if)# cable dynamic-bw-sharingRouter(config-if)# no shutdownRouter(config-if)# cable rf-channel 10 bandwidth-percent 50 remaining ratio 5In the preceding example, because DBS is enabled, the wideband interface is guaranteed 50 percent of the bandwidth and 5 as the value for allocating excess bandwidth.
Related Commands
cable rfswitch copy
To copy an image from the Cisco CMTS router to the Cisco NGRFSW-ADV or from Cisco NGRFSW-ADV to the Cisco CMTS, use the cable rfswitch copy command in privileged EXEC mode.
cable rfswitch copy filename_cmts {to-rfsw | from-rfsw} filename_rfsw
Syntax Description
Command Default
None
Command Modes
Privileged EXEC (#)
Command History
Usage Guidelines
Use the cable rfswitch copy command when an existing image on the Cisco NGRFSW-ADV or Cisco CMTS router is corrupt or out-of-date and needs to be replaced with another image.
Examples
The following example shows how to download the gcv2.11 image from the Cisco CMTS router to the Cisco NGRFSW-ADV:
Router> enableRouter# cable rfswitch copy disk0:gcv2.11 to-rfsw gcv2.11The following example shows how to upload the gcv2.11 image from the Cisco NGRFSW-ADV to the Cisco uBR10012 CMTS:
Router> enableRouter# cable rfswitch copy disk0:gcv2.11 from-rfsw gcv2.11Related Commands
show hccp channel-switch state
Displays the current state of the Cisco NGRFSW-ADV.
cable rfswitch delete
To delete an image in the Cisco NGRFSW-ADV, use the cable rfswitch delete command in privileged EXEC mode.
cable rfswitch delete filename_rfsw
Syntax Description
Command Default
None
Command Modes
Privileged EXEC (#)
Command History
Usage Guidelines
Use the cable rfswitch delete command when an existing image on the Cisco NGRFSW-ADV is corrupt, out-of-date, or needs to be replaced with another image. You cannot delete the active or the golden image on the Cisco NGRFSW-ADV.
Examples
The following example shows how to delete the gcv2.11 image on the Cisco NGRFSW-ADV:
Router> enableRouter# cable rfswitch delete gcv2.11Associated FeaturesThe cable rfswitch delete command is used to configure the Cisco uBR Advanced RF Switch (NGRFSW-ADV). See Cisco uBR Advanced RF Switch Software Configuration Guide.
Related Commands
show hccp channel-switch image
Displays the image list on the Cisco NGRFSW-ADV.
show hccp channel-switch state
Displays the current state of the Cisco NGRFSW-ADV.
cable rfswitch reboot
To reboot the Cisco NGRFSW-ADV, use the cable rfswitch reboot command in privileged EXEC mode.
cable rfswitch reboot
Syntax Description
Command Default
None
Command Modes
Privileged EXEC (#)
Command History
Examples
The following example shows how to reboot the Cisco NGRFSW-ADV:
Router> enableRouter# cable rfswitch rebootAssociated FeaturesThe cable rfswitch reboot command is used to configure the Cisco uBR Advanced RF Switch (NGRFSW-ADV). See Cisco uBR Advanced RF Switch Software Configuration Guide.
Related Commands
show hccp channel-switch image
Displays the image list on the Cisco NGRFSW-ADV.
show hccp channel-switch state
Displays the current state of the Cisco NGRFSW-ADV.
cable rfswitch set-active
To set an image as active on the Cisco NGRFSW-ADV, use the cable rfswitch set-active command in privileged EXEC mode.
cable rfswitch set-active filename_rfsw
Syntax Description
Command Default
None
Command Modes
Privileged EXEC (#)
Command History
Examples
The following example shows how to set the gcv2.11 image as active on the Cisco NGRFSW-ADV:
Router> enableRouter# cable rfswitch set-active gcv2.11Router# cable rfswitch rebootAssociated FeaturesThe cable rfswitch set-active command is used to configure the Cisco uBR Advanced RF Switch (NGRFSW-ADV). See Cisco uBR Advanced RF Switch Software Configuration Guide.
Related Commands
show hccp channel-switch image
Displays the image list on the Cisco NGRFSW-ADV.
show hccp channel-switch state
Displays the current state of the Cisco NGRFSW-ADV.
cable rsvp default-scn
To specify the default service class that enables the Resource ReSerVation Protocol (RSVP) created service flows to inherit characteristics , use the cable rsvp default-scn command in global configuration mode.
cable rsvp default-scn service-class name
Syntax Description
Command Default
Service class is not configured.
Command Modes
Global configuration mode
Command History
Usage Guidelines
The cable rsvp default-scn command allows users to specify the default service class that enables the RSVP created service flows to inherit characteristics.
Examples
The following example configures a default RSVP service class.
Router#configure terminalRouter(config)# cable service class 220 name RSVPClassRouter(config)#cable service class 220 downstreamRouter(config)#cable service class 220 max-latency 100000Router(config)#cable service class 220 req-attr-mask ffff0000Router(config)#cable rsvp default-scn RSVPClassRouter(config)#cable rsvp default-scn RSVPClassRelated Commands
show cable rsvp flow-db
Displays the contents of the RSVP to DOCSIS service-flow mapping database.
cable rf-change-trigger
To specify the amount of time an event must persist before it triggers an action for the reporting cable modem, use the cable rf-change-trigger command in global configuration mode. To restore the default value, use the no form of this command.
cable rf-change-trigger {percent value | count number} [secondary]
no cable rf-change-trigger {percent value | count number} [secondary]
Syntax Description
Command Default
If this command is not used, the default value (0) is used.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
This command applies to all non-primary RF channels on a Cisco CMTS router. The default value of 0 prevents any bonding group modifications. In order to dampen the change of a logical state of an RF channel, the trigger for the channel can be set to one half of the number used for the logical state. For example, if you enter cable rf-change-trigger percent 20, when 20 percent of the cable modems report an RF channel is down, the logical state of the RF channel is changed to down. And when 10 percent of the cable modems report that the affected RF channel is back, the logical state is changed to up.
In the case of a small number of wideband modems, you can specify an absolute value for triggering an event in addition to the percentage. Both values must be true in order to trigger the suspension of an RF channel. When both values are 0, the cable modem is reset if the cable modem reports an RF failure through a status message. Also, if you set thresholds to 0, then all cable modems with RF failures are reset and any RFs suspended from a bonding group are reactivated.
Examples
The following example shows how to specify the amount of time an event must persist before it triggers an action for the reporting cable modem:
Router# configure terminalRouter(config)# cable rf-change-trigger percent 50 count 1The following example shows how to configure the Cisco CMTS to move secondary SFs to primary interface when the trigger threshold is not reached, in Cisco IOS Release 12.2(33)SCE4:Router# configure terminalRouter(config)# cable rf-change-trigger percent 50 count 1 secondaryAssociated FeaturesThe cable rf-change-trigger command is used to configure the following features:
Related Commands
cable rf-change-dampen-time
Specifies the amount of time an RF channel must remain in its new state.
