-
Cisco IOS CMTS Cable Command Reference
-
Cisco IOS CMTS Cable Command Reference Title
-
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
-
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 through show cable t
-
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
-
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 redundancy node frequency
Cable Commands: cable p through cable r
Revised: October 27, 2008, OL-15510-05
New Commands
Modified Commands
cable rf-bandwidth-percent
12.3(23)BC1
cable rf-channel
12.3(23)BC, 12.3(23)BC1
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/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 [40-bit-des | accept-self-signed-certificate | authenticate-modem | authorize-multicast | mandatory | oaep-support | dsx-support]
no cable privacy [40-bit-des | accept-self-signed-certificate | authenticate-modem | authorize-multicast | mandatory | oaep-support | dsx-support]
Syntax Description
Command Default
BPI is disabled. When enabled, 56-bit DES encryption is enabled by default, and self-signed manufacturer certificates are not allowed.
Command Modes
Interface configuration (cable interface only)
Command History
Usage Guidelines
This command is applicable only on images that support BPI or BPI+ encryption.
Examples
The following example shows how to force baseline privacy 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 baseline privacy interface (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-certificate
Note
Related Commands
cable privacy add-certificate
To add a manufacturer or root CA certificate to the list of trusted certificates, use the cable privacy add-certificate command in global configuration mode. To remove a particular certificate, use the no form of this command.
cable privacy add-certificate {manufacturer hex-data | root hex-data}
no cable privacy add-certificate {manufacturer hex-data | root hex-data}
Syntax Description
Command Default
No default behavior or values.
Command Modes
Global configuration
Command History
Usage Guidelines
This command is applicable only on images that support BPI or BPI+ encryption.
Examples
The following example adds a manufacturer CA certificate to the CMTS list of trusted certificates:
Router(config)# cable privacy add-certificate manufacturer 35c146353431a541463b41337343938333373142FEF03A8BC7A441313134749A0A592C9C66831412Router(config)#The following example adds a root CA certificate to the CMTS list of trusted certificates:
Router(config)# cable privacy add-certificate root 00908300 00300501308202A1 3082020A A0030201 02020800 90830000 00000130 0D06092A 864886F70D010105 05003081 92310B30 09060355 04061302 4A503110 300E0603 55040A1307546F73 68696261 310F300D 06035504 0B130644 4F435349 53312730 25060355040B131E 312D312D 31205368 69626175 7261204D 696E6174 6F2D6B75 20546F6B796F3137 30350603 55040313 2E546F73 68696261 20436162 6C65204D 6F64656D20526F6F 74204365 72746966 69636174 65204175 74686F72 69747930 1E170D3030303331 38303830 3030305A 170D3230 30333138 30383030 30305A30 8192310B30090603 55040613 024A5031 10300E06 0355040A 1307546F 73686962 61310F300D060355 040B1306 444F4353 49533127 30250603 55040B13 1E312D31 2D31205368696261 75726120 4D696E61 746F2D6B 7520546F 6B796F31 37303506 03550403Router(config)#Related Commands
cable privacy bpi-plus-enforce
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
Note
Syntax Description
No additional keywords or arguments
Defaults
The cable privacy bpi-plus-enforce command is not enabled by default, but must be configured for optimal DOCSIS BPI+ security. There is no legitimate reason for a cable modem provisioned with DOCSIS 1.1 QOS to register with DOCSIS 1.0 BPI. Such behavior is not compliant with the DOCSIS 1.1 specification.
Command Modes
Global configuration mode
Command History
12.3(21)BC
This command was introduced to support Cloned Cable Modem Detection for DOCSIS BPI+ on the Cisco uBR10012 and Cisco uBR7246VXR routers.
Usage Guidelines
If the cable modem is not provisioned to use DOCSIS BPI or BPI+ security certificates, as characterized by not coming online with the above initialization states, then the existing behavior of the Cisco CMTS remains unchanged. The Cisco CMTS does not attempt to distinguish between two cable modems if neither is provisioned for BPI+ security.
Because this feature is enabled by default on the Cisco CMTS, the Cisco CMTS issues security breach notice in a log message in the generic system log or syslog if cable logging layer2events is not configured on the Cisco CMTS.
For additional information about the Cable Duplicate MAC Address Reject feature on the Cisco CMTS, or enforced DOCSIS 1.1 security, refer to the following document on Cisco.com:
•
Examples
The following brief example illustrates logging messages that are created with the detection of cloned cable modems behind the configuration in the above procedure.
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 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 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 3435414631413439383335453731423733333643Router(config)#Related Commands
cable privacy kek
To set key encryption keys (KEKs) grace-time and 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 {grace-time [seconds] | life-time [seconds]}
no cable privacy kek {grace-time | life-time}
Note
Syntax Description
Command Default
The grace-time option is set to 600 seconds (10 minutes), and the life-time option to 604,800 seconds (7 days).
Command Modes
Interface configuration (cable interface only)
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 on a grace-time or a life-time value.
The grace-time keyword is used to assign a temporary key to a CM to access the network. The life-time keyword is used to assign a more permanent key to a CM.
A CM that has a grace-time or life-time key assigned by the Cisco CMTS requests a new key before the current one expires.
Note
Examples
The following example shows how to set the KEK privacy grace-time to 800 seconds:
Router(config)# interface cable c5/1/0Router(config-if)# cable privacy kek grace-time 800Router(config-if)#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 tek
To set traffic encryption keys (TEKs) grace-time and 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 {grace-time [seconds] | life-time [seconds]}
no cable privacy tek {grace-time | life-time}
Note
Syntax Description
Command Default
The grace-time option is set to 600 seconds (10 minutes), and the life-time option to 43200 seconds (12 hours).
Command Modes
Interface configuration (cable interface only)
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 on a grace-time or a life-time value.
The grace-time keyword is used to assign a temporary key to a CM to access the network. The life-time keyword is used to assign a more permanent key to a CM.
A CM that has a grace-time or life-time key assigned by the Cisco CMTS requests a new key before the current one expires.
Note
Examples
The following example shows how to set the traffic encryption key grace-time to 800 seconds:
Router(config)# interface cable c5/1/0Router(config-if)# cable privacy tek grace-time 800Router(config-if)#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 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)#
