Cmts Command Ref PDF
Cmts Command Ref PDF
Cmts Command Ref PDF
Reference Guide
January 2005
Corporate Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 526-4100
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT
SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE
OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public
domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH
ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT
LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF
DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING,
WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO
OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
CCSP, the Cisco Square Bridge logo, Cisco Unity, Follow Me Browsing, FormShare, and StackWise are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live,
Play, and Learn, and iQuick Study are service marks of Cisco Systems, Inc.; and Aironet, ASIST, BPX, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, Cisco, the Cisco
Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Empowering the Internet Generation,
Enterprise/Solver, EtherChannel, EtherFast, EtherSwitch, Fast Step, GigaDrive, GigaStack, HomeLink, Internet Quotient, IOS, IP/TV, iQ Expertise, the iQ logo, iQ Net Readiness
Scorecard, LightStream, Linksys, MeetingPlace, MGX, the Networkers logo, Networking Academy, Network Registrar, Packet, PIX, Post-Routing, Pre-Routing, ProConnect,
RateMUX, Registrar, ScriptShare, SlideCast, SMARTnet, StrataView Plus, SwitchProbe, TeleRouter, The Fastest Way to Increase Your Internet Quotient, TransPath, and VCO are
registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.
All other trademarks mentioned in this document or Website are the property of their respective owners. The use of the word partner does not imply a partnership relationship
between Cisco and any other company. (0406R)
Preface v
Document Objectives v
Audience vi
Document Organization vi
Related Documents vi
Cisco CMTS Hardware Installation and Software Configuration Guides vi
Cisco Cable CPE Hardware Installation and Software Configuration Guides vii
Document Conventions vii
INDEX
This preface explains the objectives, intended audience, and organization of the Cisco Broadband Cable
Command Reference Guide. This preface provides the following sections, which provide a list of related
documents and define the conventions used to convey instructions and information.
• Document Objectives, page v
• Audience, page vi
• Document Organization, page vi
• Related Documents, page vi
• Document Conventions, page vii
• Obtaining Documentation, page viii
• Obtaining Technical Assistance, page ix
• Obtaining Additional Publications and Information, page x
Document Objectives
This guide describes the commands necessary to configure, maintain, and troubleshoot the following
cable platforms:
• Cisco Cable Modem Termination Systems (CMTS)
– Cisco uBR7100 series universal broadband routers, which include the Cisco uBR7111, the
Cisco uBR7114, the Cisc uBR7111E, and the Cisco uBR7114E routers.
– Cisco uBR7200 series universal broadband routers, which include the Cisco uBR7223, the
Cisco uBR7246, and the Cisco uBR7246 VXR routers.
– Cisco uBR10012 universal broadband router.
• Cisco Cable Cable Modems (CMs) and other Cable CPE Devices
– Cisco uBR904, Cisco uBR905, Cisco uBR924, and Cisco uBR925 cable access routers.
– Cisco CVA122 and Cisco CVA122E cable voice adapters.
Note This guide documents only the cable specific commands. For description of all other Cisco IOS
commands, see the command reference documentation for Cisco IOS Release 12.2, available on
Cisco.com and the Documentation CD-ROM.
Audience
This guide is intended for system administrators and support engineers who configure and maintain the
cable CMTS and CM devices.
Document Organization
This guide includes the following sections:
Title Description
Chapter 1, “Supported Platforms Provides an overview of the Cisco Broadband Cable Command
and Cisco IOS Releases” Reference Guide, including the Cisco IOS releases that are
documented.
Chapter 2, “Cisco CMTS Describes the cable-specific configuration commands that are
Configuration Commands” used to configure the Cisco CMTS features.
Chapter 3, “Cisco CMTS Show Describes the cable-specific show commands used to maintain
Commands” and troubleshoot the Cisco CMTS features.
Chapter 4, “Commands for the Describes the commands that are specific to the
Cisco uBR10012 Router” Cisco uBR10012 router and its Parallel Express Forwarding
(PXF) processors.
Chapter 5, “Cisco CMTS Describes the cable-specific debugging commands for the
Debugging Commands” Cisco CMTS routers.
Chapter 6, “Cable CPE Commands” Describes the cable-specific commands available to the family
of Cisco cable customer premises equipment (CPE) devices.
Appendix A, “Using the ROM Describes how to use the commands available when running the
Monitor” ROM monitor (ROMMON) software on the Cisco CMTS
routers.
Index Comprehensive index for the entire manual.
Related Documents
This section lists the documents that provide more detailed hardware and software information about the
Cisco CMTS routers and Cisco Cable CPE devices documented in this guide. These documents are
available on Cisco.com and the customer documentation CD-ROM.
Document Conventions
Command descriptions use the following conventions:
Convention Description
boldface font Commands and keywords are in boldface.
italic font Arguments for which you supply values are in italics.
[ ] Elements in square brackets are optional.
{x | y | z} Alternative, mutually exclusive, keywords are grouped in braces and separated by
vertical bars.
[x | y | z] Optional alternative keywords are grouped in brackets and separated by vertical
bars.
string A nonquoted set of characters. Do not use quotation marks around the string or
the string will include the quotation marks.
screen font Terminal sessions and information the system displays are in screen font.
boldface screen Information you must enter is in boldface screen font.
font
italic screen font Arguments for which you supply values are in italic screen font.
This pointer highlights an important line of text in an example.
^ The symbol ^ represents the key labeled Control—for example, the key
combination ^D in a screen display means hold down the Control key while you
press the D key.
< > Nonprinting characters, such as passwords, are in angle brackets.
Convention Description
[ ] Default responses to system prompts are in square brackets.
!, # An exclamation point ( ! ) or a pound sign ( # ) at the beginning of a line of code
indicates a comment line.
Note Means reader take note. Notes contain helpful suggestions or references to material not covered in the
publication.
Caution This symbol means reader be careful. In this situation, you might do something that could result in
equipment damage or loss of data.
Obtaining Documentation
Cisco provides several ways to obtain documentation, technical assistance, and other technical
resources. These sections explain how to obtain technical information from Cisco Systems.
Cisco.com
You can access the most current Cisco documentation on the World Wide Web at this URL:
http://www.cisco.com/univercd/home/home.htm
You can access the Cisco website at this URL:
http://www.cisco.com
International Cisco websites can be accessed from this URL:
http://www.cisco.com/public/countries_languages.shtml
Ordering Documentation
You can find instructions for ordering documentation at this URL:
http://www.cisco.com/univercd/cc/td/doc/es_inpck/pdi.htm
You can order Cisco documentation in these ways:
• Registered Cisco.com users (Cisco direct customers) can order Cisco product documentation from
the Networking Products MarketPlace:
http://www.cisco.com/en/US/partner/ordering/index.shtml
• Nonregistered Cisco.com users can order documentation through a local account representative by
calling Cisco Systems Corporate Headquarters (California, USA) at 408 526-7208 or, elsewhere in
North America, by calling 800 553-NETS (6387).
Documentation Feedback
You can submit comments electronically on Cisco.com. On the Cisco Documentation home page, click
Feedback at the top of the page.
You can send your comments in e-mail to bug-doc@cisco.com.
You can submit comments by using the response card (if present) behind the front cover of your
document or by writing to the following address:
Cisco Systems
Attn: Customer Document Ordering
170 West Tasman Drive
San Jose, CA 95134-9883
We appreciate your comments.
This chapter identifies the supported platforms and Cisco IOS Releases for the CMTS and cable CPE
technologies. The Cable CMTS commands operate on the Cisco uBR7100 series routers,
Cisco uBR7200 series routers, and Cisco uBR10012 Cable Modem Termination Systems (CMTS)
universal broadband routers. As of the date of this manual’s publication, this guide lists the commands
that are found in the Cisco IOS releases shown in Table 1-1:
The Cable CPE commands operate on the following Cisco cable CPE platforms and Cisco IOS Releases:
This section describes the cable-specific commands that configure the Cisco Cable Modem Termination
System (CMTS) universal broadband routers. Refer to the following sections for more information:
• Supported Platforms and Cisco IOS Releases, page 2-1—Describes the Cisco CMTS platforms and
Cisco IOS releases that support the commands listed in this section.
• CMTS Configuration Commands, page 2-3—Describes the cable-specific configuration commands
that are used to configure and maintain the Cisco CMTS features. (For cable-specific show
commands, see Chapter 3, “Cisco CMTS Show Commands.”)
Tip This section documents only cable-specific commands. For non-cable-specific commands, see the
command reference documentation for Cisco IOS Release 12.2, available on Cisco.com and the
Documentation CD-ROM. For information about debugging commands for the Cisco CMTS routers, see
Chapter 5, “Cisco CMTS Debugging Commands.”
Note Not all Cisco IOS releases support all Cisco CMTS platforms. See the release notes for each Cisco IOS
release for details on which platforms are supported.
Tip This section documents only cable-specific configuration commands. For non-cable-specific commands,
see the command reference documentation for Cisco IOS Release 12.2, available on Cisco.com and the
Documentation CD-ROM.
• cable vc-map
• card
• channel-id
• clear cable dsg
• clear cable flap-list
• clear cable hop
• clear cable host
• clear cable load-balance
• clear cable logging
• clear cable modem counters
• clear cable modem delete
• clear cable modem flap-counters
• clear cable modem lock
• clear cable modem offline
• clear cable modem reset
• clear cable secondary-ip
• clear hccp counters
• clear packetcable gate counter commit
• cpe max
• download
• enabled
• enforced qos-profile
• frequency
• hccp authentication
• hccp authentication key-chain
• hccp bypass version
• hccp channel-switch
• hccp check version
• hccp ds-switch
• hccp lockout
• hccp protect
• hccp resync
• hccp revertive
• hccp reverttime
• hccp switch
• hccp timers
• hccp track
• hccp unlockout
• hccp working
• ip dhcp relay information option
• ip dhcp smart-relay
• monitoring-duration
• option
• packetcable
• packetcable authorize vanilla-docsis-mta
• packetcable element-id
• packetcable gate maxcount
• packetcable timer
• penalty-period
• ping docsis
• privacy
• registered qos-profile
• service-class
• snmp manager
• snmp-server enable traps cable
• snmp-server enable traps docsis-cmts
• timestamp
• upstream freq-range
access-denied
To create a DOCSIS configuration file that disables network access to the CPE devices that are attached
to the CM, use the access-denied command in cable config-file configuration mode. To enable access,
use the no form of this command.
access-denied
no access-denied
Usage Guidelines This command sets the Network Access Control Object in the DOCSIS configuration file. If set to 1 (the
default of no access-denied), the CPE devices behind the CM are allowed to access the network. If set
to 0 (access-denied) to disable network access for the CPE devices, the CM must not forward traffic
from its attached CPE devices.
For normal operation, the CM must be set to allow access (the default). However, to deny service for
reasons such as nonpayment or unauthorized use of services, the access-denied command can be used.
Examples The following example shows how to disable network access for the CPE devices that are connected to
the CM:
router(config)# cable config-file disable.cm
router(config-file)# access-denied
router(config-file)# exit
Command Description
download Specifies download information for the configuration file.
frequency Specifies downstream frequency.
option Provides config-file options.
privacy Specifies privacy options for baseline privacy images.
service-class Specifies service class definitions for the configuration file.
snmp manager Specifies Simple Network Management Protocol (SNMP) options.
timestamp Enables time-stamp generation.
activate-rule at-byte-count
To specify the number of bytes that a subscriber can transmit during the monitoring period, use the
activate-rule at-byte-count command in enforce-rule configuration mode. To reset the rule to its default
values, use the no form of this command.
Syntax Description kbytes Maximum number of kilobytes that the subscriber can transmit in the
specified direction during the monitoring period. The valid range is 1
to 4294967 kilobytes, with a default of 0 (no limit).
Note To reset the byte count to 0, use the no form of this command.
downstream Specifies that the byte count applies to traffic in the downstream
direction.
upstream Specifies that the byte count applies to traffic in the upstream direction
(default).
enforce (Optional) Specifies that the enforce-rule QoS profile should be
applied automatically if a user violates their registered QoS profile.
Note You must have previously configured a registered QoS profile,
using the registered qos-profile command, before being able
to use the enforce option.
Defaults The kbytes value defaults to 0 (no limit), upstream direction, and enforce-rule QoS profiles are not
automatically applied (no enforce)
Usage Guidelines The activate-rule at-byte-count command specifies the maximum number of bytes that a subscriber can
transmit during the monitor window period (see the monitoring-duration command). If a subscriber
transmits traffic beyond this maximum value, the CMTS considers the subscriber to be over-consuming.
If the optional enforce keyword has been specified for an enforce-rule, the CMTS automatically
switches over-consuming subscribers to the enforced QoS profile (see the enforced qos-profile
command). The enforced QoS profile remains in force during the penalty time period (see the penalty-
period command).
An enforce-rule can be created for only one direction, either upstream or downstream. To activate
subscriber traffic management for both the upstream and downstream directions, create two different
enforce rules, with one rule’s activate-rule command specifying the downstream direction and the
other rule specifying the upstream direction.
When you change the configuration of a currently active enforce-rule, that rule begins using the new
configuration immediately to manage the cable modems tracked by this enforce-rule.
Note You can create an enforce-rule that is a duplicate of an existing enforce-rule, but the duplicate rule is not
activated and applied to service flows until at least one of its parameters is changed so that it has a unique
configuration.
Examples The following example shows a typical activate-rule command for the downstream direction:
Router# configure terminal
Router(config)# cable qos enforce-rule residential
Router(enforce-rule)# activate-rule at-byte-count 20 downstream
Router(enforce-rule)# exit
Router(config)#
The following example shows a typical activate-rule command for the upstream direction. The enforce
option is also added so that the enforce-rule QoS profile is automatically applied to users who exceed
their registered profile:
Router# configure terminal
Router(config)# cable qos enforce-rule test
Router(enforce-rule)# activate-rule at-byte-count 5 upstream enforce
Router(enforce-rule)# exit
Router(config)#
The following example shows the same command being given for a second enforce-rule. The system
rejects the command because it is a duplicate of an existing rule, using the same QoS profile and
direction. You must change at least one of this rule’s parameters to make it unique before it is mapped
and applied to service flows.
Router# configure terminal
Router(config)# cable qos enforce-rule test2
Router(enforce-rule)# activate-rule at-byte-count 5 upstream enforce
Enforce-rule test2 won't be mapped to service flows as it is duplicate of test1 with same
registered qos-profile 5 and same direction
Router(enforce-rule)# exit
Router(config)#
Command Description
penalty-period Specifies the time period that an enforced quality of service (QoS) profile
should be used for subscribers that violate their registered QoS profile.
registered qos-profile Specifies the registered Quality of Service (QoS) profile that should be used
for this enforce-rule.
show cable qos Displays the quality of service (QoS) enforce-rules that are currently
enforce-rule defined.
show cable Displays subscribers that are violating their registered quality of service
subscriber-usage (QoS) profiles.
cable arp
To activate cable Address Resolution Protocol (ARP), use the cable arp command in cable interface or
subinterface configuration mode. To block ARP requests for CMs, use the no form of this command.
cable arp
no cable arp
Usage Guidelines ARP is an Internet protocol used to map IP addresses to MAC addresses on computers and other
equipment installed in a network. You must activate ARP requests so that the Cisco CMTS can perform
IP address resolution on the downstream path.
Occasionally, you might want to use the no cable arp and clear arp-cache commands to block out new
ARP requests and clear the existing ARP table. In this situation, the Cisco CMTS will retain the ARP
addresses of currently online CMs (CMs with a known IP address) and will continue to send ARP
requests for those CMs when those ARP entries time out or are cleared, so that those CMs can continue
to remain online. ARP requests for CMs that are currently offline and for any other unknown IP
addresses, however, will remain blocked until ARP requests are reenabled on the downstream using the
cable arp command.
Note Using the no cable arp and no cable proxy-arp commands shifts all responsibility for the management
of the IP addresses used by CMs and CPE devices to the DHCP server and provisioning system.
Tip You can expect to see a temporary spike in CPU usage after initially giving the no cable arp command,
because of the need to verify CPE IP addresses. CPU usage drops after the router has verified and learned
all of the CPE IP addresses that are currently online. (This same situation occurs after initially enabling
the cable source-verify dhcp command, because the router must send a DHCP LEASEQUERY request
for every unknown CPE IP address.)
Examples The following example shows how to activate cable ARP requests for port 0 on the cable interface line
card installed in slot 6 of the Cisco CMTS:
router(config)# interface cable 6/0
router(config-if)# cable arp
router(config-if)#
The following example shows how to activate cable ARP requests for port 0 on the cable interface line
card installed in slot 6, subinterface 1, of the Cisco CMTS:
router(config)# interface cable 6/0.1
router(config-subif)# cable arp
router(config-subif)#
Syntax Description reply-accept number Configures the cable interface to accept only the specified number of ARP
window-size reply packets every window-size seconds for each active Service ID (SID) on
that interface. The cable interface drops ARP reply packets for a SID that
would exceed this number.
• number = Number of ARP reply packets that is allowed for each SID
within the window time period. The allowable range is 0 to 20 packets,
with a default of 4 packets. If number is 0, the cable interface drops all
ARP reply packets.
• window-size = Size of the window time period, in seconds, in which to
monitor ARP replies. The valid range is 1 to 5 seconds, with a default of
2 seconds.
Note Cisco IOS Release 12.3(9a)BC introduces enhanced command
option syntax for the cable arp filter command, where number and
window-size values are optional for reply-accept and request-send
settings.
request-send number Configures the cable interface to send only the specified number of ARP
window-size request packets every window-size seconds for each active SID on that
interface. The cable interface drops ARP requests for a SID that would
exceed this number.
• number = Number of ARP request packets that is allowed for each SID
within the window time period. The allowable range is 0 to 20 packets,
with a default of 4 packets. If number is 0, the cable interface does not
send any ARP request packets.
• window-size = Size of the window time period, in seconds, in which to
monitor ARP requests. The valid range is 1 to 5 seconds, with a default
of 2 seconds.
Note Cisco IOS Release 12.3(9a)BC introduces enhanced command
option syntax for the cable arp filter command, where number and
window-size values are optional for reply-accept and request-send
settings.
Defaults ARP packets are not filtered, which means the Cisco CMTS router accepts all ARP reply packets and
sends all ARP request packets.
Usage Guidelines Viruses, worms, and theft-of-service attacks can generate a large volume of ARP requests on a cable
interface. In some situations, the volume of ARP traffic can become so large that it throttles all other
traffic.
To control the number of ARP replies and ARP requests that are allowed for each SID on a cable
interface, use the cable arp filter command. This command configures the interface so that it accepts
only a certain number of ARP reply or request packets per a specified time period. If a SID generates
more ARP packets than what is allowed, the cable interface drops the excessive traffic.
By default, no ARP filtering is done. ARP filtering is enabled on individual cable interfaces, and you
can choose to filter ARP packets only on the specific cable interfaces that require it. You can further
choose to filter only ARP request packets, only ARP reply packets, or both. You can configure different
threshold values on each interface, allowing you to customize the feature for each interface’s traffic
patterns.
If using bundled cable interfaces, the Cable ARP Filtering feature is configured separately on the master
and slave interfaces. This allows you to configure the feature only on the particular interfaces that require
it.
Tip Disabling the cable ARP filtering feature, using the no cable arp filter command, does not reset the ARP
packet counters. The ARP packet counters do not increment when cable ARP filtering is disabled, but
the counters retain their current values until the interface counters are specifically cleared, using the
clear counters command.
http://www.linksys.com/Download
For the release notes for the latest revision of the firmware, see the following URL on the Linksys web
site:
http://www.linksys.com/download/vertxt/befw11s4v4_ver.txt
Examples The following example shows how to filter cable ARP reply packets, so that the cable interface accepts
a maximum of 15 ARP replies every three seconds per SID:
The following example shows how to filter cable ARP request packets, so that the cable interface sends
a maximum of 10 requests per second per SID:
Router(config)# interface cable 6/0
Router(config-if)# cable arp filter request-send 10 1
Router(config-if)#
The following example shows how to enable the filtering of cable ARP request and reply packets on a
cable interface, using the default values of 4 packets per CPE per every 2 seconds:
Router(config)# interface cable 3/0
Router(config-if)# default cable arp filter reply-accept
Router(config-if)# default cable arp filter request-send
Router(config-if)# end
Router# show running-config | include filter
Router#
The following example shows how to disable the filtering of cable ARP request and reply packets on a
cable interface:
Router(config)# interface cable 1/0
Router(config-if)# no cable arp filter reply-accept
Router(config-if)# no cable arp filter request-send
Router(config-if)#
cable bundle
To configure a cable interface to belong to an interface bundle, use the cable bundle command in cable
interface configuration mode. To delete a cable interface bundle definition, use the no form of this
command.
Syntax Description n Specifies the bundle identifier. Valid range is from 1 to 255.
master (Optional) Defines the specified interface as the master.
Usage Guidelines You can configure a maximum of four interface bundles. In each bundle, specify one interface as the
master interface by using the optional master keyword. The cable interface that is designated as master
is configured with Layer 3 configuration such as primary and secondary IP addresses and other Layer 3
specific configuration commands such as the cable arp command.
The following guidelines are required when using bundled cable interfaces:
• Configure an IP address only on the master interface. Any attempt to add an interface to a bundle is
rejected, if an IP address is configured and the interface is not specified as master interface.
• You must specify all generic IP networking information (IP address, routing protocols, switching
modes, and so on) on the bundle master interface. Do not specify generic IP networking information
on bundle slave interfaces.
• If you attempt to add an interface to a bundle as slave interface and an IP address is assigned to this
interface, the command fails. You must remove the IP address configuration before you can add the
interface to a bundle.
• If you have configured an IP address on a bundled interface and the interface is not the master
interface, a warning message appears.
• Do not create subinterfaces on a slave interface. In Cisco IOS Release 12.2(15)BC2 and later
releases, this is specifically prohibited. In prior releases, a warning message appeared when trying
to create a subinterface on a slave interface, but the subinterface was still created.
Specify generic (that is, not downstream or upstream) cable interface configurations, such as source-
verify or Address Resolution Protocol (ARP) handling, on the master interface. Do not specify generic
configuration on nonmaster interfaces.
If you configure an interface as part of a bundle and it is not the master interface, all generic cable
configuration for this interface is removed. This includes the IP address, access groups, PIM
configuration, and any other IP Layer 3 configurations. The master interface configuration then applies
to all interfaces in the bundle.
Tip We recommend configuring the no ip address command on all slave interfaces. This command is
optional but recommended, because the show ip interface brief command reports an interface as being
not OK if its configuration does not include some form of the ip address command. Specifying no ip
address corrects this.
When creating subinterfaces over the bundle master, the bundle master is not assigned any IP address
and only the subinterfaces are assigned IP addresses, helper addresses, and other Layer 3 configurations.
The reason the bundle master is not assigned an IP address is because CMs are associated with
subinterfaces rather than with a bundle master.
Note Cable interface bundling is applicable only in two-way cable configurations. It is not supported in telco-
return configurations.
If you shut down or remove the master interface in a bundle, no data packets is sent to any of the
interfaces in this bundle. Packets are still physically received from nonmaster interfaces that have not
been shut down, but those packets are discarded. This means that CMs connected to those interfaces are
not disconnected immediately, but CMs coming online are not able to obtain an IP address, download
their configuration file, or renew their IP address assignment if the DHCP lease expires.
If you shut down a slave interface, only this shutdown interface is affected.
Note When using bundled interfaces, the show interface cable command divides the interface counters
between the master and slave interfaces. The output for the master interface shows the upstream packets
per second count, while the output for the slave interfaces shows the downstream packets per second
count.
Examples See the following example to configure interface 25 to be the master interface:
Router(config)# interface cable 3/0
Router(config-if)# cable bundle 25 master
Router(config-if)#
07:28:17: %UBR7200-5-UPDOWN: Interface Cable3/0 Port U0, changed state to down
The following example shows the error message you get if you try to configure an interface with an
IP address that is not the master interface:
Router(config)# interface cable 3/0
Router(config-if)# cable bundle 5
Please remove ip address config first then reenter this command
Router(config-if)#
The following example shows how to remove a cable interface from a bundle:
Router(config)# interface cable 5/1/0
Router(config-if)# no cable bundle 5
Router(config-if)#
Note When you remove a slave cable interface from a bundle (using the no cable bundle command), you must
manually reconfigure all of the Layer 3 IP information on the interface, before cable modems can resume
communicating on that interface.
Usage Guidelines This command resets any counters that were displayed from the last time the show controllers clock-
reference command was used.
This command supports the Cisco CMTS clock feature set, which provides a synchronized clock for
improved Voice-over-IP (VoIP) operations. The clock feature set requires one of the following
configurations:
• A Cisco uBR10012 router with one or two TCC+ cards that are connected to an external national
clock source.
• A Cisco uBR7246 VXR router using a Cisco uBR-MC16S, Cisco uBR-MC16E, Cisco uBR-
MC28C, or Cisco uBR-MC28C-BNC cable interface line card. The router must also be equipped
with a Cisco cable clock card and be running Cisco IOS Release 12.1(1a)T1, Cisco IOS
Release 12.1(2)EC1, or a later release. The Cisco cable clock card should be connected to an
external national clock source.
Only these cable interface cards support the external clock card reference from a clock card to distribute
that signal to CMs or set-top boxes (STBs) attached to the specific network segments. You can use other
cable interface cards, such as the Cisco uBR-MC16C, with the clock card, but these other cable
interfaces will not synchronize their downstream SYNC messages with the external clock source.
Each CM or STB must also support VoIP applications and the clock feature set. For example, the
Cisco uBR924, running Cisco IOS Release 12.0(7)T or later releases, supports the clock card feature
automatically.
Note The show controllers clock-reference command might display compare errors on the Cisco uBR10012
router because there could be a slight delay at system startup before the TCC+ cards synchronize with
each other. These initial compare errors can be ignored and cleared with the cable clock clear-counters
command.
Examples The following example shows how to reset all counters that are displayed for the clock card:
router# cable clock clear-counters
router#
Syntax Description primary Forces the primary source to act as the clock reference.
secondary Forces the secondary source to act as the clock reference.
Defaults The clock card automatically uses the primary external source, if available. If the primary source fails,
the clock card enters holdover mode and, after a few seconds, switches to the secondary external source.
The clock card switches back to the primary source when it becomes available.
Usage Guidelines This command overrides the default behavior of the clock card when the clock card is in holdover mode.
If the clock card is not in holdover mode, this command is ignored. You cannot force the reference to a
port if the clock card is in free-running mode.
Note The clock card enters holdover mode if the forced reference is lost, even if the other external reference
is available.
To support the clock feature set in VoIP configurations, a Cisco uBR7246 VXR chassis, equipped with
a clock card; and a Cisco uBR-MC16S, a Cisco uBR-MC16E, or a Cisco uBR-MC28C cable interface
line card must be used running Cisco IOS Release 12.1(1a)T1 or later releases. Only these cable
interface line cards support the external clock card reference from a clock card to distribute that signal
to CMs or set-top boxes (STBs) attached to the specific network segments. You can use other cable
interface cards, such as the Cisco uBR-MC16C, with the clock card, but these other cable interfaces will
not synchronize their downstream SYNC messages with the external clock source.
Each CM or STB must also support VoIP applications and the clock feature set. For example, the
Cisco uBR924, running Cisco IOS Release 12.0(7)T or later releases, supports the clock card feature
automatically.
Examples The following example shows how to force the timing reference for the cable clock card to come from
the secondary external source, when the clock card is in holdover mode:
router(config)# cable clock force secondary
Defaults The clock card does not get its timing reference from the midplane TDM clock.
Usage Guidelines Because the clock card automatically provides the timing reference to the midplane TDM clock, the
midplane cannot in turn act as the reference for the clock card. This means that the cable clock source-
midplane command does not take effect unless a port adapter is configured as the primary clock
reference source for the midplane.
To support the clock feature set in VoIP configurations, a Cisco uBR7246 VXR chassis, equipped with
a clock card; and a Cisco uBR-MC16S, a Cisco uBR-MC16E, or a Cisco uBR-MC28C cable interface
line card must be used running Cisco IOS Release 12.1(1a)T1 or higher releases. Only these cable
interface line cards support the external clock card reference from a clock card to distribute that signal
to CMs or set-top boxes (STBs) attached to the specific network segments. You can use other cable
interface cards, such as the Cisco uBR-MC16C, with the clock card, but these other cable interfaces will
not synchronize their downstream SYNC messages with the external clock source.
Each CM or STB must also support VoIP applications and the clock feature set. The Cisco uBR924,
running Cisco IOS Release 12.0(7)T or later releases, supports the clock card feature automatically.
Examples The following example shows how to set the primary clock reference to the midplane TDM clock:
Router(config)# cable clock source-midplane
Router(config)#
Syntax Description time Specifies the time period, in seconds, that the Cisco CMTS should consider
the current CM/CPE list to be valid. In Cisco IOS Release 12.2(15)BC1 and
earlier releases, the valid range is 0 to 3600 seconds, with a default value of
180 seconds (3 minutes). In Cisco IOS Release 12.2(15)BC2 and later
releases, the valid range is 0 to 86400 seconds, with a default value of 900
seconds (15 minutes).
Defaults 180 seconds (3 minutes)—Cisco IOS Release 12.2(15)BC1 and earlier releases
900 seconds (15 minutes)—Cisco IOS Release 12.2(15)BC2 and later releases
Usage Guidelines The Cisco CMTS maintains an internal list of CMs and CPE devices that are currently connected on its
cable interfaces. The CMTS uses this list to provide the data for various show commands and to respond
to SNMP requests that query the entries in the cdxCmCpeTable table in the CISCO-DOCS-EXT-MIB
MIB.
By default, the Cisco CMTS uses the current list if it is less than 3 minutes old. If the current list is older
than 3 minutes, the Cisco CMTS considers it invalid and rebuilds a new list. This prevents the CMTS
from having to build a new list for every query, which could impact system performance.
You can use the cable cmcpe-list valid-time command to change the length of time that the CMTS
considers the current CM and CPE device list to be valid. This allows you to find the optimum time value
that provides the most current information without affecting the number of CPU cycles that are available
for network processing.
A smaller time period ensures that the CM and CPE device list is more current but it requires more
processing time to maintain the list. A longer time period reduces the load on the processor but the
CM/CPE list might not be current.
If CPU usage dramatically increases when performing SNMP queries of the cdxCmCpeTable table, use
this command to increase the valid list time so that the Cisco CMTS does not have to rebuild the
CM/CPE list more often than needed to respond to the queries.
Tip To find the current valid list time, use the show running-config command and look for the cable cmcpe-
list valid-time command in the output. If the command does not appear, the valid list time is set for its
default value.
Examples The following example shows how to set the valid list time to 60 seconds (1 minute):
Router(config)# cable cmcpe-list valid-time 60
The following example shows how to find the current valid list time setting:
Router# show running-config | include cmcpe-list
cable cmcpe-list valid-time 60
Router#
cable config-file
To create a configuration filename for the Cisco CMTS internal CM configuration file, use the cable
config-file command in global configuration mode. To delete the configuration filename, use the no form
of this command.
Syntax Description filename Specifies the configuration filename to create and edit.
Usage Guidelines A DOCSIS CMTS automatically downloads a DOCSIS configuration file to a CM during its initial
registration procedure. The DOCSIS configuration file configures the CM for its network operations and
includes information such as the maximum number of CPE devices that are supported, the quality of
service (QoS) options provided for the CM, and whether the CM should upgrade to a new software
image.
The DOCSIS specification defines the format of the DOCSIS configuration files, which can be created
by any number of tools. In addition to the other tools that Cisco provides for this purpose, the cable
config-file command can be used to create the DOCSIS configuration files needed for your network.
These configuration files are stored in the Flash memory on the Cisco CMTS and can be automatically
downloaded to the CM as needed.
The cable config-file command creates the DOCSIS configuration file if it does not already exist and
then enters config-file configuration mode. You can then give one of the following subcommands to
create the configuration file:
• access-denied
• channel-id
• cpe max
• download
• frequency
• option
• privacy
• service-class
• snmp manager
• timestamp
Note When a DOCSIS shared secret is configured on the downstream interface (see the cable shared-secret
command), the cable config-file command automatically inserts the appropriate MD5 Message Integrity
Check (MIC) value at the end of the dynamically generated DOCSIS configuration file. You do not need
to specify the DOCSIS shared secret string with the cable config-file command.
After using the config-file subcommands, enter the exit command to leave config-file mode and to save
the configuration file in the Flash memory. After a configuration file is created, it also appears in the
running-configuration file. To delete a configuration file and remove it from Flash memory, use the no
cable config-file command.
To allow CMs to download the configuration files, you must also enable the router’s onboard TFTP
server, using the tftp-server configuration command. Unless you are running on a small lab network,
you should also remove the default limit of 10 TFTP sessions by using the service udp-small-serves
max-servers no limit command.
In addition, the following commands are also recommended:
• cable time-server—Enables the Cisco CMTS to function as a time-of-day (ToD) server.
• ip dhcp pool—Configures the Cisco CMTS as a DHCP server. Otherwise, you need an external
DHCP server.
• ip dhcp ping packets 0—Improves the scalability of the Cisco CMTS DHCP server.
Examples The following example shows two DOCSIS configuration files being configured. The first configuration
file allows each CM to have up to four CPE devices and configures the QoS parameters for its traffic.
The second configuration file denies network access to the CM and its CPE devices.
router# configure terminal
router(config)# cable config-file test.cm
router(config-file)# cpe max 4
router(config-file)# service-class 1 priority 2
router(config-file)# service-class 1 max-upstream 128
router(config-file)# service-class 1 max-downstream 1000
router(config-file)# timestamp
router(config-file)# exit
router(config)# cable config-file denied.cm
router(config-file)# access-denied
router(config-file)# exit
router(config)#
The following is a portion of a typical Cisco IOS configuration file that shows the above two DOCSIS
configuration files, as well as a typical DHCP server configuration:
router# show running-config
...
service udp-small-servers max-servers no-limit
!
cable time-server
!
cable config-file test.cm
cpe max 4
service-class 1 priority 2
Note For complete information on DOCSIS configuration files, see Appendix C in the DOCSIS 1.1 Radio
Frequency (RF) Interface Specification, available on the DOCSIS Cable Labs official web site at
http://www.cablemodem.com/specifications.html.
cable dci-response
To configure how a cable interface responds to DCI-REQ messages for CMs on that interface, use the
cable dci-response command in cable interface configuration mode.
Syntax Description success Configures the interface so that the Cisco CMTS responds to DCI-
REQ messages from CMs on the interface by sending a DCI-RSP
response with the confirmation code of Success (0).
ignore Configures the interface so that the Cisco CMTS ignores DCI-REQ
messages from CMs on the interface. It does not send any DCI-RSP
responses.
reject permanent Configures the interface so that the Cisco CMTS responds to DCI-
REQ messages from CMs on the interface by sending a DCI-RSP
response with the confirmation code of Reject Permanent (4).
reject temporary Configures the interface so that the Cisco CMTS ignores the first four
DCI-REQ messages from a CM on the interface, but on the fifth DCI-
REQ message, the CMTS responds with a DCI-RSP response with
the confirmation code of Reject Temporary (3). The CMTS then
continues to ignore the next seven DCI-REQ messages and then
restarts this process when it receives the twelfth DCI-REQ message.
Defaults The Cisco CMTS responds to DCI-REQ messages from all CMs by sending a DCI-RSP response with
the confirmation code of Success (0).
Usage Guidelines The Device Class Identification (DCI) messages are part of the Media Access Control Specification
section of the DOCSIS 1.1 specification (revision SP-RFIv1.1-I05-000714 and above). A CM can
optionally use the DCI-REQ message to inform the CMTS of certain capabilities, such as whether it is
a CPE-controlled cable modem (CCCM).
The CMTS then responds with one of the following confirmation codes:
• Success—Allows the CM to continue with the registration process.
• Reject Permanent—Instructs the CM to abort its registration process on this downstream channel.
The CM must try all other available downstream channels before attempting to register on this
downstream channel again.
• Reject Temporary—Instructs the CM to reset its DCI-REQ counter, to send another DCI-REQ
message, and to wait for the DCI-RSP before proceeding with the registration process.
Note The CMTS can also respond with an Upstream Transmitter Disable (UP-DIS) message. See the
description of the cable dci-upstream-disable command for details.
Examples The following example shows how to configure the CMTS so that it ignores all DCI-REQ messages from
CMs on the cable interface at slot 6:
router# configure terminal
router(config)# interface c6/0
router(config-if)# cable dci-response ignore
router(config-if)#
The following example shows how to configure the CMTS so that it returns to its default behavior for
the cable interface on slot 6, which is to respond to all DCI-REQ messages from CMs by sending a DCI-
RSP with a Success confirmation code:
router# configure terminal
router(config)# interface c6/0
router(config-if)# cable dci-response success
router(config-if)#
Note The cable dci-response success command does not appear in a startup or running configuration file,
because it is the default configuration for a cable interface.
cable dci-upstream-disable
To configure a cable interface so that it transmits a DOCSIS 1.1 Upstream Transmitter Disable (UP-DIS)
message to a particular CM, use the cable dci-upstream-disable command in cable interface
configuration mode. To remove that configuration and return to the default configuration, use the no
form of this command.
Syntax Description mac-address Specifies the MAC physical layer address for a particular CM.
enable Enables the UP-DIS message for the particular CM, so that when the
CM sends a DCI-REQ message, the CMTS responds by sending an
UP-DIS response.
disable Disables the sending of UP-DIS messages to a particular CM.
Defaults The Cisco CMTS does not transmit UP-DIS messages to any CMs.
Usage Guidelines The DOCSIS 1.1 specification (revision SP-RFIv1.1-I05-000714 and above) allows a CMTS to transmit
an Upstream Transmitter Disable (UP-DIS) message to a CM. If the CM supports the UP-DIS message,
it responds by immediately disabling its upstream transmitter circuitry. The CM must be power-cycled
before it can begin transmitting on the upstream again.
Examples The following example shows the cable dci-upstream-disable command being used to enable the UP-
DIS message for the CM with the MAC address of 0123.4567.89ab.
Router# configure terminal
Router(config)# interface c6/0
Router(config-if)# cable dci-upstream-disable 0123.4567.89ab enable
Router(config-if)# exit
Router(config)# exit
Router#
cable default-phy-burst
To specify a value for the upstream Maximum Traffic Burst parameter for CMs that do not specify their
own value, use the cable default-phy-burst command in cable interface configuration mode. To reset
the maximum burst size to its default, use the no form of this command.
no cable default-phy-burst
Syntax Description burst-size Specifies the maximum number of bytes that are allowed in a burst.
The valid range is 0 to 4096 bytes, with a default of 2000 bytes. A
value of 0 specifies that CMs cannot register unless they specify a
valid burst size.
Note Do not set burst-size to less than 1522 bytes because the
DOCSIS 1.1 specification requires an absolute minimum
value of 1522 bytes for this parameter.
Usage Guidelines The DOCSIS 1.0 specification allows CMs to register without specifying a maximum upstream burst
size, or to register with a value of 0, which means an unlimited burst size. This behavior can interfere
with DOCSIS 1.1 networks because excessively large bursts on an upstream will generate unpredictable
jitter and delay in voice calls. DOCSIS 1.1 CMs can also cause this problem if they register without
enabling fragmentation of packets at the DOCSIS MAC layer.
This command allows you to specify a default burst size for CMs that register without specifying a burst
size or that register with a burst size of 0. It also specifies the maximum size of long data grants if a CM
specifies a size of 0 (unlimited) in the Upstream Channel Descriptor (UCD) packet. If a CM specifies a
long data grant that would exceed the maximum burst size, and the CM is not using DOCSIS
concatenation, the DOCSIS scheduler drops the bandwidth request.
To prevent CMs from registering without defining a burst profile, use this command with a burst-size of
zero. CMs that do not define a burst profile will not be allowed to register and come online.
Note Typically, DOCSIS 1.1 CMs set the maximum upstream transmit burst size to the larger value of 1522
bytes and maximum concatenated burst size (which can be a maximum of 4096 bytes).
The default PHY burst parameter interacts with two other parameters that are configured in the DOCSIS
configuration file:
• DOCSIS 1.1 configuration files can also specify a value for the maximum concatenation burst,
which has a default of 1522 bytes. If this parameter is greater than the default PHY burst size, the
CM can override the default PHY burst when it is using concatenation.
• DOCSIS 1.0 and 1.1 configuration files can also specify a maximum transmit burst size. In DOCSIS
1.1 configurations, this parameter defaults to 3044 bytes, with a minimum of 1522 bytes. DOCSIS
1.0 configuration files could set this parameter to a value lower than 1522 bytes, depending on what
version of the DOCSIS 1.0 specification they support. The CMTS will enforce the lower limit
between the default phy burst and the maximum transmit burst, so you should ensure that all
configuration files in your network specify a minimum of 1522 bytes for the maximum transmit
burst size.
Examples The following example shows the default maximum burst size to 1522 bytes, which is the minimum size
required by the DOCSIS 1.1 specification:
Router(config)# interface cable 5/1
Router(config-if)# cable default-phy-burst 1522
Router(config-if)#
The following example shows the default maximum burst size to 0, which means that a CM must specify
a valid burst profile before the Cisco CMTS allows it to register and come online:
Router(config)# interface cable 5/1
Router(config-if)# cable default-phy-burst 0
Router(config-if)#
The following example shows the default maximum burst size being reset to its default of 2000 bytes:
Router(config)# interface cable 5/1
Router(config-if)# no cable default-phy-burst
Router(config-if)#
cable device
To configure access list for a CM device or host, use the cable device command in privileged EXEC
mode. To remove an access group, use the no access-group option of this command.
Note The cable device command is not supported on the Cisco uBR10012 universal broadband router.
Usage Guidelines For the virtual route forwarding (VRF) syntax of this command, only the IP address option is supported.
Examples The following example shows how to assign an access list to the MAC address of a cable device:
Router# configure terminal
Router(config)# cable device 0010.7b6b.77ed acc 1
Router(config)# exit
Router#
cable dhcp-giaddr
To modify the GIADDR field of DHCPDISCOVER and DHCPREQUEST packets with a Relay IP address
before they are forwarded to the DHCP server, use the cable dhcp-giaddr command in cable interface or
subinterface configuration mode. To set the GIADDR field to its default, use the no form of this
command.
no cable dhcp-giaddr
Syntax Description policy Selects the control policy, so the primary address is used for CMs and
the secondary addresses are used for hosts and other customer
premises equipment (CPE) devices. This setting is typically used
when the CMs on the interface are configured for routing mode, so
that the CMs and hosts can use IP addresses on different subnets.
strict (Optional, only when the policy keyword is specified) Uses the
GIADDR IP address as the source IP address in the forwarded DHCP
OFFER packet.
By default when using the policy option, the Cisco CMTS changes
the source IP address in the DHCPOFFER packet to match that of the
primary address on the cable interface. Use the strict option to
prevent this behavior, which could interfere with any access lists
applied to the CM when the CM is using a different subnet from the
cable interface’s primary address space.
primary Always selects the primary address to be used for the GIADDR field
for both CMs and CPE devices. This option is typically used for the
Cisco uBR-MC16E card and Cisco uBR7100E series routers to
support EuroDOCSIS operations.
Command Modes Interface configuration and subinterface configuration (cable interface only)
Usage Guidelines You can use this command to modify the GIADDR field of DHCPDISCOVER and DHCPREQUEST
packets to provide a relay IP address before packets are forwarded to the DHCP servers. Use this
command to set a policy option such that primary addresses are used for CMs and secondary addresses
are used for hosts (such as PCs) behind the CMs.
When using multiple secondary subnets, the Cisco CMTS uses the first secondary IP address as the
GIADDR field when forwarding a DHCPDISCOVER request to the DHCP server. If no DHCP server
responds with a DHCPOFFER message after three attempts, the Cisco CMTS uses the next secondary
IP address, up to a maximum of 16 secondary addresses.
Note If you have configured a Cisco CM for routing mode and are also using the cable-modem dhcp-proxy
nat command on the CM, you must configure the corresponding cable interface on the Cisco CMTS with
the cable dhcp-giaddr policy [strict] command.
Caution You cannot use the strict option with the internal DHCP server that is onboard the Cisco CMTS router,
because the strict option requires the use of DHCP relay operation, which is not performed by DHCP
termination points such as the internal DHCP server.
Examples The following example shows how to set the primary address to be used always for GIADDR:
Router# configure terminal
Router(config)# interface cable 3/0
Router(config-if)# cable dhcp-giaddr primary
Router(config-if)#
The following example shows how to set the primary address to be used always for giaddr in the cable
subinterface mode:
Router# configure terminal
Router(config)# interface cable 6/0.1
Router(config-subif)# cable dhcp-giaddr primary
Router(config-if)#
The following example shows how to configure the router so that the primary address is used for CMs
and the secondary addresses are used for hosts. In addition, the GIADDR is used as the source IP address
in forwarded DHCPOFFER packets.
Router# configure terminal
Router(config)# interface cable 5/1/0
Router(config-if)# cable dhcp-giaddr policy strict
Router(config-if)#
Command Description
cable telco-return spd dhcp- Enforces the telco-return CM to use a specific DHCP server.
authenticate
cable telco-return spd dhcp- Identifies the IP address of the DHCP server that the telco-
server return CM must access.
ip dhcp relay information Enables the system to insert the CM MAC address into a
option DHCP packet received from a CM or host and forward the
packet to a DHCP server.
ip dhcp smart-relay Monitors client retransmissions when address pool depletion
occurs.
cable dot1q-vc-map
To map a cable modem to a particular Virtual Local Area Network (VLAN) on a local outbound Ethernet
interface, use the cable dot1q-vc-map command in global configuration mode. To remove this mapping,
or to remove a particular customer’s name from the internal tables, use the no form of this command.
Syntax Description mac-address Specifies the hardware (MAC) address for the cable modem whose traffic is
to be mapped.
ethernet-interface Specifies the outbound interface to which this cable modem should be
mapped. On the Cisco uBR7100 series and Cisco uBR7246VXR routers,
you can specify an Ethernet, Fast Ethernet, or Gigabit Ethernet interface,
depending on what interfaces are actually installed in the chassis.
vlan-id Specifies the ID for the IEEE 802.1Q Virtual Local Area Network (VLAN)
that should be used to tag the frames for this cable modem. The valid range
is 1 to 4095, with no default.
Note The switches acting as the bridge aggregators might support a lower
number of VLAN IDs. If so, the Cisco CMTS should be configured
within the limits of the switches’ maximum number of VLANs.
cust-name (Optional) Identifies the customer using this VLAN. The cust-name can be
any arbitrary alphanumeric string, up to 127 characters long.
customer cust-name (Optional) Deletes all VCs belong to this customer. The cust-name can be
any arbitrary alphanumeric string, up to 127 characters long.
Usage Guidelines This command maps a cable modem, on the basis of its hardware (MAC) address, to a particular
IEEE 802.1Q VLAN on a particular outbound Ethernet interface. This enables the cable modem’s traffic
to be part of a virtual LAN at the Layer-2 level.
Note To use this command, you must first enable the use of IEEE 802.1Q Layer 2 tunnels, using the cable l2-
vpn-service dot1q command. Then use this command to map individual cable modems to specific
VLANs.
Examples The following example shows how to enable the use of Layer 2 tunnels and then map specific CMs to
VLANs on a specific interface:
Router# config terminal
Router(config)# cable l2-vpn-service dot1q
Router(config)# cable dot1q-vc-map 000C.0e03.69f9 GigabitEthernet 1/0 4
Router(config)# cable dot1q-vc-map 0010.7bed.9c95 GigabitEthernet 1/0 4
Router(config)# exit
Router#
The following example shows the same command as above, but this time each VLAN is identified by the
customer that is using it:
Router# config terminal
Router(config)# cable l2-vpn-service dot1q
Router(config)# cable dot1q-vc-map 000C.0e03.69f9 GigabitEthernet 1/0 4 ENTERPRISE-CO1
Router(config)# cable dot1q-vc-map 0010.7bed.9c95 GigabitEthernet 1/0 4 ENTERPRISE-CO2
Router(config)# exit
Router#
The following example shows how to remove the Layer 2 mapping for a specific cable modem. This
particular cable modem’s traffic is then routed using the normal Layer 3 routing processes.
Router# config terminal
Router(config)# no cable dot1q-vc-map 000C.0e03.69f9 GigabitEthernet 1/0 4
Router(config)# exit
Router#
Syntax Description A Annex A. The downstream uses the EuroDOCSIS J.112 standard.
B Annex B. The DOCSIS-compliant cable plants that support North American channel plans
use ITU J.83 Annex B downstream radio frequency.
Defaults Annex B for all Cisco cable interface cards other than the Cisco uBR-MC16E. Annex A, if using the
Cisco uBR-MC16E cable interface line card and the Cisco uBR7111E and Cisco uBR7114E universal
broadband routers.
Usage Guidelines The MPEG framing format must be compatible with the downstream symbol rate you set. Annex B is
the North America (DOCSIS) standard and Annex A is the European (EuroDOCSIS) standard. You
should review your local standards and specifications for downstream MPEG framing to determine
which format you should use.
The Cisco uBR-MC16U/X, Cisco uBR-MC28U/X, and Cisco uBR-MC5X20U cable interface line cards
support both Annex A and Annex B operation. However, on the Cisco uBR-MC28U/X, both
downstreams must be configured for the same mode (either both Annex A or both Annex B).
On the Cisco uBR-MC16U and Cisco uBR-MC28U (with integrated upconverter), the IF frequency is
fixed at 44 MHz for both Annex A and Annex B modes of operation. On the Cisco uBR-MC16X and
Cisco uBR-MC28X (without integrated upconverter), the IF frequency is set to 36.125 MHz in Annex A
mode and 44 MHz in Annex B mode.
Note This command can be used to change the symbol rate, alpha, and other parameters for compliance with
EuroDOCSIS (annex A), or DOCSIS (annex B). Annex A is not supported on the Cisco uBR-MC1xC,
Cisco uBR-MC16B, Cisco uBR-MC16S, and Cisco uBR-MC28C cable interface line cards. Annex B is
not supported on the Cisco uBR-MC16E card and on the Cisco uBR7111E and Cisco uBR7114E
universal broadband routers.
Note The cable interface line card downstream ports and the CMs on the HFC network connected through
these ports must be set to the same MPEG framing format.
Caution In Cisco IOS Release 12.1, only Annex B MPEG framing format is supported.
Tip Changing the MPEG framing format affects the PHY layer on the downstream and disconnects all online
CMs. For this reason, if you are using N+1 HCCP redundancy, you should configure this command on
both the Protect and Working interfaces, so that the PHY layer is properly configured before a
switchover occurs. Otherwise, online CMs could be disconnected when a switchover occurs. (This also
applies to the cable downstream modulation and cable downstream interleave-depth commands.)
Examples The following example shows how to set the MPEG framing format to Annex A:
Router# configure terminal
Router(config)# interface cable 1/0
Router(config-if)# cable downstream annex A
Router(config-if)#
The following example shows how to set the MPEG framing format to Annex B:
Router# configure terminal
Router(config)# interface cable 4/0
Router(config-if)# cable downstream annex B
Router(config-if)#
Syntax Description id Specifies a downstream channel ID. Valid values are from 0 to 255.
Defaults The unit number of the downstream device, starting with a value of 1.
Usage Guidelines Use this command to make sure that each downstream channel has a unique ID when there are multiple
Cisco CMTS routers at a headend facility.
Cisco IOS assigns the default ID number of each downstream channel in the order in which devices
connected to the downstream channels appear to the CMTS. The downstream channel connected to the
first device that appears to the CMTS is configured with a default ID of 1, the downstream channel
connected to the second device that appears is configured with an ID of 2, and so on.
Assigning default values in this manner guarantees unique values for all downstreams in a single
Cisco CMTS chassis. However, this does not guarantee unique channel IDs when more than one CMTS
exists on a network, so this command can be used to override the defaults and guarantee unique IDs.
Caution Changing the downstream channel ID of an active channel automatically disconnects all connected CMs
and forces them to go offline and reregister with the CMTS, as required by the DOCSIS specifications.
Examples The following example shows how to configure the downstream channel on the cable interface line card
in slot 6 of a Cisco CMTS router with a channel ID of 44:
router(config-if)# cable downstream channel-id 44
The following example shows how to restore the downstream channel ID configuration to the default
configuration:
router(config-if)# cable downstream channel-id
Note The no form of this command is supported only on the Cisco uBR-MC16U/X, Cisco uBR-MC28U/X,
and Cisco uBR-MC5X20S/U cable interface line cards, and on the Cisco uBR7100 series universal
broadband router.
Syntax Description down-freq-hz The known center frequency of the downstream carrier in Hz (the valid
range is 55,000,000 to 858,000,000). The usable range depends on whether
the downstream is configured for DOCSIS or EuroDOCSIS operations:
• DOCSIS = 88,000,000 to 855,000,000 MHz
• Extended frequency range = 70,000,000 to 855,000,000 MHz
• EuroDOCIS = 112,000,000 to 858,000,000 MHz
The Cisco IOS supports a superset of these standards, and setting a center
frequency to a value outside these limits violates the DOCSIS or EuroDOCSIS
standards. Cisco does not guarantee the conformance of the downstream and
upconverter outputs when using frequencies outside the DOCSIS or
EuroDOCSIS standards.
Defaults Disabled. On the Cisco uBR7100 series routers, the default downstream center frequency for the
integrated upconverter is 500 MHz.
Release Modification
12.2(15)CX Support was added for the Cisco uBR-MC16U/X and Cisco uBR-MC28U/X
cable interface line cards.
12.2(15)BC2 Support was added for the extended frequency range and for the
Cisco uBR-MC5X20U cable interface line card. In addition, the command
was changed to accept only center frequencies in 250 KHz increments
(previously, the command allowed 125 KHz increments).
Usage Guidelines This command is either optional or required, depending on the cable interface line card being used.
• On the Cisco uBR7100 series routers using the integrated upconverter (the DS0 RF output), and on
cable interfaces that support integrated upconverters (such as the Cisco uBR-MC16U,
Cisco uBR-MC28U, and Cisco uBR-MC5X20U), this command configures the frequency for the
integrated upconverter. The no form of this command unsets the frequency and disables the output
from the integrated upconverter.
• For cable interfaces that use an external upconverter (such as the Cisco uBR-MC16S and the DS0
(IF) output on Cisco uBR7100 series routers), this command is informational-only, because it does
not affect the external upconverter. The external upconverter must be programmed separately with
the appropriate center frequency.
Tip We recommend configuring this command on all cable interfaces, even those that are using external
upconverters. This is because this command is required to enable the downstream frequency override
feature and for N+1 line card redundant operation when using SNMP-capable external upconverters.
The downstream frequency of your RF output must be set to match the expected input frequency of your
upconverter. To do this, you enter the fixed center frequency of the downstream channel for the
downstream port. (You can also select a default that does not set a specific fixed value.) The valid range
for a fixed center frequency is 54,000,000 to 858,000,000 Hz. The center frequency is also used to
configure an IF-to-RF upconverter that must be installed in your downstream path.
The digital carrier frequency is specified to be the center of a 6.0 MHz channel. For example, EIA
channel 95 spans 90.000 to 96.000 MHz. The center frequency is 93.000 MHz, which is the digital
carrier frequency that should be configured as the downstream frequency. The typical range for current
CATV headends is 88,000,000 to 860,000,000 Hz.
In Cisco IOS software releases before Cisco IOS Release 12.2(15)BC2, the cable downstream
frequency command allowed the center frequency to be specified in 125 KHz increments. In Cisco IOS
Release 12.2(15)BC2 and later releases, this was changed to allow only 250 KHz increments, because
of the requirements of the Broadband Processing Engine cable interface line cards that use an internal
upconverter (Cisco uBR-MC16U, Cisco uBR-MC28U, and Cisco uBR-MC5X20S/U).
Note DOCSIS allows downstreams to use any center frequency within 88,000,000 to 855,000,000 MHz.
However, when most cable modems first come online, they initially start scanning the downstream for
the frequencies that are in the NTSC channel plan. If a valid downstream is not found among those
frequencies, the cable modems then beginning scanning the remaining frequencies. For the fastest and
most efficient registration times, we recommend configuring downstreams for the frequencies that are
specified in the NTSC channel plan.
Examples The following example shows how to set the downstream center frequency display value:
router(config)# interface c6/0
router(config-if)# cable downstream frequency 96000000
router(config-if)#
Syntax Description continuous-wave Outputs an unmodulated carrier signal on the downstream, shutting down
normal data network operations.
prbs Outputs a Pseudo Random Bit Stream (PRBS) test signal on the downstream,
shutting down normal data network operations.
Defaults The downstream interface is enabled for normal data use (cable downstream if-output).
Usage Guidelines Typically, a downstream is configured to output a modulated signal, using the cable downstream if-
output command, allowing data transmissions to be sent over the HFC cable network. However, this
command can also be used to test the cable plant or to shut down the interface completely:
• cable downstream if-output continuous-wave—Generates an unmodulated, continuous sine wave
on the downstream interface. You can use a spectrum analyzer to verify the frequency, amplitude,
and power of the wave. The test signal continues on the downstream until you resume normal
modulated operations using the cable downstream if-output command.
• cable downstream if-output prbs—Generates a PRBS test signal on the downstream interface. You
can use a spectrum analyzer to verify the frequency, amplitude, and power of the wave. The test
signal continues on the downstream until you resume normal modulated operations using the cable
downstream if-output command.
• no cable downstream if-output—Terminates all signal output and shuts down the downstream
interface. The interface remains shut down until you reactive the downstream using the cable
downstream if-output command.
Note Generating a PRBS or continuous-wave test signal or shutting down the interface automatically stops the
modulated carrier data signal and disconnects all CMs on that downstream. These commands should not
be used on a live network except as part of troubleshooting major network problems.
Examples The following example shows how to enable downstream port 0 on a cable interface:
router# configure terminal
router# interface c6/0
router(config-if)# cable downstream if-output
router# (config-if)#
The following example shows a PRBS test signal being generated on a downstream for a period of time.
The downstream is then shut down so that the test engineer can verify that no signal is being sent on the
downstream. After the tests have been run, the downstream is reactivated for normal modulated data use:
router# configure terminal
router# interface c6/0
router(config-if)# cable downstream if-output prbs
(the signals are verified by a spectrum analyzer...)
router#(config-if)# no cable downstream if-output
(the downstream is checked to verify no signals are being sent on it...)
router#(config-if)# cable downstream if-output
router#(config-if)# exit
router#(config)#
Syntax Description 8 | 16 | 32 | 64 | 128 Indicates the downstream interleave depth in number of rows of
codewords.
Defaults 32
Note This command is not supported on the Cisco uBR-MC16E cable interface line card or on the
Cisco uBR7111E and Cisco uBR7114E universal broadband routers, because the interleave on the
EuroDOCSIS downstream is fixed.
Usage Guidelines This command sets the minimum latency of the system. A higher interleave depth provides more
protection from bursts of noise on the HFC network by spreading out the bits for each codeword over a
greater transmission time.
Interleave transmissions do not transmit each codeword by itself, but instead send bits from multiple
codewords at the same time, so that a noise burst affects the minimum number of bits per codeword,
which allows the Forward Error Correction (FEC) algorithm a greater chance of detecting and correcting
any transmission errors.
A higher interleave depth transmits bits from a greater number of codewords, increasing the efficacy of
the FEC algorithm. However, a higher depth also increases downstream latency, which might slow
TCP/IP throughput for some configurations, so you need to choose an interleave depth that is appropriate
both for your plant’s noise levels and application needs.
If your cable plant is experiencing high noise levels, consider increasing the interleave from the default
of 32 to 64. For plants with exceptionally high noise levels, increase the interleave to 128 to provide the
maximum protection from noise bursts.
Low interleave depth values typically cause some packet loss on typical HFC networks, because burst noise
lasts beyond the error correction block correctable length. However, on cable plants with exceptionally low
noise levels, Cisco recommends initially using the default value of 32, and then trying an interleave of either
16 or 8 to see if this increases performance without increasing the number of errors that result from noise.
Table 2-2 shows interleave characteristics and their relation to each other.
Note Table 2-2 does not apply to EuroDOCSIS cable plants because the interleave depth for EuroDOCSIS
cable interfaces is fixed.
Tip Changing the interleave depth affects the PHY layer on the downstream and disconnects all online CMs.
For this reason, if you are using N+1 HCCP redundancy, you should configure this command on both
the Protect and Working interfaces, so that the PHY layer is properly configured before a switchover
occurs. Otherwise, online CMs could be disconnected when a switchover occurs. (This also applies to
the cable downstream annex and cable downstream modulation commands.)
Examples The following example shows how to configure the downstream interleave depth to 128 microseconds:
Router# configure terminal
Router(config)# interface cable 3/0
Router(config-if)# cable downstream interleave-depth 128
Router(config-if)#
Defaults 64qam
Usage Guidelines Downstream modulation defines the speed in bits per second at which data travels downstream to the
subscriber’s CM. A symbol is the basic unit of modulation. QPSK encodes 2 bits per symbol, 16-QAM
encodes 4 bits per symbol, 64-QAM encodes 6 bits per symbol, and 256-QAM encodes 8 bits per
symbol.
Note Setting a downstream modulation format of 256-QAM requires approximately a 6-dB higher signal-to-
noise ratio (SNR) than 64-QAM at the subscriber’s cable modem. If your network is marginal or
unreliable at 256-QAM, use the 64-QAM format instead.
Tip Changing the modulation format affects the PHY layer on the downstream and disconnects all online
CMs. For this reason, if you are using N+1 HCCP redundancy, you should configure this command on
both the Protect and Working interfaces, so that the PHY layer is properly configured before a
switchover occurs. Otherwise, online CMs could be disconnected when a switchover occurs. (This also
applies to the cable downstream annex and cable downstream interleave-depth commands.)
Examples The following example shows how to set the downstream modulation to 256-QAM:
Router# configure terminal
Router(config)# interface cable 3/0
Router(config-if)# cable downstream modulation 256qam
Router(config-if)#
Usage Guidelines This command is never needed for normal operations, because downstream frequency override is
enabled by default for DOCSIS operations. However, this command can be used to disable the frequency
override feature for test and lab use, so as to force the CMs on that interface to use a particular
downstream frequency, regardless of the signal quality.
Note Because frequency override is enabled by default, this command does not appear as part of a cable
interface’s configuration section in the Cisco CMTS configuration file unless the no cable downstream
override command has been given.
Examples The following example shows how to disable the downstream frequency override feature on a particular
cable interface:
router# configure terminal
router(config)# interface cable 6/0
router(config-if)# no cable downstream override
router(config-if)# exit
router(config)#
Syntax Description token-bucket (Optional) Specifies the token-bucket filter algorithm, which enforces
an average long-term transmission rate while permitting occasional
bursts.
shaping (Optional in Release 12.1 EC, Required in Release 12.2 BC) Enables
rate limiting on the downstream port using the token-bucket policing
algorithm with default traffic shaping parameters.
granularity msec (Optional) Specifies traffic shaping granularity in milliseconds. Valid
values are 1, 2, 4, 8, or 16 milliseconds.
max-delay msec (Optional) Specifies the maximum traffic-shaping buffering delay in
milliseconds. Valid values are 128, 256, 512, or 1028 milliseconds. As
a general guideline, the lower the downstream rates, the higher the
delay should be to ensure full use of the bandwidth.
weighted-discard (Optional) Specifies the weighted discard algorithm.
exp-weight (Optional) Specifies the weight for the exponential moving average of
loss rate. Valid values are from 1 to 4.
Defaults In Cisco IOS Release 12.1 EC and earlier releases, the system defaults to monitoring the traffic to and
from each CM over each 1-second period, and if the CM exceeds its bandwidth quota for that second,
the CMTS drops packets for the rest of the second (no cable downstream rate-limit).
In Cisco IOS Release 12.2 BC and later releases, the token-bucket and shaping keywords are on by
default, and the max-delay option is set to 128 milliseconds (cable downstream rate-limit token-
bucket shaping max-delay 128).
Note In Cisco IOS Release 12.2 BC, do not use the cable downstream rate-limit token command without
specifying the shaping option, because this results in packet drops.
Release Modification
12.0(4)XI, 12.0(5)T1, The shaping keyword was added.
12.1(1)EC1
12.2(4)BC1 Support was added to the 12.2 BC train, and the defaults were changed so
that the shaping keyword is on by default, to accommodate DOCSIS 1.1
requirements.
Usage Guidelines The cable downstream rate-limit command specifies the type of DOCSIS rate limiting that the CMTS
imposes on downstream traffic that is sent to the CMs. When rate-limiting is enabled, traffic to the CM
is examined to ensure it will not exceed the limit set for the CM.
For DOCSIS networks, the best rate limiting algorithm combines the token-bucket and shaping to use
keywords, which is optimized for relatively steady data rates, such as are used for web browser, without
allowing the user to exceed the maximum allowable download rate that is specified in the DOCSIS
configuration file.
Note The token-bucket and shaping options are the default in Cisco IOS Release 12.2 BC and should not be
changed. If using a 64 kbps downstream rate, you can avoid a performance impact by turning off the
shaping option, but this is not recommended for DOCSIS 1.1 operation because it can result in erratic
traffic patterns and packet drops on the downstream.
If a packet would exceed the traffic limits for a CM, the CMTS will buffer the packet, up to the maximum
delay time given by the max-delay option, so that the traffic can be sent at a later time when it would
not violate the maximum downstream traffic limits. If the packet is still too large, or if the volume of
traffic consistently exceeds the traffic limits, even after the delay, the CMTS begins dropping packets.
The default behavior of the cable downstream rate-limit command was changed in Cisco IOS
Release 12.2 BC to accommodate the different requirements of DOCSIS 1.1 operation (which requires
the use of the token-bucket rate-limiting algorithm). This default is optimized for downstream traffic
rates that are higher than 84 kbps.
If you are using a 64 kbps downstream traffic rate on a Cisco CMTS that is running Cisco IOS Release
12.2 BC, you should set the max-delay option to 256 milliseconds to avoid a performance impact on
TCP/IP traffic that uses packets larger than 1024 bytes (such as FTP or HTTP web traffic). Alternatively,
you can set the max-burst option on the cable service class command to 3044, which is two packets of
the minimum size for DOCSIS 1.1 networks.
Decreasing the max-delay value increases how often the packets in the entire queue are processed, while
decreasing the granularity value increases the accuracy of the shaping mechanism. Decreasing these
values, however, could result in a possible increase in CPU processor usage. In most circumstances, this
increase in processor usage is negligible, but it should be monitored whenever fine-tuning the max-delay
or granularity values.
Tip For more information about the DOCSIS 1.1 rate-limiting specifications, see section C.2.2.5.2,
Maximum Sustained Traffic Rate, in the DOCSIS 1.1 specification.
Examples The following example shows how to apply the token-bucket filter algorithm on a Cisco uBR7200 series
router running Cisco IOS Release 12.1 EC:
Router(config)# interface cable 6/0
Router(config-if)# cable downstream rate-limit token-bucket
Router(config-if)#
The following example shows how to apply the token-bucket filter algorithm on a Cisco uBR10012
router running Cisco IOS Release 12.2 BC:
Router(config)# interface cable 5/1/0
Router(config-if)# cable downstream rate-limit token-bucket shaping
Router(config-if)#
The following example shows how to use token-bucket shaping with a max-delay of 256 milliseconds
on a Cisco uBR7100 series router:
Router(config)# interface cable 1/0
Router(config-if)# cable downstream rate-limit token-bucket shaping max-delay 256
Router(config-if)#
Syntax Description power-level Desired RF output power level in dBmV. The valid range is 45 to
63 dBmV.
Note The official range for acceptable power levels in the DOCSIS
specification is 50 to 61 dBmV. Cisco cable interfaces exceed
the DOCSIS specification, but power levels outside the
DOCSIS specifications should be used only in lab and test
environments.
hccp-delta diff-pwr (Protect interfaces only) When using N+1 Hotstandby Connection-
to-Connection Protocol (HCCP) redundancy, the Protect interface
adds the diff-pwr value to the current Working interface’s power
value when a switchover occurs. This allows the router to
accommodate relative differences between the RF power levels in
Working and Protect interfaces. The valid range for diff-pwr is –12 to
+12 dBmV.
hccp-override override-pwr (Protect interfaces only) When using N+1 HCCP redundancy, the
Protect interface uses the override power value instead of the
Working interface’s current power value when a switchover occurs.
This allows the router to accommodate absolute differences between
the RF power levels in Working and Protect interfaces. The valid
range for override-pwr is 45 to 63 dBmV.
Note The official range for acceptable power levels in the DOCSIS
specification is 50 to 61 dBmV. Cisco cable interfaces exceed
the DOCSIS specification, but power levels outside the
DOCSIS specifications should be used only in lab and test
environments.
Usage Guidelines The Cisco IOS command-line interface (CLI) allows the hccp-delta and hccp-override options to be
configured only on a Protect interface (an interface that has been configured with the hccp protect
command). However, it is possible to manually edit a configuration file on a TFTP server so that it
includes these options on a Working interface configuration, and then download that configuration to the
router from the TFTP server.
Take care that if you manually edit Cisco IOS configuration files that you specify these options only on
Protect interfaces. If you specify the hccp-delta or hccp-override option on a Working interface, the
router will modify the configured downstream power with the given power delta or override value.
Examples The following example shows the integrated upconverter on a Cisco uBR7100 series router being
configured for an RF output power level of 45 dBmV:
Router(config)# cable interface 1/0
Router(config-if)# cable downstream rf-power 45
The following example shows the first integrated upconverter on a Cisco uBR10012 router being
configured for an RF output power level of 53 dBmV:
Router(config)# cable interface 5/1/0
Router(config-if)# cable downstream rf-power 53
The following commands shows the first integrated upconverter being set to the default power level of
55 dBmV on the Cisco uBR10012 router:
Router(config)# cable interface 5/1/0
Router(config-if)# no cable downstream rf-power
Router(config-if)# exit
Router(config)#
The following example shows a Protect interface being configured to add 3 dBmV to the current
Working RF power level when a switchover occurs:
Router(config)# cable interface 6/0/0
Router(config-if)# cable downstream rf-power hccp-delta 3
Router(config-if)# exit
Router(config)#
The following example shows a Protect interface being configured to use an RF power level of 48 dBmV
instead of the current Working RF power level when a switchover occurs:
Router(config)# cable interface 6/0/0
Router(config-if)# cable downstream rf-power hccp-override 48
Router(config-if)# exit
Router(config)#
Note The hccp-delta and hccp-override commands configure the power of the Protect interface at the time
of the switchover. To display the RF power currently being used on a cable interface, use the show
controller cable command.
Usage Guidelines By default, the integrated upconverter on the Cisco uBR7100 series router, Cisco uBR-MC16U,
Cisco uBR-MC28U, and the Cisco uBR10-MC5X20S/U cable interface line cards is disabled, and the
downstream port does not output any signal. The no form of this command enables the integrated
upconverter, allowing it to output an RF signal through the downstream port.
However, before a valid DOCSIS downstream signal can be output, the following must also be done:
• A valid downstream RF frequency must be configured using the cable downstream frequency
cable interface command.
• The cable interface must be enabled using the no shutdown command on the cable interface.
Note This command does not affect the IF output from the DS0 downstream port on the Cisco uBR7100 series
router. The Cisco uBR10-MC5X20S/U, Cisco uBR-MC16U, and Cisco uBR-MC28U cable interface
line cards do not provide IF output for their downstream ports.
Examples The following example enables the integrated upconverter on the Cisco uBR7100 series router:
router(config)# cable interface 1/0
router(config-if)# no cable downstream rf-shutdown
The following example enables the second integrated upconverter on a Cisco uBR-MC5X20S cable
interface line card in the Cisco uBR10012 router:
router(config)# cable interface 7/0/1
router(config-if)# no cable downstream rf-shutdown
The following commands must also be given before the DS0 RF port can transmit a valid RF signal:
router(config-if)# cable downstream frequency center-frequency
router(config-if)# no shutdown
router(config-if)# exit
router(config)#
cable dsg
To enable the DOCSIS Set-Top Gateway (DSG) on a cable interface, and to configure its tunnel-mapping
parameters, use the cable dsg command in cable interface configuration mode. To remove the DSG
tunnel from the interface, use the no form of this command.
Syntax Description tunnel-MAC-address Well-known MAC address for the DSG tunnel. The tunnel-MAC-
address could also optionally be an Internet Group Management
Protocol (IGMP) multicast address, using the algorithm for converting
host group IP address to an Ethernet MAC address that is given in RFC
1112. If the MAC address is 0000.0000.0000, the DSG tunnel uses the
algorithm given in RFC 1112 to derive the multicast address for the
tunnel.
Note You can specify only Global Scope (224.0.1.0 through
238.255.255.255) and Administratively Scoped (239.0.0.0
through 239.255.255.255) addresses. You cannot use Local
Scope addresses (224.0.0.0 through 224.0.0.255).
group-ip-address Multicast group IP address for the DSG stream.
CA-vendor-name Name for the Conditional Access (CA) vendor that owns the DSG
tunnel. This parameter is a string up to 7 characters in length and
should match the vendor of the CA server. A maximum of four vendors
per router are supported.
Usage Guidelines This command enables DSG operations on the cable interface, creating a DSG tunnel that uses the
specified IGMP multicast address and well-known MAC address. If you specify a tunnel MAC address
of 0.0.0, the command converts it into an Ethernet multicast MAC address, using the following
algorithm, which is given in RFC 1112:
An IP host group address is mapped to an Ethernet multicast address by placing the low-order 23-
bits of the IP address into the low-order 23 bits of the Ethernet multicast address 01-00-5E-xx-xx-
xx (hex). Because there are 28 significant bits in an IP host group address, more than one host group
address may map to the same Ethernet multicast address.
For example, if you specify the command cable dsg 0.0.0 228.9.9.9 AAA, the command uses the IGMP
IP address of 228.9.9.9 to generate the MAC address of 0100.5E09.0909 for the DSG tunnel. If the IGMP
address were 228.129.9.9, the resulting MAC address would be 0100.5E01.0909.
Entering the cable dsg command also automatically configures the interface for the appropriate IGMP
static group, using the ip igmp static-group command. Do not manually enter another ip igmp static-
group command for this interface, because the system assumes that this IGMP configuration is for a
separate configuration that cannot be used by the DSG subsystem.
Note If any previously configured static groups exist on this interface, you should remove those other ip igmp
static-group commands on a cable interface before you can enter the cable dsg command. If you do not
remove those other groups, the cable dsg command displays a warning notifying you that you should
remove them.
The no cable dsg command similarly automatically removes the IGMP static group from the interface
by issuing the no ip igmp static-group command. Do not manually remove this static group yourself.
In addition, you must have enabled Protocol Independent Multicast (PIM) on the cable interface, using
the ip pim interface command, before enabling and configuring DSG operations. The DOCSIS Set-Top
Gateway feature supports the following PIM modes:
– sparse-mode—Sparse mode of operation.
– sparse-dense-mode—The interface is treated in either sparse mode or dense mode of operation,
depending on the mode in which the multicast group is operating.
– dense-mode—Dense mode of operation.
• You cannot create use the same IP multicast groups for both DSG traffic and for other IP multicast
traffic. If an IP multicast group is being used for DSG traffic, do not use the ip igmp static-group
command to manually configure that same IP multicast group for other, non-DSG traffic.
• Different CA vendors cannot share IP multicast addresses. Each vendor must use a unique set of IP
multicast addresses, and after an IP multicast address is assigned to a DSG tunnel, that same address
cannot be used for any other purpose. However, all other multicast addresses and groups can still be
used on the interface for other multicast applications.
• DSG-related IP unicast traffic is not supported. The CMTS receives the unicast traffic from the DSG
network controllers, but it does not forward that traffic to the set-top boxes.
• DSG traffic should be less than 2.048 Mbps per vendor, so as to conform to the DSG specifications.
• DSG does not support BPI-encrypted IP multicast streams.
Note In Cisco IOS Release 12.2(15)BC2, N+1 HCCP high-availability redundancy does not preserve the DSG
traffic and configuration after a switchover. If you configure a cable interface for both N+1 HCCP
redundancy and for DSG operations, DSG traffic does not continue after a switchover.
Examples The following example shows how to configure a cable interface on a Cisco uBR7246VXR router to
enable the DSG feature on cable interface 3/0, using a well-known MAC address of 0001.0002.0003 and
a destination IP address of 225.2.3.4:
Router# configure terminal
Router(config)# interface cable 3/0
Router(config-if)# ip pim dense-mode
Router(config-if)# ip multicast rate-limit out group-list 123 1024
Router(config-if)# cable dsg 1.2.3 225.2.3.4 CCC
Router(config-if)# exit
Router(config)# exit
Router#
Note The above configuration also automatically configures the interface with the appropriate IGMP static-
group command (ip igmp static-group 225.3.4.5). This command will appear in the interface
configuration and should not be removed manually.
The following example shows the error message that appears if you specify a broadcast IP address that
has already been added to the router’s IGMP database. This entry typically would have been created
manually on the router or dynamically by a CPE device that is attached to a cable modem on the cable
network.
Router# configure terminal
Router(config)# interface cable 3/0
Router(config-if)# cable dsg 1.1.1 224.3.3.10 cisco
Multicast group 224.3.3.10 is already in use on the interface Cable3/0, please retry.
Router#
The following example shows how to delete a DSG tunnel on a cable interface:
Router# configure terminal
Router(config)# interface cable 4/0
Router(config-if)# no cable dsg 0020.0020.0020 230.8.8.8 abc
4d17h: DSG: interface Cable5/0 left the igmp static group 230.8.8.8.
Router(config-if)# end
Router#
The following example shows the error message that appears when a unicast IP address is specified
instead of a multicast IP address:
Router(config-if)# cable dsg 1.1.1 172.68.13.10 cisco
Router(config-if)#
Usage Guidelines By default, the Cisco CMTS does not send keepalive messages on any DSG tunnels. When keepalives
are enabled using the cable dsg keepalive command, the Cisco CMTS sends one keepalive message each
second on each DSG tunnel on each downstream. In Cisco IOS Release 12.2(15)BC2, the keepalive
packet is a null packet.
Note Do not enable DSG keepalive messages unless your application and DSG set-top boxes require them.
Tip Use the show cable dsg command to display whether keepalive messages are enabled.
Examples The following example shows how to enable DSG keepalives on all cable interfaces on the router:
Router# configure terminal
Router(config)# cable dsg keepalive
Router(config)# exit
Router#
The following example shows how to disable DSG keepalives on all cable interfaces, which is the default
configuration:
Router# configure terminal
Router(config)# no cable dsg keepalive
Router(config)# exit
Router#
cable dynamic-secret
To enable the Dynamic Shared Secret feature, so that Data-over-Cable Service Interface Specifications
(DOCSIS) configuration files are verified with a Message Integrity Check (MIC) that has been created
with a dynamically generated shared secret, use the cable dynamic-secret command in cable interface
configuration mode. To disable this feature, use the no form of this command.
no cable dynamic-secret
Syntax Description lock Allows CMs that do not pass MIC verification to come online, but with
a restrictive quality of service (QoS) configuration that limits access to
the network. The CMTS also locks those CMs so that they must be
offline for 24 hours before being allowed to reregister with a valid
DOCSIS configuration file. (You can also manually unlock a cable
modem using the clear cable modem lock command.)
lock-qos (Optional) Specifies the QoS profile to be assigned to the CM while it
is locked. The valid range is 1 to 256. If not specified, the CM is locked
into a CMTS-created profile that limits both the upstream and
downstream to 10 Kbps.
Note The QoS profile must have already been created before it can
assigned using the lock lock-qos option.
mark Allows CMs to come online even if they do not present a DOCSIS
configuration file with a valid CMTS MIC, but the CMTS prints a
warning message and marks those CMs with an exclamation point (!)
in the show cable modem command.
reject Rejects registration for CMs with DOCSIS configuration files that
contain an invalid CMTS MIC.
nocrypt (Optional) Specifies that the filename for DOCSIS configuration files
should not be encrypted when the Cisco CMTS sends the files to CMs.
The CMTS instead transmits the files using their original filenames.
The nocrypt option slightly decreases the security provided by the
dynamic shared secret feature, but it allows the operator to poll the
DOCSIS config file name listed by the cable modem for more
convenient network management.
Note A cable modem that is running unauthorized or hacked
software can return whatever SNMP values the user desires.
This information should therefore not be trusted by the billing
and provisioning systems.
Defaults The Dynamic Shared Secret feature is disabled. When enabled, the filenames for DOCSIS configuration
files are encrypted.
Note Configuring the Dynamic Shared Secret feature on the master interface in a bundle also automatically
configures it for all interfaces in the bundle.
Usage Guidelines The cable dynamic-secret configuration command automatically creates a unique DOCSIS shared
secret on a per-modem basis, creating a one-time-use DOCSIS configuration file that is valid only for
the current session. This ensures that a DOCSIS configuration file that has been downloaded for one
cable modem can never be used by any other modem, nor can the same modem reuse this configuration
file at a later time. This patent-pending feature is designed to guarantee that all registered modems are
using only the QOS parameters that have been specified by the DOCSIS provisioning system for that
particular modem at the time of its registration.
The cable dynamic-secret configuration command enhances the existing shared secret support on the
Cisco CMTS by using a one-time, dynamically generated shared secret each time a cable modem
registers. This prevents theft-of-service attacks in which users are able to substitute a DOCSIS
configuration file that provides a higher-level of service during the registration phase.
The DOCSIS specification allows cable service providers to use a shared secret to create the CMTS MIC
value that is stored in a DOCSIS configuration file. If a user attempts to register with the CMTS using a
different or modified DOCSIS configuration file, the CMTS can compare the CMTS MIC value sent by
the cable modem with the CMTS MIC it has calculated. If the two MIC values are different, the file has
been modified.
The cable dynamic-secret command allows the CMTS to dynamically create the shared secret at the
time that the cable modem is registering, and that shared secret is valid only for that particular session
with that particular cable modem. A new dynamically generated shared secret is used each time each
cable modem registers, which prevents users from guessing the shared secret and using it again to
register with a modified DOCSIS configuration file.
If the cable modem’s DOCSIS configuration file fails the CMTS MIC verification check, one of the
following messages is displayed on the console:
%UBR7200-4-BADCFGFILE: Modem config file platinum.cm at C3/0: CMTS MIC Invalid
%UBR7200-4-BADCFGFILE: Modem config file platinum.cm at C3/0: No CMTS MIC
If the error message specifies that the reason for the failure is “CMTS MIC Invalid,” the CMTS MIC was
not encoded with the proper dynamically generated shared secret. If the reason is “No CMTS MIC,” the
DOCSIS configuration file did not contain any value for the CMTS MIC, which could indicate that the
customer has attempted to bypass the DOCSIS security checks by creating the user’s own DOCSIS
configuration file without any MIC values.
Note The Dynamic Shared Secret feature does not affect the use of the original shared secret or secondary
shared secrets that are configured using the cable shared-secondary-secret and cable shared-secret
commands. If these shared secrets are configured, the Cisco CMTS continues to use them to validate
the original DOCSIS configuration file that is downloaded from the TFTP server. If the DOCSIS
configuration file fails to pass the original or secondary shared secret verification checks, the cable
modem is not allowed to register, and the Dynamic Shared Secret feature is not invoked for that
particular cable modem.
Note The Cisco uBR7100 series router does not support the Dynamic Shared Secret feature when running in
MxU bridging mode.
The original filename for the DOCSIS configuration file is automatically encrypted by default to prevent
unauthorized parties from obtaining any useful information from the filename, or from attempting to
replace the original file with their own. This encryption can be disabled, using the nocrypt option, so
that DOCSIS configuration files are sent using their original filenames.
Note Do not use the cable dynamic-secret command along with the ip tftp-source command in Cisco IOS
Release 12.2(15)BC1, because this could result in certain models of CMs not being able to come online
but instead be stuck in the init(o) state. This restriction is removed in Cisco IOS Release 12.2(15)BC2
and later releases.
Modes of Operation
The cable dynamic-secret command offers three different possible responses to cable modems that fail
the CMTS MIC verification check:
• When the mark option is used, the CMTS allows CMs to come online even if they fail the CMTS
MIC validity check. However, the CMTS also prints a warning message on the console and marks
the cable modem in the show cable modem command with an exclamation point (!), so that this
situation can be investigated. The following message is displayed on the console when such a CM
registers with the Cisco CMTS:
06:53:57: %UBR7200-4-CMMARKED: Cable Modem 00ff.ffee.ddcc in C3/0 attempted theft of
service
• When the lock option is used, the CMTS assigns a restrictive QoS configuration to CMs that fail the
CMTS MIC validity check. If an optional lock-qos profile is specified, the CMTS assigns this profile
to the CM while it is locked.
If the lock-qos profile is not specified, the CMTS uses a special QoS configuration that limits the
network access for these CMs by restricting their downstream and upstream service flows to a
maximum rate of 10 kbps. (If you do not specify the lock-qos profile, you must also allow cable
modems to create QoS profiles, using the cable qos permission command. If you do not do this and
use the lock option without specifying a particular QoS profile, locked cable modems will not be
allowed to register until the lock clears or expires.)
If a customer resets their CM, the CM will reregister but still uses the restricted QoS profile. A
locked CM continues with the restricted QoS profile until it goes offline and remains offline for at
least 24 hours, at which point it is allowed to reregister with a valid DOCSIS configuration file. This
option frustrates users who are repeatedly registering with the CMTS in an attempt to guess the
shared secret, or to determine the details of the Dynamic Shared Secret security system.
In addition, the following message is displayed on the console when a CM is locked.
06:53:57: %UBR7200-4-CMLOCKED: Cable Modem 00ff.ffee.ddcc in C3/0 attempted theft of
service
Locked cable modems are shown with an exclamation point (!) in the show cable modem displays:
Router# show cable modem
MAC Address IP Address I/F MAC Prim RxPwr Timing Num BPI
State Sid (db) Offset CPE Enb
0010.9507.01db 144.205.151.130 C5/1/0/U5 online(pt) 1 0.25 938 1 N
0080.37b8.e99b 144.205.151.131 C5/1/0/U5 online 2 -0.25 1268 0 N
0002.fdfa.12ef 144.205.151.232 C6/1/0/U0 online(pt) 13 -0.25 1920 1 N
0002.fdfa.137d 144.205.151.160 C6/1/0/U0 !online 16 -0.50 1920 1 N
0003.e38f.e9ab 144.205.151.237 C6/1/0/U0 !online 3 -0.50 1926 1 N
Router#
Tip You can also manually clear the lock on a CM by using the clear cable modem lock command.
• When the reject option is used, the CMTS refuses to allow CMs to come online if they fail the
CMTS MIC validity check. These cable modems appear with a MAC state of “reject(m)” in the
displays generated by the show cable modem command. After a short timeout period, the CM
attempts to reregister with the CMTS. The CM must register with a valid DOCSIS configuration file
before being allowed to come online. When the CM does come online, the CMTS prints a warning
message on the console and marks the cable modem in the show cable modem command with an
exclamation point (!), so that this situation can be investigated.
Tip Cisco recommends that you initially use the mark option, so that potential problems are identified
without immediately interfering with users’ ability to come online. After you identify and resolve these
initial problems, reconfigure the cable interfaces with the reject or lock option to block problem cable
modems that attempt to come online without a valid shared secret.
Note To account for possible network problems, such as loss of packets and congestion, the Cisco CMTS will
allow a cable modem to attempt to register twice before marking it as having failed the Dynamic Shared
Secret authentication checks.
Filename Encryption
By default, the cable dynamic-secret command encrypts the original filename for a DOCSIS
configuration file when the Cisco CMTS transmits the file to the CM. This filename changes in a semi-
random manner, making it difficult for users to predict the filename for the file that should be
downloaded to the CM.
This does mean, however, that the filenames specified in the DHCP HELLO and ACK messages are
different, and that the filenames on the CM and on the TFTP server are different. This could interfere
with custom network management applications and scripts. If this is the case, you can disable the
automatic filename encryption by adding the nocrypt option to the command.
The nocrypt option does slightly decrease the security provided by this feature, so this possibility should
be weighed against the ability to more conveniently manage the network.
Spoof TFTP
MAC Address Vendor Interface Count Dnld Dynamic Secret
Router#
If the CMTS cannot obtain the DOCSIS configuration file from the TFTP server, a message similar to
the following is displayed on the console:
%UBR7200-4-NOCFGFILE: Cannot read modem config file platinum.cm from C3/0: <reason>
where the reason can be one of the following, depending on the error that the TFTP server reported:
• Compression Failed
• File too big
• Invalid Checksum
• Invalid IP address or hostname
• Uncompression Failed
• User Abort
Examples The following example shows how to configure a cable interface on a Cisco uBR7200 series router with
the mark option, so that CMs that fail the MIC verification are allowed to register but are marked in the
show cable modem displays so that their situation can be further investigated:
Router# configure terminal
Router(config)# interface cable 4/0
Router(config-if)# cable dynamic-secret mark
Router(config-if)# exit
Router(config)# exit
Router#
The following example shows how to configure the cable interface on a Cisco uBR7100 series router, so
that CMs that fail the MIC verification are locked with a QoS profile that limits upstream and
downstream service flows to 10 kbps:
Router# configure terminal
Router(config)# cable qos permission create
Router(config)# cable qos permission update
Router(config)# interface cable 1/0
Router(config-if)# cable dynamic-secret lock
Router(config-if)# exit
Router(config)# exit
Router#
Note If you do not use the cable qos permission global configuration command to allow cable modems to
create their own QoS profiles, the CMTS rejects this command and displays the following error message:
%Need permission for modems to create QoS profile
The following example shows how to configure a cable interface so that CMs that fail the MIC
verification are locked with a specific QoS profile:
Router# configure terminal
Router(config)# interface cable 1/0
Router(config-if)# cable dynamic-secret lock 31
Router(config-if)# exit
Router(config)# exit
Router#
Note If the specified QoS profile does not exist, the CMTS rejects this command and displays the following
error message:
%Profile qos-id to lock modem does not exist
The following example shows how to configure a cable interface on a Cisco uBR7200 series router, so
that CMs that fail the MIC verification are not allowed to register and must reregister with a valid
DOCSIS configuration file before being allowed to come online:
Router# configure terminal
Router(config)# interface cable 3/0
Router(config-if)# cable dynamic-secret reject
Router(config-if)# exit
Router(config)# exit
Router#
The following example shows how to disable the Dynamic Shared Secret feature on a cable interface on
the Cisco uBR10012 router:
Router# configure terminal
Router(config)# interface cable 6/1/0
Router(config-if)# no cable dynamic-secret
Router(config-if)# exit
Router(config)# exit
Router#
cable enable-trap
To permanently set four CISCO-DOCS-EXT-MIB MIB attributes that enable the sending of a trap when
a CM changes between the online and offline states, use the cable enable-trap command in cable
interface configuration mode. To return to the default settings found in the MIB, which disable the
sending of these traps, use the no form of this command.
Syntax Description cmonoff-notification Enables or disables the sending of the notification traps.
cmonoff-interval Specifies the minimum interval that must pass before sending out a
new trap for the same CM.
time-in-secs Specifies the number of seconds (0 to 86400 seconds). The default
value is 600 seconds.
Defaults The default is to use the MIB defaults, which specify that traps are not to be sent, with an interval value
of 600 seconds (10 minutes).
Usage Guidelines This command sets four attributes in the CISCO-DOCS-EXT-MIB MIB, so that the new values can be
automatically loaded whenever the CMTS router powers on or reloads. To do so, put the appropriate
commands in the configuration file and save it to the CMTS router’s Flash memory. The CMTS router
automatically sets the appropriate MIB values when it processes the configuration file at startup.
These commands affect whether the CM online/offline notification trap (cdxCmtsCmOnOffNotification)
is sent, and if so, the minimum interval that must exist between traps that are sent for the same CM
undergoing the same state changes. The following describes the relationship between these commands
and the attributes in the CISCO-DOCS-EXT-MIB MIB:
• The cable enable-trap cmonoff-notification command sets the cdxCmtsCmOnOffTrapEnable
attribute to 1 (true), which enables the sending of the CM online and offline traps.
• The no cable enable-trap cmonoff-notification command sets the cdxCmtsCmOnOffTrapEnable
attribute to 2 (false), which disables the sending of the CM online and offline traps.
Note Setting the cmonoff-interval option and the cdxCmtsCmOnOffTrapInterval attribute has meaning only
if cdxCmtsCmOnOffNotification traps have been previously enabled.
Examples The following commands enable the sending of CM on or off traps, with a minimum interval of 1200
seconds between traps being sent for the same CM:
router(config)# interface c6/0
router(config-if)# cable enable-trap cmonoff-notification
router(config-if)# cable enable-trap cmonoff-interval 1200
router(config-if)# exit
router(config)#
cable event priority {alert | critical | debug | emergency | error | informational | notice |
warning} flags
Syntax Description alert Sets the event reporting flag for alert system error messages. (Alert messages
indicate that some type of system or connection failure has occurred and
requires immediate attention.)
critical Sets the event reporting flag for critical system error messages. (Critical
messages indicate that an error occurred which requires immediate attention
to avoid system or connection failure.)
debug Sets the event reporting flag for debug system error messages. (Debug
messages appear only when debugging has been enabled.)
emergency Sets the event reporting flag for emergency system error messages.
(Emergency messages indicate that the system has become unusable and
requires immediate attention. This problem might also be affecting other
parts of the network.)
error Sets the event reporting flag for error system error messages. (Error
messages indicate that an error condition occurred that requires attention to
resolve. Failure to address this problem will result in some type of system or
connection failure in the near future.)
informational Sets the event reporting flag for informational system error messages.
(Informational messages might or might not be significant to the system
administrators.)
notice Sets the event reporting flag for notice system error messages. (Notice
messages indicate that a situation occurred that is normal but is significant
enough that system administrators might want to notice.)
warning Sets the event reporting flag for warning system error messages. (Warning
messages indicate that a condition occurred that indicates attention is needed
in near future to avoid potential problems. Failure to address this problem
could result in some type of system or connection failure later on.)
flags Sets the event reporting flags value, in hex, which specifies how this
particular type of event message should be reported. The valid range is 0x0
through 0xF0, which is a bitmask specifying the types of reporting that
should be done. See the Usage Guidelines for details.
Defaults The defaults are configured as per the DOCSIS 1.1 Operations Support System Interface (OSSI)
Specification:
• Emergency and alert messages = (0x10) (reported to the local volatile log)
• Critical, error, warning, and notice = (0x70) (reported to the local volatile log, and forwarded as
traps and to the SYSLOG server)
• Information and debug = 0x0 (not reported)
Usage Guidelines The DOCSIS 1.1 specifications require the CMTS to generate a set of messages for DOCSIS-specific
events. These messages can be assigned one of eight priority levels, ranging from emergency (the highest
level) to debug (the lowest level), and the CMTS can be configured to log each level of messages
differently.
The Cisco CMTS supports the following types of logging, as defined by the DOCS-CABLE-DEVICE-
MIB MIB (RFC 2669):
• none (0x0) = DOCSIS messages are not reported. (The corresponding Cisco IOS event messages,
however, continue to be logged.)
• local-volatile (0x10) = DOCSIS messages are saved in a local log on the CMTS. This log can be
limited in size and can automatically discard previous messages to make room for incoming
messages.
• syslog (0x20) = DOCSIS messages are sent to a SYSLOG server (if one has been configured, using
the cable event syslog-server command).
• traps (0x40) = DOCSIS messages are sent as SNMP traps to one or more SNMP managers.
These values can be added together to specify that the CMTS should report an event in more than one
way. For example, a value of 0x70 specifies that the CMTS should record the event in its local volatile
log, and also send it both as a trap and as a SYSLOG message.
Note If event messages are configured for traps or syslog reporting, they must also be configured for either
local volatile or local non-volatile reporting. This means that values 0x20 (syslog-only), 0x40 (trap-
only), and 0x60 (syslog and trap only) are not supported.
Use the cable event priority command to set the reporting flags for each type of event. This also
configures the appropriate instance of the docsDevEvReporting attribute DOCS-CABLE-DEVICE-MIB
MIB (RFC 2669) with the same value.
Note This command affects only the DOCSIS event messages, and does not affect how the Cisco IOS software
handles event messages. If SYSLOG traps are enabled on the Cisco CMTS (using the snmp-server
enable traps syslog command), they continue to be sent, regardless of the cable event priority
configuration.
Examples The following commands configure the Cisco CMTS so that it reports all emergency, alert, and critical
messages as SNMP traps and SYSLOG messages, as well as logging it in the local volatile log:
Router# configure terminal
Router(config)# cable event priority alert 0x70
Router(config)# cable event priority critical 0x70
Router(config)# cable event priority emergency 0x70
Router(config)#
The following commands configure the Cisco CMTS so that it reports the lowest priority messages only
to the local volatile log and SYSLOG server:
Router# configure terminal
Router(config)# cable event priority debug 0x30
Router(config)# cable event priority informational 0x30
Router(config)# cable event priority notice 0x30
Router(config)#
Syntax Description ip-address Specifies the IP address for the DOCSIS SYSLOG server, which is the
docsDevEvSyslog attribute in the DOCS-CABLE-DEVICE-MIB MIB
(RFC 2669). If the IP address is 0.0.0.0, SYSLOG service is disabled
for DOCSIS events.
Usage Guidelines The DOCSIS 1.1 specifications require the CMTS to generate a set of messages for DOCSIS-specific
events. Use the cable event syslog-server command to enable DOCSIS SYSLOG services and to set the
IP address for the DOCSIS SYSLOG server (which is the docsDevEvSyslog attribute in the DOCS-
CABLE-DEVICE-MIB MIB).
You can also configure the server’s IP address by using SNMP commands to set the docsDevEvSyslog
attribute directly. Setting the docsDevEvSyslog attribute also creates a matching cable event syslog-
server command in the router’s configuration.
When you specify the IP address for a DOCSIS SYSLOG server, either by using the cable event syslog-
server command or by setting the docsDevEvSyslog attribute, the Cisco CMTS begins generating event
messages that conform to the DOCSIS 1.1 specifications. This format is similar to but not identical to
the format that is used by the Cisco IOS software. For example, the following message is in the typical
Cisco IOS format:
%UBR7200-4-DCC_ACK_REJ_MSG_SYNTAX_ERROR: DCC-ACK rejected message syntax error
The same error message appears as follows when using the DOCSIS 1.1 format:
<133>CMTS[DOCSIS]:<67040500> DCC-ACK rejected message syntax error
To disable the sending of events to the DOCSIS SYSLOG server, you can use the no cable event syslog-
server command, or you can specify an IP address of 0.0.0.0 (cable event syslog-server 0.0.0.0). Both
commands set the docsDevEvSyslog attribute to 0.0.0.0 and disable DOCSIS SYSLOG service. This
does not, however, disable the Cisco IOS SYSLOG server (if one has been configured using the logging
ip-address command).
Note You can use the same SYSLOG server for both Cisco IOS event messages and for DOCSIS-style event
messages, but it might be more convenient to use separate servers for the two different message formats.
Use the logging ip-address command in global configuration mode to set the IP address for the
Cisco IOS SYSLOG server. The DOCSIS SYSLOG server collects only event messages for DOCSIS
events, using the DOCSIS format, while the Cisco IOS server collects all event messages (including
DOCSIS events), but using the standard Cisco IOS message format.
Tip For more information about DOCSIS SYSLOG services and event messages, see Section 4.4.2.2.2,
SYSLOG Message Format, in the DOCSIS 1.1 Operations Support System Interface (OSSI)
Specification (SP-OSSIv1.1-I06-020830). For more information about all cable-related event messages
that can be generated on the Cisco CMTS router, see the Cisco CMTS Error Message manual.
Examples The following command sets the docsDevEvSyslog attribute with an IP address of 192.168.100.137:
Router# configure terminal
Router(config)# cable event syslog-server 192.168.100.137
Router(config)#
The following commands specifies different SYSLOG servers. The server at IP address 192.168.100.137
receives the DOCSIS-style event messages, and the server at IP address 192.168.100.138 receives the
Cisco IOS style messages.
Router# configure terminal
Router(config)# cable event syslog-server 192.168.100.137
Router(config)# logging 192.168.100.138
Router(config)#
The following command sets the docsDevEvSyslog attribute to 0.0.0.0, which disables DOCSIS
SYSLOG services:
Router# configure terminal
Router(config)# no cable event syslog-server
Router(config)#
Note You can also disable DOCSIS SYSLOG services with the cable event syslog-server 0.0.0.0 command.
Command Description
snmp-server enable traps Enables traps for cable-related events.
cable
snmp-server enable traps Enables traps for DOCSIS-related MAC-layer events.
docsis-cmts
Syntax Description inhibited All SNMP traps and SYSLOG messages for DOCSIS event messages
are suppressed.
maintainBelowThreshold Throttling is performed, so that SNMP traps and SYSLOG messages
are suppressed if they would otherwise exceed the throttle threshold.
The Cisco CMTS resumes generating traps and messages at the start of
the next throttle interval.
stopAtThreshold Throttling is performed, so that the Cisco CMTS stops generating all
SNMP traps and SYSLOG messages if they would exceed the throttle
threshold. The Cisco CMTS does not resume generating traps and
messages until directed to do so by repeating this command.
unconstrained SNMP traps and SYSLOG messages for DOCSIS event messages are
not throttled.
Usage Guidelines This command sets the value of the docsDevEvThrottleAdminStatus attribute in the DOCS-CABLE-
DEVICE-MIB MIB (RFC 2669), which controls whether the Cisco CMTS should throttle SNMP traps
and SYSLOG messages that are generated for DOCSIS event messages.
The DOCS-CABLE-DEVICE-MIB MIB supports the following threshold configurations:
• inhibited—The Cisco CMTS does not generate any SNMP traps or SYSLOG messages for DOCSIS
events.
• maintainBelowThreshold—Throttling is performed, and SNMP traps and SYSLOG messages are
suppressed if they would exceed the throttle threshold (as set by the cable event throttle-interval
and cable event throttle-threshold commands). The Cisco CMTS resumes generating traps and
messages at the start of the next throttle interval.
• stopAtThreshold—Throttling is performed, and the Cisco CMTS stops generating all SNMP traps
and SYSLOG messages when they exceed the throttle threshold. The Cisco CMTS does not resume
generating traps and messages until the threshold state is reset. This can be done by repeating the
cable event throttle-adminStatus command, or by setting the docsDevEvThrottleAdminStatus
attribute in the DOCS-CABLE-DEVICE-MIB MIB.
• unconstrained—All SNMP traps and SYSLOG messages are transmitted without any throttling.
Tip For more information about DOCSIS SYSLOG services and event messages, see Section 4.4.2.2.2,
SYSLOG Message Format, in the DOCSIS 1.1 Operations Support System Interface (OSSI)
Specification (SP-OSSIv1.1-I06-020830). For more information about all cable-related event messages
that can be generated on the Cisco CMTS router, see the Cisco CMTS Error Message manual.
Examples The following commands configure the Cisco CMTS to throttle SNMP traps and SYSLOG messages
according to the specified throttle interval and threshold:
Router# configure terminal
Router(config)# cable event throttle-interval 90
Router(config)# cable event throttle-threshold 30
Router(config)# cable event throttle adminStatus maintainBelowThreshold
Router(config)#
The following commands configure the Cisco CMTS for the default behavior, so that it does not throttle
SNMP traps and SYSLOG messages. The configured throttle interval and threshold are ignored.
Router# configure terminal
Router(config)# cable event throttle adminStatus unconstrained
Router(config)#
Syntax Description seconds Length of the throttle interval, in seconds. The valid range is 0 to
2147483647 seconds, with a default of 60 seconds.
Usage Guidelines The DOCSIS 1.1 specifications require the CMTS to generate a set of messages for DOCSIS-specific
events. In certain situations, such as a power outage that causes a mass reregistration of cable modems,
this can generate such a large volume of event messages that it can impact system performance.
To avoid this possibility, use the cable event throttle-interval command, together with the cable event
throttle-threshold command, to specify the maximum number of SNMP traps or SYSLOG events that
the Cisco CMTS can generate for DOCSIS events over a specific interval:
• cable event throttle-interval—Specifies the length of the throttle interval.
• cable event throttle-threshold—Specifies the maximum number of SNMP traps and SYSLOG
events that the Cisco CMTS can generate during that period.
The threshold value counts DOCSIS events, not SNMP traps or SYSLOG messages. If a DOCSIS event
generates both an SNMP trap and a SYSLOG message, the Cisco CMTS counts it as only one event.
Note The cable event throttle-interval and cable event throttle-threshold commands do not have any effect
unless the cable event throttle-adminStatus has been configured to allow the throttling of DOCSIS
event messages.
Tip For more information about DOCSIS SYSLOG services and event messages, see Section 4.4.2.2.2,
SYSLOG Message Format, in the DOCSIS 1.1 Operations Support System Interface (OSSI)
Specification (SP-OSSIv1.1-I06-020830). For more information about all cable-related event messages
that can be generated on the Cisco CMTS router, see the Cisco CMTS Error Message manual.
Examples The following commands configure the Cisco CMTS so that it can generate a maximum number of 30
SNMP traps and SYSLOG messages for DOCSIS events over a 90-second period:
Router# configure terminal
Router(config)# cable event throttle-interval 90
Router(config)# cable event throttle-threshold 30
Router(config)#
Syntax Description number Maximum allowable number of DOCSIS events for which the
Cisco CMTS can generate SNMP traps and SYSLOG messages during
the throttle period. The valid range is 0 to 2147483647, with a default
of 10.
Defaults 10
Usage Guidelines The DOCSIS 1.1 specifications require the CMTS to generate a set of messages for DOCSIS-specific
events. In certain situations, such as a power outage that causes a mass reregistration of cable modems,
this can generate such a large volume of event messages that it can impact system performance.
To avoid this possibility, use the cable event throttle-threshold command, together with the cable event
throttle-interval command, to specify the maximum number of SNMP traps or SYSLOG events that the
Cisco CMTS can generate for DOCSIS events over a specific interval:
• cable event throttle-interval—Specifies the length of the throttle interval.
• cable event throttle-threshold—Specifies the maximum number of SNMP traps and SYSLOG
events that the Cisco CMTS can generate during that period.
The threshold value counts DOCSIS events, not SNMP traps or SYSLOG messages. If a DOCSIS event
generates both an SNMP trap and a SYSLOG message, the Cisco CMTS counts it as only one event.
Note The cable event throttle-interval and cable event throttle-threshold commands do not have any effect
unless the cable event throttle-adminStatus has been configured to allow the throttling of DOCSIS
event messages.
Tip For more information about DOCSIS SYSLOG services and event messages, see Section 4.4.2.2.2,
SYSLOG Message Format, in the DOCSIS 1.1 Operations Support System Interface (OSSI)
Specification (SP-OSSIv1.1-I06-020830). For more information about all cable-related event messages
that can be generated on the Cisco CMTS router, see the Cisco CMTS Error Message manual.
Examples The following commands configure the Cisco CMTS so that it can generate a maximum number of 25
SNMP traps and SYSLOG messages for DOCSIS events over a two-minute period:
Router# configure terminal
Router(config)# cable event throttle-interval 120
Router(config)# cable event throttle-threshold 25
Router(config)#
Syntax Description group-id Specifies a unique group ID for this filter group. The valid range is 1
to 256.
index-num Specifies a unique index for this particular filter. The valid range is 1
to 128.
Specify one of the following options and option-values:
dest-ip ip-address (Optional) Specifies the destination IP address that should be matched.
The default IP address is 0.0.0.0.
dest-mask mask (Optional) Specifies the mask for the destination address that should be
matched. The mask is ANDed with the IP address specified by the
dest-ip option and compared to the result of ANding the mask with the
packet’s destination IP address. The filter considers it a match if the
two values are the same.
Note The default mask of 0.0.0.0 matches all IP addresses.
dest-port port-num (Optional) Specifies the TCP/UDP destination port number that should
be matched. The valid range is 0 to 65535. The default value matches
all TCP/UDP port numbers.
ip-proto proto-type (Optional) Specifies the IP protocol type number that should be
matched. The valid range is 0 to 256, with a default value of 256 that
matches all protocols. Some commonly-used values are:
• 1 = ICMP, Internet Control Message Protocol.
• 2 = IGMP, Internet Group Management Protocol.
• 4 = IP in IP encapsulation.
• 6 = TCP, Transmission Control Protocol.
• 17 = UDP, User Datagram Protocol.
ip-tos tos-mask tos-value (Optional) Specifies a type of service (TOS) mask and value to be
matched:
• tos-mask = 8-bit value expressed in hexadecimal notation. The
valid range is 0x00 through 0xFF.
• tos-value = 8-bit value expressed in hexadecimal notation. The
valid range is 0x00 through 0xFF.
The tos-mask is ANDed with the tos-value and compared to the result
of ANDing the tos-mask with the packet’s actual TOS value. The filter
considers it a match if the two values are the same.
Note The default values for both parameters matches all ToS values.
match-action {accept | (Optional) Specifies the action that should be taken for packets that
drop} match this filter:
• accept = Packets that match the filter are accepted (default).
• drop = Packets that match the filter are dropped.
src-ip ip-address (Optional) Specifies the source IP address that should be matched. The
default IP address is 0.0.0.0.
src-mask mask (Optional) Specifies the mask for the source address that should be
matched. The mask is ANDed with the IP address specified by the src-
ip option and compared to the result of ANding the mask with the
packet’s source IP address. The filter considers it a match if the two
values are the same.
Note The default mask of 0.0.0.0 matches all IP addresses.
src-port port-num (Optional) Specifies the TCP/UDP source port number that should be
matched. The valid range is 0 to 65535. The default value matches all
TCP/UDP port numbers.
status {active | inactive} (Optional) Enables or disables the filter:
• active = Enables the filter immediately (default).
• inactive = Disables the filter immediately.
Note You must create a filter group using at least one of the other
options before you can use this command to enable or disable
the filter.
tcp-flags flags-mask flags- (Optional) Specifies the TCP flag mask and value to be matched:
value
• flags-mask = 8-bit value expressed in hexadecimal notation. The
valid range is 0x0 through 0x3F.
• flags-value = 8-bit value expressed in hexadecimal notation. The
valid range is 0x0 through 0x3F.
Defaults No filter groups are defined. When a filter group is created, it defaults to accepting all source and
destination IP addresses and TCP/UDP ports, all protocol types, and all ToS and TCP flag values.
Usage Guidelines This command implements DOCSIS 1.1 packet filtering, as defined in the DOCS-SUBMGT-MIB MIB.
Each filter group can contain multiple filters, as defined by the different index numbers.
When matching the source or destination addresses, the filter ANDs the mask value with the filter’s
corresponding IP address. The filter then ANDs the mask with the packet’s actual IP address and
compares the two values. If they are the same, the filter matches the packet.
For example, if you specify a src-ip of 192.168.100.0 and a src-mask of 255.255.255.0, the filter
matches all packets that have a source IP address in the range of 192.168.100.0 through
192.168.100.255. Use a mask value of 0.0.0.0 (default) to match all IP addresses. Use a mask value of
255.255.255.255 to match one specific IP address.
Similarly, when comparing TOS values, the filter ANDs the tos-mask parameter with the tos-value
parameter and compares it to the result of ANDing the tos-mask parameter with the packet’s actual TOS
value. If the two values are the same, the filter matches the packet.
Tip See the description of the docsSubMgtPktFilterTable table in this MIB for further information.
Note The DOCS-SUBMGT-MIB MIB is supported only on Cisco IOS Release 12.2(8)BC2 and later 12.2 BC
releases.
Examples The following example shows a filter group being defined that drops packets with a source IP address of
7.7.7.7 and a destination IP address of 8.8.8.8, and a source port number of 2000 and a destination port
number of 3000. All protocol types and ToS and TCP flag values are matched:
Router# configure terminal
Router(config)# cable filter group 10 index 10 src-ip 7.7.7.7
Router(config)# cable filter group 10 index 10 src-mask 255.255.0.0
Router(config)# cable filter group 10 index 10 dest-ip 8.8.8.8
Router(config)# cable filter group 10 index 10 dest-mask 255.255.0.0
Router(config)# cable filter group 10 index 10 ip-proto 256
Router(config)# cable filter group 10 index 10 src-port 2000
Router(config)# cable filter group 10 index 10 dest-port 3000
Router(config)# cable filter group 10 index 10 tcp-flags 0 0
Router(config)#
Syntax Description minutes Specifies how long, in minutes, that a CM remains in the flap list. The
valid range is 1 to 86400, with a default of 10080 minutes.
Usage Guidelines Flapping refers to the rapid disconnecting and reconnecting of a CM that is having problems holding its
connection to the CMTS. A flap list is a table maintained by the Cisco CMTS for every modem (active
or not) that is having communication difficulties. The flap list contains modem MAC addresses and logs
the time of the most recent activity. You can configure the size and entry thresholds for the flap list.
Examples The following example shows how to specify that the flap-list table retain 2400 minutes (40 hours) of
performance for this CM:
router(config)# cable flap-list aging 2400
Command Description
clear cable flap-list Clears all the entries in the flap-list table.
debug cable flap Displays information about the operation of the CM flap list that is
maintained for the cable interfaces.
ping docsis Sends a DOCSIS ping to a CM and increments the flap-list counters as
appropriate.
show cable flap-list Displays the current contents of the flap list.
Syntax Description seconds Insertion time interval in seconds. Valid values are from 60 to
86,400 seconds. The default value is 180 seconds (3 minutes).
Usage Guidelines This command controls the operation of a flapping modem detector. When a CM makes two or more
initial Ranging Requests (also known as insertion or reinsertion requests) within the period of time
defined by this command, the CM is placed in the flap list. A CM is not put into the flap list if the time
between its two consecutive initial Ranging Requests is greater than the insertion time interval.
For example, if the CMTS is configured for the default insertion time of three minutes, and if the CM
reinserts itself four minutes after its last insertion, the CM is not placed in the flap list. However, if the
CM reinserts itself two minutes after its last insertion, the CM is placed in the flap list.
Also, a CM is put into the flap list only once for each insertion time interval, even if the CM reinserts
itself multiple times. For example, if the CMTS is set for the default insertion time interval of 3 minutes,
and the CM reinserts itself three times within that period, the flap list will show that the CM has flapped
once. If the CM reinserts itself three times within the first 3 minute period and three more times within
the next 3 minute period, the flap list will show that the CM has flapped twice.
Examples The following example shows how to set the insertion time interval to 62 seconds:
router(config)# cable flap-list insertion-time 62
Command Description
cable flap-list power- Specifies the power-adjust threshold for recording a CM flap-list event.
adjust threshold
cable flap-list size Specifies the maximum number of CMs that can be listed in the flap-list
table.
clear cable flap-list Clears all the entries in the flap-list table.
debug cable flap Displays information about the operation of the CM flap list that is
maintained for the cable interfaces.
ping docsis Sends a DOCSIS ping to a CM and increments the flap-list counters as
appropriate.
show cable flap-list Displays the current contents of the flap list.
Syntax Description misses Specifies the number of consecutive MAC-layer keepalive (Station
Maintenance) that can be missed before a CM is placed in the flap list.
The valid range is 1 to 12, with a default of 6.
Defaults 6
Usage Guidelines In a DOCSIS network, the CMTS regularly sends out MAC-layer keepalive messages, known as station
maintenance messages, to each CM that is online. If a CM does not respond to a station maintenance
message, the CMTS repeats sending these messages either until the CM responds or the CMTS reaches
the maximum allowable number of messages that can be sent.
The cable flap-list miss-threshold command specifies how many consecutive station maintenance
messages can be missed before the cable modem is placed in the flap list. A miss occurs when a CM does
not reply to a station maintenance message.
Note Station maintenance messages are occasionally lost due to noise or congestion in a typical DOCSIS
network, with a loss rate of approximately 8 percent considered nominal. A higher miss rate can indicate
RF plant problems, such as intermittent upstream problems, fiber laser clipping, or common-path
distortion.
Examples The following example shows how to set the miss threshold to 5:
Router(config)# cable flap-list miss-threshold 5
Syntax Description dB Specifies the minimum power adjustment, in decibels, that results in a
flap-list event. Valid values are from 1 to 10 dB.
Defaults 2 dB
Usage Guidelines This command controls the operation of a flapping modem detector. When the power adjustment of a
CM exceeds the configured threshold value, the modem is placed in the flap list.
Note A power adjustment threshold of less than 2 dB might cause excessive flap-list event recording. Cisco
recommends setting this threshold value to 3 dB or higher.
Note For underground HFC networks with 4 amplifier cascade length, a typical threshold value should be 3
dB. For overhead HFC networks with 4 amplifier cascade length, a typical threshold value should be 4
dB. Longer coaxial cascades without return path thermal gain control and sites with extreme daily
temperatures will have larger threshold ranges.
Examples The following example shows the power-adjust threshold being set to 5 dB:
router(config)# cable flap-list power-adjust threshold 5
Syntax Description number Specifies the maximum number of CMs to be displayed. Valid values
are from 1 to 8191, with a default of 100 CMs.
Defaults 100
Usage Guidelines
Examples The following example shows how to display a maximum of 200 flap-list entries :
Router# configure terminal
Router(config)# cable flap-list size 200
Router(config)#
Command Description
ping docsis Sends a DOCSIS ping to a CM and increments the flap-list counters as
appropriate.
show cable flap-list Displays the current contents of the flap list.
cable freq-range
To configure the Cisco CMTS router for the range of frequencies that are acceptable on upstreams, use
the cable freq-range command in global configuration mode. To restore the default value (which is
based on the cable interface and on the Annex A/B configuration), use the no form of this command.
no cable freq-range
Syntax Description european Configures the Cisco CMTS router to accept upstream frequency ranges
that conform with the EuroDOCSIS specifications (5 MHz to 65 MHz).
japanese Configures the Cisco CMTS router to accept upstream frequency ranges
that conform to the extended range used in Japan (5 MHz to 55 MHz).
north-american Configures the Cisco CMTS router to accept upstream frequency ranges
that conform to the DOCSIS specifications (5 MHz to 42 MHz).
Defaults no cable freq-range, which defaults to a frequency range based on the Annex configuration:
• Annex A = european (EuroDOCSIS, 5 MHz to 65 MHz)—Supported only on cable interfaces that
support EuroDOCSIS
• Annex B = north-american (DOCSIS, 5 MHz to 55 MHz)—All cable interfaces support the 5 MHz
to 42 MHz range. The 42 MHz to 55 MHz range is supported only on certain cable interfaces.
Usage Guidelines In Cisco IOS Release 12.2(15)BC2 and later, the Cisco CMTS router supports three different modes of
operation, depending on the cable interface line cards being used. The range of frequencies that are
allowed in each mode are as follows:
• North American DOCSIS (Annex B)—Upstreams use frequencies between 5 MHz and 42 MHz.
This range is supported by all cable interface line cards.
• European EuroDOCSIS (Annex A)—Upstreams use frequencies between 5 MHz and 65 MHz.
• Japanese Extended Range (Annex B)—Upstreams use frequencies between 5 MHz and 55 MHz.
To configure the router so that it supports the proper range of upstream frequencies, use the upstream
freq-range command. After you have configured the router with the cable freq-range command, the
cable upstream frequency and cable spectrum-group (interface configuration) commands then
accept only frequencies that are in the configured range.
Typically, the upstream freq-range command is not needed because the default behavior covers the
most common configurations. However, this command can be used in the following situations:
• This command is required to enable EuroDOCSIS operations on the Cisco uBR-MC16U/X and
Cisco uBR-MC28U/X cards.
• This command is never needed for the Cisco uBR-MC5X20U card nor for EuroDOCSIS cable
interfaces (Cisco uBR-MC16E card, and the Cisco uBR7111E and Cisco uBR7114E routers),
because these interfaces default to the EuroDOCSIS range of frequencies. However, if you have
previously used this command to restrict the allowable range of frequencies, you must use the
european option to re-enable the EuroDOCSIS range of frequencies.
• The north-american option is usually not needed, because this is the default mode of operations for
all DOCSIS cable interfaces. However, this option can be useful on the Cisco uBR-MC16U/X and
Cisco uBR-MC28U/X cards when noise exists on the frequencies above 42 MHz. In this situation,
using the north-american option filters out the higher frequencies and reduces the impact of that
noise.
• Similarly, the japanese option is not needed on those cable interface cards that support it, because
this is the default configuration on those cards. However, if you have previously used the north-
american option on an interface, you need to use the japanese option to re-enable the extended
frequency range.
• Even when the upstream freq-range command is not needed to enable a frequency range, using it
ensures that the cable upstream frequency and cable spectrum-group commands allow only
frequencies that are within the desired range. This can help operators from assigning invalid
frequencies to upstreams.
Tip If one or more cable interface line cards that are installed in the chassis do not support the frequency
range that you select with this command, the command displays an informational warning message for
each of those cable interface cards. Also, you cannot configure the router for a particular frequency range
if an upstream or spectrum group on the router is currently configured for a frequency that is invalid for
the new range. If you try to do so, the command is ignored and a warning message is printed prompting
you to reconfigure the upstream or spectrum group before retrying the command.
Note This command configures only the range of frequencies that can be configured on an upstream. It does
not configure the upstreams for the DOCSIS (Annex B) or EuroDOCSIS (Annex A) modes of operation,
which is done using the cable downstream annex interface command. (Annex C mode is not supported.)
You must configure the downstream for Annex A for EuroDOCSIS operations and Annex B for DOCSIS
operations. You can configure certain cable interface cards (such as the Cisco uBR-MC28U) for both the
DOCSIS Annex B mode and the EuroDOCSIS frequency range, but this violates the DOCSIS
specifications and should not be used on standard DOCSIS networks.
The allowable range for the upstream channel frequency depends on the cable interface line card and
Cisco IOS software release being used. See Table 2-11 for the currently supported values.
Table 2-3 Allowable Frequency Range for Cable Interface Line Cards
Note The cable freq-range command fails if any upstreams or spectrum groups on the router are currently
configured for a frequency that is outside the new range being selected. You must reconfigure those
upstreams or spectrum groups, using the cable upstream frequency or cable spectrum-group
commands, for lower frequencies, and then repeat the cable freq-range command.
Examples The following example shows how to configure the Cisco CMTS router to support the EuroDOCSIS
upstream frequency range of 5 MHz to 65 MHz. The router then displays a list of the cable interface line
cards, if any, that do not support this range. After giving this command, the cable upstream frequency
command shows the valid range of upstream frequencies as being the EuroDOCSIS range:
Router# configure terminal
Router(config)# cable freq-range european
Router(config-if)#
The following example shows how to configure the Cisco CMTS router to support the extended Japanese
upstream frequency range of 5 MHz to 55 MHz. The router then displays a list of the cable interface line
cards, if any, that do not support this range. After giving this command, the cable upstream frequency
command shows the valid range of upstream frequencies as being the extended frequency range for
Japanese networks:
Router# configure terminal
Router(config)# cable freq-range japanese
Router(config)# interface cable 6/0 ! This cable interface supports the Japanese range
Router(config-if)# cable upstream 0 frequency ?
Router(config-if)#
The following example shows how to configure the Cisco CMTS router for its default configuration
(DOCSIS upstream frequency range of 5 MHz to 42 MHz). (No warning messages are displayed with
this configuration because all cable interface line cards support the basic DOCSIS frequency range.)
After giving this command, the cable upstream frequency command shows the valid range of upstream
frequencies as being the DOCSIS range:
Router# configure terminal
Router(config)# cable freq-range north-american
Router(config)# interface cable 3/0
Router(config-if)# cable upstream 0 frequency ?
Router(config-if)#
The following example shows all of the commands that are needed to configure the cable interface and
upstream on a Cisco uBR-MC28U/X cable interface line card to support a frequency in the EuroDOCSIS
upstream frequency range of 5 MHz to 65 MHz:
Router# configure terminal
Router(config)# cable freq-range european
Router(config)# interface 3/0
Router(config-if)# cable downstream annex a
Router(config-if)# cable upstream 0 frequency 62500000
Router(config-if)#
The following example shows the cable freq-range command failing because an upstream is configured
for a frequency that is invalid for the new range. The upstream must be reconfigured before the cable
freq-range command can be given successfully.
Router# configure terminal
Router(config)# cable freq-range japanese
%%Interface Cable 3/0/U0 has invalid frequency (62500000 Hz) for specified range
%%Set upstream frequencies within range prior to changing freq-range
cable helper-address
To specify a destination IP address for User Datagram Protocol (UDP) broadcast Dynamic Host
Configuration Protocol (DHCP) packets, use the cable helper-address command in cable interface or
subinterface configuration mode. To disable this feature, use the no form of this command.
Syntax Description IP-address The IP address of a DHCP server to which UDP broadcast packets will
be sent.
cable-modem (Optional) Specifies that only CM UDP broadcasts are forwarded.
host (Optional) Specifies that only host UDP broadcasts are forwarded.
Note You must specify both the cable-modem or host options in separate commands, using separate IP
addresses, if you decide to use them. If you specify only one option, then the other type of device (cable
modem or host) will not be able to connect with a DHCP server. In addition, if you use the cable-modem
or host option with the same IP address that was previously configured with this command, the new
configuration overwrites the old configuration.
Defaults If no options are specified, both CM and host UDP broadcasts are forwarded.
Usage Guidelines This command enables CMs and their attached CPE devices (hosts) to use separate DHCP servers, so
that CMs and hosts receive their IP addresses from separate address pools. The cable-modem keyword
specifies that only UDP DHCP broadcasts from CMs are forwarded to that particular destination IP
address. The host keyword specifies that only UDP broadcasts from hosts (CPE devices) are forwarded
to that particular destination IP address.
The cable helper-address command is similar to the ip helper-address command, but the cable helper-
address command has been enhanced for cable interfaces and DOCSIS networks to allow separate
helper addresses for CMs and hosts. Use only the cable helper-address command on cable interfaces,
and use the ip helper-address command on all non-cable interfaces.
The cable helper-address command, as is the case with the ip helper-address command, cannot be used
on slave interfaces, so these commands are automatically removed from an interface configuration when
the interface is configured as a slave interface. Slave interfaces use the IP configuration of the master
interface, which includes not only the IP address for the interface itself, but also the helper addresses
that have been configured on the master interface.
Tip You can repeat this command to specify any number of helper addresses, but the Cisco IOS software uses
only the first 16 valid addresses that are configured on each interface (using either the cable helper-
address command or the ip helper-address command) when forwarding DHCP requests.
Examples The following example shows how to forward UDP broadcasts from both CMs and CPE devices to the
DHCP server at 172.23.66.44:
Router(config)# interface cable 1/0
Router(config-if)# cable helper-address 172.23.66.44
Router(config-if)# exit
Router(config)#
The following example shows how to forward UDP broadcasts from CMs and CPE devices to separate
DHCP servers:
Router(config)# interface cable 6/0
Router(config-if)# cable helper-address 172.23.66.143 host
Router(config-if)# cable helper-address 172.23.66.144 cable-modem
Router(config-if)# exit
Router(config)#
The following example shows that when you specify the cable-modem and host options with the same
IP address, the second command overwrites the first one:
Router(config)# interface cable 3/0
Router(config-if)# cable helper-address 10.10.10.13 host
Router(config-if)# cable helper-address 10.10.10.13 cable-modem
Router(config-if)# exit
Router(config)# exit
Router# show running-config | include helper-address
Router#
Command Description
cable telco-return spd dhcp- Identifies the IP address of the Dynamic Host Configuration Protocol
server (DHCP) server that the telco-return CM must access.
ip dhcp relay information Enables the system to insert the CM MAC address into a DHCP
option packet received from a CM or host and forward the packet to a DHCP
server.
ip dhcp smart-relay Monitors client retransmissions when address pool depletion occurs.
Note The cable host command, and its SNMP equivalent, cdxCmCpeAccessGroup, are not supported on the
Cisco uBR10012 universal broadband router. On this router, use the standard DOCSIS MIB,
DOCS-SUBMGT-MIB, instead.
Usage Guidelines For the virtual route forwarding (VRF) syntax of this command, only the IP address option is supported.
Examples The following example shows how to assign access list number 2 to the cable host with an IP address of
10.1.1.1:
Router# cable host 10.1.1.1 access-group 2
Router#
cable insertion-interval
To configure the interval between consecutive initial ranging slots on an upstream, use the cable
insertion-interval interface configuration command. To configure the automatic setting and ignore any
minimum or maximum time settings, use the no form of this command.
no cable insertion-interval
Syntax Description fixed-intrvl Fixed interval between initial ranging slots in milliseconds. The valid
range is 100 to 2000 milliseconds.
automatic Causes the Cisco CMTS MAC scheduler for each upstream CM to vary
the initial ranging times available to new CMs joining the network.
min-intrvl (Optional) Minimum value in milliseconds between the initial ranging
slots on the upstream. The valid range is 20 to 120, with a default of 50
milliseconds.
max-intrvl (Optional) Maximum value in milliseconds between the initial ranging
slots on the upstream. The valid range is 240 to 1800, with a default of
500 milliseconds.
Defaults Automatic (dynamically varying the frequency of initial ranging upstream slots between 50 milliseconds
and 500 milliseconds)
Usage Guidelines Use this command to specify the minimum and maximum duration between initial ranging opportunities
that appear in MAP messages sent by the Cisco CMTS. MAP messages define the precise time intervals
during which CMs can send.
The default insertion interval setting (automatic) configures the Cisco CMTS to optimize the initial ranging
times available to new CMs that attempt to join the network. The optimization algorithm automatically varies
the initial ranging times between 50 and 500 milliseconds, depending on the number of CMs attempting to
come online.
Use the cable insertion-interval automatic command to bring a large number of CMs online quickly
(for example, after a major power failure). After the CMs have come online, you can override the
automatic keyword by giving this command again and specifying a specific insertion interval.
Examples The following example shows the default configuration, which is to specify automatic insertion
intervals, using the default initial ranging intervals:
Router# configure terminal
Router(config)# interface cable 3/0
Router(config-if)# cable insertion-interval automatic
Router(config-if)#
The following example shows how to set the minimum insertion interval to 100 ms:
Router# configure terminal
Router(config)# interface cable 5/1/0
Router(config-if)# cable insertion-interval 100
Router(config-if)#
cable intercept
To allow the CMTS to forward all traffic to and from a particular CM to a data collector located at particular
User Datagram Protocol (UDP) port, use the cable intercept command in cable interface configuration
mode. To deactivate this function, use the no form of this command.
Defaults Disabled
Usage Guidelines When this command is activated, the Cisco CMTS router examines each packet for the desired MAC
address; when a matching MAC address is found (for either the origination or destination endpoint), a
copy of the packet is encapsulated into a UDP packet, which is then sent to the specified server at the
given IP address and port.
Note The data collecting system at the ip-address on the udp-port must be configured to listen for and capture
the necessary data stream. An IP route to the specified IP address must exist, and IP connectivity to that
device must be present for the traffic to be captured. Before Cisco IOS Release 12.1(11b)EC, the data
collecting system must be within two routing hops of the Cisco CMTS.
This command can be used to comply with the United States Federal Communications Assistance for
Law Enforcement Act (CALEA) and other law enforcement wiretap requirements for voice
communications. For additional information, see the PacketCable Electronic Surveillance Specification,
http://www.packetcable.com/downloads/specs/pkt-sp-esp-I01-991229.pdf
Tip This command cannot be used on subinterfaces. To monitor traffic on a subinterface, configure the cable
intercept command on the main interface, and the Cisco CMTS router will match on the packets’ MAC
address to filter the appropriate traffic.
Examples The following commands specify that a copy of all traffic for the CM with the MAC address of
0080.fcaa.aabb should be forwarded to the data collector that is listening at UDP port 512 at the IP
address of 10.12.13.8. The show interface cable intercept command displays which intercepts are
currently active.
router#
cable ip-broadcast-echo
To activate upstream IP broadcast echo so that the Cisco CMTS can echo broadcast packets, use the
cable ip-broadcast-echo command in cable interface or subinterface configuration mode. To disable the
upstream IP broadcast echo, use the no form of this command.
cable ip-broadcast-echo
no cable ip-broadcast-echo
Defaults Disabled
Usage Guidelines By default, broadcast IP packets that arrive on the upstream at the Cisco CMTS are not forwarded on the
downstream ports so that they would be delivered to the other CMs and CPE devices. This behavior
prevents broadcast storms in which such packets are repeatedly looped through the network.
The cable ip-broadcast-echo command changes this behavior by forwarding such packets on the
appropriate downstream ports, so that the packet is received by all CMs and CPE devices on that segment
of the network. This allows the cable network to behave more like a standard Ethernet network, and
support direct peer-to-peer communications using IP broadcasts.
Note This command should not be used in a typical service provider network.
Examples The following example shows how to activate IP broadcast echo in the cable interface configuration
mode:
router(config-if)# cable ip-broadcast-echo
The following example shows how to activate IP broadcast echo in the cable subinterface configuration
mode:
router(config)# interface cable 6/0.1
router(config-subif)# cable ip-broadcast-echo
cable ip-multicast-echo
To enable IP multicast echo so that the Cisco CMTS can echo multicast packets, use the cable ip-
multicast-echo command in cable interface or subinterface configuration mode. To disable IP multicast
echo, use the no form of this command.
cable ip-multicast-echo
no cable ip-multicast-echo
Defaults Enabled
Usage Guidelines By default, multicast IP packets that arrive on the upstream at the Cisco CMTS are forwarded on the
appropriate downstream ports so that they are delivered to the other CMs and CPE devices on that
segment of the network. This allows the cable network to behave like a standard Ethernet network in
terms of its handling of multicast IP traffic.
This behavior might not be appropriate for certain applications or networks, so the no cable ip-
multicast-echo command changes this behavior by preventing the forwarding of multicast packets.
Disabling multicast traffic can prevent some types of broadcast storms in which such packets are
repeatedly looped through the network.
To verify if IP multicast echo has been activated or deactivated, enter the show running-config
command and look for the cable interface configuration information. If IP multicast echo has been
enabled (the default configuration), it does not appear in this output. If IP multicast echo has been
disabled, it appears in the output configuration lines as no cable ip-multicast-echo. If you are having
trouble, make sure that you have entered the correct slot and port numbers when you entered cable
interface configuration mode.
Note On the Cisco uBR10012 router, input access lists are not applied to the multicast traffic that is echoed
on each downstream. To control the echoed multicast traffic, you therefore need to configure an output
access list and apply it to each downstream interface.
Examples The following example shows how to disable IP multicast echo in the cable interface configuration
mode:
router(config-if)# no cable ip-multicast-echo
The following example shows how to enable IP multicast echo in the cable subinterface configuration
mode:
router(config)# interface cable 6/0.1
router(config-subif)# cable ip-multicast-echo
Defaults The use of Layer 2 tunneling for ATM PVC mapping is disabled.
Usage Guidelines This command enables the use of Layer 2 tunnels on all cable and ATM interfaces in the router—which
in turn allows you to map cable modems, on the basis of their hardware (MAC) addresses, to particular
PVCs on an ATM interface—using the cable vc-map command.
Examples The following example shows how to enable the use of Layer 2 tunnels on a router so that cable modems
can be mapped to particular PVCs on an ATM interface:
Router# config terminal
Router(config)# cable l2-vpn-service atm-vc
Router(config)#
Usage Guidelines This command enables the use of Layer 2 tunnels, using IEEE 802.1Q VLAN tagging, on all cable
interfaces in the router. This in turn allows you to map traffic to and from cable modems, on the basis of
the modems’ hardware (MAC) addresses, to a particular VLAN on a particular WAN interface, using the
cable dot1q-vc-map command.
Examples The following example shows how to enable the use of IEEE 802.1Q Layer 2 tunnels on a router so that
cable modems can be mapped to particular VLAN:
Router# config terminal
Router(config)# cable l2-vpn-service dot1q
Router(config)#
The following example shows how to disable the use of IEEE 802.1Q Layer 2 tunnels on a router. All
mapping of cable modems to IEEE 802.1Q VLANs is halted (but any other Layer 2 mapping, such as
the mapping of cable modems to ATM PVCs, is unaffected).
Router# config terminal
Router(config)# no cable l2-vpn-service dot1q
Router(config)#
cable load-balance exclude {modem mac-address | oui oui-value} [enforce | static | strict]
no cable load-balance exclude {modem mac-address | oui oui-value} [enforce | static | strict]
Syntax Description modem mac-address Specifies the hardware (MAC) address of an individual cable modem to be
excluded from load balancing. (You cannot specify a multicast MAC
address.)
oui oui-value Specifies the organization unique identifier (OUI) of a vendor, so that cable
modems from this vendor are excluded from load balancing. The OUI must
be specified as three hexadecimal bytes separated by either periods or
colons.
enforce (Optional) Excludes the cable modems from dynamic load balancing, but
they continue to participate in static load balancing.
static (Optional) Excludes the cable modems from static load balancing, but they
continue to participate in passive load balancing and dynamic load
balancing.
strict (Optional) Excludes the cable modems from all forms of load balancing.
static strict (Optional) Excludes the cable modem from active and passive load
balancing, but they continue to participate in dynamic load balancing.
Defaults By default, all cable modems on an interface are automatically included in all configured load-balancing
operations when that cable interface is assigned to a load-balance group (no cable load-balance
exclude). When a cable modem is excluded without any options specified, the cable modem is excluded
from dynamic and static load balancing, but it continues to participate in passive load balancing.
Usage Guidelines The cable load-balance exclude command allows you to specify that particular cable modems should
not participate in one or more types of load-balancing operations. This might be done for cable modems
that are currently provisioned for premium services, for cable modems that do not respond appropriately
to upstream channel change (UCC) or channel override messages, or for other reasons.
In particular, you must use the cable load-balance exclude command to exclude cable modems that
require specific upstream channels or downstream frequencies. Load balancing cannot be done when
cable modems are assigned specific channels or frequencies in their DOCSIS configuration files.
You can use the cable load-balance exclude command to specify that these cable modems should not
participate in the following types of load-balancing operations:
• Static load balancing—Load balancing is done at the time a cable modem registers by specifying the
proper target channel in the Downstream Frequency Override or an Upstream Channel ID Override
field in the registration response (REG-RSP) message that the Cisco CMTS sends to the cable
modem. This is the default form of registration-based load balancing.
• Passive load balancing—Load balancing is done at the time a cable modem registers by ignoring a
cable modem’s registration request (REG-REQ) message until it uses the correct target channels.
Use the cable load-balance exclude command to specify this form of load balancing for older cable
modems that do not respond well to the active form of load balancing.
• Dynamic load balancing—A form of traffic-based load balancing, in which cable modems are
balanced among upstreams and downstreams after they come online, while they are passing traffic.
(Dynamic load balancing is enabled using the enforce option with the cable load-balance group
threshold command.)
Use the cable load-balance exclude command to exclude a cable modem from any combination of load-
balancing operations. Table 2-4 shows which forms of load-balancing operations are excluded and which
are enabled for each form of the cable load-balance exclude command:
Note Excluding cable modems might be required for some cable modems that are not DOCSIS-compliant.
Such cable modems can go offline for long periods of time when load balancing is attempted using
DOCSIS MAC messages. If this is the case, use the cable load-balance exclude command to exclude
such cable modems from load-balancing operations until the modem can be upgraded to DOCSIS-
compliant software.
Examples The following example shows how to exclude a particular cable modem with the MAC address of
0001.0203.0405 from active and dynamic load-balancing operations:
Router# config terminal
Router(config)# cable load-balance exclude mac 0001.0203.0405
Router(config)#
The following example shows how to exclude all cable modems with the OUI of 00.00.0C from active
and dynamic load-balancing operations:
Router# config terminal
Router(config)# cable load-balance exclude oui 00.00.0C
Router(config)#
The following example shows how to exclude all cable modems with the OUI of 00.00.0C from dynamic
load-balancing operations. These cable modems are still subject to static load-balancing operations.
Router# config terminal
Router(config)# cable load-balance exclude oui 00.00.0C enforce
Router(config)#
The following example shows how to exclude a particular cable modem from all forms of load-balancing
operations:
Router# config terminal
Router(config)# cable load-balance exclude mac 0001.0203.0405 strict
Router(config)#
Syntax Description n Specifies the number of the load-balance group. The valid range is 1 to 20.
Note You can create a maximum of 20 load-balance groups on each
chassis. However, you can reuse those load-balance groups on
different sets of cable interfaces, as long as they are in different
domains. If downstreams are not included in a load-balance group,
then each downstream can be considered a separate domain.
method modem (Optional) Specifies that the load-balance group should use the number of
active cable modems on an interface to determine the current load (default).
This method does not take into account the amount of traffic flowing
through those particular cable modems.
method service-flows (Optional) Specifies that the load-balance group should use the number of
active service flow IDs (SFIDs) on an interface to determine the current
load.
method utilization (Optional) Specifies that the load-balance group should use an interface’s
current percentage of utilization to determine the current load.
Tip The utilization method does not begin moving cable modems for
load balancing until the utilization of the interface is at 25 percent
or more. This is done to avoid the unnecessary moving of cable
modems due to temporary spikes in an interface’s utilization rates.
Defaults No load-balance groups are created. By default, a load-balance group uses the actual number of cable
modems online each interface to determine load balancing needs (modem option).
Note If you do not create any load-balance groups, the Cisco CMTS defaults to using a form of registration-
based load balancing that attempts to equally distribute cable modems among upstreams at the time the
cable modems register and come online. No load balancing is done for downstreams or for cable modems
that are already online.
Usage Guidelines The cable load-balance command creates a load-balance group, which can then be assigned to a number
of upstream and downstream cable interfaces to allow the Cisco CMTS to load balance cable modems
as needed. The Cisco CMTS can use the load-balance groups for static, passive, and dynamic load
balancing of both upstream and downstream channels. You can configure downstreams and upstreams
to use the same load balancing parameters, or you can configure upstreams and downstreams separately.
Note You can create a maximum of 20 load-balance groups on each chassis. However, you can reuse those
load-balance groups on different sets of cable interfaces, as long as they are in different domains. If
downstreams are not included in a load-balance group, then each downstream can be considered a
separate domain.
Use the cable load-balance group (global configuration) command to initially create and configure a
load-balance group. Then use the cable load-balance group (interface configuration) command to
assign this load-balance group to an upstream or downstream, so that the cable interface will begin
participating in load-balancing operations.
You can configure a load-balance group to use one of the following types of load-balancing methods:
• Modem Method—Uses the number of active cable modems on an interface.
• Service Flow Method—Uses the number of active Service Flow IDs (SFIDs) on an interface.
• Utilization Method—Uses an interface’s current percentage of utilization.
See the following sections for more information about each method.
Modem Method
The modem method of load-balancing uses the number of active cable modems on an interface to
determine the current load. This is a form of distribution-based load balancing, in which the absolute
numbers of modems are used to determine whether interfaces are load balanced.
This method does not take into account the amount of traffic flowing through the cable modems, but the
system does take into account the relative bandwidth of the channels being used, so that channels with
higher bandwidths are allocated higher numbers of cable modems. This means that when interfaces are
using different channel widths or modulation profiles, the system can assign different numbers of cable
modems to the interfaces to achieve a balanced load. For example:
• Channel widths— If two upstreams are being load balanced, and one upstream is configured with a
channel width of 1.6 MHz and the other upstream is configured for a channel width of 3.2 MHz, the
Cisco CMTS allocates twice as many cable modems to the second upstream, because its channel
width is twice as large as the first upstream’s channel width.
• Modulation profiles— If one downstream is configured for 64-QAM and the other downstream is
configured for 256-QAM, the Cisco CMTS allocates a proportionately larger number of cable
modems to the second downstream so as to achieve a balanced load.
When both the channel width and different modulation profile are set differently on two interfaces, the
system calculates a “weight” value to use as a guide to determine the relative bandwidths of the
interfaces.
Tip In a system with balanced loads, the interfaces will contain the same number of cable modems only when
the interfaces are configured with the same modulation parameters.
The service-flows method of load balancing uses the number of active service flow IDs (SFIDs) on an
interface to determine the current load. This is a form of distribution-based load balancing, in which the
absolute numbers of service flows are used to determine whether interfaces are load balanced.
This method does not take into account the amount of traffic flowing on each SFID, but the system does
take into account the relative bandwidth of the channels being used, so that channels with higher
bandwidths are allocated higher numbers of SFIDs. This means that when interfaces are using different
channel widths or modulation profiles, the system can assign different numbers of SFIDs to the
interfaces to achieve a balanced load. For example:
• Channel widths— For example, if two upstreams are being load balanced, and one upstream is
configured with a channel width of 1.6 MHz and the other upstream is configured for a channel
width of 3.2 MHz, the Cisco CMTS allocates twice as many SFIDs to the second upstream, because
its channel width is twice as large as the first upstream’s channel width.
• Modulation profiles— For example, if one downstream is configured for 64-QAM and the other
downstream is configured for 256-QAM, the Cisco CMTS allocates a proportionately larger number
of SFIDs to the second downstream so as to achieve a balanced load.
When both the channel width and different modulation profile are set differently on two interfaces, the
system calculates a “weight” value to use as a guide to determine the relative bandwidths of the
interfaces.
Tip In a system with balanced loads, the interfaces will contain the same number of SFIDs only when the
interfaces are configured with the same modulation parameters.
Utilization Method
The utilization method uses an interface’s current percentage of utilization to determine the current
load. This method uses the amount of traffic being sent over an interface, in the form of the percentage
of total bandwidth being used. (To avoid unnecessary movement of cable modems, the utilization
method does not perform load balancing until an interface is at least 25 percent of utilization.)
Note Do not use the utilization method of load balancing on cable interfaces that have a small
number of cable modems and where a single modem is responsible for the majority of the
interface load. In this condition, the Cisco CMTS could end up continually moving cable
modems from one interface to another in an endless attempt to load balance the interfaces.
To avoid this, configure the utilization threshold to a value that is higher than what can be
caused by any single cable modem.
When using the utilization method, the system takes into account the relative throughput and bandwidth
(as determined by the modulation profiles and channel widths) of each interface when evaluating the load
on those interfaces. For example, if two upstreams are being load-balanced using the utilization method,
and the first upstream has twice the bandwidth of the second upstream, the two upstreams are considered
balanced when they reach the same percentage of utilization. The first upstream is carrying more traffic
than the second upstream because it has a larger capacity for traffic, but the percentage of utilization will
be the same.
Note Certain conditions can cause a system instability that could result in the Cisco CMTS endlessly
attempting to load balance the interfaces. For example, this situation could occur in noisy environments,
where cable modems drop offline on a regular basis, or when cable modems are repeatedly trying to
register because the provisioning system has sent them the wrong DOCSIS configuration files. If the
Cisco CMTS detects such unstable situations, it does not load balance cable modems from those
interfaces until the system stabilizes. However, if the system instability persists, you should increase the
threshold values using the cable load-balance group threshold command until you can solve the
stability problems.
Use the no form of this command to delete a load-balance group. Deleting a load-balance group also
automatically removes all upstream and downstream channel associations that were made with that
group using the cable load-balance and cable upstream load-balance commands.
Tip To exclude individual cable modems from one or more types of load balancing, use the cable load-
balance exclude command.
Examples The following example shows how to create a load-balance group numbered 10, using the default method
of modem, which specifies that the Cisco CMTS uses the actual number of cable modems that are online
to determine load-balancing operations.
Router# config terminal
Router(config)# cable load-balance group 10
Router(config)#
The following example shows how to create a load-balance group numbered 1, which uses the number
of active SFIDs on an interface to determine the current load on the interface:
Router# config terminal
Router(config)# cable load-balance group 1 method service-flows
Router(config)#
Command Description
cable upstream load- Assigns an upstream to a load-balance group.
balance group
clear cable load- Clears the counters or state machine used to track load-balancing
balance operations.
show cable load- Displays real-time statistical and operational information for load-
balance balancing operations.
Syntax Description n Specifies the number of the load-balance group to which the downstream
should be assigned. The valid range is 1 to 20.
Defaults A downstream is not assigned to a load-balance group. When you use this command to add a downstream
to a group, it also automatically adds all of the associated upstreams to the same group, unless you have
also used the cable upstream load-balance group command to assign the upstreams to different groups.
Usage Guidelines After you have used the cable load-balance group (global configuration) command to initially create
and configure a load-balance group, use the cable load-balance group (interface configuration)
command to assign this load-balance group to a downstream. This enables the cable interface to begin
participating in load-balancing operations.
Tip Use the cable upstream load-balance group command to assign this load-balance group to an
upstream.
The following rules apply when creating and assigning load-balance groups:
• A downstream or upstream can belong to only one load-balance group.
• All downstreams and upstreams in a load-balance group must share physical radio frequency (RF)
connectivity to the same group of cable modems. Downstreams can be in a separate load-balance
group than upstreams, but all downstreams or all upstreams that have the same RF physical
connectivity must be members of the same load-balance group. You cannot distribute downstreams
or upstreams that share physical connectivity across multiple load-balance groups.
Note If both downstreams and upstreams are assigned to the same load-balance group, the
Cisco CMTS attempts to balance both the downstream and upstream values when it moves
cable modems.
• If the load-balance group includes downstream interfaces, you must also configure the downstream
center frequency on those interfaces, using the cable downstream frequency cable interface
command. This command is informational-only on cable interfaces that use an external upconverter,
but it is required for load balancing, so that the Cisco CMTS knows where to move cable modems
when it is load balancing downstreams.
• Load balancing is done only on a per-chassis basis—all interfaces in a load-balance group must be
in the same chassis.
Note In Cisco IOS Release 12.2(15)BC1, you can configure an interface for both load balancing and Hot-
Standby Connection-to-Connection (HCCP) N+1 redundancy, but load balancing does not continue after
a switchover from a Working to a Protect interface. Load balancing resumes when the Cisco CMTS
switches back to the Working interface.
Examples The following example shows how to assign the first downstream on the cable interface line in slot five
to load balance group 5:
Router# config terminal
Router(config)# interface cable 5/0
Router(config-if)# cable load-balance group 5
Router(config-if)#
Syntax Description n Specifies the number of the load-balance group. The valid range is 1 to 20.
interval Specifies the frequency, in seconds, for how often the Cisco CMTS should
determine the current load on each cable interface. This also determines the
minimum time between when cable modems can be moved to load balance
the interfaces. One cable modem at most is moved during each interval time
period. The valid range is 0 to 3600 seconds, with a default value of 10
seconds.
Defaults Each load-balance group defaults to a frequency of 10 seconds to determine the current load on an
interface, allowing at most one cable modem to be moved every 10 seconds.
Usage Guidelines To properly perform load balancing, the Cisco CMTS must determine the actual load on an interface on
a periodic basis. This frequency of the updates also determines how frequently cable modems can be
moved to achieve balanced loads. One cable modem, at most, is moved during each update period.
The more often these updates are performed, the more accurate the Cisco CMTS can be in performing
its load-balancing operations. As a general rule, begin with the default frequency value of 10 seconds,
and then adjust the value accordingly, in small increments, as load balancing conditions or performance
levels might require.
Note Having too small an interval could result in cable modems being constantly moved to achieve balanced
loads during peak usage times when load balance could spike to transient heavy traffic. Also, more
frequent updates can have a performance impact, especially on routers with a large number of active
interfaces and cable modems.
Examples The following example shows how to configure load-balance group 3 so that it performs a policy update
every 30 seconds:
Router# config terminal
Router(config)# cable load-balance group 3 interval 30
Router(config)#
The following example shows how to reset load-balance group 10 to its default update frequency of 10
seconds:
Router# config terminal
Router(config)# no cable load-balance group 10 interval
Router(config)#
Syntax Description n Specifies the number of the load-balance group. The valid range is 1 to 20.
Defaults Cable modems with active UGS service flows can be moved for load-balancing (cable load-balance
group n policy ugs)
Usage Guidelines The cable load-balance group policy ugs command determines whether a load-balance group can move
cable modems with UGS service flows, so as to enforce dynamic load balancing policies. Because most
voice calls use UGS service flows to allow real-time traffic, this option is primarily used to determine
whether the Cisco CMTS will move cable modems with active voice calls.
If you disable this option (no cable load-balance group policy ugs), the Cisco CMTS does not move
cable modems with active UGS service flows to a new upstream or downstream. This prevents some
possible interruptions of service to these customers, but it could result in denial of service conditions for
other customers if the interface starts becoming overloaded.
To avoid this, the default configuration (cable load-balance group policy ugs) of this command allows
the Cisco CMTS to move cable modems to a new upstream or downstream, even if they have active UGS
service flows. This enables the Cisco CMTS to perform optimum load balancing, but it could cause a
momentary interruption in the voice call—users on the voice call might hear a momentary drop during
the call, but the call should not be terminated.
Note The cable load-balance group policy ugs command affects only dynamic load-balancing operations
and does not affect static and passive load-balancing operations. Dynamic load balancing is enabled
using the enforce option with the cable load-balance group threshold command.
Examples The following example shows how to enable the UGS policy on a load-balance group (the default
configuration), so that the Cisco CMTS can move cable modems with active UGS service flows as
needed to enforce the current dynamic load balancing policy:
Router# config terminal
Router(config)# cable load-balance group 13 policy ugs
Router(config)#
The following example shows how to configure a load-balance group so that the Cisco CMTS does not
move cable modems with active UGS service flows (default configuration):
Router# config terminal
Router(config)# no cable load-balance group 100 policy ugs
Router(config)#
Syntax Description n Specifies the number of the load-balance group. The valid range is 1 to 20.
load load-value Specifies the maximum load difference, as expressed in a percentage of
total load, that can exist between interfaces in a load-balance group before
the Cisco CMTS performs load balancing. If the load between interfaces is
greater than the value specified by load-value, cable modems that are
registering are assigned to the lesser-utilized interface until the load
difference is once again below this value. The valid range for load-value is
1 to 100 percent, with a default of 10 percent.
Note The default of 10 percent is the minimum recommended threshold.
Do not set this threshold below 10 percent unless you have been
instructed to do so by Cisco TAC.
enforce threshold (Optional) Enables dynamic load balancing, which moves online cable
modems after their initial registration to achieve load balancing of the cable
interfaces in a load-balance group. Cable modems that are currently online
are moved when the load difference between two interfaces in the load-
balance group exceeds this percentage. Modems continue to be moved until
the load difference falls below this value.
The possible valid range for threshold is 1 to 100 percent, but the threshold
must be equal to or greater than the percentage specified with the load-value
option. For this reason, the actual minimum for threshold is the current
setting of the load-value option. The default is also the same value as the
load-value parameter.
load minimum number (Optional) Specifies that cable modems should be moved only if the load
between the two interfaces is greater than the specified number of cable
modems or service flows (valid only when the method is the number of
modems or service flows). The valid range is 1 to 100, with a default of 5.
stability percent Specifies the threshold to be used to determine whether a channel or
interface is unstable, in terms of the percentage of successful ranging
requests. The percent value specifies the minimum percentage of successful
ranging requests that is acceptable; otherwise, the CMTS begins moving
CMs. The valid range is 1 to 100 percent, with a default of 50 percent.
ugs band-value Specifies that the Cisco CMTS should move cable modems with active UGS
service flows when the current UGS usage reaches the percentage of total
bandwidth available that is specified by the band-value parameter. The valid
range for band-value is 0 to 100 percent, with a default of 70 percent.
Note This option is effective only when the enforce option has also been
used to enable dynamic load balancing, and the Cisco CMTS has
been authorized to move cable modems with active UGS service
flows (using the cable load-balance group policy ugs command).
Defaults The load parameter defaults to 10 percent, the load minimum parameter defaults to 5, the stability
parameter defaults to 50 percent, and the ugs parameter defaults to 70 percent. By default, only static
load balancing is done (no enforce option). If the enforce option is given without a threshold value, it
defaults to the same value as the load parameter.
Usage Guidelines The cable load-balance group threshold command configures a load-balance group for the threshold
values that it should use to determine when a cable modem should be moved to a new downstream or
upstream. You can specify the following different thresholds:
• load—Specifies the maximum load usage that can exist between interfaces in a load-balance group
before the Cisco CMTS begins static load-balancing operations. The default value of load-value is
10 percent, which means that two upstreams or two downstreams can have usage rates that vary up
to 10 percent before the Cisco CMTS begins rebalancing the load usage. This rebalancing, however,
is done only when cable modems first register with the Cisco CMTS—the Cisco CMTS does not
switch cable modems that are already online.
For example, if the load value is 10 percent, and upstream 1 is at 23 percent and upstream 2 is at 30
percent, no cable modems are moved. However, if load usage for upstream 2 reaches 35 percent, the
Cisco CMTS begins assigning new cable modems, as they register, to upstream 1 until the difference
in load usage between the two upstreams falls below 10 percent.
Note The default of 10 percent is the minimum recommended threshold. Do not set this threshold
below 10 percent unless you have been instructed to do so by Cisco TAC.
• enforce—Enables dynamic load balancing, so that the Cisco CMTS can move cable modems that
are already online. This option has its own threshold value, which specifies the difference in load
usage that must exist between two interfaces in a group before the Cisco CMTS begins moving
online cable modems. The Cisco CMTS continues to move cable modems until the difference in load
usage rates falls below the threshold value.
When using dynamic load balancing and an upstream channel is overloaded, the Cisco CMTS sends
an Upstream Channel Change (UCC) request to a cable modem to instruct it to move to another
upstream. The cable modem should move to the new upstream channel, without going offline or
having to reregister with the CMTS.
When using dynamic load balancing and a downstream channel is overloaded, the Cisco CMTS
sends an abort response to a cable modem’s ranging request (RNG-REQ) message. When the cable
modem sends a new REG-REQ message, the Cisco CMTS specifies the new downstream channel in
the Downstream Frequency Override field in its REG-RSP message. The cable modem must go
offline and reregister on the new downstream channel, so as to conform to the DOCSIS 1.0
specifications.
Note In Cisco IOS Release 12.2(15)BC1, the dynamic load balancing method results in cable
modems going offline and having to reregister whenever the modems are moved between
downstreams. This is because the DOCSIS 1.0 specification requires cable modems to
reregister whenever the downstream is changed using the Downstream Frequency Override
message. Cable modems should not go offline when moved between upstreams.
The Cisco CMTS also continues to enforce the load threshold value to perform static load balancing
as well. Therefore, the threshold percentage should be equal to or greater than the percentage
specified with the load load-value option.
For example, if you specify load 10 enforce 15, the Cisco CMTS monitors the load usage between
cable interfaces in the load-balance group. If upstream 1 reaches 33 percent and upstream 2 reaches
45 percent, the Cisco CMTS begins static load-balancing operations by assigning new cable
modems to upstream 1 when they register. If the difference still continues to grow, and upstream 2
reaches 50 percent, the Cisco CMTS also begins dynamic load-balancing operations by moving
online cable modems, until the difference in load usage falls below 15 percent. The Cisco CMTS
then continues static load-balancing operations until the difference falls below 10 percent.
Tip The enforce threshold is not displayed in the configuration file if it is the same as the load
threshold. For example, if you enter the “cable load-balance group 1 threshold load 50
enforce 50” command, it appears as “cable load-balance group 1 threshold load 50 enforce”
in the configuration file.
• load minimum—Specifies that cable modems should be moved only if the load between the two
interfaces is greater than the specified number of cable modems or service flows. This option is valid
only when you have configured the load-balance group using either the method modem or
method service-flows options with the cable load-balance group (global configuration)
command. It is not used with the utilization method.
• stability—Specifies the minimum percentage of ranging requests that are successful before the
Cisco CMTS determines that the interface or channel is unstable. When the channel has fewer than
this percentage of cable modems responding to periodic ranging requests over a one-minute period,
the Cisco CMTS begins moving modems to other channels in the load-balance group. For example,
when set to 75 percent, the Cisco CMTS begins moving modems when fewer than 75 percent of
modems are replying to ranging requests.
• ugs—Specifies a threshold for when the Cisco CMTS should move cable modems that have active
UGS service flows, which are typically used for active voice calls. This option goes into force only
when dynamic load balancing has been enabled (using the enforce option), and the Cisco CMTS has
been allowed to move cable modems with active UGS service flows (using the cable load-balance
group policy ugs command). The band-value threshold specifies the maximum usage of UGS
service flows that should exist before the Cisco CMTS begins moving calls.
For example, if the band-value threshold is at its default of 70 percent, the Cisco CMTS does not
begin moving cable modems with active UGS service flows until UGS usage on an upstream or
downstream reaches 70 percent of the total available bandwidth. The Cisco CMTS continues
moving cable modems that are online with active UGS service flows until the UGS usage on the
interface falls below 70 percent.
Note Certain conditions can cause a system instability that could result in the Cisco CMTS endlessly
attempting to load balance the interfaces. For example, this situation could occur in noisy environments,
where cable modems drop offline on a regular basis, or when cable modems are repeatedly trying to
register because the provisioning system has sent them the wrong DOCSIS configuration files. If the
Cisco CMTS detects such unstable situations, it does not load balance cable modems from those
interfaces until the system stabilizes. However, if the system instability persists, you should increase the
threshold values using the cable load-balance group threshold command until the system stabilizes.
Examples The following example shows how to configure load-balance group 2 so that it performs static load
balancing when the difference between two cable interfaces in the group is 20 percent or more.
Router# config terminal
Router(config)# cable load-balance group 2 threshold load 20
Router(config)#
The following example shows how to configure load-balance group 5 so that it performs static load
balancing when the difference in usage between two cable interfaces in the group is 20 percent or more,
and so that it performs dynamic load balancing when the difference in usage is 30 percent or more. The
Cisco CMTS will also begin moving cable modems with active UGS service flows when UGS service
flows reach 60 percent of the total bandwidth available on the upstream channel.
Router(config)# cable load-balance group 5 threshold load 20 enforce 30
Router(config)# cable load-balance group 5 threshold ugs 60
Router(config)# cable load-balance group 5 policy ugs
Router(config)#
Note You must configure the load-balance group with the cable load-balance group policy ugs command
before the Cisco CMTS begins enforcing the threshold that was set with the cable load-balance group
threshold ugs command.
Syntax Description buffer-size Specifies the total size of the buffer that will contain the logged error
messages. The valid range is 4096 to 1048576 bytes (4 KB to 1 MB),
with a default value of 4096 bytes.
Note The maximum buffer size is limited by the amount of actual
unused memory that is available on the Cisco CMTS.
Defaults Error messages for bad IP source addresses are logged to the console or current system log, if defined.
If logged is enabled, without specifying a specific buffer size, the default size is 4096 bytes (4 KB).
Usage Guidelines The cable source-verify command enables service providers to verify that the IP addresses being used
on the cable interface have been properly assigned by the provider’s DHCP servers. When a bad IP
address is detected, the Cisco CMTS generates a BADIPSOURCE error message in the console logs.
In previous Cisco IOS releases, the Cisco CMTS generated these particular error messages for every IP
packet that contained a bad IP source address. This can create a large volume of error messages that can
make it difficult to see other error messages in the console logs.
To create a separate log for these error messages, use the cable logging badipsource command. You can
also specify the size of the buffer that will contain these error messages. When the buffer becomes full,
the oldest messages are deleted to make room for newer messages, so choose a buffer size that will allow
you to retain all messages until you can examine them.
On the Cisco uBR10012 router, this command includes only the BADIPSOURCE error messages
generated by the PRE module. The cable interface line cards also generate their own error messages, but
because these error messages are typically duplicates of the ones generated by the PRE module, they are
not included in the separate log.
Tip If you find that the current buffer is too small to contain the current volume of error log messages, you
can issue this command again with a larger buffer size. However, doing so will automatically clear out
all messages currently in the buffer, so be certain that you have viewed all of the current messages before
giving a second cable logging badipsource command.
Note Be cautious when specifying the buffer size, because the Cisco CMTS could run out of memory for other
tasks. Use the show memory EXEC command to display the maximum available processor memory,
and set the buffer size for this command to a value well within that maximum value.
To display the contents of this error log, use the show cable logging command. To clear the buffer after
you have viewed the error messages, use the clear cable logging command. You can also use the service
timestamps log command to add a timestamp to the messages in the log.
To print the BADIPSOURCE messages to the console or syslog server, use the no cable logging
badipsource command (which is the default configuration). Note that this configuration does not turn
off the generation of BADIPSOURCE messages, but only configures the system for the default log
message behavior.
Tip If you do not want to see any BADIPSOURCE messages at all, use the cable logging badipsource 4096
command so that these messages go to a separate buffer with the smallest possible size. You will then
not see these error messages unless you explicitly use the show cable logging command to display them.
Examples The following example shows how to enable the logging of bad IP source address error messages, using
a buffer size of 524,288 bytes (512 KB):
Router# configure terminal
Router(config)# cable logging badipsource 524288
Router(config)#
Tip You must also use the cable source-verify command to enable verification of source IP addresses before
the buffer will contain any error messages about bad IP source addresses. If you do not use the cable
source-verify command, you can still use the cable logging badipsource command to create a buffer,
but the buffer will always remain empty.
The following example shows how to enlarge the current buffer for bad IP source address error messages
by giving the cable logging badipsource command a second time. Because this will empty out the buffer
of all current messages, be sure to display the current buffer contents before giving the command a
second time.
Router# configure terminal
The following example shows how to stop the logging of bad IP source address error messages to a
separate buffer. This clears out all error messages from the buffer and removes the buffer from memory,
and future error messages for bad IP source addresses are logged to the console or to the current system
log, if any.
Router# configure terminal
Router(config)# no cable logging badipsource
Router(config)#
Related Commands cable source-verify Enables verification of IP addresses for CMs and CPE devices on the
upstream.
clear cable logging Removes all error messages about bad IP source addresses on the
cable interfaces from the error log buffer.
show cable logging Displays the log of error messages about bad IP source addresses on
the cable interfaces.
Defaults DOCSIS events are saved to the general logging buffer on the Cisco CMTS by default.
Usage Guidelines Use the show cable logging command to check whether the logging feature is enabled and the status of
the logging buffer.
Examples The following example shows how to clear the log buffer that contains a bad IP source address error
messages:
Router# show cable logging summary
cable map-advance
To configure the dynamic map advance algorithm, use the cable map-advance command in cable
interface configuration mode. Use the no form of this command to disable this function.
no cable map-advance
Syntax Description dynamic safety Enables the dynamic MAP advance algorithm that automatically tunes
lookahead time in MAPs based on the current farthest CM on a
particular upstream port. The safety argument specifies a safety factor
for the dynamic map advance algorithm in microseconds. This value
controls the amount of extra lookahead time in MAPs to account for
inaccuracies of the measurement system and internal software
latencies. The valid range is 300 to 1500 microseconds, with a default
of 1000.
Note Using larger safety factors increases the run time lookahead in
MAPs, but reduces the upstream performance.
static Enables the static map advance algorithm that uses a fixed lookahead
time value in MAPs based on the worst-case propagation delay of 100
mile HFC cable network.
max-delay Specifies the maximum round trip delay between the cable plant and
furthest CM in microseconds. The valid range is 100 to 2000
microseconds, with a default of 1800. The typical delay for a mile of
coaxial cable is approximately 7 microseconds. The typical delay for a
mile of fiber cable is approximately 8 microseconds.
Defaults Dynamic map advance with a safety factor of 1000 microseconds and a max-delay of 1800 microseconds
Usage Guidelines The max-delay option, which was introduced in Cisco IOS Release 12.1(10)EC, specifies the maximum
possible round-trip delay between the cable plant and furthest CM in the cable network. A CM will not
be allowed to exceed the maximum timing offset given by the max-delay value (in static mode) or given
by the combination of the max-delay and safety values (in dynamic mode). If a CM reports a timing
offset beyond the maximum value, the CMTS will reset its offset to the maximum value and put an
exclamation point (!) next to its offset value in the show cable modem display.
In dynamic MAP operation, Cisco IOS 12.1(10)EC also implements a regular polling of the furthest CM,
to determine if that CM is now offline. If the furthest CM has gone offline, the CMTS scans the currently
online CMs to determine which CM is now the furthest offline and updates the dynamic MAP advance
algorithm with the new value.
Tip The show cable modem command displays the CM timing offset in DOCSIS ticks. Use the following
method to convert microseconds to DOCSIS ticks: ticks = microseconds*64/6.25. To
Note Dynamic map advance might need to be temporarily turned off if the first modem to be connected outside
of the CMTS is close to the 100-mile limit of the DOCSIS specification.
Tip To reset the timing offset values on an upstream, use the shutdown and no shutdown commands to reset
the upstream port. This will temporarily force all CMs on that upstream offline until they reacquire the
upstream.
Examples The following example shows how to configure the dynamic map advance to 4000 microseconds:
router(config-if)# cable map-advance dynamic 4000
Related Commands show cable modem Displays statistics for the connected CMs.
cable max-hosts
To specify the maximum number of hosts that can be attached to a subscriber's CM, use the cable max-
hosts command in cable interface configuration mode. Use the no form of this command to reset the
allowable number of hosts attached to a CM to the default value of 0 hosts.
cable max-hosts n
no cable max-hosts
Syntax Description n Specify the maximum number of hosts that can be attached to a CM on
this interface. Valid range is from 0 to 255 hosts. Default value is 0.
Defaults 0
Usage Guidelines The Cisco CMTS uses three commands set the maximum number of hosts for a particular CM, for all
CMs on a particular cable interface, or for all CMs using the Cisco CMTS router:
• cable modem max-hosts—Sets the maximum number of hosts for a particular CM.
• cable max-hosts—Sets the maximum number of hosts for all CMs on a particular cable interface.
• cable modem max-cpe—Sets the maximum number of hosts for all CMs using the Cisco CMTS
router.
The more specific commands override the settings of the less specific commands. For example, if you
use the cable modem max-cpe command to set the maximum number of hosts to 2 for all CMs, you can
still use the cable modem max-hosts command to give a particular CM a larger maximum host value.
Note The CMTS assigns the MAX Host value to a cable modem at the time that the cable modem registers
with the CMTS. Changing any of the MAX Host commands affects only cable modems that register after
the change.
Tip For more information on how these commands interact to set the maximum CPE values, see the chapter
Maximum CPE or Host Parameters for the Cisco Cable Modem Termination System in the
Cisco CMTS Feature Guide, available on Cisco.com and the Documentation CD-ROM.
Examples The following example shows how to set the maximum hosts for CMs on this particular cable interface
to 15:
Router(config)# interface c6/0
Router(config-if)# cable max-hosts 15
Syntax Description access-list Specifies that the IP multicast streams defined by the access list be
encrypted. Access lists can be IP access list numbers or an IP access
list name. Valid access list numbers are from 100 to 199.
Usage Guidelines The cable match address command binds an access-list to a cable interface, allowing multicast
encryption to be performed on traffic through that interface. To configure the access list, use the
ip access-list command.
For additional information on configuring for multicast operations, see the chapters on IP Multicast in
the Release 12.2 Cisco IOS IP Configuration Guide and in Volume 3 of the Cisco IOS IP Command
Reference.
Note This command is available only on images that support Baseline Privacy Interface (BPI) and Baseline
Privacy Interface Plus (BPI+) encryption.
Examples The following example shows how to specify that the multicast stream defined by the access list named
reno be encrypted on cable interface 3/0:
router(config)# interface c3/0
router(config-if)# cable match address reno
The following example shows how to specify that the multicast stream defined by the access list number
102 be encrypted:
router(config)# interface c3/0
router(config-if)# cable match address 102
Note The cable modem access-group command is not supported on the Cisco uBR10012 universal
broadband router.
Examples The following example shows the cable modem access-group command assigning access-list 1 to the
CM with the MAC address of abcd.ef01.2345:
Router# cable modem abcd.ef01.2345 access-group 1
Router#
Command Description
cable modem max- Specifies the maximum hosts for a CM.
hosts
cable modem qos Specifies the QoS profile for a CM.
profile
show cable modem Displays CM configuration settings.
Usage Guidelines This command allows the CMTS administrator to change the downstream frequency for a CM,
overriding the DOCSIS configuration file setting. This command is not applicable on Cisco IOS
Release 12.1(3a)EC.
Examples The following example shows how to change the downstream frequency of the CM having IP address
172.172.172.12 to 570 MHz:
router# cable modem 172.172.172.12 change-freq 57000000
router#
Syntax Description n Specifies the configuration file value. Valid range is 1 to 255.
unlimited Specifies the maximum CPE value to be unlimited.
Defaults The max-cpe value provided in the configuration file will be used by the CMTS to limit the number of
hosts connected to a single CM (no cable modem max-cpe).
Examples The following example shows how to override the max-cpe setting in a CM configuration file:
router(config)# cable modem max-cpe unlimited
Usage Guidelines The CMTS enables up to n number of hosts for a modem.When set to unlimited, or n is larger than the
max-cpe value in the configuration file of a CM, this command overrides the configuration file value.
Note When setting to unlimited or n is greater than the max-cpe value in the configuration file of a CM, the
CM has to control the maximum number of hosts, and the DHCP server has to control the number of IP
addresses assigned to hosts behind a single CM.
Caution Use of this command might open a security hole in the system by enabling denial of service attacks.
Specifically, it might enable a user to obtain a large number of IP addresses, thereby taking down the
entire network, after all the available IP addresses have been reserved by this single user.
Cisco recommends that, if this command is enabled, the number of IP addresses assigned to hosts behind
a single modem be strictly controlled by the DHCP server.
The Cisco CMTS uses three commands set the maximum number of hosts for a particular CM, for all
CMs on a particular cable interface, or for all CMs using the Cisco CMTS router:
• cable modem max-hosts—Sets the maximum number of hosts for a particular CM.
• cable max-hosts—Sets the maximum number of hosts for all CMs on a particular cable interface.
• cable modem max-cpe—Sets the maximum number of hosts for all CMs using the Cisco CMTS
router.
The more specific commands override the settings of the less specific commands. For example, if you
use the cable modem max-cpe command to set the maximum number of hosts to 2 for all CMs, you can
still use the cable modem max-hosts command to give a particular CM a larger maximum host value.
Note The CMTS assigns the MAX Host value to a cable modem at the time that the cable modem registers
with the CMTS. Changing any of the MAX Host commands affects only cable modems that register after
the change.
Tip For more information on how these commands interact to set the maximum CPE values, see the chapter
Maximum CPE or Host Parameters for the Cisco Cable Modem Termination System in the
Cisco CMTS Feature Guide, available on Cisco.com and the Documentation CD-ROM.
Note The “Number of CPES” field in the show cable modem command shows the maximum CPE value for
the CM, not the value for the CMTS that is set by the cable modem max-cpe command.
Defaults 0
Usage Guidelines The Cisco CMTS uses three commands set the maximum number of hosts for a particular CM, for all
CMs on a particular cable interface, or for all CMs using the Cisco CMTS router:
• cable modem max-hosts—Sets the maximum number of hosts for a particular CM.
• cable max-hosts—Sets the maximum number of hosts for all CMs on a particular cable interface.
• cable modem max-cpe—Sets the maximum number of hosts for all CMs using the Cisco CMTS
router.
The more specific commands override the settings of the less specific commands. For example, if you
use the cable modem max-cpe command to set the maximum number of hosts to 2 for all CMs, you can
still use the cable modem max-hosts command to give a particular CM a larger maximum host value.
Note The CMTS assigns the MAX Host value to a cable modem at the time that the cable modem registers
with the CMTS. Changing any of the MAX Host commands affects only cable modems that register after
the change.
Tip For more information on how these commands interact to set the maximum CPE values, see the chapter
Maximum CPE or Host Parameters for the Cisco Cable Modem Termination System in the
Cisco CMTS Feature Guide, available on Cisco.com and the Documentation CD-ROM.
Examples The following example shows sets the CM with the IP address of 172.172.172.12 to a maximum of 40
attached CPE devices:
router# cable modem 172.172.172.12 max-hosts 40
Usage Guidelines On a Cisco CMTS running DOCSIS 1.0 software, the cable modem qos profile command forces a CM
to use a specific QoS profile.
On a Cisco CMTS running DOCSIS 1.1 software, the cable modem qos profile command temporarily
forces a DOCSIS 1.0 or DOCSIS 1.0+ CM to use a specific QoS profile, without forcing the CM to first
go off-line and re-register. For DOCSIS 1.0+ CMs, this command affects only the primary SID on the
CM.
Note In Cisco IOS Release 12.2(15)BC1, this command has an effect only when the profile that it specifies
and the original QoS profile on the CM have been created already on the Cisco CMTS, using the cable
qos profile command. In Cisco IOS Release 12.2(15)BC2 and later releases, this restriction is removed
and this command can also be used to change the profile for a CM even when it is using a CM-created
QoS profile.
This command does not affect DOCSIS 1.1 CMs, which support dynamic service change messages that
allow the QoS profile to be changed dynamically.
Note This command acts as a toggle. Give the cable modem qos profile command once to enforce a QoS
profile. Give the same command again with the same parameters to cancel the enforcement of that profile
(the CM will return to using its registered profile.)
When the no-persistence option is specified, the QoS profile is not applied when a cable modem reboots.
Instead, the Cisco CMTS allows the cable modem to use the QoS profile that is specified in its DOCSIS
configuration file.
The no-persistence option can be used when initially when identifying potential problem applications
and users. When repeat offenders are identified, the service provider can remove the no-persistence
option, so that these users continue to use the specified QoS profile even if they reboot their cable
modems.
Examples The following example shows how to specify a QoS profile index to a CM:
Router# cable modem qos profile 255
Router#
Syntax Description polling-delay Specifies the delay between each poll that the CMTS makes to collect
the CM statistics. When the CMTS completes one remote-query poll,
the CMTS waits this time period before beginning another poll. Valid
range is from 1 to 86,400 seconds, with a recommended default value
of 30 seconds.
community-string Defines the Simple Network Management Protocol (SNMP)
community string.
Usage Guidelines
Note With Cisco IOS Release 12.2BC and 12.1EC, difficulty has been observed when attempting to remove
the remote-query feature from the Cisco CMTS. The no form of this command does not remove the
cable modem remote-query once configured on the Cisco CMTS. This restriction applies to Cisco
uBR7100 series, Cisco uBR7200 series, and Cisco uBR10012 routers, and is being tracked as caveat
number CSCdy10666.
To use the remote-query feature, you must configure the CM and Cisco CMTS as follows:
• Configure a read-only SNMP community string on the CM for use with the remote-query feature.
This typically should be a separate community string from the read-write string used to remotely
monitor and configure the CM.
• Configure a matching community string on the Cisco CMTS using the snmp-server community
community-string and snmp-server manager commands.
• Enable the remote-query feature on the Cisco CMTS with the cable modem remote-query polling-
delay community-string command. The polling-delay should be chosen so that the statistics can be
obtained in a timely manner without seriously impacting system performance. Cisco recommends
initially setting the polling-delay to 30 seconds and adjusting that time period as needed.
Note The polling-delay time period determines only how long the Cisco CMTS waits after
completing one polling cycle before beginning a new polling cycle. It does not indicate how
long the Cisco CMTS spends in each polling cycle, which depends on the number of cable
modems being polled. To calculate the approximate time for a polling cycle, assume 4 to 5
CMs per second (100 to 200 milliseconds per CM). Also take into account the possibility
that one or more cable modems might not respond, with an approximate timeout period of
90 seconds.
You must specify matching community strings for the CM, the snmp-server community community-
string command, and the cable modem remote-query command.
Note You can reissue the cable modem remote-query command to change the polling interval at any time,
and the change becomes effective immediately. However, to change the SNMP community string, you
must first disable remote polling with the no snmp manager and no cable modem remote-query
commands. Then reconfigure the new community string with the snmp-server community community-
string, snmp-server manager, and cable modem remote-query commands.
Tip After enabling the remote-query feature, you can display the collected statistics with the show cable
modem remote-query command. You can also display these statistics by querying the attributes in the
CISCO-DOCS-REMOTE-QUERY-MIB MIB.
Examples The following example illustrates how to set the polling interval to 5 seconds and the SNMP community
string to private:
Router# configure terminal
Router(config)# cable modem remote-query 5 private
Router(config)# snmp-server community private
Router(config)# snmp-server manager
Router(config)#
The following example demonstrates how to change the remote-query configuration, by first deleting the
existing configuration and then giving the new configuration:
Router# configure terminal
Router(config)# no cable modem remote-query
Router(config)# no snmp-server manager
Router(config)# cable modem remote-query 10 public
Router(config)# snmp-server community public
Router(config)# snmp-server manager
Router(config)#
Syntax Description OUI Specifies the Organizational Unique Identifier (OUI). An OUI is the
first 3 octets (3 bytes, 6 hexadecimal digits) of the CM MAC address and
typically indicates the vendor for the CM. The octets can be specified as
one string (for example: 000102), or each octet can be separated by a
hyphen, period, or colon (for example: 00-01-02 or 00:01:02 or
00.01.02).
Note You can use either a period or colon as the separator between
octets when manually entering this command, but the
command that is written to the running and startup
configuration files will always use a period.
vendor-name (Optional) Specifies an arbitrary string identifying the vendor for this
OUI.
Defaults A default database contains approximately 300 OUIs associated with approximately 60 vendor names.
Usage Guidelines The cable modem vendor command allows you to associate an arbitrary string with an OUI to identify
the vendor of the associated CM. The vendor name is then displayed as part of the show cable modem
vendor command.
The show cable modem vendor command uses a default database of approximately 300 OUIs. If the
OUI and vendor are not in that database, the show cable modem vendor command displays the OUI as
the vendor name, but you can use the cable modem vendor command to associate a vendor name with
the new OUI.
If you specify an OUI with the cable modem vendor command that already exists in the OUI database,
the previous value is overwritten with the new value. You can use the default prefix to restore the
original value for an OUI in the default database.
You can also use the no cable modem vendor command to remove the association between an OUI and
a vendor name. The show cable modem vendor command then displays only the OUI as the vendor
name.
Tip The Institute of Electrical and Electronics Engineers (IEEE) is the official issuer of OUI values. The
IEEE OUI web site is at http://standards.ieee.org/regauth/oui/index.shtml.
Examples The following shows several examples of the cable modem vendor command using Cisco OUIs:
Router(config)# cable modem vendor 00:01:42 Cisco
Router(config)# cable modem vendor 00:01:43 Cisco
Router(config)# cable modem vendor 00:01:63 Cisco
Router(config)# cable modem vendor 00:01:64 Cisco
Router(config)# cable modem vendor 00:0A:41 Cisco
Router(config)# cable modem vendor 00:0A:42 Cisco
Router(config)#
The following shows an example of the default cable modem vendor command being used to restore
the original association between Cisco and its company OUI of 00:00:0C. Any previous user-defined
vendor name is deleted from the OUI database.
Router(config)# default cable modem vendor 00000C
The following shows an example of the no cable modem vendor command being used to remove the
association between Cisco and an OUI of 00:0A:42. If any CMs exist with that OUI, the show cable
modem vendor command will display the OUI (“00:0A:42”) as the vendor name.
Router(config)# no cable modem vendor 00:0A:42
Router(config)#
cable modulation-profile
To define a modulation profile for use on the router, use the cable modulation-profile command in
global configuration mode. To remove the entire modulation profile or to reset a default profile to its
default values, use the no form of this command.
cable modulation-profile profile iuc fec-tbytes fec-len burst-len guard-t mod scrambler seed diff
pre-len last-cw uw-len
cable modulation-profile profile iuc fec-tbytes fec-len burst-len guard-t mod scrambler seed diff
pre-len last-cw uw-len
cable modulation-profile profile iuc fec-tbytes fec-len burst-len guard-t mod scrambler seed diff
pre-len last-cw uw-len
Syntax Description profile Specifies the modulation profile number. The valid values for the profile
number depend on the cable interface being used and the upstream’s mode
of operation. Use the following as guidelines, and see Table 2-5 on page 2-
171 for specifics.
• If the upstream is configured for DOCSIS 1.0 and DOCSIS 1.1 mode,
the valid range is from 1 to 99, depending on the cable interface. The
system creates profile 1 as the default DOCSIS 1.x profile.
• If the upstream is configured for DOCSIS 1.x and DOCSIS 2.0 mixed
mode, the valid range is from 100 to 199, depending on the cable
interface. The system creates profile 141 as the default mixed mode
profile.
• If the upstream is configured for DOCSIS 2.0 A-TDMA mode, the valid
range is from 200 to 299, depending on the cable interface. The system
creates profile 241 as the default DOCSIS 2.0 A-TDMA profile.
In Cisco IOS Release 12.2(15)CX and later releases, you can create a
maximum of 10 profiles for each mode of operation, for a total of 30
profiles. In earlier software releases, you can create a maximum of 8
profiles only for DOCSIS 1.0 and DOCSIS 1.1 mode.
mix (DOCSIS 1.0 and DOCSIS 1.1 mode only) Creates a default QPSK/16-
QAM mix modulation profile where short and long grant bursts are sent
using 16-QAM, while request, initial ranging, and station maintenance
bursts are sent using QPSK). The burst parameters are set to their default
values for each burst type.
mix-high (DOCSIS 1.x/2.0 mixed and DOCSIS 2.0 modes only) Creates a default
QPSK/64-QAM modulation profile.
mix-low (DOCSIS 1.x/2.0 mixed and DOCSIS 2.0 modes only) Creates a default
QPSK/16-QAM modulation profile.
mix-mid (DOCSIS 1.x/2.0 mixed and DOCSIS 2.0 A-TDMA modes only) Creates a
default QPSK/32-QAM modulation profile.
mix-qam (DOCSIS 1.x/2.0 mixed and DOCSIS 2.0 A-TDMA modes only) Creates a
default 16-QAM/64-QAM modulation profile.
qam-8 (DOCSIS 2.0 A-TDMA mode only) Creates a default 8-QAM modulation
profile.
qam-16 Creates a default 16-QAM modulation profile.
qam-32 (DOCSIS 2.0 A-TDMA mode only) Creates a default 32-QAM modulation
profile.
qam-64 (DOCSIS 2.0 A-TDMA mode only) Creates a default 64-QAM modulation
profile.
qpsk Creates a default QPSK modulation profile.
robust-mix (DOCSIS 1.0 and DOCSIS 1.1 mode only) Creates a default QPSK/16-
QAM modulation profile with a longer preamble that is more robust and
more able to deal with noise on the upstream better than the mix profile.
robust-mix-high (DOCSIS 1.x/2.0 mixed and DOCSIS 2.0 A-TDMA modes only) Creates a
default QPSK/64-QAM mixed modulation profile with a longer preamble
that is more robust and more able to deal with noise on the upstream better
than the mix-high profile.
Defaults Modulation profile 1 is defined as a qpsk Time Division Multiple Access (TDMA) profile.
In Cisco IOS Release 12.2(15)CX, Release 12.2(15)BC2 and later releases, additional modulation
profiles are defined as the default mixed TDMA/A-TDMA profile and the default Advanced TDMA (A-
TDMA) profile. The modulation profile numbers for these default values are 1, 41, 101, 121, 201, 221,
or 241, depending on the cable interface line cards being used (see Table 2-5 on page 2-171).
Note The default profiles (1, 41, 101, 121, 201, 221, or 241) cannot be deleted. Using the no cable
modulation-profile command on these particular profiles resets them to their original, default values.
Usage Guidelines A modulation profile is a collection of at least six burst profiles that are sent out in an upstream channel
descriptor (UCD) message to configure a modem’s transmit parameters.
You can use the no cable modulation-profile command to remove all modulation profiles except the
default modulation profiles (1, 21, 41, 101, 121, 201, 221, and 241, depending on the cable interface line
cards being used). In the case of the default modulation profiles, the no cable modulation-profile
command resets the default profile to its default values.
Note You cannot delete the default modulation profiles (1, 21, 41, 101, 121, 201, 221, and 241). Using the no
cable modulation-profile command on these particular profiles resets them to their original, default
values.
We recommend that you use the predefined profiles instead of manually specifying the individual bursts
for a modulation profile. The predefined profiles are optimized for the default of 32 symbols per minislot
for each particular modulation scheme. The robust predefined profiles use a longer preamble for better
handling of noise on the upstream, but at the cost of consuming more PHY layer bandwidth than the
other non-robust profiles.
If you want to manually specify the individual bursts, enter a line with all parameters for each upstream
burst type. Then repeat this command for each burst type, which also must be e fully specified. A profile
with incomplete or missing bursts can cause unreliable operation or loss of modem connectivity.
Caution Changes to modulation profiles causes changes to the physical layer. Because changing physical layer
characteristics affects router performance and function, this task should be reserved for expert users who
have a thorough understanding of DOCSIS systems and how each parameter affects the network.
Note The reqdata burst type is included as a placeholder for SNMP scripts that might reference it, but it has
no effect. You can use this command (and SNMP commands) to specify the reqdata types, but the
DOCSIS MAC scheduler on the Cisco CMTS does not use this type of burst.
Cable Interface DOCSIS 1.X (TDMA) Mixed DOCSIS 1.X/2.0 DOCSIS 2.0 (A-TDMA)
1
Cisco uBR7100 series 1 to 10 , default=1 N/A N/A
Cisco uBR-MC16C 1 to 10, default=1 N/A N/A
Cisco uBR-MC16S 1 to 10, default=1 N/A N/A
Cisco uBR-MC28C 1 to 10, default=1 N/A N/A
Cisco uBR-MC5X20S, 21 to 30, default=21 121 to 130, default=121 221 to 230, default=221
Cisco uBR-MC5X20U
Cisco uBR-MC16U/X, Cisco uBR-MC28U/X 41 to 50, default=41 141 to 150, default=141 241 to 250, default=241
1. Only 8 modulation profiles are supported in Cisco IOS software releases before 12.2(15)BC1, so in these releases the valid range is from 1 to 8.
Note You cannot delete the default modulation profiles (1, 21, 41, 101, 121, 201, 221, and 241).
Note Do not use the qam-16 mode unless you have verified that your cable plant can support that modulation
profile. Most cable plants should instead use the qpsk or mix modulation profile for the primary profile.
Caution Turning the scrambler off can cause packet loss and is used only in lab testing environments.
Errors or incompatible configurations in the burst profiles cause CMs to drop connectivity, to drop short
or long data packets, or to fail to connect to the network. It is possible to build a burst profile set for
which no implementation of a DOCSIS receiver is capable of receiving the modem’s transmission.
Data rates of 160 Ksymbol/sec and 2560 Ksymbol/sec are highly sensitive to unique word length,
preamble length, and FEC sizing. Incorrect choices for these values can cause poor, or no, connectivity
at these symbol rates.
Note The default profiles (1, 21, 41, 101, 121, 141, 201, 221, and 241) cannot be deleted. Using the no cable
modulation-profile command on these particular profiles resets them to their original, default values.
Examples The following example shows how to create a mixed modulation profile, using 16-QAM for the short
and long grant bursts and QPSK for the request, initial ranging, and station maintenance bursts. The burst
parameters are set to their default values for each burst type.
Router(config)# cable modulation-profile 8 mix
Router(config)# exit
Mod IUC Type Preamb Diff FEC FEC Scrambl Max Guard Last Scrambl Preamb
length enco T CW seed B time CW offset
Router#
Note The above example shows the default values for the burst parameters. The main differences in the default
values between 16-QAM and QPSK bursts are in the Type and Preamble Length fields.
The following example shows how to define the burst parameters for profile 2 with the following
parameters: 0 fec-tbytes, 16 kbytes fec-len, a burst-len of 1, a guard time of 8, a mod value of qpsk,
scrambler enabled with a seed value of 152, differential encoding disabled, a preamble length of 64 bits,
a fixed code-word length, and 8-bit unique words for upstream unique word length.
Router(config)# cable modulation-profile 2 request 0 16 1 8 qpsk scrambler 152 no-diff 64
fixed uw8
Router(config)# cable modulation-profile 2 reqdata 0 16 1 8 qpsk scrambler 152 no-diff 64
fixed uw8
Router(config)# cable modulation-profile 2 initial 5 34 0 48 qpsk scrambler 152 no-diff
128 fixed uw16
Router(config)# cable modulation-profile 2 station 5 34 0 48 qpsk scrambler 152 no-diff
128 fixed uw16
Router(config)# cable modulation-profile 2 short 6 75 6 8 16qam scrambler 152 no-diff 144
fixed uw8
Router(config)# cable modulation-profile 2 long 8 220 0 8 16qam scrambler 152 no-diff 160
fixed uw8
Note You must create all of the bursts (request, initial, station, short and long) for this modulation profile,
using the modulation profile command. The reqdata burst is optional.
The following example shows an example of a DOCSIS 1.X/DOCSIS 2.0 mixed modulation profile:
Router# configure terminal
Router(config)# cable modulation-profile 142 request 0 16 0 8 qpsk scrambler 152 no-diff
64 fixed uw8
Router(config)# cable modulation-profile 142 initial 5 34 0 48 qpsk scrambler 152 no-diff
32 fixed uw16
Router(config)# cable modulation-profile 142 station 5 34 0 48 qpsk scrambler 152 no-diff
32 fixed uw16
Router(config)# cable modulation-profile 142 short 5 75 6 8 qpsk scrambler 152 no-diff 72
shortened uw8
Router(config)# cable modulation-profile 142 long 8 220 0 8 qpsk scrambler 152 no-diff 80
shortened uw8
Router(config)# cable modulation-profile 142 a-short qpsk0 0 18 5 99 10 8 64qam scrambler
152 no-diff 128 shortened uw8
Router(config)# cable modulation-profile 142 a-long qpsk0 0 18 15 200 0 8 64qam scrambler
152 no-diff 128 shortened uw8
Router(config)#
The following example shows an example of a DOCSIS 2.0 A-TDMA modulation profile:
Router# configure terminal
Router(config)# cable modulation-profile 242 request qpsk0 0 0 0 16 0 8 qpsk scrambler 152
no-diff 64 fixed uw8
Router(config)# cable modulation-profile 242 initial qpsk0 0 0 5 34 0 48 qpsk scrambler
152 no-diff 32 fixed uw16
Router(config)# cable modulation-profile 242 station qpsk0 0 0 5 34 0 48 qpsk scrambler
152 no-diff 32 fixed uw16
See the show cable modulation-profile command for a description of the output display fields.
cable monitor
To enable the forwarding of selected packets on the cable interface to an external LAN analyzer, use the
cable monitor command in cable interface configuration mode. To disable this function, use the no form
of this command.
no cable monitor
Syntax Description incoming Forwards only packets being received on the upstream.
outbound Forwards only packets being transmitted on the downstream.
timestamp Enables packet time-stamping by appending a four-byte value to the
forwarded packets. The timestamp value is in hundredths of a second.
interface interface Specifies the WAN interface to which an external LAN analyzer is
attached, and to which packets should be forwarded. You can forward
packets only to an Ethernet, Fast Ethernet, or Gigabit Ethernet interface.
access-list name| number Specifies the IP access list name or number (1 to 2699).
mac-address address Specifies the MAC address of the device being monitored.
sid sid-number Specifies the service ID for the packets that should be forwarded
(1 to 16384).
Note This option is supported only in Cisco IOS releases that support
DOCSIS 1.1 operations.
packet-type (Optional) Specifies whether data or MAC packets are forwarded.
data docsis Specifies that complete DOCSIS packets (both the DOCSIS header and the
complete Ethernet frame) should be forwarded.
Note Enabling this option can result in %LINK-4-TOOBIG messages
being generated if the original Ethernet frame is at or near the
maximum Ethernet size of 1500 bytes. This is because this option
adds additional bytes (the DOCSIS header) to the Ethernet frame,
which can result in a total frame size that exceeds the maximum
size that is allowed for standard Ethernet frames.
data ethernet Specifies that the DOCSIS header should be stripped from the packet and
that only the Ethernet frame should be forwarded.
mac [type type] Specifies that only DOCSIS MAC-layer packets should be forwarded. If
you are using the sid option, you can also optionally specify the type
option with one of the following keywords to indicate that only the specific
type of MAC-layer traffic should be forwarded:
dsa—Dynamic service addition
dsc—Dynamic service change
dsd—Dynamic service deletion
map-grant—Grants
map-req—Requests
Usage Guidelines The cable monitor command allows an external LAN packet analyzer to monitor inbound and outbound
data packets for specific types of traffic between the Cisco CMTS and the CMs on a cable interface. This
feature enables the CMTS administrator to analyze traffic problems with customer data exchanges.
The interface used for forwarding packets can be used only for the external LAN analyzer; and cannot
be used for other purposes. For complete information on configuring and using this feature, see the
Cable Monitor for the Cisco CMTS chapter in the Cisco CMTS Feature Guide, available on Cisco.com
and the Customer Documentation CD-ROM.
Tip One possible software utility you can use for decoding the DOCSIS MAC frames is release 0.9.6 or later
of the Ethereal software, which is available for Windows and Unix systems at http://www.ethereal.com.
Examples The following example shows how to configure the Cisco CMTS so that it monitors incoming MAC-
layer packets for the CM with the MAC address of 0123.4567.89ab and forwards copies of the packets
to the LAN analyzer on the Ethernet interface in slot 1, port 2:
router(config-if)# cable monitor incoming interface e1/2 mac-address 0123.4567.89ab
packet-type mac
The following example shows how to configure a Cisco CMTS running DOCSIS 1.1 software so that it
monitors incoming MAC-layer packets of type DSA for the CM identified by SID 173 and forwards
copies of the packets to the LAN analyzer on the Ethernet interface in slot 1, port 2:
router(config-if)# cable monitor incoming interface e1/2 sid 173 packet-type mac type dsa
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.
Syntax Description on Turns on power to the specified cable interface line card.
off Turns off power to the specified cable interface line card. Power to that
particular card slot remains off until power is turned back on using the
cable power on version of this command.
slot/card Specifies the slot and card number for the desired cable interface card
number. The valid range for slot is 5 to 8 and for card is 0 or 1.
Defaults Cable interface line cards are powered on by default when the card is inserted into the chassis slot.
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 You can also use the LC Power off Status Reg and Line Card Presence Status Reg fields in
the show controllers clock-reference command to determine whether a cable interface line
card is actually present in the chassis and whether it has been powered on or off.
• Powering off a cable interface line card automatically drops all sessions with the cable modems that
are using that card’s upstreams and downstreams. Do not use this command on a live network unless
this is what you intend.
• All cards are powered on when you upgrade to a new software image for the Cisco uBR10012 router,
even if a card had previously been powered off using the cable power off command.
• You can turn power both on and off to a cable interface line card slot, even if a card is not physically
present in the slot.
• This is the only CLI command that actually powers off a card. The hw module reset command
appears to perform a similar function, but it performs only the equivalent of issuing the shutdown
and no shutdown commands on the card.
• When power is turned off for a cable interface line card, the power to that card slot will remain off
until the cable power on command is used to turn the power back on. If you insert a cable interface
card in to a slot that had been previously powered down, you will have to use the cable power on
command to turn on power before being able to use the card.
• This command requires that a working TCC+ card be present because the TCC+ card controls and
monitors the operation of the cable interface line cards. In Cisco IOS Release 12.2(8)BC1 and later,
this command is disabled if a working TCC+ card is not present in the router.
Note The Cisco uBR10012 router requires a working TCC+ card for normal operations. Using the
router without a working TCC+ card is not a supported configuration.
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/0
Line Card 5/0 is POWERED OFF
router# show int c5/0/0
Cable5/0/0 is down, line protocol is down
Hardware is not present
Hardware is UBR10012 CLC, address is 0005.00e0.2f14 (bia 0005.00e0.2f14)
Internet address is 10.20.42.1/24
MTU 1500 bytes, BW 27000 Kbit, DLY 1000 usec,
reliability 255/255, txload 1/255, rxload 1/255
...
router#
Note The show interface cable command will not display output for a card that is not physically present, so
if you can use the show interface cable command but it indicates that the hardware is not present, this
usually means that power to the card has been turned off using the cable power off command.
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/1
Line Card 6/1 is not present
router#
Note Power is still turned on or off to a cable interface line card slot, even when the card is not physically
present in that slot.
Syntax Description all Preserves all primary service flow traffic counters when a
DOCSIS 1.1-provisioned CM goes offline. This includes the counters
displayed by CLI commands and counters that are obtained through
SNMP requests.
snmp-only Preserves only the primary service flow traffic counters that are
obtained through SNMP requests. The counters displayed by CLI
commands are reset to zero when a DOCSIS 1.1-provisioned CM
goes offline.
Defaults 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.
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 This command affects only CMs that are provisioned for DOCSIS 1.1 operations and that are currently
online all cable interfaces on the Cisco CMTS. Information is not preserved for DOCSIS 1.1-
provisioned CMs that went offline before this command was given. The service-flow information for
CMs that are provisioned for DOCSIS 1.0 operations is always preserved, regardless of how this
command is configured.
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 all
Router(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-only
Router(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 keep
Router(config)#
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.
Defaults BPI is disabled. When enabled, 56-bit DES encryption is enabled by default, and self-signed
manufacturer certificates are not allowed.
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/1
Router(config-if)# cable privacy mandatory
The following example shows how to turn on the baseline privacy interface (BPI) modem authentication
for an interface:
Router(config)# interface cable 5/1/1
Router(config-if)# cable privacy authenticate-modem
The following example shows how to turn on BPI multicast authorization on a particular cable interface:
Router(config)# interface cable 1/0
Router(config-if) cable privacy authorize-multicast
The following example shows how to allow CMs to register with self-signed certificates on a particular
cable interface:
Router(config)# interface cable 7/1/0
Router(config-if) cable privacy accept-self-signed-certificate
Note The cable privacy accept-self-signed-certificate command affects only those CMs that register after
you give the command. For example, if you give the no cable privacy accept-self-signed-certificate
command so that CMs cannot register using self-signed certificates, you must then issue the clear cable
modem all reset command to force all CMs reregister using certificates that are chained to the DOCSIS
root certificate.
Syntax Description manufacturer hex-data Specifies the hexadecimal data for the manufacturer CA certificate.
Enter multiple lines as needed, and use a blank line to terminate the
string.
root hex-data Specifies the hexadecimal data for the root CA certificate. Enter
multiple lines as needed, and use a blank line to terminate the string.
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
35c146353431a541463b41337343938333373142
FEF03A8BC7A441313134749A0A592C9C66831412
Router(config)#
The following example adds a root CA certificate to the CMTS list of trusted certificates:
Router(config)# cable privacy add-certificate root 00908300 00300501
308202A1 3082020A A0030201 02020800 90830000 00000130 0D06092A 864886F7
0D010105 05003081 92310B30 09060355 04061302 4A503110 300E0603 55040A13
07546F73 68696261 310F300D 06035504 0B130644 4F435349 53312730 25060355
040B131E 312D312D 31205368 69626175 7261204D 696E6174 6F2D6B75 20546F6B
796F3137 30350603 55040313 2E546F73 68696261 20436162 6C65204D 6F64656D
20526F6F 74204365 72746966 69636174 65204175 74686F72 69747930 1E170D30
Router(config)#
Syntax Description cm mac-address Specifies the MAC address for the CM certificate to be added to the
hotlist. The mac-address should be specified as a hexadecimal string,
without periods or other separators. In Cisco IOS Release
12.2(15)BC2 and later releases, you can also specify it as three sets of
hexadecimal digits, separated by periods.
manufacturer cert-serial- Specifies the serial number for the particular manufacturer CA
number certificate. The cert-serial-number should be specified as a
hexadecimal string up to 32 bytes in length. Enter multiple lines as
needed, and use a blank line to terminate the string.
Usage Guidelines This command is applicable only on images that support BPI or BPI+ encryption.
Note The cable privacy hotlist command is not supported on the Cisco uBR10012 router. To add a
manufacturer’s or CM certificate to the hotlist on the Cisco uBR10012 router, use SNMP commands to
set the appropriate attributes in DOCS-BPI-PLUS-MIB. For more information see the Configuring
DOCSIS 1.1 on the Cisco CMTS chapter in the CMTS Feature Guide.
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 t
Router(config)# cable privacy hotlist cm 00C08345de51
Router(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 t
Router(config)# cable privacy hotlist manufacturer
3435414631413439383335453731423733333643
Router(config)#
Note This command is applicable only on images that support BPI or BPI+ encryption.
Syntax Description grace-time seconds (Optional) Length of key encryption grace-time in seconds. Valid range
is 60 to 1800 seconds. The default is 600 seconds (10 minutes).
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).
Defaults The grace-time option is set to 600 seconds (10 minutes), and the life-time option to 604,800 seconds
(7 days).
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 The cable privacy kek grace-time command is primarily intended for lab and testing use, and typically
should not be used for normal operations because it changes the grace time for all CMs on the cable
interface. To change the grace time for a particular cable modem, include the new value as part of the
Baseline Privacy Configuration Settings in the DOCSIS configuration file that is downloaded to the CM.
Examples The following example shows how to set the KEK privacy grace-time to 800 seconds:
Router(config)# interface cable c5/1/0
Router(config-if)# cable privacy kek grace-time 800
Router(config-if)#
The following example shows how to set the KEK privacy life-time to 750,000 seconds:
Router(config)# interface cable c3/0
Router(config-if)# cable privacy kek life-time 750000
Router(config-if)#
Note This command is applicable only on images that support BPI or BPI+ encryption.
Syntax Description grace-time seconds (Optional) Length of traffic encryption grace-time in seconds. Valid range
is 60 to 1800 seconds. Default is 600 seconds (10 minutes).
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).
Defaults The grace-time option is set to 600 seconds (10 minutes), and the life-time option to 43200 seconds
(12 hours).
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 The cable privacy tek grace-time command is primarily intended for lab and testing use, and typically
should not be used for normal operations because it changes the grace time for all CMs on the cable
interface. To change the grace time for a particular cable modem, include the new value as part of the
Baseline Privacy Configuration Settings in the DOCSIS configuration file that is downloaded to the CM.
Examples The following example shows how to set the traffic encryption key grace-time to 800 seconds:
Router(config)# interface cable c5/1/0
Router(config-if)# cable privacy tek grace-time 800
Router(config-if)#
The following example shows how to set the traffic encryption key life-time to 800000 seconds:
Router(config)# interface cable c3/0
Router(config-if)# cable privacy tek life-time 800000
Router(config-if)#
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
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 Using the no cable arp and no cable proxy-arp commands shifts all responsibility for the management
of the IP addresses used by CMs and CPE devices to the DHCP server and provisioning system.
Examples The following example shows how to activate proxy ARP for host-to-host communications:
router(config-subif)# cable proxy-arp
The following example shows how to activate proxy ARP for host-to-host communications, on the cable
subinterface:
router(config)# interface cable 6/0.1
router(config-subif)# cable proxy-arp
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.
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
subcommands to configure the enforce-rule:
• activate-rule at-byte-count
• enabled
• enforced qos-profile
• monitoring-duration
• penalty-period
• registered qos-profile
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.
Tip Use the exit command to leave enforce-rule configuration mode and to return to global configuration
mode.
Note In Cisco IOS Release 12.2(15)BC1, you can create a maximum of 20 enforce-rules. If you have created
20 enforce-rules and want to create another new rule, you must first delete one of the existing rules.
Otherwise, the CMTS displays an error message.
Examples The following example shows an enforce-rule named residential being created. The system then enters
the enforce-rule configuration mode:
Router# configure terminal
Router(config)# cable qos enforce-rule residential
Router(enforce-rule)# ?
The following example shows the enforce-rule named test being deleted:
Router# configure terminal
Router(config)# no cable qos enforce-rule test
Router(config)#
The following example shows the error message that is displayed if you try to create more than 20
enforce-rules:
Router# configure terminal
Router(config)# cable qos enforce-rule residential
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 terminal
Router(config)# cable qos enforce-rule reallyreallyreallylongname
Router(enforce-rule)#
Command Description
enforced qos-profile Specifies the quality of service (QoS) profile that should be enforced when
users violate their assigned QoS profiles.
monitoring-duration Specifies the time period and sample rate to be used for monitoring
subscribers.
penalty-period Specifies the time period that an enforced quality of service (QoS) profile
should be used for subscribers that violate their registered QoS profile.
registered qos-profile Specifies the registered Quality of Service (QoS) profile that should be used
for this enforce-rule.
show cable qos Displays the quality of service (QoS) enforce-rules that are currently
enforce-rule defined.
show cable subscriber- Displays subscribers that are violating their registered quality of service
usage (QoS) profiles.
Syntax Description create Permits creation of QoS table entries by Simple Network Management
Protocol (SNMP).
enforce index The enforce keyword overrides the provisioned QoS profile of the CM
and enforces a specific CMTS-local QoS profile. The index argument
specifies the number of the QoS profile to be enforced on all CMs
connecting to the CMTS. Valid values are from 1 to 255.
Note Both the originally provisioned QoS profile and the enforced
QoS profile must be created on the Cisco CMTS. This option
does not support profiles that are created by the CM.
modems Permits creation of QoS table entries by modem registration requests.
update Permits dynamic update of QoS table entries by SNMP.
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 modems
The 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 modem
cable qos profile groupnum [grant-interval interval | grant-size size | guaranteed-upstream rate
| ip-precedence value | max-burst rate | max-downstream rate | max-upstream rate |
name string | priority value | privacy | tos-overwrite tos-mask tos-value]
Syntax Description groupnum QoS profile group number. The valid range is 1 to 255.
QoS profiles 1 and 2 are required by the system; they are preconfigured
and cannot be modified nor removed. QoS profile 1 is used during
registration; QoS profile 2 is the default QoS profile.
grant-interval interval The periodic interval in microseconds at which the CM wants to send
the fixed-sized upstream MAC frames. It is used to compute the period
in between constant bit rate (CBR) slots for the CM. Valid range is
from 0 to 65535. The default is 0.
grant-size size The size of the DOCSIS MAC frame the CM wants periodically to send
on the upstream transmission. This value in bytes does not include any
PHY layer overhead. It includes the complete fixed MAC frame size
starting from the frame control byte to the CRC of the protocol data
unit (PDU). This parameter is used by the CMTS to set the size of the
periodic CBR slot for the CM after adding the PHY overhead. Valid
range is from 0 to 65535. The default is 0.
guaranteed-upstream rate Guaranteed minimum upstream rate in kilobytes per second. Valid
values are from 0 to 100000. Default value is 0 (no reserved rate).
ip-precedence value Bits in the type-of-service (ToS) byte that enable you to configure
individual data rate limits on a per modem basis. Valid values are from
0 to 7. The default is 0.
Note This option has been deprecated and removed from the CLI,
because its function should be accomplished through the
DOCSIS configuration file.
max-burst rate Maximum upstream transmit burst size in bytes that the modem can
send for any single transmit burst. Valid values are from 0 to 65,535
bytes. Default value is 0 (no limit). The recommended value range is
1600 to 1800 bytes. Using a value of 0 or greater than 1800 bytes can cause
latency issues for Voice-over-IP. A value of less than 1500 bytes can
prevent the upstream transmission of large Ethernet frames for any modem
or CMTS not implementing fragmentation.
Note The CM enforces the maximum upstream transmit burst limit.
The Cisco CMTS does not enforce this limit, but this command
can still be used for documentation and troubleshooting
purposes.
max-downstream rate Maximum downstream data rate in kilobits per second that a modem
using this QoS profile receives. Valid values are from 0 to 100,000.
Default value is 0 (no downstream rate limit).
Note This option has been deprecated and removed from the CLI,
because its function should be accomplished through the
DOCSIS configuration file.
maximum-upstream rate Maximum upstream data rate in kilobits per second that a modem using
this QoS profile receives. Valid values are from 0 to 100,000. Default
value is 0 (no upstream rate limit).
name string Arbitrary, unique string to identify this QoS profile. The maximum
length is 32 characters before Cisco IOS Release 12.2(11)BC2, and
80 characters in Cisco IOS Release 12.2(11)BC2 and later.
priority value Relative priority number assigned to upstream traffic by this QoS
profile. Valid values are from 0 to 7, with 7 being the highest priority.
Default value is 0.
privacy Enables Baseline Privacy Interface (BPI) encryption. The default is to
disable BPI encryption.
tos-overwrite tos-mask tos- Overwrite the ToS field in the IP datagrams received on the upstream
value before forwarding them downstream (or IP backbone). This parameter
sets the hexadecimal mask bits to the hexadecimal values for the ToS
mask and ToS value, thereby helping the CMTS identify datagrams for
QoS on the backbone.
Each parameter is an 8-bit hexadecimal value that ranges from 0x00 to
0xFF. The default value is 0xFF starting with Cisco IOS Release
12.2(15)BC2 and later, and the default is 0x00 in earlier releases. The
new TOS value is calculated using the following formula:
New ToS = ((Original ToS) AND (NOT tos-mask)) OR tos-value
Note This formula is how the TOS was calculated in DOCSIS 1.0+
networks before the DOCSIS 1.1 specification was finalized.
For information on the new method of calculating the TOS in
DOCSIS 1.1 networks, see the cable service class command.
Defaults If the cable qos profile command is given without any options, it creates a profile with all default values:
Baseline Privacy Interface is disabled, and all other values are set to 0.
Release Modification
12.0(5)T The ip-precedence option was added, and the range for the
max-downstream option was increased.
12.0(7)XR2 The output was reorganized and name, grant-size, and grant-interval
parameters were added.
12.1(4)CX This command was deprecated for DOCSIS 1.1 use, because DOCSIS 1.1
replaces the QoS profile model with a service flow model. See the cable
service class command for details.
12.2(11)CY, The maximum length of the name string was increased from 32 characters
12.2(11)BC2 to 80 characters.
12.2(15)BC21 The ip-precedence and max-downstream options were removed, because
their functions can be better accomplished through the DOCSIS
configuration file.
Usage Guidelines The cable qos profile command configures the quality of service (QoS) settings for a particular class of
service on a DOCSIS 1.0 or DOCSIS 1.0+ network. This command cannot be used on DOCSIS 1.1 and
DOCSIS 2.0 networks, which use the cable service class command instead.
In Cisco IOS Release 12.2(15)BC21, the ip-precedence and max-downstream options were removed.
If you are supporting DOCSIS 1.0+ CMs that require these parameters for voice over IP (VoIP) traffic
and other real-time traffic, use the following Cisco Vendor-Specific Fields (VSIF) in the CM’s DOCSIS
configuration file:
Table 2-6 Cisco VSIF Fields for IP Precedence and Max Downstream Rate
Examples The following example shows how to configure QoS profile 4 with a guaranteed upstream rate of 8 kbps,
a maximum transmission burst of 1800 bytes, a maximum downstream rate of 128 kbps, a priority of 4,
cable baseline privacy set, and a tos-overwrite mask and value byte (in hex) of 0x2:
router(config)# cable qos profile 4 guaranteed-upstream 8
router(config)# cable qos profile 4 max-burst 1800
router(config)# cable qos profile 4 max-downstream 128
router(config)# cable qos profile 4 privacy
router(config)# cable qos profile 4 priority 4
router(config)# cable qos profile 4 tos-overwrite 0xE0 0xE0
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.
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.
Defaults 3 minutes
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 terminal
router#(config)# interface c6/0
router(config-if)# cable registration-timeout 10
router(config-if)# exit
router(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
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-option
Command Description
cable telco-return spd dhcp- Enforces the telco-return CM to use a specific DHCP server.
authenticate
cable telco-return spd dhcp- Identifies the IP address of the DHCP server that the telco-return CM
server must access.
ip dhcp relay information Enables the system to insert the CM MAC address into a DHCP
option packet received from a CM or host and forward the packet to a DHCP
server.
ip dhcp smart-relay Monitors client retransmissions when address pool depletion occurs.
Syntax Description class-index Specifies the class ID for the class to be modified. Valid range is 1 to 255.
activity-timeout Specifies the activity timeout (0 to 65,535).
admission-timeout Specifies the admitted timeout (0 to 65,535).
downstream Specifies that the service class is for the downstream direction (from the
CMTS to the CM). (The default direction is upstream.)
grant-interval Specifies the grant interval (0 to 4,294,967,295 microseconds).
grant-jitter Specifies the grant jitter (0 to 4,294,967,295 microseconds).
grant-size Specifies the grant size (0 to 65,535 bytes).
grants-per-interval Specifies the grants per interval (0 to 127 grants).
max-burst Specifies the maximum transmission burst (1522 to 4,294,967,295 bytes).
Note The recommended value range is 1600 to 1800 bytes. Using a value
of 0 or greater than 1800 bytes can cause latency issues for Voice-
over-IP. A value of less than 1522 bytes can prevent the upstream
transmission of large ethernet frames for any CM or CMTS not
implementing fragmentation.
max-concat-burst Specifies the maximum concatenation burst (0 to 65,535 bytes).
max-latency Specifies the maximum latency allowed (0 to 4,294,967,295 microseconds).
max-rate Specifies the maximum rate (0 to 4,294,967,295 bps).
min-packet-size Specifies the minimum packet size for reserved rate (0 to 65,535 bytes).
min-rate Specifies the minimum rate (0 to 4,294,967,295 bps).
name Specifies the service class name string.
poll-interval Specifies the poll interval (0 to 4,294,967,295 microseconds).
poll-jitter Specifies the poll jitter (0 to 4,294,967,295 microseconds).
priority Specifies the priority (0 to 7, where 7 is the highest priority).
req-trans-policy Specifies the request transmission policy bit field (0 to FFFFFFF in
hexadecimal).
sched-type Specifies the service class schedule type:
2–Best-Effort Schedule Type
3–Non-Real-Time Polling Service Schedule Type (supported only in
Cisco 12.2(4)BC and later releases)
4–Real-Time Polling Service Schedule Type
5–Unsolicited Grant Service with Activity Detection Schedule Type
6–Unsolicited Grant Service Schedule Type
tos-overwrite and- Overwrites the ToS byte by first ANDing the TOS value with the and-mask
mask or-mask value and then ORing the result of that operation with the or-mask value.
Both parameters must be specified in hexadecimal. The and-mask value can
range from 0x0 to 0xFF and the or-mask value can range from 0x0 to 0xFF.
upstream Specifies that the service class is for the upstream direction (from the CM
to the CMTS). This is the default direction.
Defaults Values that are not specified are set to their DOCSIS 1.1 defaults, if applicable to the service-class
schedule type. See Section C.2.2, Service Flow Encodings, in the DOCSIS 1.1 specification.
Usage Guidelines The sched-type option must always be specified for each class. When a certain scheduling type is
selected, take care that the mandatory parameters for that scheduling type are explicitly entered, while
nonapplicable parameters must be explicitly removed.
The default direction is upstream. We recommend that you do not change the direction of a service class
after you have created it, because some of the existing service class parameters might not be appropriate
for the new direction. Instead, delete the current service class and create a new service class with the
correct upstream or downstream direction.
If the service class is newly created, a service-class name must be defined before entering the parameters
for the service class.
Note Section C.2.2.6.10, IP Type of Service Overwrite, of the DOCSIS 1.1 specification changed the operation
of tos-overwrite option. In DOCSIS 1.1 networks, the new TOS value is calculated by the following
formula: New IP TOS = ((Original TOS value AND and-mask) OR or-mask). (For a description of the
previous method of calculating the TOS value, see the cable qos profile command.) The default is to
leave the TOS value unchanged (no overwrite).
Examples The following examples show configurations that use the cable service class command to create service
classes. Based on the scheduling type specified, some command lines are mandatory, while others are
optional.
Each example shown here is a complete configuration set for creating a service class.
Configuring a Service Class for Unsolicited Grant Scheduling with Activity Scheduling
Router(config)# cable service class 2 name UP_UGSAD
Router(config)# cable service class 2 sched-type 5
Router(config)# cable service class 2 grant-size 100
Router(config)# cable service class 2 grant-interval 20000
Router(config)# cable service class 2 grant-jitter 4000
Router(config)# cable service class 2 grants-per-interval 1
Router(config)# cable service class 2 poll-interval 10000
Router(config)# cable service class 2 poll-jitter 4000
Router(config)# cable service class 2 min-packet-size 100
Router(config)# cable service class 2 req-trans-policy 0x1FF
Router(config)# cable service class 2 tos-overwrite 0x1F 0xE0
Router(config)# cable service class 2 activity-timeout 30
Router(config)# cable service class 2 admission-timeout 30
Syntax Description n Specifies the threshold limit in seconds, with 10 seconds as the default.
Configurable limits are 1 to 3600 seconds.
Defaults The default is to enable the inactivity timer, with a default value of 10 seconds.
Usage Guidelines DOCSIS 1.1 allows a CM to request Unsolicited Grant Service (UGS) for an upstream, allowing the CM
to reserve a certain amount of Constant Bit Rate (CBR) bandwidth for real-time traffic, such as Voice-
over-IP (VoIP) calls. The UGS-AD variation allows the CMTS to switch a service flow to Real Time
Polling Service (RTPS) after a certain period of inactivity, so that bandwidth is not reserved when it is
not needed. The CM can then request UGS service when the flow again becomes active.
Note This command replaced the cable service-flow inactivity-timeout command, which was used in
DOCSIS 1.0 operation to enable or disable watchdog cleanup of dynamic service flows that are not
sending any packets on the upstream.
The cable service flow inactivity-threshold command sets the inactivity timer for how long a service
flow must be inactive before the CMTS can switch it from UGS-AD to RTPS. The no cable service flow
inactivity-threshold command disables the timer and resets it to its default value of 10 seconds, so that
the CMTS always provides UGS service to the service flow, even when the flow is idle.
Caution The no cable service flow inactivity-threshold command effectively disables the use of RTPS and
USG-AD services and configures the CMTS to provide only UGS services. This will prevent a CM that
registered for USG-AD services from being able to obtain upstream transmission opportunities, resulting
in a significant loss of bandwidth when a large number of CMs are requesting UGS-AD service flows.
Examples The following example shows the inactivity timer being set to 20 seconds:
Router(config)# cable service flow inactivity-threshold 20
Router(config)#
The following command disables the inactivity timer, so that the service flow remains UGS, even during
periods of inactivity:
Router(config)# no cable service flow inactivity-threshold
Router(config)#
Syntax Description minutes Specifies service-flow inactivity-timeout in minutes. Valid range is 1 to 120
minutes. Default value is 30 minutes.
Defaults 30 minutes
Usage Guidelines Resources such as service identifiers (SIDs) and bandwidth are dynamically allocated by a CM using
Dynamic Service Addition (DSA) transaction. If the CM fails to release these resources by issuing a
Dynamic Service Deletion (DSD), then the resources might be locked indefinitely. Use this command to
release unused resources.
Examples The following example shows how to set the inactivity timeout for dynamic service flows to 2 minutes.
Once this setting is specified, any dynamic SID that does not show any activity in 2 minutes will be
deleted.
Router(config)# cable service-flow inactivity-timeout 2
The following example shows how to set the inactivity timeout back to the default value of 30 minutes:
Router(config)# cable service-flow inactivity-timeout
Command Description
cable qos profile Configures a QoS profile.
show controllers cable Displays QoS profiles.
cable sflog
To enable service flow logging and to configure the number and duration of entries in the log, use the
cable sflog command in global configuration mode. To disable service flow logging, use the no form of
the command.
no cable sflog
Syntax Description max-entry number Specifies the maximum number of entries in the service flow log. When the
log becomes full, the oldest entries are deleted to make room for new entries.
The valid range is 0 to 59999, with a default of 0 (which disables service
flow logging).
Note The max-entry value applies to the entire chassis on the
Cisco uBR7100 series and Cisco uBR7200 series routers, but applies
to individual cable line cards on the Cisco uBR10012 router.
entry-duration time Specifies how long, in seconds, entries can remain in the service flow log.
The CMTS deletes entries in the log that are older than this value. The valid
range is 1 to 86400 seconds, with a default value of 3600 seconds (1 hour).
Defaults max-entry = 0 (service flow logging is disabled) and entry-duration = 3600 seconds
Usage Guidelines A DOCSIS specification currently being developed requires the DOCSIS CMTS to maintain a log table
that contains entries of deleted service flows. The cable sflog command enables the logging of deleted
service flows in this table and also sets the maximum number of entries in the log. When the log becomes
full, the oldest entries are deleted to make room for the newest ones.
This command also configures how long each entry can remain in the log. When an entry has been in the
table for the specified time, the CMTS deletes it, even if the log is not currently full.
To display the service flow log, use SNMP commands to display the docsQosServiceFlowLogEntry
entries in the docsQosServiceFlowLogTable table. These attributes are defined in the Data Over Cable
System Interface Specification Quality of Service Management Information Base (DOCSIS-QOS MIB)
internet draft.
Cisco IOS Release 12.2(15)BC1 supports version 4 of this DOCSIS-QOS MIB draft, which is available
on the IETF Internet-Drafts web site:
http://http://www.ietf.org/ID.html
Note At the time of this document’s release, the DOCSIS-QOS MIB is still in draft form and is therefore
subject to change in future releases of Cisco IOS software.
The max-entry value specified by this command applies to the entire chassis for the Cisco uBR7100
series and Cisco uBR7200 series routers, but to individual line cards on the Cisco uBR10012 router.
However, the Cisco uBR10012 router still maintains only one log table for all deleted service flows.
For example, if the max-entry value is set to 10,000 on a Cisco uBR7200 series router, the service flow
log table holds a maximum of 10,000 entries for all cable line cards in the chassis. If the max-entry value
is set to 10,000 on a Cisco uBR100012 router that has four cable line cards installed, the service flow
log table holds a maximum of 40,000 entries, with each cable line card having a maximum of 10,000
entries each.
Examples The following example shows how to enable service flow logging with a maximum of 2,000 entries in
the log, and with each entry remaining in the log for a maximum of 2 hours (7200 seconds):
Router(config)# cable sflog max-entry 2000 entry-duration 7200
The following example shows how to set the max-entry value to its default of 0 and disable service flow
logging:
Router# configure terminal
Router(config)# no cable sflog
Router(config)# exit
Router#
cable shared-secondary-secret
To configure one or more secondary shared-secret keys that CMs can use to successfully process the
DOCSIS configuration file and register with the CMTS, use the cable shared-secondary-secret
command in cable interface configuration mode. To remove the secondary shared secrets, use the no
form of this command.
Syntax Description index index-num Specifies the order in which the CMTS will use the secondary shared-secrets
to verify the CM during the registration process. The valid range is 1 to 16.
0 (Optional) Specifies that an unencrypted message will follow.
7 (Optional) Specifies that an encrypted message will follow.
Note As a general rule, the 7 option is not used by users at the command
line because it requires a pre-encrypted password. Typically, the 7
option is useful only when cutting and pasting commands from
another router’s configuration file.
authentication-key Text string specifying the shared secret string. When you also use the service
password-encryption command, the key is stored in encrypted form. The
text string can be any arbitrary string up to 80 characters in length.
Defaults No secondary shared secret is used. If no encryption option is specified, the key is stored in the
configuration file as encrypted text if the service password-encryption command has also been given.
Usage Guidelines The cable shared-secondary-secret command can be used to supplement the cable shared-secret
command so as to prevent unauthorized interception and alteration of the DOCSIS configuration file that
is downloaded to the CM during the registration process. The DOCSIS specification allows for a CM
and CMTS to use a shared secret (a secret encryption string) to calculate the MD5 Message Integrity
Check (MIC) value for the DOCSIS configuration file that is downloaded to the CM.
The CM must use the proper shared secret encryption string to successfully decrypt and process the
configuration file, and then register with the CMTS. If the CM does not have the proper encryption
string, it will be unable to calculate the proper MIC value, and the show cable modem command will
show reject(m) for the modem to indicate a MIC authentication failure.
Note At any particular time, the majority of CMs should use the primary shared secret to avoid
excessive registration times.
• Create DOCSIS configuration files that use the shared-secret encryption string to create the MD5
MIC value. This can be done using the Cisco DOCSIS Configurator tool by entering the shared-
secret string in the CMTS Authentication field in the Miscellaneous parameters.
Tip The shared-secret string itself is not saved in the DOCSIS configuration file, so you must re-enter the
string in the CMTS Authentication field whenever you create or edit a DOCSIS configuration file using
the Cisco DOCSIS Configurator tool.
• Use the cable shared-secondary-secret command to configure the cable interfaces with one or
more matching shared-secret strings. The string configured on an interface must match the string
used to create the DOCSIS configuration files downloaded to the CMs on that interface, or the CMs
will not be able to register. You can use different shared secrets for each interface, if you are also
using a different set of configuration files for each interface.
• To encrypt the shared-secret strings in the CMTS configuration, you must include the service
password-encryption global configuration command in the router’s configuration.
Note You cannot use the shared secret feature with the files created by the internal DOCSIS configuration file
editor (cable config-file command).
Examples The following example shows how to specify multiple secondary shared-secret string using encrypted
keys:
Router# config t
Router(config)# service password-encryption
Router(config)# int c6/0
Router(config-if)# cable shared-secret n01jk_1a
Router(config-if)# cable shared-secondary-secret index 1 cabl3-x21b
Router(config-if)# cable shared-secondary-secret index 2 dasc9_ruld55ist5q3z
Router(config-if)# cable shared-secondary-secret index 3 j35u556_x_0
Router(config-if)# exit
Router(config)# exit
Router# show running-config | include shared
cable shared-secret 7 1407513181A0F13253920
cable shared-secondary-secret 7 14031A021F0D39263D3832263104080407
cable shared-secondary-secret 7 071B29455D000A0B18060615142B38373F3C2726111202431259545D6
cable shared-secondary-secret 7 0501555A34191B5F261D28420A555D
Router#
Note In this example, the shared-secret strings are initially entered as clear text, but because the service
password-encryption command has been used, the strings are encrypted in the configuration file.
cable shared-secret
To configure an authentication shared-secret encryption key that CMs must use to successfully process
the DOCSIS configuration file and register with the CMTS, use the cable shared-secret command in
cable interface configuration mode. To disable the use of a shared-secret key during the CM registration
phase, use the no form of this command.
no cable shared-secret
Syntax Description 0 (Optional) Specifies that an unencrypted message (clear text) will follow.
7 (Optional) Specifies that an encrypted message will follow.
Note As a general rule, the 7 option is not used by users at the command
line because it requires a pre-encrypted password. Typically, the 7
option is useful only when cutting and pasting commands from
another router’s configuration file.
authentication-key Text string specifying the shared secret string. When you also use the service
password-encryption command, the key is stored in encrypted form. The
text string can be any arbitrary string up to 80 characters in length.
Defaults No shared-secret encryption key is used during registration, only the default DOCSIS MD5-encrypted
checksum. When cable shared-secret is given without specifying an encryption option, the key is stored
in the configuration file as an encrypted password if the service password-encryption command has
also been given.
Usage Guidelines The cable shared-secret command can be used to prevent unauthorized interception and alteration of
the DOCSIS configuration file that is downloaded to the CM during the registration process. The cable
shared-secret command specifies a secret encryption string that the CMTS uses to calculate the MD5
Message Integrity Check (MIC) value that is appended to every DOCSIS configuration file and that the
CM and CMTS use to verify the file’s integrity.
The CM must use the shared secret encryption string to successfully decrypt and process the
configuration file, and then register with the CMTS. If the CM does not have the proper encryption
string, it will be unable to calculate the proper MIC value, and the show cable modem command will
show reject(m) for the modem to indicate a MIC authentication failure.
Note The shared-secret string itself is not saved in the DOCSIS configuration file, so you must re-
enter the string in the CMTS Authentication field whenever you create or edit a DOCSIS
configuration file using the Cisco DOCSIS Configurator tool.
• Use the cable shared-secret command to configure the cable interfaces with a matching shared-
secret string. The string configured on an interface must match the string used to create the DOCSIS
configuration files downloaded to the CMs on that interface, or the CMs will not be able to register.
You can use different shared secrets for each interface, if you are also using a different set of
configuration files for each interface.
• To encrypt the shared-secret string in the CMTS configuration, you must include the service
password-encryption global configuration command in the router’s configuration.
Note You cannot use the shared secret feature with the files created by the internal DOCSIS configuration file
editor (cable config-file command).
Note In Cisco IOS Release 12.2(8)BC2 and later releases, you can also use the cable shared-secondary-
secret command to specify multiple shared-secret strings, so that you can gradually phase in a new
shared secret string.
Note This change affects only the encryption of the passwords that are stored in the configuration file. It does
not affect the actual encryption that is used between the CMTS and CMs, so you do not need to change
the shared secret in the DOCSIS configuration files for the CMs.
Examples The following example shows how to specify a shared-secret string using an encrypted key:
Router# config t
Router(config)# service password-encryption
Router(config)# int c6/0
Router(config-if)# cable shared-secret password
Router(config-if)# exit
Router(config)# exit
Router# show running-config | include shared
cable shared-secret 7 1407513181A0F13253920
Router#
Note In this example, the shared-secret string is initially entered as clear text, but because the service
password-encryption command has been used, the string is encrypted in the configuration file.
The following example shows how to remove the use of a shared-secret encryption key on a cable
interface. That particular interface then ignores any shared-secret that is used when calculating the MD5
checksum:
Router# config t
Router(config)# int c6/0
Router(config-if)# no cable shared-secret
Router(config-if)# end
Router#
cable source-verify
To enable verification of IP addresses for CMs and CPE devices on the upstream, use the cable source-
verify command in cable interface or subinterface configuration mode. To disable verification, use the
no form of this command.
no cable source-verify
Syntax Description dhcp (Optional) Specifies that queries will be sent to verify unknown source
IP addresses in upstream data packets.
Note Do not enable the local DHCP server on the Cisco CMTS and
configure local DHCP address pools, using the ip dhcp pool
command, when using this option, because this prevents DHCP
address validation.
leasetimer value (Optional) Specifies the time, in minutes, for how often the router
should check its internal CPE database for IP addresses whose lease
times have expired. The valid range for value is 1 to 240 minutes, with
a default of 60 minutes.
Note The leasetimer option takes effect only when the dhcp option
is also used on an interface. Also, this option is supported only
on the master interface and cannot be configured on
subinterfaces. Configuring it for a master interface
automatically applies it to all subinterfaces.
Defaults Disabled. When the dhcp option is specified, the leasetimer option defaults to 60 minutes.
Note Configuring the cable source-verify command on the master interface of a bundle will
configure it for all of the slave interfaces in the bundle as well.
Release Modification
12.2(15)BC2 Support for verifying CMs and CPE devices that are on a different subnet
than the cable interface was enhanced to use Reverse Path Forwarding
(RFP).
12.3(9a)BC Cisco IOS Release 12.3(9a)BC adds the option of using a per SID basis for
deriving lease queries from CPE devices. This release also introduces a
global rate limit for lease queries initiated by downstream traffic.
Usage Guidelines The cable source-verify command helps to prevent the spoofing of IP addresses by CMs or their CPE
devices by verifying that the upstream packets coming from each CM are known to be associated with
the IP address in that packet. Packets with IP addresses that do not match those associated with the CM
are dropped.
In order to protect the Cisco CMTS from denial of service attacks, Cisco IOS Release 12.3(9a)BC adds
the option of using a per SID basis for deriving lease queries from CPE devices. This release also
introduces a global rate limit for lease queries initiated by downstream traffic. These enhancements
reduce the CPU utilization of DHCP Receive and ISR processes when the Cisco CMTS is configured
with the cable source-verify dhcp and no cable arp commands.
Caution In current Cisco IOS Release 12.1 EC and 12.2 BC software images, the Cisco CMTS can crash with a
“bus error exception” when the cable source-verify command is configured on a cable interface, and the
routing configuration of that interface is being changed while traffic is passing through the interface. To
avoid this problem, temporarily disable this feature (using no cable source-verify) on the interface
before you configure the routing parameters. Then after you have finished the routing configuration,
reenable the feature using the cable source-verify command. Alternatively, you can also change the
routing parameters when the interface is not passing traffic (such as when the interface is shut down).
Caution In Cisco IOS Release 12.2(15)BC1 and earlier releases, you cannot use the cable source-verify
command on a Cisco uBR-MC16U/X, Cisco uBR-MC28U/X, or Cisco uBR-MC5X20S/U cable
interface line card that is using an MPLS/VPN configuration when you are also using duplicate or
overlapping IP address ranges for CPE devices on different cable interfaces/subinterfaces. To use the
cable source-verify command, you must assign unique IP addresses for each cable interface or
sub-interface. This is being tracked as caveat CSCed53355.
Tip If you notice that CMs are going offline and their IP addresses later appear as PCs or CPE devices behind
other CMs on other cable interface downstreams, consider using the cable source-verify command.
The Cisco CMTS maintains a database that links the MAC and IP addresses of known CPE devices with
the CMs that are providing network access for those CPE devices. The CMTS typically populates this
database with information obtained by examining the Dynamic Host Configuration Protocol (DHCP)
packets sent between the CPE devices and the DHCP server. Other IP traffic provides information about
which CMs service which CPE devices.
After the cable source-verify command is issued, every IP upstream packet is examined. If the IP and
MAC addresses of the CPE device are already associated with a known, online CM, it is allowed through.
If not, the source IP address is examined to determine if it belongs to the cable network. If so, and if the
dhcp option is not used, the packet is allowed through.
Tip You can expect to see a temporary spike in CPU usage after initially enabling the cable source-verify
dhcp command, because the router must send a DHCP LEASEQUERY request for every unknown CPE
IP address. CPU usage drops after the router has verified and learned all of the CPE IP addresses that
are currently online. (This same situation also occurs after giving the no cable arp command, because
of the need to verify CPE IP addresses.)
Note The dhcp option automatically blocks all statically-assigned IP addresses unless the DHCP server has
been configured to recognize those addresses and respond with the appropriate LEASEQUERY
response.
The cable source-verify command by itself prevents someone from stealing another customer’s IP
address. The cable source-verify dhcp command adds another level of security by refusing access to
any CPE device with an IP address that has not been assigned by the DHCP server.
Note This dhcp option requires that the DHCP server support the LEASEQUERY message. The
Cisco Network Registrar (CNR) supports LEASEQUERY in version 3.01(T) and above. The
LEASEQUERY message is currently defined in an IETF draft, which is dated October, 2003 and
available at the following URL:
http://www.ietf.org/internet-drafts/draft-ietf-dhc-leasequery-06.txt
Caution Do not enable the local DHCP server on the Cisco CMTS and configure local DHCP address pools, using
the ip dhcp pool command, when you are also enabling the cable source-verify dhcp command,
because the DHCP server on the Cisco CMTS can intercept the LEASEQUERY messages and prevent
them from reaching the external DHCP server. This in turn prevents address validation from succeeding
because the DHCP server on the Cisco CMTS does not support LEASEQUERY messages.
Tip The cable source-verify command is similar in function to the ip verify unicast reverse-path
command, which is used on other interfaces, except that the cable source-verify command is optimized
for cable interfaces.
Note The leasetimer option is active only if you have also specified the cable source-verify dhcp command
for the cable interface. If the dhcp option is not used, the leasetimer option has no effect. In addition,
the leasetimer option can be configured only on an interface, not a subinterface. Applying it to a master
interface automatically applies it to all subinterfaces.
The leasetimer option allows you to configure how often the timer checks the lease times, so as to
specify the maximum amount of time a CPE device can use an IP address that was previously assigned
by the DHCP server but whose lease time has since expired. The time period can range from 1 minute
to 240 minutes (4 hours), with a grace period of 2 minutes to allow a PC enough time to make a DHCP
request to renew the IP address. To turn off the timer, so that the CMTS no longer checks the lease times,
issue the cable source-verify command without the dhcp option, or turn off the feature entirely with the
no cable source-verify command.
Tip In some circumstances, spoofing can still occur even after the cable source-verify command is used, due
to the behavior of the ARP protocol. For additional security, consider blocking ARP requests to the CMs
using the no cable arp and no cable proxy-arp commands. For more details, see the Cisco Tech Note
at the following URL:
http://www.cisco.com/warp/public/109/source_verify.html
Examples The following example shows how to turn on CM upstream verification and configures the Cisco CMTS
router to send DHCP LEASEQUERIES to verify unknown source IP addresses in upstream data packets:
Router# configure terminal
Router#(config) interface c4/0
Router(config-if)# cable source-verify dhcp
Router(config-if)#
The following example shows how to enable the leasetimer feature so that every two hours, the CMTS
checks the IP addresses in the CPE database for that particular interface for expired lease times:
Router# configure terminal
Router#(config) interface c1/0
Router(config-if)# cable source-verify dhcp
Router(config-if)# cable source-verify leasetimer 120
Router(config-if)#
The following example shows how to configure the cable interface so that the CMTS can verify IP
addresses that are on a different subnet than the one that the cable interface is using:
Router# configure terminal
Router(config)# ip cef
Router#(config) interface c7/0/0
Router(config-if)# ip verify unicast source reachable-via rx
Router(config-if)# cable source-verify dhcp
Router(config-if)#
The following example shows the error message that is displayed if you try to configure the leasetimer
option on a subinterface, instead of an interface:
Router# configure terminal
Router#(config) interface c1/0.1
Router(config-subif)# cable source-verify dhcp
Router(config-subif)# cable source-verify leasetimer 120
% Invalid input detected at '^' marker.
Router(config-subif)#
Syntax Description threshold Maximum number of DHCP lease queries allowed per SID for each interval
period. The valid range is 0 to 255 lease queries.
interval Time period, in seconds, over which lease queries should be monitored. The
valid range is 1 to 10 seconds.
Usage Guidelines When the cable source-verify dhcp and no cable arp commands are configured on a cable interface,
the Cisco CMTS router sends a DHCP LEASEQUERY request to the DHCP server to verify unknown
IP addresses that are found in packets to and from customer premises equipment (CPE) devices that are
using the cable modems on the cable interface. The DHCP server returns a DHCP ACK message with
the MAC address of the CPE device that has been assigned this IP address, if any. The router can then
verify that this CPE device is authorized to use this IP address, which prevents users from assigning
unauthorized IP addresses to their CPE devices.
Problems can occur, though, when viruses, denial of service (DoS) attacks, and theft-of-service attacks
scan ranges of IP addresses, in an attempt to find unused addresses. This type of activity can generate a
large volume of DHCP LEASEQUERY requests, which can result in high CPU utilization and a lack of
available bandwidth for other customers.
To prevent such a large volume of LEASEQUERY requests on all downstreams in the Cisco CMTS
router, use the cable source-verify leasequery-filter downstream command. After configuring this
command, the Cisco CMTS allows only a certain number of DHCP LEASEQUERY requests in the
downstream direction within each interval time period.
For example, the cable source-verify leasequery-filter downstream 5 10 command configures the
router so that it allows a maximum of 5 DHCP LEASEQUERY requests every 10 seconds for each SID
on the downstream direction. This command applies to all downstream cable interfaces in the router.
Note The cable source-verify leasequery-filter downstream command enables DHCP lease query filtering
on all downstreams, but the actual filtering does not begin until the cable source-verify dhcp command
and the no cable arp command are configured on a particular downstream. You can configure these
commands on either the downstream’s main interface, or on a subinterface for the downstream. If these
commands are configured on a subinterface, however, the lease query filtering occurs only for cable
modems using that subinterface.
Tip Use the cable source-verify leasequery-filter upstream command to filter DHCP LEASEQUERY
requests in the upstream direction.
Examples The following example shows how to configure the Cisco CMTS router so that it allows a maximum of
10 DHCP lease query requests per SID over each five-second interval on all downstream cable interfaces.
This example also shows the configuration of cable source-verify dhcp and no cable arp commands on
a cable interface, which are required to use this feature.
Router# configure terminal
Router(config)# cable source-verify leasequery-filter downstream 10 5
Router(config)# interface cable 5/1/0
Router(config-if)# cable source-verify dhcp
Router(config-if)# no cable arp
Router(config-if)#
Syntax Description threshold Maximum number of DHCP lease queries allowed per SID for each interval
period. The valid range is 0 to 20 lease queries.
interval Time period, in seconds, over which lease queries should be monitored. The
valid range is 1 to 5 seconds.
Usage Guidelines When the cable source-verify dhcp and no cable arp commands are configured on a cable interface,
the Cisco Cable Modem Termination System (CMTS) router sends a DHCP LEASEQUERY request to
the DHCP server to verify unknown IP addresses that are found in packets to and from customer
premises equipment (CPE) devices that are using the cable modems on the cable interface. The DHCP
server returns a DHCP ACK message with the MAC address of the CPE device that has been assigned
this IP address, if any. The router can then verify that this CPE device is authorized to use this IP address,
which prevents users from assigning unauthorized IP addresses to their CPE devices.
Problems can occur, though, when viruses, denial of service (DoS) attacks, and theft-of-service attacks
scan ranges of IP addresses, in an attempt to find unused addresses. This type of activity can generate a
large volume of DHCP LEASEQUERY requests, which can result in high CPU utilization and a lack of
available bandwidth for other customers.
To prevent such a large volume of LEASEQUERY requests on the upstreams on a cable interface, use
the cable source-verify leasequery-filter upstream command. After configuring this command, the
Cisco CMTS allows only a certain number of DHCP LEASEQUERY requests in the upstream direction
within each interval time period.
For example, the cable source-verify leasequery-filter upstream 5 5 command configures the router
so that it allows a maximum of 5 DHCP LEASEQUERY requests every 5 seconds for each SID on the
upstream direction. This command applies to all upstreams on the cable interface.
Note The cable source-verify leasequery-filter upstream command enables DHCP lease query filtering on
all upstreams on a cable interface, but the actual filtering does not begin until the cable source-verify
dhcp command and the no cable arp command are configured on the upstream’s associated downstream
interface. You can configure these commands on either the downstream’s main interface, or on a
subinterface for the downstream. If these commands are configured on a subinterface, however, the lease
query filtering occurs only for cable modems using that subinterface.
Note If using cable interface bundling, configure the cable source-verify leasequery-filter upstream
command on all master and slave interfaces.
Tip Use the cable source-verify leasequery-filter downstream command to filter DHCP LEASEQUERY
requests in the downstream direction.
Examples The following example shows how to configure the Cisco CMTS router so that it allows a maximum of
five DHCP lease query requests per SID over each two-second interval on all upstreams on a particular
cable interface. This example also shows the configuration of cable source-verify dhcp and no cable
arp commands on the cable interface, which are required to use this feature.
Router# configure terminal
Router(config)# interface cable 6/0
Router(config-if)# cable source-verify dhcp
Router(config-if)# cable source-verify leasequery-filter upstream 5 2
Router(config-if)# no cable arp
Router(config-if)#
cable spectrum-group group-number [time day hh:mm:ss] band up-freq1-hz up-freq2-hz [pwr-lvl-
dbmv]
Syntax Description group-number Specifies the spectrum group for which you are specifying a parameter value or
specifies the number of the spectrum group you wish to remove from your router
configuration. Valid range is from 1 to 32, or from 1 to 40, depending on the
Cisco IOS software release.
time day (Optional) for scheduled spectrum groups, enter the day of the week (Sun—Sat) and
hh:mm:ss the time of day that the frequency and input power level should change.
frequency up- Specifies a center frequency for the upstream group. The valid range is 5,000,000 Hz
freq-hz to 42,000,000 Hz (DOCSIS), 55,000,000 Hz (Japan), or 65,000,000 (EuroDOCSIS).
Note You can enter this command multiple times for the same spectrum group to
create a group of individual frequencies to be used for frequency hopping.
band up-freq1- Specifies a range of center frequencies the Cisco CMTS can scan to find an
hz up-freq2-hz acceptable channel to which the spectrum group may hop. The valid range for up-
freq1-hz is 5,000,000 Hz to 42,000,000 Hz (DOCSIS), 55,000,000 Hz (Japan), or
65,000,000 (EuroDOCSIS), but up-freq2-hz must be greater than up-freq1-hz.
Note Cisco recommends using the band option, and not the frequency option,
when creating spectrum groups for the Cisco uBR-MC16S cable interface
line card because this allows the card to scan the entire range of frequencies
for its automatic frequency hopping feature.
pwr-lvl-dbmv (Optional) Specifies the nominal input power level. The valid range is –10 to
+25 dBmV, with a default of 0 dBmV. Some cable plants might want to change only
the input power level, and not the frequency, on a daily time schedule.
Defaults If not specified, the group is set for a nominal input power level of 0 dBmV and the group is not
scheduled for automatic frequency or power changes.
Release Modification
12.0(13)SC, 12.1(4)EC, The allowable frequency range was increased to 65 MHz to
12.2(4)BC1 support the EuroDOCSIS frequency range of the Cisco uBR-
MC16E cable interface line card.
12.2(15)BC2 The maximum number of spectrum groups was increased from 32
to 40 groups per router.
Usage Guidelines Frequency agility is configured and activated using spectrum groups that are controlled by the spectrum
manager. You can create from 1 to 32, or from 1 to 40, spectrum groups for each cable modem card
upstream port, depending on the Cisco IOS software release.
To create spectrum groups, specify a list of upstream frequencies and nominal power levels that each
spectrum group can use when an upstream frequency change is necessary. Each spectrum group should
have its own list of upstream frequencies. At 1.6 MHz, the valid range is –10 dBmV to 25 dBmV. The
power level value should be changed only if you want to change only the power level as part of spectrum
management. The standard power level is 0 dBmV.
The the cable spectrum-group command sets the center frequency for the upstream, but the total
frequency bandwidth that is actually used depends on the channel width. Table 2-7 shows the possible
center frequencies for each channel width, for both DOCSIS and EuroDOCSIS cable interfaces.
The allowable range for the upstream channel frequency depends on the cable interface line card and
Cisco IOS software release being used. See Table 2-11 for the currently supported values.
Table 2-8 Allowable Frequency Range for the cable upstream frequency Command
Note If both an Cisco uBR-MC16E cable interface line card and a Cisco uBR-MC16C or a Cisco uBR-
MC16S cable interface line card are present in the chassis, a spectrum group in the 42-MHz to 65-MHz
range should not be assigned.
Tip Cisco cable interface line cards always program the upstream’s center frequency in 16 KHz increments,
and this is the frequency displayed by the show controller cable upstream command. For example, if
you use the cable upstream frequency command to specify a center frequency of 27 MHz (cable
upstream x frequency 27000000), the actual center frequency will be 27.008 MHz, which is the next
highest 16 KHz boundary.
You must repeat this command for each frequency or power level that you want to add to a spectrum
group’s list of valid values.
After you have created one or more spectrum groups for your cable network, you can add characteristics
to them, providing you with more definitive control over frequency usage and frequency hopping.
The cable interface does not operate until you either create and configure a spectrum group or set a fixed
upstream frequency. See the cable upstream channel-width command.
Examples The following example shows how to configure spectrum group 1 with an upstream frequency of
6,500,000 Hz and a default power level of 0 dBmV:
Router(config)# cable spectrum-group 1 frequency 6500000
The following example shows how to add the upstream frequency 7,000,000 Hz to the list of valid
frequencies with a default power level of 0 dBmV for spectrum group 1:
Router(config)# cable spectrum-group 1 frequency 7000000
The following example shows how to configure spectrum group 2 with an upstream frequency
7,500,000 Hz and change the power level to 5 dBmV:
Router(config)# cable spectrum-group 2 frequency 7500000 5
The following example shows how to configure spectrum group 3 with an upstream band of 12,000,000
to 18,000,000 Hz and default power level of 0 dBmV:
Router(config)# cable spectrum-group 3 band 12000000 18000000
The following example shows how to add the upstream band 20,000,000 to 24,000,000 Hz to the list of
valid bands with a change in the power level of 13 dBmV for spectrum group 3:
Router(config)# cable spectrum-group 3 band 20000000 24000000 13
The following example shows how to configure a continuous band between 5,000,004 and
40,000,000 Hz for scheduled spectrum group 4 with a default power level of 0 dBmV. The spectrum
group will be available to the spectrum group starting at 12:00 p.m. local time each Monday:
Router(config)# cable spectrum-group 4 time Monday 12:00:00 band 5000004 40000000
The following example shows how to add the upstream frequency 9,500,000 Hz to the list of valid
frequencies and change the nominal power level to 5 dBmV. The spectrum manager adjusts frequencies
and power levels on this group at 2:00 a.m. local time each day:
Router(config)# cable spectrum-group 3 time 02:00:00 frequency 9500000 5
The following example shows how to remove a specified spectrum group from your configuration:
Router(config)# no cable spectrum-group 3
Router(config)#
Syntax Description group-number Specifies the spectrum group that should be used as the default group for the
upstreams on this cable interface. The valid range is from 1 to 32, or from 1 to 40,
depending on the Cisco IOS software release.
Usage Guidelines This command assigns a default spectrum group to all of the upstreams on the cable interface. All
upstreams on the interface use this spectrum group unless you override this configuration, using one of
the following commands:
• To assign a different spectrum group to a particular upstream, use the cable upstream spectrum-
group command.
• To assign a new frequency to a particular upstream, use the cable upstream frequency command.
These two commands override the cable spectrum-group command for the particular upstreams to
which they are applied. The remaining upstreams in the interface, however, continue to use the default
configuration that is specified by the cable spectrum-group command.
Tip You must first create and configure the spectrum groups before you can assign them to an interface. To
create and configure spectrum groups, use the set of cable spectrum-group commands that are available
in global configuration mode.
Examples The following example shows how to assign spectrum group 1 to all of the upstreams on the cable
interface in slot 3/0:
Router(config)# interface cable 3/0
Syntax Description groupnum Spectrum group number. Valid values are from 1 to 32, or from 1 to 40,
depending on the Cisco IOS software release.
seconds Specifies the frequency-hop time period in seconds. Valid values are
from 1 to 3600 seconds (before Cisco IOS Release 12.2(8)BC1), or
from 1 to 300 seconds (Cisco IOS Release 12.2(8)BC1 or later).
Usage Guidelines The cable spectrum-group hop period command defines the minimum amount of time that must pass
between upstream frequency hops. If ingress noise becomes excessive on a particular upstream, you can
set this time period to a smaller value, so as to allow frequency hopping to continue more rapidly until a
clear channel is found. Conversely, if the problem appears to be a transient condition, such as a defective CM
generating a large volume of errored packets, this time period can be increased to a larger value, so as to avoid
excessive frequency hopping by allowing more time between frequency hops.
On the Cisco uBR-MC1xC cards, the maximum recommended hop period is 20 seconds. On the
Cisco uBR-MC16S and Cisco uBR-MC5X20S/U cards, the minimum recommended hop period is 25
seconds and the maximum recommended hop period is 35 seconds.
In Cisco IOS Release 12.2(15)BC2, the Cisco CMTS adaptively increases the hop period from the user-
defined value to the maximum value (300 seconds) whenever an upstream does not currently have any
CMs ranging on it, so as to avoid unnecessary frequency hopping. The user-defined value is restored
when a CM starts ranging on the upstream.
Note The hop period should be set to at least 25 seconds on the Cisco uBR-MC16S and Cisco uBR-
MC5X20S/U cards so that transient network problems that are unrelated to ingress noise do not generate
unnecessary frequency hops.
Examples The following example shows how to change the minimum frequency-hop interval to 60 seconds. This
means that frequency hops for this spectrum group cannot occur more quickly than once every 60
seconds, even if other characteristics, such as exceeding the CNR or FEC threshold values, would
normally trigger the hop.
router# configure terminal
router(config)# cable spectrum-group 1 hop period 60
router(config)#
Syntax Description groupnum Spectrum group number. Valid values are from 1 to 32, or from 1 to 40,
depending on the Cisco IOS software release.
percent (Optional) Specifies the frequency hop threshold as a percentage of
station maintenance messages that are lost. Valid range is from 1 to 100
percent.
Defaults 20 percent
Usage Guidelines The Cisco CMTS sends a station maintenance message to each CM at least once every 25 to 30 seconds.
If a CM does not respond to a station maintenance message within that time period, the CMTS then
resends station maintenance messages at a faster rate (typically one second apart) in an attempt to restore
connectivity with the CM.
Station maintenance messages can be lost because CMs have lost connectivity with the CMTS, or
because ingress noise and other factors are causing dropped and errored packets. Downstream noise can
also affect the delivery of station maintenance messages. When a user-configurable percentage of station
maintenance messages are lost, the CMTS hops to a new upstream frequency to improve connectivity
and sends out an Upstream Channel Descriptor (UCD) update to the CMs to inform them of the change.
The optimal hop threshold value depends on several factors, including the quality of the upstream return
path and the number of CMs on the upstream. In addition, the hop threshold works together with the hop
period so that transient network problems do not generate an unnecessary number of frequency hops.
Ideally, the hop threshold should be set low enough so that the frequency hop can occur before a
significant number of CMs go offline, but not so low that it generates frequency hops that are not needed.
For example, if the hop threshold is at its default of 20 percent and an upstream has 100 active CMs, a
power outage that affected 20 CMs would usually cause a frequency hop since this is a 20 percent loss
of CMs, which in turn would be responsible for at least 20 percent loss of station maintenance messages.
But in this situation, the frequency hop would be unneeded because changing the upstream frequency
could not correct the original problem (the power outage). If this were a common situation on this
upstream, the network administrator might increase the hop threshold so that the repeated power outages
would not generate unneeded frequency hops.
If, on the other hand, the power outage affected only 10 CMs, a frequency hop would not occur unless
another factor, such as ingress noise, created a sufficient loss of station maintenance messages to reach
the 20 percent threshold. In this situation, the default threshold of 20 percent might be sufficient.
Downstream problems can also generate frequency hops. For example, if 20 CMs were on a particularly
noisy downstream, over time they could miss a sufficient number of station maintenance messages to
generate a frequency hop. The network administrator could increase the hop threshold to limit the
possibility of frequency hops due to downstream impairments.
Also, faulty CMs could generate a frequency hop under certain conditions. For example, if a number of
faulty CMs generated a large number of uncorrectable forward error correction (FEC) errors or
otherwise missed 50 to 60 percent of their station maintenance messages, without actually going offline,
over time they could miss a sufficient number of station maintenance messages to cause a frequency hop
or modulation change. The network administrator could increase the hop threshold to prevent the CMTS
from generating a frequency hop or modulation change for problems such as these, which are unrelated
to actual noise on the upstream.
Note If a previous frequency hop had already occurred within the user-configurable hop period, the CMTS
will not immediately frequency hop. Instead, the CMTS would wait until the hop period expires, and if
the percentage of station maintenance messages still exceeds the hop threshold, the CMTS would
perform another frequency hop.
Tip When an upstream has 25 or fewer CMs (which is typical with lab and test environments), the CMTS
increases the rate at which it sends station maintenance messages to the CMs. This higher polling rate,
along with the small number of CMs, means that frequency hopping can occur more quickly than with
a normally loaded upstream, especially when a small number of CMs are powered down or generate
noisy traffic.
Note The DOCSIS specification states that when a CM misses 16 sequential station maintenance messages,
the CMTS should consider the CM offline and should stop sending station maintenance messages to that
CM. The CM must then reregister with the CMTS to resume connectivity.
Examples The following example shows how to set the threshold that triggers frequency hop to 25 percent of
station maintenance messages on the upstream that is assigned to spectrum-group 4:
router# configure terminal
router(config)# cable spectrum-group 4 hop threshold 25
router(config)#
Syntax Description groupnum Spectrum group number. Valid values are from 1 to 32, or from 1 to 40,
depending on the Cisco IOS software release.
Defaults Upstream port frequency is the same for all ports in the spectrum group.
Usage Guidelines Because this command forces upstream ports to use the same spectrum, you must ensure that you do not
configure spectrum groups that have overlapping frequencies. To use shared spectrum groups, each
group must be using a discrete set of frequencies.
Caution Depending on the frequencies being used, and how cable modems are distributed across those
frequencies and among spectrum groups, switching from a group from shared to non-shared, or from
non-shared to shared, could cause CMs in the spectrum group to go offline and begin reranging
procedures. You should therefore use this command only during regularly schedule maintenance times,
so that a minimum number of online customers are affected.
Note This command does not enable any sort of load balancing on the shared upstreams.
Examples The following example shows how to specify that all the upstream ports for spectrum group 4 share the
same upstream frequency, and that these upstream frequencies are not assigned to other upstream
interfaces:
Router(config)# cable spectrum-group 4 shared
Router(config)#
Syntax Description no When used with the active and learnable options, the no form of the
command sets the default attributes to false. When used with the max-cpe
and filter-group options, the no form of the command sets the attribute to 0.
active Sets the docsSubMgtCpeActiveDefault attribute, which controls whether
the CMTS manages the CPE devices for a particular CM—when set to
TRUE, the CMTS enforces the MAX-CPE value and the implemented
filters. The no cable submgmt default active command sets the default
value to FALSE (the original default), which turns off CPE management at
the CMTS.
learnable Sets the docsSubMgtCpeLearnableDefault attribute, which controls
whether the CMTS learns the CPE IP addresses for a particular CM—when
set to TRUE (the original default), the CMTS learns IP addresses up to the
MAX-CPE value. The no cable submgmt default learnable command sets
the default value to FALSE, which means that the IP address for each
allowable CPE device must be specified in the DOCSIS configuration file.
max-cpe cpe-num Sets the docsSubMgtCpeMaxIpDefault attribute, which specifies the
default number of simultaneous IP addresses (CPE devices) permitted for
the CM. The possible range is 0 to 1024, where 0 specifies that all CPE
traffic from the CM is dropped. The default is 16.
filter-group Specifies a filter group, which can be applied to either upstream or
downstream traffic for either a CM or its CPE devices.
cm Specifies that the filter group applies to traffic to or from a CM.
cpe Specifies that the filter group applies to traffic to or from a CPE device.
downstream Specifies that the filter group applies to the downstream traffic that is going
to the specified CM or CPE device.
upstream Specifies that the filter group applies to the upstream traffic that is coming
from the specified CM or CPE device.
group-id Specifies the filter group ID (0 to 1024) to be applied for the CM or CPE,
downstream or upstream filter. This ID references the filter indexes that are
used for rows in the docsSubMgtPktFilterTable. A value of 0 indicates that
no filtering is used for this particular type of traffic.
Defaults The Subscriber Management MIB defaults to the following default values:
• The active parameter defaults to FALSE (the CMTS does not actively manage CPE devices).
• The learnable parameter defaults to TRUE (the CMTS learns the IP addresses for CPE devices).
• The max-cpe parameter defaults to 16 IP addresses.
• The filter group ID for each type of filter group defaults to 0, which means that no filtering is done
on that type of traffic.
Usage Guidelines This command enables field technicians to add a temporary CPE device behind the subscriber’s cable
modem. The temporary CPE device shares the same SID settings as the original CPE device, even though
the temporary CPE device has a different MAC address. The original CPE device automatically changes
from dhcp cpe to static cpe in the CMTS host routing tables, and the CPE device continues to receive
service with the same SID.
To disable Cisco CMTS Static CPE Override on the Cisco CMTS, use the no form of this command. This
automatically updates the routing tables and enables the MAC address from the technician’s laptop for
a future field service connection at a different location.Prior to using this command, the first (existing)
DHCP CPE device maintains its DHCP dynamic MAC address behind the cable modem. The SID is
assigned to this IP address.
However, by enabling Static CPE override, you gain the following states and options on two CPE devices
behind the cable modem.
• The SID definition on the first CPE device is assigned a different static IP address. This enables you
to change the existing (dynamic) DHCP IP address to a static IP address without first clearing the
DHCP CPE host entries from the Cisco CMTS. The CPE IP state changes from dhcp to static cpe.
• This static override allows a second CPE device with a second MAC address behind the same cable
modem with SID1 to be assigned same IP address as the first CPE device.
Note The second CPE device changes from dhcp cpe to static CPE in the CMTS host tables.
The DOCSIS 1.1 Subscriber Management MIB (DOCS-SUBMGT-MIB) creates and maintains a number
of tables that describe the state of subscriber management for the CMs and CPE devices being serviced
by the Cisco CMTS. The CMTS creates rows in these tables for each CM and CPE device when the CM
registers with the CMTS, and if the CM does not specify a value for an attribute in this table, the CMTS
uses the defaults specified by the cable submgmt default command.
Timesaver The DOCS-SUBMGT-MIB MIB contains its own default values for these attributes, and those defaults
can be overridden by giving the appropriate SNMP SET commands. The cable submgmt default
command, however, allows the new defaults to be included in the Cisco IOS configuration file so that
the defaults are automatically reconfigured whenever the CMTS reboots or reloads.
Note The cable submgmt default command sets only the default value for these attributes. These default
values are used only if the CM does not specify other values when it registers with the CMTS. If the CM
does specify different values at registration time, those values are used instead of these default values.
The attributes in DOCS-SUBMGT-MIB control how the CMTS manages the CPE devices behind a CM
and the filters that are applied to the traffic to and from a particular CM and its CPE devices. The
following sections describe the relationship between the different forms of the cable submgmt default
commands and the attributes in DOCS-SUBMGT-MIB.
CPE Management
The first form of the cable submgmt default command controls the default values for the entries in the
docsSubMgtCpeControlTable, which controls how the CMTS manages the CPE devices for each CM:
cable submgmt default active
Sets the docsSubMgtCpeActiveDefault attribute, which is the default value for the
docsSubMgtCpeControlActive attribute in docsSubMgtCpeControlTable. This attribute controls
whether the CMTS performs CPE management for a particular CM.
• The cable submgmt default active command sets the default to TRUE, which specifies that the
CMTS is to manage CPE devices by enforcing the MAX-CPE number and the implemented filters.
• The no cable submgmt default active command sets the default to FALSE (the default value),
which specifies that the CMTS is not to perform CPE management for the particular CM.
cable submgmt default learnable
Sets the docsSubMgtCpeLearnableDefault attribute, which is the default value for the
docsSubMgtCpeControlLearnable attribute in docsSubMgtCpeControlTable. This attribute controls
whether the CMTS learns the IP addresses for CPE devices behind a particular CM.
• The cable submgmt default learnable command sets the default to TRUE (the default value),
which specifies that the CMTS is to learn the IP addresses for the CPE devices behind the CM, up
to the value specified by the MAX-CPE parameter. The CMTS learns the IP addresses by monitoring
the traffic sent by the CPE devices, and the first CPE devices to transmit traffic are the first CPE
devices to be learned.
• The no cable submgmt default learnable command sets the default to FALSE, which specifies that
the CMTS does not learn the IP addresses for the CPE devices behind a particular CM. Instead, the IP
addresses for each CM that is to be allowed access must be specified in the DOCSIS configuration file.
cable submgmt default max-cpe cpe-num
Sets the docsSubMgtCpeMaxIpDefault attribute, which specifies the default value for the
docsSubMgtCpeControlMaxCpeIp attribute in docsSubMgtCpeControlTable. This attribute specifies
the maximum number of IP addresses that can transmit traffic through a particular CM. The possible
range is 0 to 1024, and the original default is 16.
Note The MAX-CPE attribute is used only when the CMTS is actively managing CPE devices for the CM.
The second form of the cable submgmt default command controls the default values for the entries in
the docsSubMgtCmFilterTable, which assigns the CM to one or more filter groups. A filter group
specifies what filters are applied to the traffic going to or coming from each particular CM or CPE
device. Filter groups can be numbered 0 to 1024, where 0 specifies that no filtering is done for that
particular traffic type.
Note The actual filters specified in these commands must be created by setting the appropriate attributes in
the DOCS-SUBMGT-MIB MIB using SNMP SET commands.
Examples The following commands specify that the CMTS defaults to actively managing the CPE devices for each
CM that registers, allowing and learning up to four IP addresses for the CPE devices behind that CM.
Router# configure terminal
Router(config)# cable submgmt default active
Router(config)# cable submgmt default learnable
Router(config)# cable submgmt default max-cpe 4
Router(config)#
The following commands specify that the CMTS defaults to actively managing the CPE devices for each
CM that registers. Each CM, however, must specify its own MAX-CPE value; otherwise, that value
defaults to 0 and all traffic to and from the CPE devices for that CM is blocked.
Router# configure terminal
Router(config)# cable submgmt default active
Router(config)# cable submgmt default max-cpe 0
Router(config)#
The following commands specify that the CMTS defaults to not actively managing the CPE devices for
each CM that registers. However, if the CM at registration time indicates that the CMTS is to actively
manage the CPE devices, the CMTS defaults to allowing only one CPE device. Learning also is disabled,
so that one CPE device, therefore, must be specified in the DOCSIS configuration file that the CM uses
to register.
The following commands specify that the CMTS defaults to assigning three filter groups to each CM that
registers. Unless the CM indicates otherwise at registration time, downstream and upstream traffic for
the CPE devices behind the CM is filtered according to the rules for filter groups 20 and 21, respectively.
Filter group 1 is applied to the downstream traffic addressed to the CM. Upstream traffic sent by the CM,
however, is not filtered.
Router# configure terminal
Router(config)# cable submgmt default filter-group cpe downstream 20
Router(config)# cable submgmt default filter-group cpe upstream 21
Router(config)# cable submgmt default filter-group cm downstream 1
Router(config)# cable submgmt default filter-group cm upstream 0
Router(config)#
Note The above example assumes that filter groups 1, 20, and 21 have already been created on the CMTS using
the appropriate SNMP commands.
Related Commands For additional information about configuring Static CPE Override on the Cisco CMTS, refer to the
following document on Cisco.com:
• Cisco CMTS Static CPE Override
http://www.cisco.com/en/US/products/hw/cable/ps2217/prod_troubleshooting_guide09186a00802
84e08.html
cable sync-interval
To specify the interval between successive sync message transmissions from the Cisco CMTS, use the
cable sync-interval command in cable interface configuration mode. To return the sync message interval
to its default value, use the no form of this command.
no cable sync-interval
Syntax Description msec Specifies the interval in milliseconds (ms) between successive sync
message transmissions from the Cisco CMTS. Valid values are from
1 to 200 ms. Default value is 10 ms.
Defaults 10 ms
Usage Guidelines To verify whether or not a sync message interval has been configured, enter the show running-config
command and look for the cable interface configuration information. If a sync message interval has been
configured, it appears in this output. If the sync message interval has been deactivated or reset to its
default value, no sync interval command line appears in the output.
Examples The following example shows how to specify the interval for the sync message transmissions to 100 ms:
Router (config-if)# cable sync-interval 100
Note This command is available only in images that support telco-return. These images have a “t” as part of
the image name.
cable telco-return spd Sets the password that the telco-return CM uses for authentication
password when establishing a PPP connection.
cable telco-return spd Sets the telephone numbers that the telco-return CM dials when
phonenum connecting to the headend’s network access server.
cable telco-return spd ppp- Selects the authentication procedure to use when the telco-return CM
authenticate is establishing a PPP connection.
cable telco-return spd Selects a RADIUS server domain to use for the login response string.
radius-realm
cable telco-return spd Includes the service provider name in the SPD message.
service-provider
cable telco-return spd Sets the number of failed dial-up connections that can occur before the
threshold CM indicates a connection failure.
cable telco-return spd Sets the username that the telco-return CM uses for authentication
username when establishing a PPP connection.
Syntax Description seconds Number of seconds between intervals for sending TCD and TSI
messages. Valid range is 2 through 60 seconds.
Defaults 2 seconds
Examples The following example shows how to set the TCD and TSI message interval to 40 seconds:
router(config-if)# cable telco-return interval 40
Note This command is available only in images that support telco-return. These images have a “t” as part of
the image name.
cable telco-return spd Sets the password that the telco-return CM uses for authentication
password when establishing a PPP connection.
cable telco-return spd Sets the telephone numbers that the telco-return CM dials when
phonenum connecting to the headend’s network access server.
cable telco-return spd ppp- Selects the authentication procedure to use when the telco-return CM
authenticate is establishing a PPP connection.
cable telco-return spd Selects a RADIUS server domain to use for the login response string.
radius-realm
cable telco-return spd Includes the service provider name in the SPD.
service-provider
cable telco-return spd Sets the number of failed dial-up connections that can occur before the
threshold CM indicates a connection failure.
cable telco-return spd Sets the username that the telco-return CM uses for authentication
username when establishing a PPP connection.
Syntax Description ip-address Registration IP address that is sent in Termination System Information
(TSI) messages. Value is any of the cable interface’s IP addresses.
Usage Guidelines This command sets the Registration IP Address parameter in TSI messages. By default, the downstream
channel IP address of the Cisco CMTS is also used for the registration IP address. When this cable telco-
return registration-ip command is configured, telco-return CMs send their registration requests to this
IP address instead of to the downstream channel IP address.
Note This command is available only in images that support telco-return. These images have a “t” as part of
the image name.
Examples The following example shows how to send the CM’s registration requests to IP address 172.16.1.1:
router(config-if)# cable telco-return registration-ip 172.16.1.1
cable telco-return spd dial- Sets the number of seconds that a telephone connection is idle before
timer the telco-return CM disconnects the call.
cable telco-return spd Indicates the service provider descriptor (SPD) that the telco-return
factory-default CM uses during the initialization process.
cable telco-return spd Enables the telco-return CM to operate in manual-dial mode.
manual-dial
cable telco-return spd Sets the password that the telco-return CM uses for authentication
password when establishing a PPP connection.
cable telco-return spd Sets the telephone numbers that the telco-return CM dials when
phonenum connecting to the headend’s network access server.
cable telco-return spd ppp- Selects the authentication procedure to use when the telco-return CM
authenticate is establishing a PPP connection.
cable telco-return spd Selects a RADIUS server domain to use for the login response string.
radius-realm
cable telco-return spd Includes the service provider name in the SPD.
service-provider
cable telco-return spd Sets the number of failed dial-up connections that can occur before the
threshold CM indicates a connection failure.
cable telco-return spd Sets the username that the telco-return CM uses for authentication
username when establishing a PPP connection.
Syntax Description spd-number Service provider descriptor (SPD) number for which this parameter is
set. Valid range is 1 through 5.
Usage Guidelines This command sets the DHCP Authenticate parameter to TRUE (1) for the specified SPD in the
Telephony Channel Descriptor (TCD) messages. It indicates that the CM must use the DHCP server that
is specified with the cable telco-return spd dhcp-server command.
Note This command is available only in images that support telco-return. These images have a “t” as part of
the image name.
Examples The following example indicates that for SPD 2, CMs must use the DHCP server identified by IP address
192.168.255.255:
router(config-if)# cable telco-return spd 2 dhcp-authenticate
router(config-if)# cable telco-return spd 2 dhcp-server 192.168.255.255
cable telco-return spd dhcp- Identifies the IP address of the DHCP server that the telco-return CMs
server must use.
cable telco-return spd dial- Sets the number of seconds that a telephone connection is idle before
timer the telco-return CM disconnects the call.
cable telco-return spd Indicates the SPD that the telco-return CM uses during the
factory-default initialization process.
cable telco-return spd Enables the telco-return CM to operate in manual-dial mode.
manual-dial
cable telco-return spd Sets the password that the telco-return CM uses for authentication
password when establishing a PPP connection.
cable telco-return spd Sets the telephone numbers that the telco-return CM dials when
phonenum connecting to the headend’s network access server.
cable telco-return spd ppp- Selects the authentication procedure to use when the telco-return CM
authenticate is establishing a PPP connection.
cable telco-return spd Selects a RADIUS server domain to use for the login response string.
radius-realm
cable telco-return spd Includes the service provider name in the SPD.
service-provider
cable telco-return spd Sets the number of failed dial-up connections that can occur before the
threshold CM indicates a connection failure.
cable telco-return spd Sets the username that the telco-return CM uses for authentication
username when establishing a PPP connection.
Syntax Description spd-number Service provider descriptor (SPD) number for which this parameter is
set. Valid range is 1 through 5.
ip-address IP address of the DHCP server that CMs must use.
Usage Guidelines This command sets the DHCP Server parameter in the specified SPD in Telephony Channel Descriptor
(TCD) messages. Telco-return CMs use the DHCP server that is identified by this IP address if the cable
telco-return spd dhcp-authenticate command is configured. If the cable telco-return spd dhcp-
authenticate command is not configured, the CMs use any available DHCP server.
Note This command is available only in images that support telco-return. These images have a “t” as part of
the image name.
Examples The following example indicates that for SPD 2, CMs must use the DHCP server identified by IP address
192.168.255.255:
router(config-if)# cable telco-return spd 2 dhcp-authenticate
router(config-if)# cable telco-return spd 2 dhcp-server 192.168.255.255
cable telco-return Selects a different IP address for the telco-return CM to send its
registration-ip registration requests.
cable telco-return spd dhcp- Indicates that telco-return CMs must use a specific DHCP server.
authenticate
cable telco-return spd dial- Sets the number of seconds that a telephone connection is idle before
timer the telco-return CM disconnects the call.
cable telco-return spd Indicates the SPD that the telco-return CM uses during the
factory-default initialization process.
cable telco-return spd Enables the telco-return CM to operate in manual-dial mode.
manual-dial
cable telco-return spd Sets the password that the telco-return CM uses for authentication
password when establishing a PPP connection.
cable telco-return spd Sets the telephone numbers that the telco-return CM dials when
phonenum connecting to the headend’s network access server.
cable telco-return spd ppp- Selects the authentication procedure to use when the telco-return CM
authenticate is establishing a PPP connection.
cable telco-return spd Selects a RADIUS server domain to use for the login response string.
radius-realm
cable telco-return spd Includes the service provider name in the SPD.
service-provider
cable telco-return spd Sets the number of failed dial-up connections that can occur before the
threshold CM indicates a connection failure.
cable telco-return spd Sets the username that the telco-return CM uses for authentication
username when establishing a PPP connection.
Syntax Description spd-number Service provider descriptor (SPD) number for which this parameter is
set. Valid range is 1 through 5.
seconds Number of seconds that a connection is idle before the CM
disconnects the call. Valid range is 0 through 4,294,967,295. The
default of 0 means that the dial-timer is not used.
Defaults The dial-timer is set to 0, which means that inactive telephone connections are not disconnected.
Usage Guidelines This command sets the Demand Dial Timer parameter for the specified SPD in Telephony Channel
Descriptor (TCD) messages. This enables the CM to emulate true dial-on-demand functionality by
monitoring inactive networking time and allowing it to disconnect any telephone connection that exceeds
the timer.
Note This command is available only in images that support telco-return. These images have a “t” as part of
the image name.
Examples The following example shows how to set the timer to 2 hours:
router(config-if)# cable telco-return spd 2 dial-timer 7200
cable telco-return Selects a different IP address for the telco-return CM to send its
registration-ip registration requests.
cable telco-return spd dhcp- Indicates that telco-return CMs must use a specific DHCP server.
authenticate
cable telco-return spd dhcp- Identifies the IP address of the DHCP server that the telco-return CMs
server must use.
cable telco-return spd Indicates the SPD that the telco-return CM uses during the
factory-default initialization process.
cable telco-return spd Enables the telco-return CM to operate in manual-dial mode.
manual-dial
cable telco-return spd Sets the password that the telco-return CM uses for authentication
password when establishing a PPP connection.
cable telco-return spd Sets the telephone numbers that the telco-return CM dials when
phonenum connecting to the headend’s network access server.
cable telco-return spd ppp- Selects the authentication procedure to use when the telco-return CM
authenticate is establishing a PPP connection.
cable telco-return spd Selects a RADIUS server domain to use for the login response string.
radius-realm
cable telco-return spd Includes the service provider name in the SPD.
service-provider
cable telco-return spd Sets the number of failed dial-up connections that can occur before the
threshold CM indicates a connection failure.
cable telco-return spd Sets the username that the telco-return CM uses for authentication
username when establishing a PPP connection.
Syntax Description spd-number Service provider descriptor (SPD) that contains the set of telephony
attributes used by the CM during initialization. Valid range is 1
through 5.
Defaults The Factory Default Flag in the SPD is set to 0, which means that this SPD is not used for the
initialization process.
Usage Guidelines This command sets the Factory Default parameter in the specified SPD in Telephony Channel Descriptor
(TCD) messages. This determines the set of telephony attributes, as defined by the SPD, that are used
for the initialization process when the CM is powered on or is reset to its factory default.
Note This command is available only in images that support telco-return. These images have a “t” as part of
the image name.
Examples The following example shows how to set the telco-return CM to use SPD 2 during the initialization
procedure:
router(config-if)# cable telco-return spd 2 factory-default
cable telco-return spd dhcp- Indicates that telco-return CMs must use a specific Dynamic Host
authenticate Configuration Protocol (DHCP) server.
cable telco-return spd dhcp- Identifies the IP address of the DHCP server that the telco-return CMs
server must use.
cable telco-return spd dial- Sets the number of seconds that a telephone connection is idle before
timer the telco-return CM disconnects the call.
cable telco-return spd Enables the telco-return CM to operate in manual-dial mode.
manual-dial
cable telco-return spd Sets the password that the telco-return CM uses for authentication
password when establishing a PPP connection.
cable telco-return spd Sets the telephone numbers that the telco-return CM dials when
phonenum connecting to the headend’s network access server.
cable telco-return spd ppp- Selects the authentication procedure to use when the telco-return CM
authenticate is establishing a PPP connection.
cable telco-return spd Selects a RADIUS server domain to use for the login response string.
radius-realm
cable telco-return spd Includes the service provider name in the SPD.
service-provider
cable telco-return spd Sets the number of failed dial-up connections that can occur before the
threshold CM indicates a connection failure.
cable telco-return spd Sets the username that the telco-return CM uses for authentication
username when establishing a PPP connection.
Syntax Description spd-number Service provider descriptor (SPD) number for which this parameter is
set. Valid range is 1 through 5.
Usage Guidelines This command sets the Manual Dial vendor-specific parameter in the specified SPD in Telephony
Channel Descriptor (TCD) messages.
Note This command is available only in images that support telco-return. These images have a “t” as part of
the image name.
Examples The following example shows how to set manual-dial mode for SPD 1:
router(config-if)# cable telco-return spd 1 manual-dial
cable telco-return spd dhcp- Identifies the IP address of the DHCP server that the telco-return CMs
server must use.
cable telco-return spd dial- Sets the number of seconds that a telephone connection is idle before
timer the telco-return CM disconnects the call.
cable telco-return spd Indicates the SPD that the telco-return CM uses during the
factory-default initialization process.
cable telco-return spd Sets the password that the telco-return CM uses for authentication
password when establishing a PPP connection.
cable telco-return spd Sets the telephone numbers that the telco-return CM dials when
phonenum connecting to the headend’s network access server.
cable telco-return spd ppp- Selects the authentication procedure to use when the telco-return CM
authenticate is establishing a PPP connection.
cable telco-return spd Selects a RADIUS server domain to use for the login response string.
radius-realm
cable telco-return spd Includes the service provider name in the SPD.
service-provider
cable telco-return spd Sets the number of failed dial-up connections that can occur before the
threshold CM indicates a connection failure.
cable telco-return spd Sets the username that the telco-return CM uses for authentication
username when establishing a PPP connection.
Syntax Description spd-number Service provider descriptor (SPD) number for which this parameter is
set. Valid range is 1 through 5.
password-string Login password that the CM uses for authentication during the
initialization procedure.
Usage Guidelines This command sets the Login Password parameter for the specified SPD in Telephony Channel
Descriptor (TCD) messages.
Note This command is available only in images that support telco-return. These images have a “t” as part of
the image name.
Examples The following example shows how to set the password to 9JwoKd7 in service provider descriptor 2:
router(config-if)# cable telco-return spd 2 password 9JwoKd7
cable telco-return spd dhcp- Indicates that telco-return CMs must use a specific DHCP server.
authenticate
cable telco-return spd dhcp- Identifies the IP address of the DHCP server that the telco-return CMs
server must use.
cable telco-return spd dial- Sets the number of seconds that a telephone connection is idle before
timer the telco-return CM disconnects the call.
cable telco-return spd Indicates the SPD that the telco-return CM uses during the
factory-default initialization process.
cable telco-return spd Enables the telco-return CM to operate in manual-dial mode.
manual-dial
cable telco-return spd Sets the telephone numbers that the telco-return CM dials when
phonenum connecting to the headend’s network access server.
cable telco-return spd ppp- Selects the authentication procedure to use when the telco-return CM
authenticate is establishing a PPP connection.
cable telco-return spd Selects a RADIUS server domain to use for the login response string.
radius-realm
cable telco-return spd Includes the service provider name in the SPD.
service-provider
cable telco-return spd Sets the number of failed dial-up connections that can occur before the
threshold CM indicates a connection failure.
cable telco-return spd Sets the username that the telco-return CM uses for authentication
username when establishing a PPP connection.
Syntax Description spd-number Service provider descriptor (SPD) number for which this parameter is
set. Valid range is 1 through 5.
dial-string Telephone number that the CM uses to connect to the headend’s
network access server.
Usage Guidelines This command sets the Phone Number parameters in the specified SPD in Telephony Channel Descriptor
(TCD) messages. You can repeat this command, entering as many as three telephone numbers for the
CM to use when attempting to establish a PPP connection with the network access server. The phone
numbers are mapped to the parameters Phone Number1, Phone Number2, Phone Number3 in the order
in which you enter them. The CM attempts to connect using Phone Number1 first. If it fails to connect,
and its number of retries exceeds the limit set with the cable telco-return spd threshold command, the
CM dials the next number in the list.
Note This command is available only in images that support telco-return. These images have a “t” as part of
the image name.
Examples The following example shows how to set the primary phone number to 9255551212. If the CM fails to
connect using that number, it tries the next phone number, 9255551234:
router(config-if)# cable telco-return spd 2 phonenum 9255551212
router(config-if)# cable telco-return spd 2 phonenum 9255551234
Syntax Description spd-number Service provider descriptor (SPD) number for which this parameter is
set. Valid range is 1 through 5.
both Challenge Handshake Authentication Protocol (CHAP) is used if the
network access server supports CHAP. Password Authentication
Protocol (PAP) is used only if the network access server does not
support CHAP.
chap CHAP authentication is used.
pap PAP authentication is used.
Defaults The default is both; either CHAP or PAP is used depending on the methods supported by the network
access server.
Usage Guidelines This command sets the PPP Authentication parameter for the specified SPD in Telephony Channel
Descriptor (TCD) messages.
Note This command is available only in images that support telco-return. These images have a “t” as part of
the image name.
Syntax Description spd-number Service provider descriptor (SPD) number for which this parameter is
set. Valid range is 1 through 5.
string Alphanumeric string identifying a RADIUS server domain.
Usage Guidelines This command sets the RADIUS Realm parameter for the specified SPD in Telephony Channel
Descriptor (TCD) messages. When this command is configured, telco-return CMs use this realm string
to construct a domain name for the login username when responding to a PPP login query.
Note This command is available only in images that support telco-return. These images have a “t” as part of
the image name.
cable telco-return spd dhcp- Indicates that telco-return CMs must use a specific DHCP server.
authenticate
cable telco-return spd dhcp- Identifies the IP address of the DHCP server that the telco-return CMs
server must use.
cable telco-return spd dial- Sets the number of seconds that a telephone connection is idle before
timer the telco-return CM disconnects the call.
cable telco-return spd Indicates the SPD that the telco-return CM uses during the
factory-default initialization process.
cable telco-return spd Enables the telco-return CM to operate in manual-dial mode.
manual-dial
cable telco-return spd Sets the password that the telco-return CM uses for authentication
password when establishing a PPP connection.
cable telco-return spd Sets the telephone numbers that the telco-return CM dials when
phonenum connecting to the headend’s network access server.
cable telco-return spd ppp- Selects the authentication procedure to use when the telco-return CM
authenticate is establishing a PPP connection.
cable telco-return spd Includes the service provider name in the SPD.
service-provider
cable telco-return spd Sets the number of failed dial-up connections that can occur before the
threshold CM indicates a connection failure.
cable telco-return spd Sets the username that the telco-return CM uses for authentication
username when establishing a PPP connection.
Syntax Description spd-number Service provider descriptor number for which this parameter is set.
Valid range is 1 through 5.
spd-string Alphanumeric string that identifies the service provider.
Usage Guidelines This command sets the Service Provider Name parameter for the specified SPD in the Telephony
Channel Descriptor (TCD) messages.
Note This command is available only in images that support telco-return. These images have a “t” as part of
the image name.
Examples The following example shows the service provider name being set to “san_jose” for SPD 2:
router(config-if)# cable telco-return spd 2 service-provider san_jose
cable telco-return spd dhcp- Identifies the IP address of the DHCP server that the telco-return CMs
server must use.
cable telco-return spd dial- Sets the number of seconds that a telephone connection is idle before
timer the telco-return CM disconnects the call.
cable telco-return spd Indicates the SPD that the telco-return CM uses during the
factory-default initialization process.
cable telco-return spd Enables the telco-return CM to operate in manual-dial mode.
manual-dial
cable telco-return spd Sets the password that the telco-return CM uses for authentication
password when establishing a PPP connection.
cable telco-return spd Sets the telephone numbers that the telco-return CM dials when
phonenum connecting to the headend’s network access server.
cable telco-return spd ppp- Selects the authentication procedure to use when the telco-return CM
authenticate is establishing a PPP connection.
cable telco-return spd Selects a RADIUS server domain to use for the login response string.
radius-realm
cable telco-return spd Sets the number of failed dial-up connections that can occur before the
threshold CM indicates a connection failure.
cable telco-return spd Sets the username that the telco-return CM uses for authentication
username when establishing a PPP connection.
Syntax Description spd-number Service provider descriptor (SPD) number for which this parameter is
set. Valid range is 1 through 5.
threshold-number Number of dial-up attempts that fail before the CM declares a
connection failure. Valid range is 1 through 255.
Usage Guidelines This command sets the Connection Threshold parameter for the specified SPD in the Telephony Channel
Descriptor (TCD) messages. A dial-up attempt is considered a connection failure if an answer
connection is not made after ten rings. The CM continues to try to connect until the connection threshold
is reached. If multiple phone numbers are configured using the cable telco-return spd phonenum
command, the CM dials each phone number until it makes a connection or exceeds the configured
threshold.
Note This command is available only in images that support telco-return. These images have a “t” as part of
the image name.
Examples The following example shows the connection threshold being set to 20:
router(config-if)# cable telco-return spd 2 threshold 20
cable telco-return Selects a different IP address for the telco-return CM to send its
registration-ip registration requests.
cable telco-return spd dhcp- Indicates that telco-return CMs must use a specific DHCP server.
authenticate
cable telco-return spd dhcp- Identifies the IP address of the DHCP server that the telco-return CMs
server must use.
cable telco-return spd dial- Sets the number of seconds that a telephone connection is idle before
timer the telco-return CM disconnects the call.
cable telco-return spd Indicates the SPD that the telco-return CM uses during the
factory-default initialization process.
cable telco-return spd Enables the telco-return CM to operate in manual-dial mode.
manual-dial
cable telco-return spd Sets the password that the telco-return CM uses for authentication
password when establishing a PPP connection.
cable telco-return spd Sets the telephone numbers that the telco-return CM dials when
phonenum connecting to the headend’s network access server.
cable telco-return spd ppp- Selects the authentication procedure to use when the telco-return CM
authenticate is establishing a PPP connection.
cable telco-return spd Selects a RADIUS server domain to use for the login response string.
radius-realm
cable telco-return spd Includes the service provider name in the SPD.
service-provider
cable telco-return spd Sets the username that the telco-return CM uses for authentication
username when establishing a PPP connection.
Syntax Description spd-number Service provider descriptor (SPD) number for which this parameter is
set. Valid range is 1 through 5.
login-string Username that the CM uses for authentication during the initialization
procedure.
Usage Guidelines This command sets the Login Username parameter for the specified SPD in the Telephony Channel
Descriptor (TCD) messages.
Note This command is available only in images that support telco-return. These images have a “t” as part of
the image name.
Examples The following example shows the username being set to “sandy” for SPD 3:
router(config-if)# cable telco-return spd 3 username sandy
cable telco-return spd dhcp- Indicates that telco-return CMs must use a specific DHCP server.
authenticate
cable telco-return spd dhcp- Identifies the IP address of the DHCP server that the telco-return CMs
server must use.
cable telco-return spd dial- Sets the number of seconds that a telephone connection is idle before
timer the telco-return CM disconnects the call.
cable telco-return spd Indicates the SPD that the telco-return CM uses during the
factory-default initialization process.
cable telco-return spd Enables the telco-return CM to operate in manual-dial mode.
manual-dial
cable telco-return spd Sets the password that the telco-return CM uses for authentication
password when establishing a PPP connection.
cable telco-return spd Sets the telephone numbers that the telco-return CM dials when
phonenum connecting to the headend’s network access server.
cable telco-return spd ppp- Selects the authentication procedure to use when the telco-return CM
authenticate is establishing a PPP connection.
cable telco-return spd Selects a RADIUS server domain to use for the login response string.
radius-realm
cable telco-return spd Includes the service provider name in the SPD.
service-provider
cable telco-return spd Sets the number of failed dial-up connections that can occur before the
threshold CM indicates a connection failure.
cable tftp-enforce
To require that all CMs on a cable interface attempt to download a DOCSIS configuration file using the
Trivial File Transfer Protocol (TFTP) through the cable interface before being allowed to register and
come online, use the cable tftp-enforce command in cable interface configuration mode. To disable this
feature, use the no form of this command.
Syntax Description mark-only (Optional) Allow CMs to come online without attempting to download
a DOCSIS configuration file through the Cisco CMTS cable interface,
but prints a warning message and marks those CMs with a pound sign
(#) in the show cable modem command.
Defaults TFTP downloads through the Cisco CMTS are not required (no cable tftp-enforce).
Usage Guidelines The cable tftp-enforce cable interface configuration command requires all cable modems on a cable
interface to attempt a TFTP request for the DOCSIS configuration file through the cable interface with
the Cisco CMTS router before being allowed to register and come online. This can help prevent the
following situations from occurring:
• Users who attempt theft-of-service by reconfiguring their local networks to allow the downloading
of an unauthorized DOCSIS configuration file from a local TFTP server. Typically, some users do
this to obtain services that they have not paid for, such as higher guaranteed bandwidths or a higher
priority Quality of Service (QoS) profile.
• Some brands or models of cable modems might be running older software releases that cache the
DOCSIS configuration file and use the cached version instead of downloading the actual file from
a TFTP server during the registration process. Although this can marginally speed up the registration
process, it also violates the DOCSIS requirements and could create a situation in which the cable
modem is not using the proper DOCSIS configuration file. A user might then be mistakenly accused
of theft-of-service, when in reality the problem is the non-DOCSIS-compliant cable modem.
The cable tftp-enforce command identifies these situations and can block these cable modems from
registering and coming online. This command also has a mark-only option that allows these cable
modems to come online, but it also identifies the cable modems so that the network administrators can
investigate the situation further before taking any action.
When the command is used without the mark-only option, cable modems that do not download a TFTP
file through the cable interface are blocked from registering and coming online. The following message
is displayed on the console when such a cable modem attempts to register:
06:53:57: %UBR7200-4-REGISTRATION_BEFORE_TFTP: Registration request unexpected:
Cable Modem did not attempt TFTP. Registration Rejected. CM Mac Addr <00ff.ff66.12fb>
The mark-only option allows cable modems that do not download the TFTP file to come online, but it
also prints a warning message on the console and marks the cable modem in the show cable modem
command with a pound sign (#). The following message is displayed on the console when such a cable
modem registers with the Cisco CMTS.
06:53:57: %UBR7200-4-REGISTRATION_BEFORE_TFTP: Registration request unexpected:
Cable Modem did not attempt TFTP. Modem marked with #. CM Mac Addr <00ff.ff66.12fb>
Tip Cisco recommends that you initially configure cable interfaces with the mark-only option, so that
potential problems are identified without immediately interfering with users’ ability to come online.
After you identify and resolve these initial problems, reconfigure the cable interfaces without the mark-
only option to block problem cable modems that attempt to come online without downloading a valid
DOCSIS configuration file.
The default behavior is not to require the TFTP download through the cable interface with the
Cisco CMTS router. Each cable interface must be configured with this command to require the TFTP
download.
Note The cable tftp-enforce command cannot be used on subinterfaces or on non-cable interfaces.
Note In the above situation, cable modems that do not download a DOCSIS configuration file are marked as
“offline” instead of “reject(c)” by the show cable modem command. The console still displays the
%UBR10000-4-REGISTRATION_BEFORE_TFTP error message, however, to allow you to identify
these cable modems as TFTP violators.
Examples The following example shows how to enforce TFTP downloads for all of the cable modems on cable
interface 3/0. These cable modems must attempt a TFTP download of the DOCSIS configuration file
through the cable interface with the Cisco CMTS. If they do not, they are not allowed to register or come
online, and they are marked as having either a registration error—reject(c)—in the show cable modem
command.
Note The initial version of this feature marked CMs that failed the TFTP check as having a Message Integrity
Check (MIC) failure—reject(m). The command was changed to show reject(c) in Cisco IOS Release
12.2(8)BC2 and Release 12.1(19)EC.
Router#
Note DOCSIS-compliant cable modems that are rejected with a MIC failure go into the offline state for a short
period of time and then retry the registration process.
The debug cable registration command can be used to display additional information:
Router# debug cable interface c3/0 verbose
Router# debug cable registration
CMTS registration debugging is on
Cable Modem did not attempt TFTP. Registration Rejected. CM Mac Addr <00ff.ff66.12fb>
Registration failed for Cable Modem 00ff.ff66.12fb on interface Cable3/0/U0:
CoS/Sflow/Cfr/PHS failed in REG-REQ
Jun 6 23:27:15.859: REG-RSP Status : failure (2)
Jun 6 23:27:15.859: Registration Response:
Jun 6 23:27:15.859: 0x0000: C2 00 00 1B 00 00 00 50 73 4E B4 19 00 05 00 E0
Jun 6 23:27:15.859: 0x0010: 56 AC 00 09 00 00 03 01 07 00 00 02 02
Jun 6 23:27:15.859: Registration Response Transmitted
The following example of the mark-only option shows how that cable modems that do not attempt a
TFTP download through the Cisco CMTS are allowed to register and come online, but they are marked
with a pound sign (#) when using the show cable modem command.
Router# configure terminal
Router(config)# interface cable 3/0
Router(config-if)# cable tftp-enforce mark-only
Router(config-if)# exit
Router(config)#
Router#
The debug cable registration command can be used to display additional information:
Jun 6 23:27:15.859: Registration request from 00ff.ff66.12fb, SID 7 on Cable3/0/U1
Jun 6 23:27:15.859: Found a network access control parameter: Ok
Jun 6 23:27:15.859: Found a class of service block: Ok
Jun 6 23:27:15.859: Found Baseline Privacy config: Ok
Jun 6 23:27:15.859: Found Max CPE: Ok
Jun 6 23:27:15.859: Found CM MIC: Ok
Jun 6 23:27:15.859: Found CMTS MIC: Ok
Jun 6 23:27:15.859: Found modem ip: Ok
Jun 6 23:27:15.859: Found modem capabilities: Ok
Jun 6 23:27:15.859: Finished parsing REG Request
Jun 6 23:27:15.859: Cable Modem sent Registration Request without attempting required
TFTP
23:27:15: %UBR7200-4-REGISTRATION_BEFORE_TFTP: Registration request unexpected:
Cable Modem did not attempt TFTP. Modem marked with #. CM Mac Addr <00ff.ff66.12fb>
Jun 6 23:27:15.859: Sec sids obtained for all requested classes of service
Jun 6 23:27:15.859: Performing connection admission control (CAC) for each Sid
Jun 6 23:27:15.859: CAC Status for ClassID:1 is CAC_SUCCESS
Jun 6 23:27:15.859: Registration Status: ok (0)
Jun 6 23:27:15.859: Registration Response Transmitted
Tip You can also use the show interface cable sid and show cable qos profile commands to examine the
SID and service classes in use, to determine whether a CM has registered using unauthorized QoS
parameters.
cable time-server
To enable the integrated time-of-day (ToD) server on the Cisco CMTS series, enter the cable time-
server command in global configuration mode. To disable the time-of-day server function, use the no
form of this command.
cable time-server
no cable time-server
Defaults Disabled
Usage Guidelines Per the DOCSIS specifications, the ToD server uses the UDP protocol, so UDP minor servers must also
be enabled using the service udp-small-servers max-servers no-limit command.
Examples The following example shows how to enable the time-of-day server:
router# configure terminal
router(config)# service udp-small-servers max-servers no-limit
router(config)# cable time-server
router(config)#
Syntax Description n Specifies the upstream port. Valid values start with 0 for the first
upstream port on the cable interface line card.
percentage Specifies the percentage overbooking rate to limit overbooking. Valid
values are from 10 to 1000 percent, with a default of 100 percent.
Usage Guidelines This command limits the maximum number of CMs for a given upstream port by looking at the minimum
guaranteed upstream bandwidth allocated to each CM. Cable modems providing residential services and
commercial services can be given different weights according to their traffic needs. This command
affects only whether CMs can register with the CMTS—it does not affect CMs that have already come
online.
The CMTS uses the minimum guaranteed upstream bandwidth field from the CM’s DOCSIS
configuration file to calculate whether the CM can come online or not. If the CM’s minimum guaranteed
upstream bandwidth would exceed the total upstream bandwidth multiplied by the overbooking
percentage specified by this command, the CM cannot come online on that upstream. The CM will
attempt to find another upstream, and if it cannot register on any upstreams, it will attempt to lock on to
a new downstream.
Note A CM with a guaranteed upstream bandwidth does not consume that bandwidth unless it has active
traffic. By guaranteeing a CM a minimum upstream bandwidth, individual customers are assured of
never being totally shut out from network access in a very high-traffic situation.
Table 2-9 shows the approximate bandwidth for each upstream channel, depending on channel width,
symbol rate, and modulation type, when admission control is used at 100 percent. When setting
admission control to other values, scale the bandwidth values in Table 2-9 accordingly, so as to plan for
the maximum number of CMs effectively allowed per upstream port.
For example, with a 3.2 MHz channel width and QPSK modulation, the total bandwidth is approximately
5 Mbps. This is the maximum allowable bandwidth that can be allocated to CMs at the default admission
rate of 100%. If each CM is allocated a minimum upstream bandwidth of 128 kbps, this means a
maximum of 40 CMs will be allowed to come online.
To verify whether or not upstream admission control is configured and activated, use the show interface
command for a cable upstream to display its configuration information. If upstream admission control
is configured and enabled, the output contains an entry stating “CIR admission control enforced.” If
upstream admission control is disabled, no admission control entry is displayed in the output.
Note Setting the admission control limit to below the current total reserved bandwidth for the channel does
not immediately force any CMs offline, but may prevent CMs from reconnecting if they drop offline at
a later time. Increasing the admission control limit allows more CMs to connect.
When an upstream becomes overbooked, use the test cable ucc command to move a cable modem that
is currently online from one upstream port to another. For example, the following example shows that
the cable modem with the IP address of 10.128.1.128 is being moved from port C3/0/U0 to C3/0/U1:
router# show cable modem 10.128.1.128
Interface Prim Online Timing Rec QoS CPE IP address MAC address
Sid State Offset Power
Cable3/0/U0 101 online 1919 5.25 7 0 10.128.1.128 0030.1976.7067
Examples The following example shows overbooking on upstream port 4 being limited to 125 percent:
Router(config)# interface cable 3/0
Router(config-if)# cable upstream 4 admission-control 125
Router(config-if)#
Use the show interface cable upstream command to display the current status of admission control on
an interface. For example, the following command output shows that this upstream has allocated a total
bandwidth of 2.5 Mbit/sec to those online CMs that were assigned a guaranteed upstream bandwidth in
their DOCSIS configuration files.
This displays also shows that the admission control is being enforced at a subscription level of 125
percent. The Virtual channel BW field is computed by multiplying channel bandwidth by the admission
control limit. The Admissions requests rejected counter shows the number of cable modems that
attempted to register but were refused because of the admission control policy.
Router# show interface c3/0 u4
Cable3/0: Upstream 4 is up
Received 11585 broadcasts, 11854 multicasts, 3222651 unicasts
0 discards, 829 errors, 0 unknown protocol
3246090 packets input, 5 uncorrectable
557 noise, 0 microreflections
Total Modems On This Upstream Channel : 69 (68 active)
Default MAC scheduler
Queue[Rng Polls] 0/64, fifo queueing, 0 drops
Queue[Cont Mslots] 0/52, fifo queueing, 0 drops
Queue[CIR Grants] 0/64, fair queueing, 0 drops
Queue[BE Grants] 0/64, fair queueing, 0 drops
Queue[Grant Shpr] 0/64, calendar queueing, 0 drops
Reserved slot table currently has 0 CBR entries
Req IEs 205196036, Req/Data IEs 0
Init Mtn IEs 7604617, Stn Mtn IEs 422496
Long Grant IEs 4848, Short Grant IEs 1646196
Avg upstream channel utilization : 1%
Avg percent contention slots : 94%
Avg percent initial ranging slots : 1%
Avg percent minislots lost on late MAPs : 0%
Total channel bw reserved 2500000 bps
CIR admission control enforced
Subscribtion level 125%
Virtual channel bw 6400000 bps
Admission requests rejected 32
Current minislot count : 5200298 Flag: 0
Scheduled minislot count : 5200420 Flag: 0
Router#
If a CM is denied access due to the admission control policy, its entry in the show cable modem
command output shows “reject(c)”:
Router# show cable modem
Interface Prim Online Timing Rec QoS CPE IP address MAC address
Sid State Offset Power
Cable2/0/U0 1 online 2288 0.50 4 0 10.16.30.66 0010.7bb3.fb45
Cable2/0/U0 2 online 2288 0.50 4 0 10.16.30.68 0010.7bb3.fb7b
Cable2/0/U0 3 init(i) 2280 0.00 2 0 10.16.30.69 0010.9500.05e
. . .
Cable3/0/U1 113 online 3921 0.00 5 0 10.128.1.108 0030.9433.c38b
Cable3/0/U1 114 online 3920 0.25 6 0 10.128.1.87 0030.1976.6ebf
Cable3/0/U0 115 reject(c) 3922 0.25 2 0 10.128.1.75 0030.1976.703b
Cable3/0/U0 116 online 3919 0.75 5 0 10.128.1.57 0030.1976.6fa1
show cable modem Displays statistics for a CM, including its upstream port and
primary SID.
show interface cable Displays the interface configuration, which for an upstream
upstream includes the current admission control policy, if any.
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the
first upstream port on the cable interface line card.
first-choice-width Specifies upstream channel width in hertz (Hz). Valid values for all
cards are:
• 200,000 (160,000 symbols/sec)—Not valid when using
Unsolicited Grant Service (UGS) or UGS with Activity Detection
(UGS-AD) service flows (such as PacketCable voice calls)
• 400,000 (320,000 symbols/sec)
• 800,000 (640,000 symbols/sec)
• 1,600,000 (1,280,000 symbols/sec)
• 3,200,000 (2,560,000 symbols/sec)
The Cisco uBR-MC5X20S/U, Cisco uBR-MC16U/X, and
Cisco uBR-MC28U/X cards also support 6,400,000 Hz
(5,120,000 symbols/sec) when operating in DOCSIS 2.0
(A-TDMA-only) mode.
last-choice-width (Cisco uBR-MC16S, Cisco uBR-MC16U/X, Cisco uBR-MC28U/X,
and Cisco uBR-MC5x20S/U only) The upstream channel width in
hertz. The valid values are the same as those for the first-choice-width
parameter, but for proper operation, the last-choice-width should be
equal to or less than the first-choice-width value. Use this parameter
with supported cards to enable symbol rate management algorithms.
The symbol rate automatically steps up from the first-choice-width
value to the highest value until a stable channel is established.
Note The last-choice-width argument is applicable only to the
Cisco uBR-MC16S, Cisco uBR-MC16U/X,
Cisco uBR-MC28U/X, and Cisco uBR-MC5X20S/U cards.
Defaults first-choice-width defaults to 1,600,000 Hz, last-choice-width defaults to 1,600,000 Hz for those cable
interface line cards that support it
Usage Guidelines The last-choice-width parameter is supported only by the Cisco uBR-MC16S, Cisco uBR-MC16U/X,
Cisco uBR-MC28U/X, and Cisco uBR-MC5X20S/U cable interface line cards. When one of these
particular cards is installed, the system attempts to increase the channel width from the smallest channel
width value to the largest channel width value, one step at a time.
Note In Cisco IOS Release 12.2(15)BC1 and later releases, changing the channel width could also force a
frequency hop, if the current frequency does not fit within the new channel width parameters, or if the
system needs to reset the fixed frequency or shared frequency group parameters to match the new
channel width.
Caution In DOCSIS 1.X networks, do not change the channel width more than one step at a time on an interface
that has cable modems that are currently online. The DOCSIS 1.X specifications require that cable
modems remain online when the channel width is changed in single step increments (such as 800,000 to
1,600,000), but cable modems can go offline when you change the channel width in larger amounts (such
as changing it from 800,000 to 3,200,000). DOCSIS 2.0 cable modems might support changing the
channel width by two steps, but each brand of modem should be tested for this before attempting it on a
live network. Also, after changing the channel width, do not change the channel width again until all
cable modems have performed their ranging adjustments for the new width (which could take up to a
minute, depending on the number of cable modems).
Note To specify only one channel width for the Cisco uBR-MC16S, Cisco uBR-MC16U/X,
Cisco uBR-MC28U/X, or Cisco uBR-MC5X20S/U card, specify the same value for both the first-
choice-width and last-choice-width parameters. For example:
When using this command to change channel-widths for an upstream interface on the
Cisco uBR-MC5X20S cable interface line card, some DOCSIS 1.1 CMs can go offline if you do not also
change the minislot size to the corresponding value. See the following examples for the correct channel-
width and minislot pairings:
router(config-if)# cable upstream 0 channel-width 3200000
router(config-if)# cable upstream 0 minislot 4
Note This limitation does not affect DOCSIS 1.1-compliant CMs. Also, in Cisco IOS Release 12.2(15)CX,
Cisco IOS Release 12.2(15)BC2, and later releases, manually changing the minislot size is not needed
on the Cisco uBR-MC16U/X, Cisco uBR-MC28C, and Cisco uBR-MC28U/X cards, because these cards
automatically change the minislot size when the channel width is changed, so as to produce 32 symbols
per minislot.
PacketCable Limitations
The 200,000 Hz channel width cannot be used on upstreams that support PacketCable voice calls, or on
any upstreams that use Unsolicited Grant Service (UGS) or UGS with Activity Detection (UGS-AD)
service flows. Using this small a channel width with voice and other UGS/UGS-AD service flows results
in calls being rejected because of “DSA MULTIPLE ERRORS”.
Examples The following example shows upstream port 2 on a Cisco uBR-MCXXC card being configured with a
channel width of 200,000 Hz (which is equivalent to a symbol rate of 160 kilosymbols/second):
Router(config-if)# cable upstream 2 channel-width 200000
Router(config-if)#
The following example shows upstream port 2 on a Cisco uBR-MC16S, Cisco uBR-MC16U/X,
Cisco uBR-MC28U/X, or Cisco uBR-MC5X20S card being configured with a channel width of 200,000
Hz (which is equivalent to a symbol rate of 160 kilosymbols/second):
Router(config-if)# cable upstream 2 channel-width 200000 200000
Router(config-if)#
The following example shows upstream port 3 being configured to step from a channel width of
1,600,000 Hz to a channel width of 3,200,000 Hz in increments of 200,000 Hz:
Router(config-if)# cable upstream 3 channel-width 1600000 3200000
Router(config-if)#
The following example shows an upstream port on a Cisco uBR-MC16U/X, Cisco uBR-MC28U/X, or
Cisco uBR-MC5X20S card being configured with a channel width of 6.4 MHz, which is supported only
in DOCSIS 2.0 A-TDMA-only mode:
Router(config-if)# cable upstream 0 channel-width 6400000
Router(config-if)#
Related Commands
Command Description
cable upstream Disables optimum frequency hopping on the Cisco uBR-MC16S and
hopping blind Cisco uBR-MC5X20S cable interface line cards.
cable upstream Specifies the minislot size (in ticks) for a specific upstream interface.
minislot-size
cable upstream Overrides modulation types specified in the modulation profile for the
modulation-profile specified upstream channel.
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the
first upstream port on the cable interface line card.
Usage Guidelines Concatenation is part of DOCSIS 1.0 extension support. Concatenation provides for improved
bandwidth efficiency but must be supported at both the headend CMTS and the CM.
DOCSIS concatenation combines multiple upstream packets into one packet to reduce packet overhead
and overall latency and increase transmission efficiency. Using concatenation, a DOCSIS CM needs to
make only one bandwidth request for a concatenated packet, compared to making bandwidth requests
for each individual packet. This technique is especially effective for bursty real-time traffic such as voice
calls.
Concatenation support improves upstream per CM data throughput. The Cisco CMTS radio frequency
(RF) line card driver can receive only one MAC frame in a data burst. Thus the CM must make explicit
bandwidth requests for every packet it sends upstream. This limits the maximum upstream data
throughput received by the CM due to the inherent request-to-grant round-trip latency of the hybrid
fiber-coaxial (HFC) cable system incurred by every packet. To increase this per-CM upstream
throughput, the Cisco CMTS driver has been enhanced to receive a concatenated burst of multiple MAC
frames from the same CM.
Note Concatenation is not supported on the Cisco uBR-MC11 FPGA and Cisco uBR-MC16B cable interface
line cards.
Examples The following example shows how to enable concatenation for CMs on upstream port 2 on the cable
interface in slot 3/0:
router(config)# interface c3/0
router(config-if)# cable upstream 2 concatenation
Syntax Description logical-port Specifies the upstream port number for the logical port assignment. The
number of logical ports is configured with the cable modulation-profile
command, and the valid range is from 0 to one less than the current value
set with the cable modulation-profile command.
Tip The default value for max-ports command is 4, which means the
default range for logical-port is 0 to 3.
physical-port Specifies the upstream port number for the actual physical port to be
assigned. The valid range is 0 to 19, with no default.
Defaults By default, the Cisco uBR-MC5X20S/U cable interface line card uses a fixed configuration, in which
each downstream is allocated four upstream ports.
Usage Guidelines The cable upstream connector command changes the default assignment of upstream ports to MAC
domains on the Cisco uBR-MC5X20S/U card. This command creates a virtual upstream for a
downstream and assigns it to a particular physical port.
The default port mapping assigns four upstream ports to each of the downstream ports (MAC domains).
The ports are assigned sequentially, in the order in which they appear on the card’s front panel.
The no version of this command removes the upstream port mapping and shuts down the upstream port.
The port must be remapped to another physical port before it can come online again.
Tip Use the cable upstream max-ports command to set the maximum number of upstream ports per
downstream before using the cable upstream connector command.
Table 2-10 Default Upstream Port Assignments for the Cisco uBR-MC5X20S/U Cable Interface Line Card
The physical upstream ports can be assigned in any combination to a downstream, up to a maximum of
8 upstreams per downstream. If you have previously mapped an upstream port to a physical port using
the cable upstream connector command, you must first remove that mapping, using the no form of the
command, before changing it.
Examples The following example shows how to configure a downstream (MAC domain) on the
Cisco uBR-MC5X20S card for 8 upstream ports:
Router# configure terminal
Router(config)# interface cable c8/1/0
Router(config-if)# cable upstream max-ports 8
Router(config-if)# cable upstream 0 connector 16
Router(config-if)# cable upstream 1 connector 17
Router(config-if)# cable upstream 2 connector 18
Router(config-if)# cable upstream 3 connector 12
Router(config-if)# cable upstream 4 connector 13
Router(config-if)# cable upstream 5 connector 14
Router(config-if)# cable upstream 6 connector 15
Router(config-if)# cable upstream 7 connector 11
Router(config-if)# exit
Router(config)# exit
Router#
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the
first upstream port on the cable interface line card.
automatic Specifies automatic data backoff start and stop values. It enables
dynamic variation in the start and end values.
start Binary exponential algorithm. Sets the start value for data backoff.
Valid values are from 0 to 15.
end Binary exponential algorithm. Sets the end value for data backoff.
Valid values are from 0 to 15.
Defaults Automatic
Usage Guidelines The DOCSIS-specified method of contention resolution for CMs used to send data or requests on the
upstream channel is a truncated binary exponential backoff with the initial backoff window and the
maximum backoff window controlled by the CMTS. The Cisco CMTS router specifies backoff window
values for both data and initial ranging, and sends these values downstream as part of the Bandwidth
Allocation Map (MAP) MAC message.
The values specified in this command are exponential power-of-two values. For example, a value of 4
indicates a window between 0 and 15; a value of 10 indicates a window between 0 and 1023.
Cisco recommends that you use the automatic settings for data backoff. If you decide to manually specify
the data-backoff values, use the following formula as a guideline for the start and end binary exponents:
0.33 = (2**stop - 2**start)/n
where n is the number of CMs on the upstream. Choose start and stop values that come closest to the
value of 0.33 (which is the optimal probability to transmit on a contention-based system).
Examples The following example shows how to set the automatic data backoff values for upstream 2 on a cable
interface card:
Router# configure terminal
Router(config)# interface cable 3/0
Router(config-if)# cable upstream 2 data-backoff automatic
Router(config-if)#
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the
first upstream port on the cable interface line card.
label An arbitrary string, up to 80 characters long, that describes this
upstream for management and tracking purposes. If the string contains
any spaces, enclose the string within quotes.
Usage Guidelines Use the cable upstream description command assign arbitrary labels to the upstreams on the cable
interfaces. These labels can contain any information that identifies the upstream and that could aid in
network management or troubleshooting.
Tip Use the show interface cable upstream command to display the labels that are assigned to a particular
upstream.
Examples The following example shows how to assign descriptions to the first two upstreams on the cable interface
in slot 3:
Router# configure terminal
Router(config)# interface cable 3/0
Router(config-if)# cable upstream 0 description "SJ-Node1-Upstream 0"
Router(config-if)# cable upstream 1 description "SJ-Node1-Upstream 1 (Unused)"
Router(config-if)#
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the
first upstream port on the cable interface line card.
Defaults Enabled
Usage Guidelines To verify whether or not upstream differential encoding is activated, enter the show running-config
command and look for the cable interface configuration information. If upstream differential encoding
is enabled, a differential encoding entry is displayed in the output of the show running-config
command. If upstream differential encoding is disabled, no differential encoding entry is displayed in
the output.
If you are having trouble, make sure that the cable connections are not loose or disconnected; the cable
interface line card is firmly seated in its chassis slot; the captive installation screws are tight; you have
entered the correct slot and port numbers; and you selected a valid frequency for your router.
Examples The following example shows how to enable differential encoding for upstream port 2:
Router(config-if)# cable upstream 2 differential-encoding
Router(config-if)#
Syntax Description n Specifies the upstream port. Valid values start with 0 for the first
upstream port on the cable interface line card.
atdma Configures the upstream for DOCSIS 2.0 Advanced Time Division
Multiple Access (A-TDMA) modulation profiles only.
tdma Configures the upstream for DOCSIS 1.0/DOCSIS 1.1 Time Division
Multiple Access (TDMA) modulation profiles only (default).
tdma-atdma Configures the upstream for both A-TDMA and TDMA operation
(mixed mode).
Note If using abbreviations at the command line, you must specify
at least “tdma-” to select mixed mode. If you choose a shorter
abbreviation, you select TDMA-only mode.
Defaults All upstreams are configured TDMA-only mode (DOCSIS 1.0/DOCSIS 1.1).
Usage Guidelines The DOCSIS 2.0 specification provides support for advanced modulation profiles that increase potential
upstream bandwidth by building on the existing TDMA support. The Advanced TDMA profiles support
higher QAM rates up to 64-QAM and wider channel widths up to 6.4 MHz (5.12 Msymbols).
Note The advanced hardware-based spectrum management features for the Cisco uBR-MC16S/U/X,
Cisco uBR-MC28U/X, and Cisco uBR-MC5X20S/U cards are supported only in the DOCSIS 1.0/1.1
TDMA-only mode. They cannot be used in the mixed or A-TDMA-only modes.
The DOCSIS 2.0 specification allows an upstream to be configured in one of the following three modes:
• A-TDMA only mode—Upstreams support only cable modems that register using A-TDMA
modulation profiles. The CMTS does not allow DOCSIS 1.0 and DOCSIS 1.1 cable modems to
register and come online these upstreams. The Cisco uBR-MC5X20S/U, Cisco uBR-MC16U/X, and
Cisco uBR-MC28U/X cards also support 6,400,000 Hz (5,120,000 symbols/sec) when operating in
DOCSIS 2.0 (A-TDMA-only) mode.
Changing the DOCSIS mode to A-TDMA only mode also automatically changes the symbol rate to
5.12 megasymbols per second and the channel width to 6.4 MHz. Dynamic upstream modulation is
also automatically disabled.
In addition, the following are required to support the DOCSIS 2.0 A-TDMA features:
– Cable modems must be DOCSIS 2.0 capable.
– The DOCSIS configuration file for the cable modem must either omit the DOCSIS 2.0 Enable
field (TLV 39), or it must set TLV 39 to 1 (enable). If you set TLV 39 to 0 (disable), a
DOCSIS 2.0 CM uses the TDMA mode.
– The upstream must be configured for either A-TDMA-only or mixed TDMA/A-TDMA mode.
• TDMA-only mode—Upstreams support only cable modems that register using TDMA modulation
profiles. DOCSIS 2.0 cable modems can register on these upstreams only by using a
DOCSIS 1.0/DOCSIS 1.1 modulation profile (which typically would happen only when a
DOCSIS 2.0 cable modem cannot find an A-TDMA channel in its DOCSIS domain).
Changing the DOCSIS mode to TDMA-only mode also automatically changes the symbol rate to
1.28 megasymbols per second and the channel width to 1.6 MHz. Dynamic upstream modulation is
also automatically disabled.
• Mixed mode—Upstreams support both DOCSIS 1.0/DOCSIS 1.1 cable modems using TDMA
modulation profiles and DOCSIS 2.0 cable modems using A-TDMA modulation profiles. (The
maximum channel width in mixed mode is 3.2 MHz.)
Changing the DOCSIS mode to mixed mode also automatically changes the symbol rate to
1.28 megasymbols per second and the channel width to 1.6 MHz. Dynamic upstream modulation is
also automatically disabled.
Note Mixed mode upstreams do not support the 6.4 MHz channel width.
Changing the DOCSIS Mode for an Upstream Port Forces the Cable Modems on That Upstream to Go Offline and
Reregister
When you switch the DOCSIS mode of an upstream between the TDMA-only, mixed TDMA/A-TDMA,
and A-TDMA-only modes, cable modems that are currently online on that upstream are taken offline
and are forced to reregister, so that the CMTS can determine the capabilities of the cable modems on the
new channels.
If you change an upstream port to A-TDMA only mode, DOCSIS 1.x cable modems will not be able to
come online on that upstream. If you change an upstream to TDMA only mode, DOCSIS 2.0-compliant
cable modems are expected to attempt to come online on another upstream that is configured for A-
TDMA or mixed mode. If no such upstreams are configured, or if the cable modem is configured to use
only that particular upstream, it comes online in DOCSIS 1.x mode.
Note DOCSIS 2.0-capable cable modems that are already online on a TDMA-only upstream do not
automatically reregister on another upstream that has been configured for mixed-mode or A-TDMA-only
operations. The cable modem must either be reset or the CMTS must send an Upstream Channel Change
(UCC) message to instruct the cable modem to move to the new channel.
If you change an upstream port to the mixed TDMA/A-TDMA mode, and some cable modems remain
offline, or appear to come online but cannot pass traffic, upgrade the modem software to a DOCSIS-
compliant software version.
Note The cable physical plant must support the higher upstream bandwidths and symbol rates to be able to
use the A-TDMA or mixed mode modulation profiles.
Examples The following example shows how to configure the first four upstreams for the first downstream on the
Cisco uBR-MC28U/X cable interface line card in slot 5/0. The first two upstreams are configured for A-
TDMA mode and the last two upstreams are configured for mixed TDMA/A-TDMA mode.
Router# config terminal
Router(config)# interface cable 5/0/0
Router(config-if)# cable upstream 0 docsis-mode atdma
%%Docsis mode set to ATDMA only, 1.x CMs will go offline.
%%The following defaults will be set:
%%Channel Width 6.4MHz
%%Minislot Size 1 tick
%%Modulation Profile 241
Router(config-if)# exit
Router(config)# exit
Router#
The following example shows the abbreviations needed to configure TDMA-only and mixed
TDMA/A-TDMA modes.
Router# config terminal
Router(config)# interface cable 4/0
Router(config-if)#
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first
upstream port on the cable interface line card.
Usage Guidelines The DOCSIS 1.1 specification allows a CM to specify a pre-equalization coefficient so that the CMTS
can engage in adaptive equalization to mitigate the effects of echoes in the cable plant, ingress on the
upstream, in-channel tilt issues, and group delay. This can be needed when the upstream is operating in
16-QAM mode.
The cable upstream equalization-coefficient command enables the use of this adaptive equalization on
an upstream. When pre-equalization is disabled, the Cisco CMTS uses the spectrum adjustments given
in section 4.2, Upstream, of the DOCSIS 1.1 specification.
The CMTS uses an equalization scheme that matches the configuration of the upstream. When the
upstream is configured for DOCSIS 1.0 and DOCSIS 1.1 modulation profiles, the CMTS enables and
uses 8 complex taps. When the upstream is configured for DOCSIS 1.x/2.0 mixed mode, the CMTS uses
24 taps by default, but truncates to 8 taps for DOCSIS 1.x CMs. In DOCSIS 2.0 A-TDMA-only mode,
the CMTS uses 24 taps all the time.
Note For more information about the use of pre-equalization, see section 6.3, MAC Management Messages,
in the DOCSIS 1.1 specification.
Examples The following example shows how to enable the use of the equalization coefficient on upstream 0 on the
cable interface line card in slot 5/1 on the Cisco uBR10012 router:
Router# configure terminal
Router(config)# interface cable 5/1/0
Router(config-if)# cable upstream 0 equalization-coefficient
Router(config-if)#
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first
upstream port on the cable interface line card.
Defaults Enabled
Usage Guidelines The Cisco CMTS uses FEC to attempt to correct any upstream data that might have been corrupted. To
use this feature, you need to activate FEC on the upstream RF carrier. When FEC is activated, the
Cisco CMTS commands all CMs on the network to activate FEC.
Examples The following example shows how to activate upstream forward error correction:
router (config-if)# cable upstream 0 fec
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the
first upstream port on the cable interface line card.
t-bytes Overrides the FEC strength specified in the modulation profile for
this upstream channel. Valid values are from 0 to 10, where:
• 0 disables FEC.
• 1 is the lowest FEC strength.
• 10 is the highest FEC strength.
Examples The following example shows how to configure the cable upstream fec-strength command:
router(config-if)# cable upstream 2 fec-strength 3
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first
upstream port on the cable interface line card.
Defaults By default, fragmentation is enabled for all upstream ports on ASIC line cards (Cisco uBR-MC11C,
Cisco uBR-MC12C, Cisco uBR-MC14C, Cisco uBR-MC16C, Cisco uBR-MC16S, and Cisco uBR-
MC28C) and disabled for all upstream ports on old FPGA line cards.
Note Cisco IOS Release 12.1 CX supports the Multiple Grant Mode of DOCSIS 1.1 fragmentation.
Usage Guidelines This command enables and disables DOCSIS layer 2 fragmentation, which reduces run-time jitter
experienced by constant bit rate (CBR) slots on the corresponding upstream. Disabling fragmentation
increases the run-time jitter, but also reduces the fragmentation reassembly overhead for fragmented
MAC frames. For ports running CBR traffic, fragmentation should be enabled (the default).
Examples The following command shows DOCSIS fragmentation being enabled on upstream 0 on the cable
interface in slot 2/0:
Router# configure terminal
Router(config)# interface c2/0
Router(config-if)# cable upstream 0 fragmentation
Router(config-if)#
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first
upstream port on the cable interface line card.
fragment-threshold Number of bytes for the threshold at which DOCSIS frames are fragmented.
The valid range is 0 to 4000, with a default of 2000 bytes.
number-of-fragments Number of fragments that the cable interface line card should create when
fragmenting DOCSIS frames. The card attempts to create this many equal-
sized fragments when fragmenting. The valid range is 1 to 10, with a default
of 3 fragments.
Usage Guidelines DOCSIS 1.1 allows the CMTS to fragment DOCSIS frames to improve performance, especially in
networks that combine real-time traffic, such as voice, with data traffic. The cable upstream
fragment-force command allows you to specify the size of frames that should be fragmented, as well as
the number of fragments that should be created when fragmenting.
Tip This command takes effect only when fragmentation has been enabled on the upstream using the cable
upstream fragmentation command (which is the default configuration). This command also supercedes
the configuration of the cable default-phy-burst command, if necessary.
In the default configuration, the Cisco CMTS fragments DOCSIS frames that are 2,000 bytes or larger
in size, and it fragments these frames into three equally-sized fragments. Do not use a fragment size
greater than 2,000 bytes on the Cisco uBR-MC5X20S/U cable interface line cards, and do not use a
fragment size greater than 3,500 bytes on all other cable interface line cards, unless otherwise instructed
by a Cisco TAC engineer.
When using DOCSIS concatenation, you might need to change the cable default-phy-burst command
from its default size of 2,000 bytes, so that multiple frames can be concatenated into a maximum-sized
burst. If you set the cable default-phy-burst command to zero, the max burst then becomes the lowest
of 255 mini-slots, the maximum concatenated burst setting in the DOCSIS configuration file, or the
value of the long data grant burst that is specified in the upstream’s profile.
Caution Ensure that the number-of-fragments parameter is large enough to keep the size of each fragment of a
mximum-sized burst less than the 2,000 bytes or 3,500 bytes specified above. If fragments are too large,
the cable modem might not be able to come online or pass traffic.
Examples The following command shows how to enable DOCSIS fragmentation on frames that are 1500 bytes or
larger, using four fragments per frame:
Router# configure terminal
Router(config)# interface c2/0
Router(config-if)# cable upstream 0 fragment-force 1500 4
Router(config-if)#
The following example shows how to disable the forced fragmentation of DOCSIS frames on an
upstream. This also resets the fragment-threshold parameter to 2,000 bytes.
Router# configure terminal
Router(config)# interface c5/1/0
Router(config-if)# no cable upstream 0 fragment-force
Router(config-if)#
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the
first upstream port on the cable interface line card.
% of frequency adjustment Specifies the percentage of frequency-adjustment packets required to
switch from the regular power-adjustment method to the noise power-
adjustment method. Valid range is from 10 to 100 percent.
Examples The following example shows how to change the power-adjustment method when the frequency-
adjustment packet count reaches 50 percent:
Router(config-if)# cable upstream 0 freq-adj averaging 50
Syntax Description n Specifies the upstream port number on the cable interface line card for
which you want to assign an upstream frequency. Valid values start with
0 for the first upstream port on the cable interface line card.
up-freq-hz The upstream center frequency is configured to a fixed Hertz (Hz) value.
The valid upstream frequency range is 5 MHz (5000000 Hz) to 42 MHz
(42000000 Hz), 55 MHz (55000000 Hz), or 65 MHz (65000000 Hz),
depending on the cable interface line card being used. If you wish to have
the Cisco CMTS dynamically specify a center frequency for the given
upstream interface, do not enter any frequency value.
Usage Guidelines The upstream channel frequency of your RF output must be set to comply with the expected input
frequency of your cable interface line card. To configure an upstream channel frequency, you may:
• Configure a fixed frequency between the allowable ranges and enable the upstream port,
or
• Create a global spectrum group, assign the interface to it, and enable the upstream port.
The allowable range for the upstream channel frequency depends on the cable interface line card and
Cisco IOS software release being used. See Table 2-11 for the currently supported values.
Table 2-11 Allowable Frequency Range for the cable upstream frequency Command
Note In Cisco IOS Release 12.2(15)BC2 and later releases, the allowable range of frequencies that you can
select with the cable upstream frequency command is determined by the configuration of the upstream
freq-range command.
Tip If both a Cisco uBR-MC16E cable interface line card and a Cisco uBR-MC16C and/or a
Cisco uBR-MC16S cable interface line card are present in the chassis, a spectrum group in the 42 MHz
to 65 MHz range should not be assigned.
To configure the default upstream frequency (which is no fixed frequency), enter the cable upstream n
frequency command without specifying a center frequency.
Examples The following example shows how to configure the upstream center frequency for port 0, located in slot
6, to 5,700,000 Hz:
Router(config-if)# cable upstream 0 frequency 5700000
Router(config-if)# exit
Router(config)# exit
Router# show running-config | include frequency
cable upstream 0 frequency 5696000
Router#
Note Cisco cable interface line cards always program the upstream’s center frequency in 16 KHz increments,
and this is the frequency displayed by the lines added to the router’s configuration and by the show
controllers cable upstream command. For example, if you use the cable upstream frequency
command to specify a center frequency of 27 MHz (cable upstream x frequency 27000000), the actual
center frequency will be 27.008 MHz, which is the next highest 16 KHz boundary. The configuration file
will therefore show the line cable upstream 0 frequency 27008000.
The following example shows how to configure the upstream center frequency to a frequency
(54,700,000 Hz) within the extended Japanese frequency range:
Router# configure terminal
Router(config)# upstream freq-range japanese
Router(config)# interface cable 3/0
Router(config-if)# cable upstream 0 frequency 54000000
Router(config-if)# exit
Router(config)# exit
Router#
The following example shows how to allow the Cisco CMTS to dynamically specify a center frequency
for the upstream port 0:
Router(config-if)# no cable upstream 0 frequency
The following command example from Cisco IOS Release 12.3 BC illustrates the allowable upstream
frequency range in Hz:
Syntax Description n Specifies the upstream port. Valid values start with 0 for the first
upstream port on the cable interface line card.
frequency, modulation, Specifies the priority of corrective actions to be taken when ingress
channel-width noise occurs on a downstream.
Note The channel-width option must come after the frequency
option, either immediately or after the modulation option, as
shown in the above examples.
Usage Guidelines This command specifies the priority of the corrective actions that should be taken when a frequency hop
is necessary to correct excessive ingress noise on an upstream. For example, if the upstream on a
Cisco uBR-MC16S card is set for the default settings (frequency, modulation, and channel-width), the
following occurs when the upstream noise exceeds the CNR threshold value for the current modulation
profile:
1. The Cisco uBR-MC16S changes to a new frequency, if a clean frequency is available in its spectrum
group.
2. If no clean frequency is available, the Cisco uBR-MC16S uses the Dynamic Upstream Modulation
feature to switch the upstream to the secondary modulation profile.
3. If the noise levels still exceed the CNR threshold value for the secondary modulation profile, and if
the upstream has been configured for a range of channel widths, the Cisco uBR-MC16S narrows the
channel width of the upstream by half. If the noise levels are still excessive, the channel width is
again cut in half, and this process continues until a clean upstream is found or the bandwidth is
reduced to the minimum channel width that has been configured using the cable upstream channel-
width command.
Allowable DOCSIS channel widths are 3.2 MHz, 1.6 MHz, 800 KHz, 400 KHz, and 200 KHz. If the
channel width drops to 200 KHz, but the noise still exceeds the SNR threshold, the CMs go offline.
Note The default specifies only a single channel width of 1.6 MHz. If this is not changed to
specify a range of allowable channel widths (using the cable upstream channel-width
command), the Cisco uBR-MC16S does not attempt to change the channel width.
To use the Dynamic Upstream Modulation feature, you must first create two modulation profiles (using
the cable modulation-profile command) and assign them to the upstream (using the cable upstream
modulation-profile command).
Examples The following example shows that when ingress noise on the upstream exceeds the threshold allowed for
the primary modulation profile, the Cisco uBR-MC16S line card should first switch to the secondary
modulation profile, then try frequency hopping, and if that fails to correct problem, to finally try
narrowing the channel width:
Router(config)# interface cable 3/0
Router(config-if)# cable upstream 0 hop-priority modulation frequency channel-width
Router(config-if)# exit
Router(config)#
Syntax Description n Specifies the upstream port for which blind frequency hopping will be
activated. Valid values start with 0 for the first upstream port on the
cable interface line card.
Usage Guidelines Enter this command to override the hardware spectrum manager’s decision to optimize hopping.
Note Do not use this command unless you have a specific reason to disable optimum hopping configurations.
For example, if you are experimenting with a Cisco uBR-MC16S or Cisco uBR-MC5X20S/U card, you
can use this command to enforce blind hopping on individual upstream channels.
Examples The following example shows how to specify hopping blind on the upstream port 0:
router(config-if)# cable upstream 0 hopping blind
Command Description
cable upstream power-level Specifies the upstream cable interface receive power level in
dBmV.
cable upstream shutdown Activates or shuts down a specified upstream cable interface.
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first
upstream port on the cable interface line card.
interval Triggering interval, in milliseconds. The valid range is 10 to 3000
milliseconds, with a default value of 200 milliseconds.
Usage Guidelines Broadband Processing Engine (BPE) cable interface line cards, such as the Cisco uBR-MC28U/X cards,
contain advanced hardware-based noise cancellation circuitry that digitally removes in-channel
impairments such as ingress, common path distortion, and certain types of impulse noise. To configure
how often these line cards should train their noise cancellation circuity, so as to adapt to changes in the
noise types and levels, use the cable upstream ingress-noise-cancellation command.
When you enable ingress noise cancellation on an upstream, the Cisco CMTS periodically schedules a
256-symbol idle slot on the upstream channel. The interval option specified in the cable upstream
ingress-noise-cancellation command determines how often this idle slot is generated.
The default for BPE cards is for the card to train its circuitry every 200 milliseconds. The smaller the
triggering interval, the faster the card can adjust to changes in ingress noise, which makes the upstream
more robust to noise problems, but at the cost of decreasing bandwidth on the upstream channel. To
determine the bandwidth cost, in percentage of raw bandwidth, use the following formula:
(256/interval)/channel-symbol-rate
where interval is the time period in milliseconds specified by the cable upstream ingress-noise-
cancellation command, and channel-symbol-rate is the symbol rate in kilohertz. For example, if the
upstream is using a 2.56 MHz channel rate and a noise cancellation interval of 10 milliseconds, the
bandwidth cost is 1% of the total raw bandwidth:
(256/10)/2560 = 0.01 (1% of bandwidth)
Note This command is available only on the Cisco uBR-MC5X20U, Cisco uBR-MC16U/X and
Cisco uBR-MC28U/X cable interface line card. It cannot be used on other cable interface line cards.
Examples The following example shows how to configure the first upstream on a Cisco uBR-MC16U/X or
Cisco uBR-MC28U/X card to perform ingress noise cancellation every 300 milliseconds:
Router# configure terminal
Router(config)# interface cable 5/0
Router(config-if)# cable upstream 0 ingress-noise-cancellation 300
Router(config-if)#
Related Commands cable modulation-profile Defines a modulation profile for use on the router.
cable upstream channel- Specifies an upstream channel width for an upstream port.
width
cable upstream docsis- Configures an upstream to use either DOCSIS 1.x or DOCSIS 2.0
mode modulation profiles.
cable upstream frequency Enters a fixed frequency of the upstream RF carrier for an upstream port.
cable upstream minislot- Specifies the minislot size (in ticks) for a specific upstream interface.
size
cable upstream Assigns one or two modulation profiles to an upstream port.
modulation-profile
cable upstream power- Sets the input power level for the upstream RF carrier in decibels per
level millivolt (dBmV).
show cable hop Displays CM configuration settings.
show cable modulation- Displays the modulation profile information for a Cisco CMTS.
profile
show interface cable mac- Displays the current time-slot scheduling state and statistics.
schedule
show interface cable sid Displays cable interface information.
Syntax Description uport Specifies the upstream port that should be assigned to the load-balance
group. Upstream port values start with 0 and end with a value that depends
on the number of upstream ports on the cable interface line card.
n Specifies the number of the load-balance group to which the upstream
should be assigned. The valid range is 1 to 255.
Defaults An upstream is not assigned to any load-balance groups. If you use the cable load-balance group
(interface configuration) command to assign a downstream interface to a load-balance group, all its
upstreams are automatically assigned to the same group until you use the cable upstream load-balance
group command to reassign an upstream to a different group.
Usage Guidelines After you have used the cable load-balance group (global configuration) command to initially create
and configure a load-balance group, use the cable upstream load-balance group command to assign
this load-balance group to an upstream. This enables the cable interface to begin participating in load-
balancing operations.
Tip Use the cable load-balance group (interface configuration) command to assign this load-balance
group to a downstream.
The following rules apply when creating and assigning load-balance groups:
• A downstream or upstream can belong to only one load-balance group.
• All downstreams and upstreams in a load-balance group must share physical radio frequency (RF)
connectivity to the same group of cable modems. Downstreams can be in a separate load-balance
group than upstreams, but all downstreams or all upstreams that have the same RF physical
connectivity must be members of the same load-balance group. You cannot distribute downstreams
or upstreams that share physical connectivity across multiple load-balance groups.
• Load balancing is done only on a per-chassis basis—all interfaces in a load-balance group must be
in the same chassis.
Examples The following example shows how to assign the first four upstreams for cable interface 5/1 to load
balance group 14:
Router# config terminal
Router(config)# interface cable 5/1/0
Router(config-if)# cable upstream 0 load-balance group 14
Router(config-if)# cable upstream 1 load-balance group 14
Router(config-if)# cable upstream 2 load-balance group 14
Router(config-if)# cable upstream 3 load-balance group 14
Router(config-if)#
Syntax Description uport Specifies the upstream port to be configured. Upstream port values start
with 0 and end with a value that depends on the number of upstream ports
on the cable interface line card.
Defaults Cable modems are not required to maintain their power spectral density after a modulation rate change
(no cable upstream maintain-psd).
Note In Cisco IOS Release 12.2(15)BC2 and later releases, this command is automatically removed from the
configuration when you configure an upstream for a TDMA-only or mixed TDMA/A-TDMA
configuration.
Usage Guidelines Use this command to specify whether DOCSIS 2.0 CMs should maintain their power spectral density
when the Cisco CMTS changes their upstream modulation rate in an upstream channel descriptor (UCD)
message. When you configure an upstream with the cable upstream maintain-psd command, the
Cisco CMTS sets TLV 15 (Maintain Power Spectral Density) to ON in the UCD messages it sends to the
CMs on that upstream.
When TLV 15 is on, and when the new UCD specifies a new upstream modulation rate for the CM, the
CM must change its transmit power level to keep its power spectral density as close as possible to what
it was before the modulation rate change. The CM must maintain this power spectral density until the
CMTS sends a power adjustment command in a Ranging-Response (RNG-RSP) message.
The default configuration (no cable upstream maintain-psd) configures TLV 15 to OFF, and CMs are
not required to maintain their power spectral density after a modulation rate change. However, per the
DOCSIS specifications, the CMs continue to maintain constant total input power on the upstream.
Note This command affects only DOCSIS 2.0 CMs that are online an upstream that is configured for the
DOCSIS 2.0 A-TDMA-only mode. This command has no effect on DOCSIS 1.0 and DOCSIS 1.1 CMs,
which will continue to maintain constant total input power on the upstream, per the DOCSIS 1.x
specifications.
Examples The following example shows how to configure four upstreams on a cable interface line card to require
cable modems to maintain a constant power spectral density after a modulation rate change.
Router# configure terminal
Router(config)# interface cable c6/1/0
Router(config-if)# cable upstream 0 maintain-psd
Router(config-if)# cable upstream 1 maintain-psd
Router(config-if)# cable upstream 2 maintain-psd
Router(config-if)# cable upstream 3 maintain-psd
Router(config-if)# exit
Router(config)# exit
Router#
The following example shows how to configure an upstream for the default behavior, which is that CMs
are not required to maintain a constant power spectral density after a modulation rate change, but do
continue to maintain constant total input power levels on the upstream.
Router# configure terminal
Router(config)# interface cable c5/1/0
Router(config-if)# no cable upstream 0 maintain-psd
Router(config-if)# exit
Router(config)# exit
Router#
Defaults 4
Usage Guidelines Use this command to specify how many upstreams a downstream (MAC domain) will support on the
Cisco uBR-MC5X20S card, before using the cable upstream connector command to assign upstreams
to physical ports on the card. The downstreams on a card can be configured for different maximum
upstream values.
After using this command, the valid range for upstreams on that cable interface will be from 0 to one
less than the maximum port value. For example, if you use the cable upstream max-ports 6 command
to specify a maximum of 6 upstreams for the downstream, the valid range for upstreams will be 0 to 5.
Examples The following example shows how to configure all of the downstreams on a Cisco uBR-MC5X20S card
for a maximum number of 6 upstreams.
Router# configure terminal
Router(config)# interface cable c6/1/0
Router(config-if)# cable upstream max-ports 6
Router(config-if)# interface cable c6/1/1
Router(config-if)# cable upstream max-ports 6
Router(config-if)# interface cable c6/1/2
Router(config-if)# cable upstream max-ports 6
Router(config-if)# interface cable c6/1/3
Router(config-if)# cable upstream max-ports 6
Router(config-if)# interface cable c6/1/4
Router(config-if)# cable upstream max-ports 6
Router(config-if)# exit
Router(config)# exit
Router#
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the
first upstream port on the cable interface line card.
size Specifies the minislot size in time ticks. Valid minislot sizes are:
• 1—(32 symbols at 6.4MHz channel width) Supported by the
Cisco uBR-MC16U/X, Cisco uBR-MC28U/X and
Cisco uBR-MC5X20S/U cable interface line cards when operating
in Advanced TDMA (A-TDMA) DOCSIS 2.0 only mode.
• 2 (32 symbols at at 3.2 MHz channel width)
• 4 (64 symbols at 3.2 MHz channel width)
• 8 (128 symbols at 3.2 MHz channel width)
• 16 (256 symbols at 3.2 MHz channel width)
• 32 (512 symbols at 3.2 MHz channel width)
• 64 (1024 symbols at 3.2 MHz channel width)
• 128 (2048 symbols at 3.2 MHz channel width)
Defaults The default settings vary, depending on the upstream’s channel width. The default values were changed
in Cisco IOS Release 12.2(15)BC1 and later releases to better optimize data and voice traffic on the
upstream. Table 2-12 on page 2-330 lists the default minislot values for each channel width for
Cisco IOS releases before and after Cisco IOS Release 12.2(15)BC1.
Release Modification
12.2(15)BC1 The default minislot size was reduced to optimize the upstream for data and
Voice-over-IP (VoIP) traffic. The previous defaults produced 16 bytes per
minislot when using QPSK modulation and a 1.6 MHz channel width, and
the new defaults produce 8 bytes per minislot with the same configuration.
12.2(15)BC2 Support was added for the minislot size of 1 to support DOCSIS 2.0
A-TDMA and mixed modulation profiles on the Cisco uBR-MC5X20S/U
cable interface line cards.
Usage Guidelines The minislot size determines the minimum amount of information that can be transmitted on the
upstream. How much a particular minislot size can contain depends on the modulation profile and
channel width being used, with higher-bandwidth settings allowing larger amounts of data.
Because DOCSIS specifications require that the minislot size contain at least 32 symbols, you might
need to change the minislot size whenever you change the channel width or modulation of an upstream,
to meet the DOCSIS requirements.
Note In Cisco IOS Release 12.2(15)CX, Cisco IOS Release 12.2(15)BC2, and later releases, manually
changing the minislot size is not needed on the Cisco uBR-MC16U/X, Cisco uBR-MC28C, and
Cisco uBR-MC28U/X cards, because these cards automatically change the minislot size when the
channel width is changed, to produce 32 symbols per minislot, as required by the DOCSIS
specifications.
Table 2-12 lists the default minislot sizes for each channel width for Cisco IOS releases before and after
Cisco IOS Release 12.2(15)BC1.
Releases Earlier than Cisco IOS Release Cisco IOS Release 12.2(15)BC1 and Later
12.2(15)BC1 (creates 64 symbols and 16 bytes Releases (creates 32 symbols and 8 bytes per
per minislot) minislot)
Default Minislot Size (in Default Minislot Size (in
Channel Width Ticks) Channel Width Ticks)
0.2 MHz 64 0.2 MHz 32
0.4 MHz 32 0.4 MHz 16
0.8 MHz 16 0.8 MHz 8
1.6 MHz 8 1.6 MHz 4
3.2 MHz 4 3.2 MHz 2
6.4 MHz 11
(DOCSIS 2.0 only)
1. You must be using a 6.4 MHz channel width if using a minislot size of 1 tick. Otherwise, you will violate the DOCSIS
requirements that each minislot should contain 32 symbols.
Caution Using values of 64 or 128 for higher symbol rates such as 1280 kilosymbols/second or
2560 kilosymbols/second can cause performance problems. Depending on your current setting’s symbol
rate, you should select the minislot size (in ticks) that yields a minislot size of 32 or 64 symbols.
Examples The following example shows how to set the minislot size on upstream port 4 to 16:
Router# configure terminal
Router(config)# interface cable 3/0
Router(config-if)# cable upstream 4 minislot-size 16
Router(config-if)# exit
Router(config)# exit
Router#
Related Commands cable modulation-profile Defines a modulation profile for use on the router.
cable upstream channel- Specifies an upstream channel width for an upstream port.
width
cable upstream docsis- Configures an upstream to use either DOCSIS 1.x or DOCSIS 2.0
mode modulation profiles.
cable upstream Enables the use of a DOCSIS 1.1 pre-equalization coefficient on an
equalization-coefficient upstream.
cable upstream Assigns one or two modulation profiles to an upstream port.
modulation-profile
show cable hop Displays CM configuration settings.
show cable modulation- Displays the modulation profile information for a Cisco CMTS.
profile
show interface cable mac- Displays the current time-slot scheduling state and statistics.
schedule
show interface cable sid Displays cable interface information.
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the
first upstream port on the cable interface line card.
primary-profile number Number identifying the primary modulation profile for the upstream
port. The primary modulation profile is used when the upstream is
operating with nominal noise conditions. The valid values depend on
the cable interface being used and the mode of operation:
• If the upstream is configured for DOCSIS 1.0 and DOCSIS 1.1
mode, the valid range is from 1 to 99, depending on the cable
interface. The system creates profiles 1, 21, and 41 as the default
DOCSIS 1.x profiles, depending on the installed cable interfaces.
• If the upstream is configured for DOCSIS 1.x and DOCSIS 2.0
mixed mode, the valid range is from 100 to 199, depending on the
cable interface. The system creates profiles 101, 121, and 141 as
the default mixed mode profiles, depending on the installed cable
interfaces.
• If the upstream is configured for DOCSIS 2.0 A-TDMA mode, the
valid range is from 200 to 299, depending on the cable interface.
The system creates profiles 201, 221, and 241 as the default
DOCSIS 2.0 A-TDMA profiles, depending on the installed cable
interfaces.
Note See the description of the cable modulation-profile command
for a table of the valid ranges for the individual cable interface
cards.
secondary-profile number Secondary modulation profile for the upstream port, which is used
when noise on the upstream increases to the point that the primary
modulation profile can no longer be used. The valid values are the
same ranges as for the primary modulation profile.
Note The secondary modulation profile should specify a more robust
performance profile (in terms of coping with noise) than the
primary profile.
Defaults Default modulation profiles are created, using profile numbers 1, 21, 41, 101, 121, 201, 221, and 241,
depending on DOCSIS mode and the cable interface line cards being used. See Table 2-5 on page 2-171
for the list of supported profiles and cable interface line cards.
Usage Guidelines The cable upstream modulation-profile command can assign one or two modulation profiles to an
upstream port, depending on the type of cable interface and Cisco IOS software release being used.
the upstream exceeds the threshold for the primary profile, the upstream switches to the secondary
modulation profile. When the noise conditions improve (defined as a SNR value that is 3 dB greater
than the threshold value and FEC counters that are below the threshold values), the upstream
automatically switches back to the primary modulation profile. If the noise conditions continue to
worsen, however, the line card begins frequency hopping to find a cleaner upstream channel.
For example, the primary modulation profile could be configured for 16-QAM (or mixed 16-QAM
and QPSK) operation, while the secondary profile could be configured for QPSK operation. If noise
conditions on the upstream threaten to force CMs offline, the upstream switches to the secondary
profile to implement QPSK operation. When the noise ingress conditions are solved, the upstream
switches back to 16-QAM operation.
Note For more information on this form of the Dynamic Upstream Modulation feature, see the
chapter, Spectrum Management for the Cisco Cable Modem Termination System, in the
Cisco CMTS Feature Guide.
When Dynamic Upstream Modulation is enabled and spectrum groups are configured on the same
interface, the line cards respond to excessive noise by first switching to the secondary modulation
profile. If noise conditions worsen, the line card attempts to find a new upstream channel by
frequency hopping, and if that fails, the line card reduces the channel width.
• The upstream port is on a Cisco uBR-MC16S line card that is used on Cisco CMTS routers using
Cisco IOS Release 12.1(7)CX1 or later release, or on a Cisco uBR-MC5X20S/U line card.
The Dynamic Upstream Modulation feature on the Cisco uBR-MC16S line card is identical to that
for other line cards except that the spectrum management hardware onboard the Cisco uBR-MC16S
or Cisco uBR-MC5X20S/U line card uses the CNR instead of the SNR value. The CNR value is a
more accurate description of noise conditions on the upstream. Because of this, these line cards
switch back to the primary modulation profile when noise conditions improve to a CNR value that
is only 1 dB greater than the threshold value (assuming FEC counters are also below the threshold
values).
Note If the Cisco CMTS router is running Cisco IOS Release 12.1(3a)EC1 or a later Cisco IOS
release, the Dynamic Upstream Modulation feature on the Cisco uBR-MC16S line card
operates the same as it does on the other line cards.
When Dynamic Upstream Modulation is enabled and spectrum groups are configured on the same
interface, the line cards respond to excessive noise by taking the first corrective action, as
determined by the cable upstream hop-priority command (either frequency hopping or changing
to the secondary modulation profile). If noise conditions worsen, the line card takes the second
corrective action that has been defined, and if that fails, the line card takes the last corrective action.
Note The Dynamic Upstream Modulation feature uses the DOCSIS-specified thresholds for 16-QAM and
QPSK operation to determine when to switch modulation profiles. We therefore recommend that the
primary profile use 16 -QAM or mixed 16-QAM/QPSK modulation, and that the second profile use
QPSK modulation. However, this is not mandatory, and the two profiles could be the same (16-QAM or
QPSK), but the secondary profile should still be considered a more robust profile than the primary profile
in terms of coping with noise conditions.
Tip Modulation profiles must be first created using the cable modulation-profile command before they can
be assigned using the cable upstream modulation-profile command.
Examples The following example assigns the primary modulation profile 2 and the secondary modulation profile 1
to upstream port 0 on the cable interface line card in slot 3. This automatically enables the Dynamic
Upstream Modulation feature for all CMs using that upstream.
Router(config)# interface cable 3/0
Router(config-if)# cable upstream 0 modulation-profile 2 1
Router(config-if)#
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the
first upstream port on the cable interface line card.
continue pwr-level Specifies the power threshold value that determines the value of the
Ranging Status field in the Ranging Response (RNG-RSP) messages
that the CMTS sends to the CM. The valid range is from 2 to 15 dB,
with a default of 2 dB.
threshold value Specifies the power adjustment threshold. The threshold range is
from 0 to 10 dB, with a default of 1 dB.
noise perc-pwr-adj Specifies the percentage of power adjustment packets that is required
to change the adjustment method from the regular power-adjustment
method to the noise power-adjustment method, which uses an
averaging algorithm to smooth out wide jumps in the power level.
The valid range is 10 to 100 percent, with a default of 30 percent.
Defaults The continue option defaults to 2 dB, the noise option defaults to 30 percent, and the threshold option
defaults to 1 dB.
Usage Guidelines When a CM comes online, it sets itself for the optimal power level, as determined by the CMTS. As the
CMTS periodically polls each CM, the CMTS examines the CM’s power level and orders the CM to
adjust its power level to adapt to current total attenuation between it and the CMTS. These power
adjustments can be required because of temperature variations, upstream frequency hopping, or
increased attenuation that has been added either intentionally or unintentionally. The cable upstream
power-adjust command controls how the CMTS makes these power adjustments.
Note To set the upstream power level on the CMTS, see cable upstream power-level, page 2-340.
Note The threshold parameter can be set from 0 dB to 10 dB with a default of 1 dB. However, do not set the
threshold to 0 dB because this means that the CMTS will command all CMs to continually change their
power levels until the CMTS measures the power levels at exactly 0 dBmV. Cisco recommends that you
set the threshold parameter to a minimum of its default value of 1 dB so that the CMs do not change
their power levels continually for minuscule RF plant variations.
Note Cisco recommends designing the network so that CMs are at least 6 dB from the CM’s maximum
transmit power level. This will accommodate new services, changing modulation schemes, different
channel widths, customer-installed passives, temperature variations, and other non-linearities. DOCSIS
specifies a minimal power range of +8 dBmV to +55 dBmV for 16-QAM operation and +8 dBmV to
+58 dBmV maximum power level for QPSK operation. Cisco CMs typically have a maximum power
level of +60 dBmV, which exceeds the DOCSIS standards.
Tip If a number of CMs are transmitting close to their maximum transmit power, try increasing the continue
range to allow the CMTS to continue adjusting the CM’s power levels. This situation can happen when
systems use high value taps, such as 29 dB taps, in the design of the plant.
Note When the CM requires 16 successive power adjustments that are greater than the value of the continue
option, the CMTS reinitializes the CM and starts to rescan downstream carriers, as per the DOCSIS
specification.
Note A CM that shows an exclamation point (!) in the show cable flap-list and show cable modem displays
is typically more prone to packet loss than other CMs.
Tip The cable upstream power-adjust noise command is typically not needed during normal operations,
but it can help in certain situations where the cable plant is experiencing ingress noise and other
interference that is forcing many CMs to frequently re-range. If the show cable flap-list and show cable
modem commands show a large number of CMs with asterisks (*), experiment with the noise option, so
that the CMTS will average its CM power readings before sending any power adjustments to the CMs.
Note When a CM is in power averaging mode, the show cable flap-list and show cable modem commands
shows an asterisk (*) for that particular CM.
Examples The following example shows the commands needed so that the CMTS will begin using the power
averaging adjustment method when 50 percent of Ranging Requests result in a power adjustment beyond
the threshold level of 2 dB:
router(config)# interface c6/0
router(config-if)# cable upstream 0 power-adjust threshold 2
router(config-if)# cable upstream 0 power-adjust noise 50
router(config-if)#
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first
upstream port on the cable interface line card.
dbmv Decibels per millivolt designating the upstream signal input power level.
Valid range is –16 dBmV to +26 dBmV, depending on the cable interface and
the upstream’s symbol rate (channel width).
Defaults 0 dBmV
Usage Guidelines The Cisco CMTS controls the output power levels of the CMs to meet the desired upstream input power
level. The nominal input power level for the upstream RF carrier is specified in decibels per millivolt
(dBmV). The default setting of 0 dBmV is the optimal setting for the upstream power level.
The valid range for the input power level depends on the data rate, as expressed as the symbol rate and
channel width. Table 2-13 shows the valid power levels for each allowable rate, as given in the DOCSIS
specification. Higher (more positive) values cause the CMs to increase their transmit power, achieving
a greater carrier-to-noise ratio (CNR).
Note Some cable interfaces might allow smaller ranges of either –10 to +10 or –10 to +25 dBmV.
Tip You can use inline attenuators to force CMs to transmit at higher power levels and to achieve a higher
CNR value on the network.
Caution If you increase the input power level or add inline attenuators before the CMTS, the CMs on your HFC
network increase their transmit power level. Be careful if you adjust this parameter. You might violate
the upstream return laser design parameters or exceed the CM’s maximum transmit power level.
Note Do not adjust your input power level by more than 5 dB in a 30-second interval. If you increase the
power level by more than 5 dB within 30 seconds, you will disrupt CM service on your network. If you
decrease the power level by more than 5 dB within 30 seconds, the CMs on your network will be forced
to re-range.
Tip When setting upstream power levels, Cisco recommends that the adjacent channels of equal bandwidth
not have a large variation. The recommended maximum input power variance is 5 to 6 dB.
Examples The following example shows how to set the input power level for upstream port 0 to -5 dBmV:
Router(config)# interface cable 5/1/0
Router(config-if)# cable upstream 0 power-level -5
Router(config-if)#
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the
first upstream port on the cable interface line card.
automatic Specifies the fixed data backoff start and end values.
Note The automatic setting is not supported on
Cisco uBR-MC5X20S/U cable interface line cards, which
should use manually configured ranging backoff instead.
start Binary exponential algorithm. Sets the start value for initial ranging
backoff. Valid values are from 0 to 15.
end Binary exponential algorithm. Sets the end value for initial ranging
backoff. Valid values are from 0 to 15.
Usage Guidelines The DOCSIS-specified method of contention resolution for CMs used to send data or requests on the
upstream channel is a truncated binary exponential back-off with the initial backoff window and the
maximum backoff window controlled by the CMTS. The Cisco CMTS router specifies backoff window
values for both data and initial ranging and sends these values downstream as part of the Bandwidth
Allocation Map (MAP) MAC message. The values are power-of-two values. For example, a value of 4
indicates a window between 0 and 15; a value of 10 indicates a window between 0 and 1023.
The automatic setting is optimized for a maximum of 250 CMs per upstream port. Set manual values
for data backoff windows only when operating with more than 250 CMs per upstream port. (The
automatic setting is not supported on Cisco uBR-MC5X20S/U cable interface line cards, which should
use manually configured ranging backoff instead.)
Tip Use the show controllers cable upstream command to display the current Ranging Backoff settings.
Examples The following example shows how to set the range backoff to automatic for upstream port 2:
Router(config)# interface cable 4/0
Router(config-if)# cable upstream 2 range-backoff automatic
Router(config-if)#
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the
first upstream port on the cable interface line card.
token-bucket shaping (Optional) Enables rate limiting for the specified upstream cable
interface using the token-bucket policing algorithm. The shaping
option enables token-bucket shaping.
Usage Guidelines Upstream rate limiting allows upstream bandwidth requests from rate-exceeding CMs to be buffered
without incurring TCP-related timeouts and retransmits. This enables the Cisco CMTS to enforce the
peak upstream rate for each CM without degrading overall TCP performance for the subscriber CPE
devices. Upstream grant shaping is per cable modem (SID).
When the token-bucket algorithm is configured, the Cisco CMTS automatically drops packets in
violation of allowable upstream bandwidth.
Use of the default value (the upstream port’s rate limit) enforces strict DOCSIS-compliant rate limiting.
Cisco highly recommends to using the default setting of token-bucket with the shaping option.
Examples The following example shows how to configure the token bucket filter algorithm with traffic shaping on
upstream port 4:
router(config-if)# cable upstream 4 rate-limit token-bucket
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first
upstream port on the cable interface line card.
Defaults Disabled
Usage Guidelines This command causes CMs to enable their pseudo-random scrambler circuitry to improve the robustness
of the upstream receiver on the line card.
The scrambler on the upstream radio frequency (RF) carrier enables CMs on the HFC network to use
built-in scrambler circuitry for upstream data transmissions. The scrambler circuitry improves reliability
of the upstream receiver on the cable interface line card. The upstream scrambler is activated by default
and should not be disabled under normal circumstances.
Caution Scrambler must be activated for normal operation. Deactivate only for prototype CMs that do not support
scrambler.
Examples The following example shows how to activate the upstream scrambler:
router(config-if)# cable upstream 0 scrambler#
Command Description
cable upstream power-level Sets the input power level for the upstream RF carrier in
decibels per millivolt (dBmV).
cable upstream shutdown Disables the upstream port.
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first
upstream port on the cable interface line card.
Usage Guidelines The cable upstream shutdown command shuts down a single upstream port without affecting any of
the other upstream or downstream ports on the cable interface. To shut down the entire interface, use the
shutdown command in cable interface configuration mode.
Examples The following example shows how to disable the upstream port:
router(config-if)# cable upstream 0 shutdown
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first upstream
port on the cable interface line card.
group-number Specifies the spectrum group for which you are specifying a parameter value or
specifies the number of the spectrum group you wish to remove from your router
configuration. Valid range is from 1 to 32, or from 1 to 40, depending on the
Cisco IOS software release.
Usage Guidelines This command assigns a spectrum group to a single upstream on the cable interface line card. To
configure the spectrum groups, use the set of cable spectrum-group commands in global configuration
mode.
Note You can also spectrum groups to all of the upstreams on the cable interface using the cable spectrum-
group (interface configuration) command.
Examples The following example shows how to assign spectrum group 12 to the first upstream on the cable
interface line card in slot 5/0:
Router(config)# interface cable 5/0
Router(config-if)# cable upstream 0 spectrum-group 12
Router(config-if)# exit
Router(config)#
Note This command can be used only on upstreams on the Cisco uBR-MC16S cable interface line cards.
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the
first upstream port on the cable interface line card.
interval-in-ms The valid range is 1000 to 25000 milliseconds, with a default of 15000
milliseconds.
Usage Guidelines The Cisco uBR-MC16S cable interface line cards contain digital signal processors (DSPs) that perform
hardware spectrum management. Use the cable upstream snr-polling command to determine how often
that hardware should examine an upstream’s signal to determine the current CNR value.
Examples The following example shows how to configure the sixth upstream on a Cisco uBR-MC16S cable
interface card so that the DSP samples the upstream signal every 10 seconds (10,000 milliseconds):
Router(config)# interface cable 3/0
Router(config-if)# cable upstream 5 snr-polling 10000
Router(config-if)#
Command Description
show cable hop Displays the current hop period and threshold for an upstream, along with
other statistics.
show cable modulation- Displays the cable modulation profiles that have been created.
profile
Note This command can be used only on upstreams on the Cisco uBR-MC16S cable interface line cards.
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the
first upstream port on the cable interface line card.
cnr-profile1 threshold1-in- Specifies the CNR threshold for the primary modulation profile
DB specified for the upstream. The threshold is specified in dB (5–35,
default is 25).
cnr-profile2 threshold2-in- Specifies the CNR threshold for the secondary modulation profile
DB specified for the upstream. The threshold is specified in dB (5–35,
default is 15 dB and must be less than the primary threshold).
corr-fec fec-corrected Specifies the allowable number of correctable FEC errors for the
upstream. The fec-corrected parameter is given as a percentage of total
packets received on the upstream during the polling period, with a valid
range of 1 to 30, and a default of 3.
uncorr-fec fec-uncorrected Specifies the allowable number of uncorrectable FEC errors for the
upstream. The fec-uncorrected parameter is given as a percentage of
total packets received on the upstream during the polling period, with a
valid range of 1 to 30, and a default of 1.
Note For normal plant use, Cisco recommends that the uncorrectable
FEC threshold remain at its default of 1 percent to avoid an
unacceptable number of errors on the channel.
Defaults The CNR threshold for the primary modulation profile defaults to 25 dB. The CNR threshold for the
secondary modulation profile defaults to 15 dB. The correctable FEC error threshold defaults to
3 percent of total packets received, and the uncorrectable FEC error threshold defaults to 1 percent of
total packets received.
Note The ranges and defaults for the correctable and uncorrectable FEC error thresholds were changed in
Cisco IOS Release 12.2(8)BC2.
Usage Guidelines Separate CNR thresholds are assigned to the primary and secondary modulation profiles. Both profiles,
however, are assigned the same correctable and uncorrectable FEC values.
Note The uncorrectable FEC error count includes packets that have header checksum errors and “no unique
word detected” errors.
Examples The following example shows upstream 5 configured with the CNR threshold for the primary modulation
profile set to 20 dB, the CNR threshold for the secondary modulation profile set to 10 dB, the correctable
FEC error rate set to 5 percent of total packets received on the upstream, and the uncorrectable FEC error
rate set to 1 percent of total packets received on the upstream:
Router(config)# interface cable 3/0
Router(config-if)# cable upstream 5 threshold cnr-profile1 20 cnr-profile2 10 corr-fec 5
uncorr-fec 1
Router(config-if)#
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the
first upstream port on the cable interface line card.
continue sec Sets the minimum timing adjustment that sets continue ranging status
in seconds. The range for sec is 2 to 64 seconds. Default value is
2 seconds.
threshold sec Sets the timing adjustment threshold in seconds. Valid threshold value
is 1 to 32 seconds. Default is 1 second.
Usage Guidelines To verify whether or not upstream timing adjustment is configured and activated, enter the show
running-config command and look for the cable interface configuration information. If upstream timing
adjustment is enabled, either or both of the continue and threshold timing adjustment entries are
displayed in the show running-config output. If both the continue and threshold upstream timing
adjustments are disabled, no timing adjustment entry is displayed in the show running-config output.
If you are having trouble, make sure that the cable connections are not loose or disconnected; the cable
interface line card is firmly seated in its chassis slot; the captive installation screws are tight; and you
have entered the correct slot and port numbers.
Note The cable timing-adjust command is applicable only on Cisco IOS Release 12.0(12)SC and Cisco IOS
Release 12.1(3)T. It is deprecated and removed on Cisco IOS Release 12.1(3a)EC, 12.1(4)CX, and later
releases.
Examples The following example shows how to set the upstream time adjustment ranging value to 5 seconds:
CMTS01(config-if)# cable upstream 0 time-adjust continue 5
The following example shows how to set the threshold value to the default of 12 seconds:
CMTS01(config-if)# cable upstream 0 time-adjust threshold 12
Syntax Description n Specifies the upstream port number. Valid values start with 0 for the first
upstream port on the cable interface line card.
limit jitter Specifies the allowable jitter limit caused by unfragmentable slots, in
microseconds (0 to 4,294,967,295).
cac-enforce Rejects service flows requesting jitter less than the fragmentable slot jitter.
Defaults By default, the limit is 0 microseconds and the cac-enforce option is enabled.
Usage Guidelines This command controls how much jitter due to unfragmented slots is to be tolerated on each port. If the
specified value for the tolerated limit is less than the size of a maximum unfragmentable slot, the MAC
scheduler automatically blocks the slots in the scheduling table so that the unfragmentable slot can be
accommodated in the blocked space and avoid causing excessive jitter to CBR slots.
The cac-enforce option enforces the rule that service flows requesting run-time jitter less than
unfragmentable slot jitter should be rejected.
Examples The following example shows the jitter being set to 10 milliseconds (10,000 microseconds) for upstream
port 0 on cable interface 2/0:
Router# configure terminal
Router(config)# interface c2/0
Router(config-if)# cable upstream 0 unfrag-slot-jitter limit 10000
Router(config-if)#
cable vc-map
To map a cable modem to a particular permanent virtual connection (PVC) on an Asynchronous Transfer
Mode (ATM) interface, use the cable vc-map command in global configuration mode. To remove this
mapping, use the no form of this command.
Syntax Description mac-address Specifies the hardware (MAC) address for the cable modem whose traffic is
to be mapped.
atm-interface Specifies the outbound ATM interface to which this cable modem should be
mapped.
vpi/vci Specifies the virtual path identifier (VPI) and virtual channel identifier
(VCI) on the ATM interface to which this cable modem should be mapped.
cust-name (Optional) Identifies the customer for this PVC. The cust-name can be any
arbitrary alphanumeric string, up to 127 characters long.
customer cust-name (Optional) Deletes all PVCs belong to this customer. The cust-name can be
any arbitrary alphanumeric string, up to 127 characters long.
Usage Guidelines This command maps a cable modem, on the basis of its hardware (MAC) address, to a particular PVC
on an ATM interface.
Note To use this command, you must first enable the use of Layer 2 tunnels, using the cable l2-vpn-service
atm-vc command. Then use the cable vc-map command to enable the mapping of individual cable
modems to specific PVCs.
Examples The following example shows how to enable the use of Layer 2 tunnels and then map specific CMs to
specific PVCS:
Router# config terminal
Router(config)# cable l2-vpn-service atm-vc
Router(config)# cable vc-map 0007.0e03.69f9 ATM2/0 1/1
Router(config)# cable vc-map 0010.7bed.9c95 ATM2/0 1/2
Router(config)# exit
Router#
The following example shows the same configuration as above, but with the addition of a customer name
that identifies the customer that is using each particular PVC:
Router# config terminal
Router(config)# cable l2-vpn-service atm-vc
Router(config)# cable vc-map 0007.0e03.69f9 ATM2/0 1/1 ENTERPRISE-CO1
Router(config)# cable vc-map 0010.7bed.9c95 ATM2/0 1/2 ENTERPRISE-CO2
Router(config)# exit
Router#
card
To preprovision a slot in the Cisco uBR10012 universal broadband router for a particular interface card,
so that you can configure the interface without it being physically present in the slot, use the card
command in global configuration mode. To remove the preprovisioning for a card, so that the physical
slot reports being empty, use the no form of this command.
no card slot/port
Syntax Description slot Identifies the Cisco CMTS chassis slot number for the card. The valid
range is 1 to 8.
port Identifies the Cisco CMTS port number for the card. The valid values
are 0 or 1, depending on the slot number.
card-type Specifies the type of card that should be used to preprovision the slot.
See Table 2-14 for a list of the supported cards.
Note The list of supported card types depends on the Cisco IOS software release being used. See the release
notes for your release for the complete list of cards that are supported.
Defaults An empty card slot is not preprovisioned and cannot be configured or displayed.
Release Modification
12.2(15)CX1 Support was added for the Cisco uBR-MC16U/X and Cisco uBR-MC28U/X
cable interface line cards.
12.2(15)BC2 Support was added for the Cisco uBR-MC16U/X, Cisco uBR-MC28U/X,
and Cisco uBR-MC5X20U cable interface line cards.
Usage Guidelines This command preprovisions a slot in the Cisco uBR10012 router to accept a particular line card, so that
you can configure the interface without the card being physically present in the chassis. This command
allows system administrators to plan for future configurations, without having to wait for the physical
hardware to first arrive. When the line card does arrive, the installer can bring the card online by inserting
the card into the chassis and connecting the necessary cables, without having to do any further
configuration using the command-line interface.
The type of card must be appropriate for the slot being specified. Slots 1/1 and 2/1 are reserved for TCC+
utility cards. Slots 1/0 through 4/0 are reserved for network uplink line cards. Slot 5/0 through 8/1 are
reserved for cable interface line cards. Slot 0/0 is reserved for the FastEthernet interface on the PRE1
module and cannot be specified in this command.
Table 2-14 lists the types of cards that are supported as card-types for the card command:
Tip When a card has been preprovisioned and is not physically present in the chassis, the show interface
command for that slot displays the message “Hardware is not present.” Some show commands might
also list the preprovisioned card in their displays. In addition, using the card command does not change
the output of the ENTITY-MIB, which shows only the equipment that is physically installed in the router.
When a line card is inserted in the Cisco uBR10012 chassis, the router performs the following actions,
depending on whether the card slot is preprovisioned for the card:
• If the inserted line card matches the type of line card preprovisioned for the slot, the system applies
the preprovisioned configuration to the line card.
• If the line card slot was not preprovisioned, the system applies a basic configuration to the line card
and adds that configuration to the running configuration file.
• If the line card slot was preprovisioned for one type of line card, but another type of line card has
been inserted, the system replaces the preprovisioned configuration (in the running configuration
file) with a basic configuration for the line card that was actually inserted. The startup configuration
file is not changed.
Tip Use the show running-config | include card command to display which slots, if any, are preprovisioned
for a particular card type.
The no card slot/port command removes the preprovisioning information from the given card slot. This
also removes all configuration information for that card slot, as well as any information in the SNMP
MIB database about the card and its card slot.
Examples The following example shows a list of supported card types for Cisco IOS Release 12.2(8)BC1, and then
shows that slot 8/0 is being preprovisioned for a Cisco uBR-LCP2-MC28C cable interface line card. The
cable interface for slot 8/0 can then be configured.
Router# config t
Router(config)# card 5/0 ?
1cable-mc16c create a uBR10000 line card with MC16C
1cable-mc16e create a uBR10000 line card with MC16E
1gigethernet-1 create a GE_1_PORT cardtype
1oc12pos-1 create a OC12POS_1_PORT cardtype
2cable-mc28bnc create a uBR10000 line card with MC28C, BNC connector
2cable-mc28c create a uBR10000 line card with MC28C
2oc12srp-sm-lr create a uBR10000 oc12 SRP card with SM LR
Router(config)# card 8/0 2cable-mc28c
Router(config)# int c8/0
Router(config-if)#
The following example shows the output from the show interface command for a preprovisioned cable
interface. The second line of the output shows that the hardware is not present.
Router# show interface c8/0/0
Cable8/0/0 is initializing, line protocol is down
Hardware is not present
Hardware is UBR10000 CLC, address is 0001.6440.d160 (bia 0001.6440.d160)
MTU 1500 bytes, BW 27000 Kbit, DLY 1000 usec,
reliability 255/255, txload 1/255, rxload 1/255
Encapsulation MCNS, loopback not set
ARP type: ARPA, ARP Timeout 04:00:00
Last input never, output never, output hang never
channel-id
To create a DOCSIS configuration file that specifies the upstream channel ID for a CM configuration
file, use the channel-id command in cable config-file configuration mode. To remove the channel ID
specification, use the no form of this command.
channel-id upstreamchan-id
no channel-id
Syntax Description upstreamchan-id Specifies the upstream channel ID. Valid range is 0 to 255, depending on the
number of actual upstream ports on the cable interface being used.
Defaults If no upstream channel ID is specified, the CM uses the upstream channel from the Upstream Channel
Description (UCD) messages it receives on the downstream channel.
Usage Guidelines This command sets the Upstream Channel ID Configuration Setting field in the DOCSIS configuration
file. Typically, the CM uses the upstream channel ID that is specified by the CMTS during the
registration process, but this command overrides that setting and forces the CM to use the upstream
channel specified in the DOCSIS configuration file. If that upstream does not exist, or if the upstream
cannot be obtained for some reason, the CM cannot come online.
Note If you are using a telco-return CM, the upstream channel must be 0.
Examples The following example shows how to set the upstream channel ID for the configuration file to 3. If the
CM cannot obtain this upstream channel, it does not come online.
router(config)# cable config-file channeloverride.cm
router(config-file)# channel-id 3
router(config-file)# exit
Command Description
cpe max Specifies CPE information.
download Specifies download information for the configuration file.
frequency Specifies downstream frequency.
option Provides config-file options.
privacy Specifies privacy options for baseline privacy images.
service-class Specifies service class definitions for the configuration file.
snmp manager Specifies Simple Network Management Protocol (SNMP) options.
timestamp Enables time-stamp generation.
Usage Guidelines DSG operation is disabled using the no cable dsg command, but this does not clear out the DSG-related
counter (“mapping entry is used”), so that you can retain its value in case you intend to restart DSG
operations again. If, however, you want to reset those counters to zero, use the clear cable dsg command.
Note This command resets the “mapping entry is used” counters for all DSG tunnels and interfaces on the
router.
Examples The following example shows how to clear the DSG counters for all cable interfaces on the router, and
shows an example of the show cable dsg command showing the counters after they have been cleared.
Router# show cable dsg stats
Router#
Syntax Description mac-addr Specifies the 48-bit MAC address (hardware address) of an individual
CM to be cleared from the flap-list table.
all Removes all CMs from the flap-list table.
save-counters (Optional) Preserves the flap-list counters that are displayed by the
show cable flap-list command and by using SNMP requests to access
the CISCO-CABLE-SPECTRUM-MIB MIB.
Usage Guidelines Cable modems are removed from the flap-list table after the number of days (between 1 and 60) specified
by the cable flap-list aging global configuration command. Use the clear cable flap-list command to
remove individual CMs from the flap-list while retaining flapping activity for other CMs, or to clear the
entire flap-list table.
Examples The following example shows how to remove all the CMs from the flap-list table:
router# clear cable flap-list all
Syntax Description cable slot/port (Optional) Clears the hop counters on a specific cable interface on the
Cisco uBR7100 series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On
the Cisco uBR7200 series router, slot can range from 3 to 6, and port
can be 0 or 1, depending on the cable interface.
cable slot/subslot/port (Optional) Clears the hop counters on a specific cable interface on the
Cisco uBR10012 router. The following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
upstream uport (Optional) Clears the hop counters on a specific upstream port on a
specific cable interface. The valid values for uport start with 0 for the
first upstream port on the cable interface line card.
Usage Guidelines The clear cable hop command clears the correctable and uncorrectable forward error corrections (FEC)
counters that are displayed by the show cable hop command. You can clear the counters for all interfaces
on the Cisco CMTS, for one specific interface (one downstream and its associated upstreams), or for a
specific upstream on a cable interface.
Examples The following example shows how to clear the frequency hop counters on all cable interfaces on the
Cisco CMTS, along with sample output from the show cable hop command that shows the counters
being cleared:
Router# show cable hop
Upstream Port Poll Missed Min Missed Hop Hop Corr Uncorr
Port Status Rate Poll Poll Poll Thres Period FEC FEC
(ms) Count Sample Pcnt Pcnt (sec) Errors Errors
Cable3/0/U0 15.008 Mhz 1000 * * *set to fixed frequency * * * 2238 133
Cable3/0/U1 admindown 1000 * * * frequency not set * * * 0 0
Cable3/0/U2 admindown 1000 * * * frequency not set * * * 0 0
Cable3/0/U3 admindown 1000 * * * frequency not set * * * 0 0
Upstream Port Poll Missed Min Missed Hop Hop Corr Uncorr
Port Status Rate Poll Poll Poll Thres Period FEC FEC
(ms) Count Sample Pcnt Pcnt (sec) Errors Errors
Cable3/0/U0 15.008 Mhz 1000 * * *set to fixed frequency * * * 0 0
Cable3/0/U1 admindown 1000 * * * frequency not set * * * 0 0
Cable3/0/U2 admindown 1000 * * * frequency not set * * * 0 0
Cable3/0/U3 admindown 1000 * * * frequency not set * * * 0 0
Router#
The following example shows how to clear the frequency hop counters on a specific cable interface on
the Cisco CMTS:
Router# clear cable hop c5/0
Router#
The following example shows how to clear the frequency hop counters on a specific upstream on the
Cisco CMTS:
Router# clear cable hop c5/1/0 upstream 2
Router#
Usage Guidelines This command removes a host’s IP and MAC addresses from the router’s internal address tables. This
might be necessary to allow a new host to come online from the previous host’s CM.
Note If the cleared host continues communicating through the CM, the Cisco CMTS adds the host back to its
internal address tables, and the show interface cable interface modem command shows it as having a
“static” address. To block the host from any further access, use the cable source-verify dhcp command,
so that the host cannot access the network unless it obtains an IP address from an authorized DHCP
server.
Examples The following example shows how to remove a PC's MAC address from the router's internal address
tables on the Cisco CMTS:
Router# clear cable host 0050.7366.17ab
Router#
Command Description
show cable device Display the CMs and the hosts behind the CMs on the network.
access-group
show cable host Displays only the hosts behind the CMs on the network.
access-group
Examples The following example shows how to clear all of the counters that track load-balancing operations,
resetting them all to zero:
Router# clear cable load-balance counters
Router#
The following example shows how to clear the state machine that is used for load-balancing operations.
Router# clear cable load-balance state
Router#
Command Description
cable load-balance Configures how the Cisco CMTS should load balance cable modems with
group policy ugs active unsolicited grant service (UGS) service flows.
cable load-balance Configures the threshold values that a load-balance group should use for
group threshold load-balancing operations.
cable upstream load- Assigns an upstream to a load-balance group.
balance group
show cable load- Displays real-time statistical and operational information for load-
balance balancing operations.
Usage Guidelines The cable logging badipsource command creates a circular buffer that contains the BADIPSOURCE
error messages that the Cisco CMTS generates when it discovers a CM or CPE device using an
unauthorized IP address. When the buffer becomes full, the oldest messages are deleted to make room
for newer messages.
When you have viewed all of the error messages in the current buffer, use the clear cable logging
command to clear out the buffer to make room for newer messages.
Examples The following example shows how to clear the log buffer that contains the bad IP source address error
messages:
Router# show cable logging summary
Cable logging: BADIPSOURCE Enabled
Total buffer size (bytes): 1000000
Used buffer size (bytes) : 36968
Logged messages : 231
Router# clear cable logging badipsource
Router# show cable logging summary
Cable logging: BADIPSOURCE Enabled
Total buffer size (bytes): 1000000
Used buffer size (bytes) : 0
Logged messages : 0
Router#
Related Commands cable logging badipsource Logs error messages about bad IP source addresses on the cable
interfaces.
cable source-verify Enables verification of IP addresses for CMs and CPE devices on the
upstream.
show cable logging Displays the log of error messages about bad IP source addresses on
the cable interfaces.
clear cable modem {mac-addr | ip-addr | [cable slot/port] {all | oui string | reject} } counters
clear cable modem {mac-addr | ip-addr | [cable slot/subslot/port] {all | oui string | reject} }
counters
Syntax Description mac-addr Specifies the 48-bit hardware address (MAC address) of an individual
CM.
ip-addr Specifies the IP address of an individual CM.
cable slot/port (Optional) Identifies the a interface and downstream port on the
Cisco uBR7100 series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can
be 0 or 1, depending on the cable interface.
cable slot/subslot/port (Optional) Identifies a cable interface on the Cisco uBR10012 router.
The following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
all Resets the flapping counters for all CMs.
oui string Resets the flapping counters for all CMs that match the specified
Organization Unique Identifier (OUI). The string parameter can be
either the three byte hexadecimal string (such as 00.00.0C) or a vendor
name that has been defined using the cable modem vendor command.
reject Resets the flapping counters for all CMs that are currently in one of the
reject states (see the description of these states in the show cable
modem command).
Examples The following example shows how to clear the counters for the CM at IP address 172.12.23.45:
Router# clear cable modem 172.12.23.45 counters
Router#
The following example shows how to clear the counters for all CMs that have a OUI that has been defined
as having the vendor name of Cisco using the cable modem vendor command:
Router# clear cable modem oui Cisco counters
Router#
The following example shows how to clear the counters for all CMs that are currently in one of the reject
states:
Router# clear cable modem reject counters
Router#
Note If running Cisco IOS Release 12.2(15)BC1 or later, use the clear cable modem flap-counters command
to clear the CM flap-list counters.
clear cable modem {mac-addr | ip-addr | [cable slot/port] {all | oui string | reject} } delete
clear cable modem {mac-addr | ip-addr | [cable slot/subslot/port] {all | oui string | reject} } delete
Syntax Description mac-addr Specifies the 48-bit hardware address (MAC address) of an individual
CM.
ip-addr Specifies the IP address of an individual CM.
cable slot/port (Optional) Identifies the a interface and downstream port on the
Cisco uBR7100 series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can
be 0 or 1, depending on the cable interface.
cable slot/subslot/port (Optional) Identifies a cable interface on the Cisco uBR10012 router.
The following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
all Deletes all the CMs from the Station Maintenance List.
oui string Deletes all CMs that match the specified Organization Unique
Identifier (OUI). The string parameter can be either the three byte
hexadecimal string (such as 00.00.0C) or a vendor name that has been
defined using the cable modem vendor command.
reject Deletes all CMs that are currently in one of the reject states (see the
description of these states in the show cable modem command).
Usage Guidelines This command instructs the Cisco CMTS to stop sending DOCSIS station maintenance messages to one
or more CMs, which effectively terminates the link to those CMs. To remove one or more CMs from the
router’s internal tables and to instruct them to reset, use the clear cable modem reset command.
Caution The clear cable modem all delete command should normally be used only on a test or lab network. If
used on a large network, it could impact service for a significant period of time, as it would force all
CMs to simultaneously reset and reregister with the Cisco CMTS. In addition, if HCCP N+1 redundancy
has also been configured, using the clear cable modem delete command can trigger a switchover to one
or more Protect interfaces, unless no keepalive has also been configured on the cable interfaces.
The following example shows how to delete all CMs that have a OUI that has been defined as having the
vendor name of Cisco using the cable modem vendor command:
Router# clear cable modem oui Cisco delete
Router#
The following example shows how to delete all CMs that are currently in one of the reject states:
Router# clear cable modem reject delete
Router#
clear cable modem {mac-addr | ip-addr | cable slot/port {all | oui string | reject} } flap-counters
clear cable modem {mac-addr | ip-addr | cable slot/subslot/port {all | oui string | reject} } flap-
counters
Syntax Description mac-addr Specifies the 48-bit hardware address (MAC address) of an individual
CM.
ip-addr Specifies the IP address of an individual CM.
cable slot/port Identifies the a interface and downstream port on the Cisco uBR7100
series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can
be 0 or 1, depending on the cable interface.
cable slot/subslot/port Identifies a cable interface on the Cisco uBR10012 router. The
following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
all Resets the flapping counters for all CMs.
oui string Resets the flapping counters for all CMs that match the specified
Organization Unique Identifier (OUI). The string parameter can be
either the three byte hexadecimal string (such as 00.00.0C) or a vendor
name that has been defined using the cable modem vendor command.
reject Resets the flapping counters for all CMs that are currently in one of the
reject states (see the description of these states in the show cable
modem command).
Examples The following example shows how to clear the counters for the CM at IP address 172.12.23.45:
Router# clear cable modem 172.12.23.45 flap-counters
Router#
The following example shows how to clear the counters for all CMs that have a OUI that has been defined
as having the vendor name of Cisco using the cable modem vendor command:
Router# clear cable modem oui Cisco flap-counters
Router#
The following example shows how to clear the counters for all CMs that are currently in one of the reject
states:
Router# clear cable modem reject flap-counters
Router#
Syntax Description mac-addr Specifies the 48-bit hardware address (MAC address) of an individual
CM.
ip-addr Specifies the IP address of an individual CM.
cable slot/port Identifies the a interface and downstream port on the Cisco uBR7100
series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can
be 0 or 1, depending on the cable interface.
cable slot/subslot/port Identifies a cable interface on the Cisco uBR10012 router. The
following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
all Resets the lock for all CMs.
oui string Resets the lock for all CMs from a vendor that matches the specified
Organization Unique Identifier (OUI). The string parameter can be
either the three byte hexadecimal string (such as 00.00.0C) or a vendor
name that has been defined using the cable modem vendor command.
Usage Guidelines When you have configured the cable dynamic-secret lock command on a cable interface, the CMTS
“locks” CMs that use a DOCSIS configuration file that fails the CMTS verification check. These CMs
are allowed to come online, but with a restrictive QoS configuration that limits their service flows to
10 kbps.
Locked CMs will not be allowed to reregister with a valid DOCSIS configuration file until they have
been offline, without attempting to reregister, for at least 24 hours. You can manually clear the lock on
a CM by using the clear cable modem lock command in privileged EXEC mode.
The clear cable modem lock command also automatically resets the CMs, so that they will reregister
with the CMTS. If the CMs then reregister with a valid DOCSIS configuration file, the CMTS will allow
the CMs to come online with the requested QoS profiles. If the CMs violate the DOCSIS specifications
again, they will be locked again.
Note If a CM is not manually unlocked, it remains locked until it stays offline, without attempting to
reregister, for 24 hours. It can also be unlocked by using the clear cable modem delete command to
manually remove the CM from all of the CMTS internal databases.
Examples The following example shows how to clear the lock for the CM with the MAC address of
0102.030F.0E.0D:
Router# clear cable modem 0102.030F.0E.0D lock
Router#
The following example shows how to clear the lock for the CM at IP address 172.12.23.45:
Router# clear cable modem 172.12.23.45 lock
Router#
The following example shows how to clear the locks for all CMs that have a OUI that has been defined
as having the vendor name of Cisco using the cable modem vendor command:
Router# clear cable modem oui Cisco lock
Router#
Syntax Description cable slot/port (Optional) Identifies the a interface and downstream port on the
Cisco uBR7100 series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can
be 0 or 1, depending on the cable interface.
cable slot/subslot/port (Optional) Identifies a cable interface on the Cisco uBR10012 router.
The following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
counters Clears the flap list counters for all CMs that are currently offline.
delete Removes all CMs that are currently offline from the router’s internal
tables. The show cable modem command will no longer display these
CMs until they attempt to reregister with the CMTS.
Examples The following example shows how to clear the counters for the offline CMs on a particular cable
interface:
Router# clear cable modem c3/0 offline counters
Router#
The following example shows how to delete all offline CMs from the router’s internal tables for a
particular cable interface, and to remove them from the show cable modem command displays:
Router# clear cable modem c3/0 offline delete
Router#
clear cable modem {mac-addr | ip-addr | [cable slot/port] {all | oui string | reject} } reset
clear cable modem {mac-addr | ip-addr | [cable slot/subslot/port] {all | oui string | reject} } reset
Syntax Description mac-addr Specifies the 48-bit hardware address (MAC address) of an individual
CM, or of any CPE devices or hosts behind that CM.
ip-addr Specifies the IP address of an individual CM, or of any CPE devices or
hosts behind that CM.
cable slot/port (Optional) Identifies the a interface and downstream port on the
Cisco uBR7100 series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can
be 0 or 1, depending on the cable interface.
cable slot/subslot/port (Optional) Identifies a cable interface on the Cisco uBR10012 router.
The following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
all Removes all the CMs from the Station Maintenance List. (This option
is valid only on the Release 12.1 EC train.)
oui string Removes and resets all CMs that match the specified Organization
Unique Identifier (OUI). The string parameter can be either the three
byte hexadecimal string (such as 00.00.0C) or a vendor name that has
been defined using the cable modem vendor command.
reject Removes and resets all CMs that are currently in one of the reject states
(see the description of these states in the show cable modem
command).
Release Modification
12.2(11)BC3 The all option was removed from the Release 12.2 BC train, and replaced
with the interface option.
12.2(15)BC1 The cable interface was made an optional keyword for this command.
Usage Guidelines This command instructs the Cisco CMTS to stop sending DOCSIS station maintenance messages to one
or more CMs, which effectively terminates the link to those CMs. A CM responds to this by resetting
itself. Depending on when the CM received the last station maintenance message, it can take up to 30
seconds before the CM detects the missing station maintenance messages and resets itself.
In some circumstances, the customer premises equipment (CPE) devices behind a CM stops receiving
traffic after the CM is reset. This is because the CMTS still has the CPE device listed in its address tables,
but the CM does not after being reset, so the traffic passes through the CMTS but is dropped by the CM.
To resolve this situation, the CPE device should simply send some type of traffic to the CM, such as a
ping packet. (You can also resolve this situation by using the clear arp-cache command on the
Cisco CMTS router to clear the router’s address table, but this is not recommended, because it
temporarily interrupts all traffic on the router.)
Note The clear cable modem all reset command can result in the CPU utilization temporarily reaching
100 percent for a couple of minutes, as the CPU processes the command for all CMs. The CPU
utilization will return to normal within a couple of minutes.
Caution The clear cable modem all reset command should normally be used only on a test or lab network. If
used on a large network, it could impact service for a significant period of time, as it would force all
CMs to simultaneously reset and reregister with the Cisco CMTS.
Tip You can also specify the MAC address or IP address for a CPE device or host, and the Cisco CMTS resets
the CM that is associated with that CPE device in its internal database.
The following example shows how to reset all CMs that have a OUI that has been defined as having the
vendor name of Cisco using the cable modem vendor command:
Router# clear cable modem oui Cisco reset
Router#
The following example shows how to reset all CMs that are currently in one of the reject states:
Router# clear cable modem reject reset
Router#
Related Commands
Command Description
clear cable flap-list Resets the flap-list table for a specific CM or for all CMs.
clear cable modem Resets the flapping counters of a CM to zero.
counters
clear cable modem Removes one or more CMs from the internal address and routing tables.
delete
clear cable modem Resets the lock on one or more CMs.
lock
clear cable modem Removes all offline CMs from the internal address and routing tables, or
offline clears all flap list counters for offline CMs.
show cable modem Displays the current status for one or more CMs.
clear cable secondary-ip interface cable slot/port [all | sid sid [ip-address]]
clear cable secondary-ip interface cable slot/subport/port [all | sid sid [ip-address]]
Syntax Description interface cable Identifies the cable interface and downstream port on the Cisco uBR7100
slot/port series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0
or 1, depending on the cable interface.
interface cable Identifies the cable interface on the Cisco uBR10012 router. The following
slot/subslot/port are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
all Specifies that all IP addresses in the secondary IP address table should be
cleared.
sid sid Specifies that all IP addresses for a particular Service ID (SID) should be
cleared. The valid range is 1 to 8191.
ip-address (Optional) Specifies that the IP address for a particular CM or CPE device
should be cleared.
Usage Guidelines To support BPI and BPI+ operations with CMs and CPE devices that use secondary IP addresses, the
CMTS maintains a database that links the known secondary IP addresses to the SIDs used by those
devices. When the CMTS and CM need to renew their public keys, the CMTS uses this database to
ensure that all IP addresses are sufficiently updated to allow proper routing and fast switching.
Tip You can display the list of known IP addresses per SID by using the show interface cable sid command.
If you encounter apparent problems with secondary IP addressing, or if you want to manually clear the
table of IP addresses for a particular SID, use the clear cable secondary-ip command.
Tip One possible situation that might occur is if a CM first assigns a secondary IP address to one CPE device,
but later that same IP address is assigned to another CPE device behind a different CM. If this happens,
the IP address will continue to show up as a secondary IP address for the original CM until that CM
renews its public keys. This will not affect network connectivity for either CPE or CM. You can,
however, clear the unneeded secondary IP address from the CMTS database using the clear cable
secondary-ip command.
Examples The following example shows how to clear all of the secondary IP addresses for a particular cable
interface:
Router# clear cable secondary-ip interface cable 3/0 all
Router#
The following example shows how to clear the secondary IP addresses for all CM and CPE devices on
cable interface 1/0 that are using SID 5:
Router# clear cable secondary-ip interface cable 1/0 sid 5
Router#
The following example shows how to clear the secondary IP addresses for the CM and CPE devices on
cable interface 5/0 that are using SID 113 and IP address 10.10.17.3:
Router# clear cable secondary-ip interface cable 5/0 sid 113 10.10.17.3
Router#
Syntax Description group Clears the counters for the specified group number. The valid range is 1 to
255.
all Clears the counters for all HCCP groups.
Usage Guidelines This command clears the counter that are displayed by the show hccp and show hccp interface
commands. You can clear the counters for a single HCCP group, or all HCCP groups.
Examples The following example shows the counters for group 1 being reset to 0:
Router# clear hccp 1 counters
Router#
The following example shows the counters for all groups being reset to 0:
Router# clear hccp all counters
Router#
Usage Guidelines This command clears the counter that tracks the total number of gates that the CMTS has moved into the
COMMITTED state since the CMTS was last reset or since the counters were last cleared. To display
the total number of committed gates, use the show packetcable gate and show packetcable gate
counter commit commands.
Examples The following example shows the committed gate counter being reset to zero:
Router# clear packetcable gate counter commit
Router#
cpe max
To create a DOCSIS configuration file that specifies the maximum number of CPE devices that can use
the CM to connect to the cable network, use the cpe max command in cable config-file configuration
mode. To remove the CPE specification, use the no form of this command.
no cpe max
Syntax Description cpe-num Specifies the number of CPEs. Valid range is 1 to 254.
Usage Guidelines The CM enforces the limitation imposed by the cpe max command, but the CMTS might enforce its own
lower number of CPE devices. On Cisco CMTS routers, a cpe-num value of 0 enables an unlimited
number of hosts, but on some CMs, this value provides only 0 hosts.
Examples The following example shows how to set the maximum CPE value for the configuration file:
router(config)# cable config-file channeloverride.cm
router(config-file)# cpe max 3
router(config-file)# exit
Command Description
snmp manager Specifies Simple Network Management Protocol (SNMP) options.
timestamp Enables time-stamp generation.
download
To create a DOCSIS configuration file that instructs the CM to download a new software image, use the
download command in cable config-file configuration mode. To disable the specification, use the no
form of this command.
Note Because of conflicts with other Cisco IOS commands, you cannot abbreviate the no form of this
command. You must specify the complete command name and option, such as no download image or
no download server.
Usage Guidelines This command sets the Software Upgrade Filename and Software Upgrade TFTP Server fields in the
DOCSIS configuration file. The DOCSIS specification allows the DOCSIS configuration file to specify
that the CM must be running a particular software image. If the CM is not currently using that image, it
must then download the image before continuing the registration process. For security, performance, and
scalability reasons, a particular TFTP server can be specified from which the CM must download the
new software image.
The filename specified by download image command must be a fully qualified file and pathname that
exactly matches the file and pathname as they exist on the TFTP download server. For example, if the
software image is named ubr920-k1v4y556i-mz and is in a subdirectory named cisco_cms on the TFTP
server, the filename specified with this command should be cisco_cms/ubr920-k1v4y556i-mz.
If the oui-list parameter is specified, the download image filename is provided only to the CMs that
contain those particular OUIs. This helps ensure that the CM does not download a software image that
is intended for another vendor’s CMs.
Note For each configuration file, multiple download images can be specified. Because each filename can be
listed only once, entering a different list of OUIs for a single filename clears the old list. To support more
than eight OUIs with the same file, use a different download software image name, and create a duplicate
file or alias on the TFTP server.
The download server command is not required. If it is not specified, the CM uses the same server that
provided its DOCSIS configuration file. However, the download server command requires that the
image filename also be specified using the download image command.
Examples The following command shows how to setup a DOCSIS configuration file so that the cable modem will
upgrade its software image:
router(config)# cable config-file upgrade.cm
router(config-file)# download image ubr920-k1v4y556i-mz.121-3a.T1 oui 00.50.73 00.D0.BA
00.D0.58 00.01.96
router(config-file)# download server 10.15.24.33
router(config-file)# exit
router(config)#
enabled
To activate an enforce-rule and begin subscriber traffic management, use the enabled command in
enforce-rule configuration mode. To disable the enforce-rule without deleting it, use the no form of this
command.
enabled
no enabled
Usage Guidelines An enforce-rule is created and configured using the cable qos enforce-rule command, but it is not
activated until you give the enabled command. Use the no enabled command to disable an enforce-rule
without removing it from the CMTS configuration. When you disable an enforce-rule, all cable modems
with that rule’s registered QoS profile are no longer tracked by the subscriber traffic management
feature.
The following example shows an enforce-rule being disabled. The rule remains in the CMTS
configuration file:
Router# configure terminal
Router(config)# cable qos enforce-rule residential
Router(enforce-rule)# no enabled
Router(enforce-rule)# exit
Router(config)#
enforced qos-profile
To specify a quality of service (QoS) profile that should be enforced when users violate their registered
QoS profiles, use the enforced qos-profile command in enforce-rule configuration mode. To delete the
enforced QoS profile from the enforce-rule, use the no form of this command.
Syntax Description profile-id Specifies the QoS profile to be enforced. The valid range is 0 to 16383,
with a default of 0.
Note Both the originally provisioned QoS profile and the enforced
QoS profile must be created on the Cisco CMTS. This option
does not support profiles that are created by the CM.
no-persistence (Optional) Specifies that the enforced QoS profile should not remain
in force when a cable modem reboots. Instead, when a cable modem
that is in the penalty period reboots, it is automatically removed from
the penalty period and assigned the QoS profile that is specified in its
DOCSIS configuration file.
The default is without this option, so that enforced QoS profiles remain
in force for cable modems across reboots.
Defaults The profile-id defaults to 0, and enforced QoS profiles are persistent across cable modem reboots.
Usage Guidelines An enforce-rule can specify an enforced QoS profile, which is automatically applied to subscribers that
transmit more traffic than what is allowed by their registered QoS profile. The enforced QoS profile
remains in effect during the penalty time period (see the penalty-period command). At the end of the
penalty period, the subscriber returns to their registered QoS profile.
If a cable modem reboots while it is in its penalty time period, it continues using the enforced QoS
profile, unless the service provider has manually changed the modem’s registered QoS profile using the
cable modem qos profile command.
When you change the enforced QoS profile for a currently active enforce-rule, any cable modems using
this rule that are currently in the penalty period continue using the previously configured enforced QoS
profile. Any cable modems that enter the penalty period after this configuration change, however, use
the new enforced QoS profile.
An enforced QoS profile must have been already created on the CMTS before you can assign it to an
enforce-rule. If the rule does not exist, the system displays an error message.
When the no-persistence option is specified, the enforced QoS profile is still automatically applied to
subscribers that violate their bandwidth requirements. However, when the cable modem reboots, the
Cisco CMTS allows the cable modem to use the QoS profile that is specified in its DOCSIS
configuration file.
The no-persistence option can be used when initially using the subscriber traffic management option so
as to identify potential problem applications and users. When repeat offenders are identified, they can
then be assigned enforce-rules that do not use the no-persistence option, so that they remain in the
penalty period even if they reboot their cable modems.
Note The system automatically applies the enforced QoS profile to violators only if the enforce option has
been used with the activate-rule at-byte-count command.
Examples The following example shows profile 12 being assigned as the enforced QoS profile to an enforce-rule:
Router# configure terminal
Router(config)# cable qos enforce-rule residential
Router(enforce-rule)# enforced qos-profile 12
Router(enforce-rule)# exit
Router(config)#
The following example shows profile 12 being assigned as the enforced QoS profile to an enforce-rule,
but with the no-persistence option specified, so that the enforced QoS profile does not remain in force
if the cable modem reboots:
Router# configure terminal
Router(config)# cable qos enforce-rule residential
Router(enforce-rule)# enforced qos-profile 12 no-persistence
Router(enforce-rule)# exit
Router(config)#
The following example shows the error message that is displayed when the specified QoS profile does
not exist on the CMTS:
Router# configure terminal
Router(config)# cable qos enforce-rule test
Router(enforce-rule)# enforced qos-profile 98
Router(enforce-rule)#
Command Description
penalty-period Specifies the time period that an enforced quality of service (QoS) profile
should be used for subscribers that violate their registered QoS profile.
registered qos-profile Specifies the registered Quality of Service (QoS) profile that should be used
for this enforce-rule.
show cable qos Displays the quality of service (QoS) enforce-rules that are currently
enforce-rule defined.
show cable Displays subscribers that are violating their registered quality of service
subscriber-usage (QoS) profiles.
frequency
To create a DOCSIS configuration file that specifies the center frequency for downstream channel for a
CM, use the frequency command in cable config-file configuration mode. To remove the downstream
channel frequency, use the no form of this command.
frequency freq
no frequency freq
Syntax Description freq Specifies the downstream frequency in multiples of 62500 Hz. Valid range
is 88 to 860 MHz.
Defaults The CM defaults to scanning the downstream for available downstream frequencies.
Usage Guidelines This command typically is not used because the CM during its registration process scans the downstream
frequency spectrum for an available downstream channel. If the CM finds a channel and can successfully
lock on it, the CM uses that channel until the CMTS instructs otherwise.
However, there could be situations in which you want to specify that a CM should use a specific
downstream center frequency. In these situations, use the frequency command to require the CM to use
that frequency. For example, specifying a particular center frequency can improve the ability of the
network to recover when a CM loses downstream lock, because it retries only the one frequency instead
of scanning the entire downstream spectrum.
Note The frequency specified by the configuration file must match the output frequency of the upconverter;
otherwise, the CM cycles offline each time the configuration file is received.
Examples The following example shows how to specify the downstream center frequency for a DOCSIS
configuration file:
router(config)# cable config-file fixedfreq.cm
router(config-file)# frequency 453000000
router(config)# exit
hccp authentication
To specify the authentication algorithm on a Working CMTS, Protect CMTS, or both use the hccp
authentication command in cable interface configuration mode. To disable authentication on a Working
CMTS or Protect CMTS, use the no form of this command.
Syntax Description group The group number for the specified interface. Valid values are any number
from 1 to 255, inclusive.
md5 Authentication algorithm. In Cisco IOS Release 12.1(3a)EC, MD5 is the
only authentication algorithm supported.
text Unencrypted text specification. Rather than automatically encrypting the
authentication key-chain when using the MD5 authentication algorithm,
Cisco IOS software simply passes the authentication key-chain as standard,
unencrypted text.
Usage Guidelines Use this command together with the hccp authentication key-chain command to enable and specify the
type of 1+1 redundancy authentication you will use in your protection scheme.
Examples The following example shows how to specify MD5 as the authentication algorithm for group 1:
router(config-if)# hccp 1 authentication md5
Syntax Description group The group number for the specified interface. Valid values are any number
from 1 to 255, inclusive.
key-chain A text string matching a key chain in the Working CMTS or Protect CMTS
configuration file. A key chain must have at least one key and can have up
to 2,147,483,647 keys.
Usage Guidelines Use this command in conjunction with the hccp authentication command to enable and specify the type
of 1+1 redundancy authentication you will use in your protection scheme.
Note You cannot perform authentication on a specified group until you have first defined at least one
authentication key chain in global configuration mode.
Examples The following excerpt from a configuration file enables authentication using the MD5 algorithm and
defines the authentication key “cisco1” for group 1:
!
key chain cisco1
key 1
key-string abcdefg
key 2
key-string 123456789
!
...
!
interface cable 3/0
hccp 1 authentication md5
hccp 1 authentication key-chain cisco1
!
Syntax Description group The group number for the specified interface. The valid range is 1 to 255.
Defaults Normal HCCP operations (hccp group check version), where hardware and software version checks are
made between the Working and Protect cable interface line cards.
Usage Guidelines By default, the Cisco CMTS verifies that the Working and Protect cable interfaces are using the same
versions of software and hardware, so as to avoid potential incompatibilities during a switchover. The
hardware check verifies that the Working and Protect cable interface line cards are compatible. The
software check verifies that the two cards are running the same major versions of software. If either of
these two conditions is not true, the CMTS by default does not perform the switchover.
You can override these version checks for a particular HCCP group by using the hccp bypass version
command. After you give this command, the Cisco CMTS does not check the hardware or software
versions of the two cable interfaces before performing a switchover. To return to normal HCCP
operations, so that version checks are made for a group, use the hccp check version command.
Note Two cable interface line cards are compatible when the Protect card has at least the same number of
upstreams or downstreams as the Working card. The exceptions to this are that the Cisco uBR-MC16E
card can be protected only by another Cisco uBR-MC16E card. Also, the DOCSIS versions of the
Cisco uBR-MC16 card can be protected only by another Cisco uBR-MC16C card. You cannot use the
Cisco uBR-MC28C card to protect a Cisco uBR-MC16B/C/S card.
Examples The following example shows how to disable the hardware and software version checks for HCCP group
number 20. After giving this command, the Cisco CMTS will switchover from the Working to Protect
interface in group 20 without first verifying the cards’ compatibility:
Router# hccp 20 bypass version
Router#
hccp channel-switch
To configure the Cisco CMTS so that a Cisco RF Switch or VCom (Wavecom) upconverter becomes a
Hot Standby Connection-to-Connection Protocol (HCCP) member in a particular HCCP group, use the
hccp channel-switch command in cable interface configuration mode. To remove the configuration for
the Cisco RF Wwitch or upconverter, use the no form of this command.
hccp group channel-switch member-id switch-name tty-switch [aux | console | vty] line-number
port
Syntax Description group The group number for the specified interface. The valid range is 1 to 255.
member-id The member number within the specified group. The valid range is 1 to 255.
switch-name (Optional) Alpha-numeric string specifies the name of the
Cisco RF Switch.
rfswitch-group Specifies that this is the configuration for a Cisco RF Switch group.
rfswitch-module Specifies that this is the configuration for a Cisco RF Switch module.
rfswitch-ip-address Specifies the IP address of the Cisco RF Switch to which the CMTS is
connected.
module-bitmap Specifies the module-bitmap in hexadecimal. The valid range is 0 to
FFFFFFFF.
Tip See the TAC-authored N+1 Tips and Configuration document on
Cisco.com for more information on the format of the bitmap, and
for a worksheet that can be used to calculate the bitmap.
module-number Specifies the module number on the Cisco RF Switch. The valid range is 1
to 255.
Note This setting must be configured on the Cisco RF Switch as well as
the Cisco CMTS.
position Specifies the position for the Working channel on the Cisco RF Switch. The
valid range is 1 to 8.
tty-switch Specifies the configuration of a Cisco RF Switch that is controlled by its
TTY line. You can further specify the type of port being used to control the
switch. By default, one of the Cisco RF Switch’s serial ports is used, or you
can use the aux, console, or vty lines.
Note Ensure that the switch’s DIP switch is set to 00.
aux (Optional) Specifies that the auxiliary port is being used to control the
Cisco RF Switch.
console (Optional) Specifies that the console port is being used to control the
Cisco RF Switch.
vty (Optional) Specifies that a Virtual Terminal connection (Telnet connection)
is being used to control the Cisco RF Switch.
line-number Specifies the line number on which the Cisco RF Switch is receiving control
information for this CMTS. The valid range is 0 to 17 for the default serial
port, 0 for the aux port, 0 for the console port, and 0 to 99 for the vty port.
port Specifies the port number being used on the Cisco RF Switch. The valid
range is 1 to 255.
wavecom-hd Specifies that this is the configuration for a VCom (Wavecom) HD4040 and
QHD4040 upconverter.
wavecom-ma Specifies that this is the configuration for a VCom (Wavecom)
DUAL4040D, MA4040D, or UC4040D upconverter.
prot-ip-address Specifies the IP address for the upconverter used for the Protect interface
used for this cable interface.
protect-module Specifies the module number on the upconverter used for the Protect
interface to be used for this cable interface. The valid range is 1 to 255.
work-ip-address Specifies the IP address for the upconverter used for the Working interface
used for this cable interface.
work-module Specifies the module number on the upconverter used for the Working
interface to be used for this cable interface. The valid range is 1 to 255.
Defaults The CMTS is not configured to use a Cisco RF Switch by default, and no cable interfaces are configured
for N+1 redundancy by default.
Usage Guidelines You must configure each Working and Protect cable interface for use with the Cisco RF Switch, typically
specifying one hccp channel-switch command to configure the Cisco RF Switch information, and
another hccp channel-switch command to configure the upconverter.
The Protect interface is configured with the same hccp channel-switch commands as those that are used
on the Working interface. However, typically, the same Protect interface is configured with multiple
hccp channel-switch commands to protect multiple Working interfaces.
Examples The following example shows the cable interface 8/1/0 being configured as member 1 for the Working
interface of HCCP group 1. This interface is configured to use the Wavecom HD4040 upconverter with
the IP address of 10.97.1.21. The upconverter’s module number 2 (B) is used for the Protect interface,
and module number 16 (P) is used for the Working interface. The interface uses the Cisco RF Switch at
IP address 10.97.1.20, using a module bitmap of AA200000 in switch slot 1.
Router# configure terminal
Router(config)# interface cable8/1/0
Router(config-if)# hccp 1 working 1
Router(config-if)# hccp 1 channel-switch 1 uc wavecom-hd 10.97.1.21 2 10.97.1.21 16
Router(config-if)# hccp 1 channel-switch 1 rfswitch rfswitch-group 10.97.1.20 AA200000 1
The following example shows the corresponding configuration for the Protect interface for member 1 of
HCCP group 1, which is cable interface 5/1/0 on the same chassis. The hccp channel-switch commands
are identical to those used for cable interface 8/1/0.
Router# configure terminal
Router(config)# interface cable5/1/0
Router(config-if)# hccp 1 protect 1 10.97.1.8
Router(config-if)# hccp 1 channel-switch 1 uc wavecom-hd 10.97.1.21 2 10.97.1.21 16
Router(config-if)# hccp 1 channel-switch 1 rfswitch rfswitch-group 10.97.1.20 AA200000 1
Typically, the same Protect interface is used to protect multiple Working cable interfaces. For example,
this same interface could be configured as follows to protect a Working interface that is using module
number 14 (N) on the same Wavecom HD4040 upconverter, using slot 2 in the RF Switch.
Router# configure terminal
Router(config)# interface cable5/1/0
Router(config-if)# hccp 1 protect 2 10.97.1.8
Router(config-if)# hccp 1 channel-switch 2 uc wavecom-hd 10.97.1.21 2 10.97.1.21 14
Router(config-if)# hccp 1 channel-switch 2 rfswitch rfswitch-group 10.97.1.20 AA200000 2
Syntax Description group The group number for the specified interface. The valid range is 1 to 255.
Defaults Normal HCCP operations (hccp group check version), where hardware and software version checks are
made between the Working and Protect cable interface line cards.
Usage Guidelines By default, the Cisco CMTS verifies that the Working and Protect cable interfaces are using the same
versions of software and hardware, so as to avoid potential incompatibilities during a switchover. The
hardware check verifies that the Working and Protect cable interface line cards are compatible. The
software check verifies that the two cards are running the same major versions of software. If either of
these two conditions is not true, the CMTS by default does not perform the switchover.
You can override these version checks for a particular HCCP group by using the hccp bypass version
command. After you give this command, the Cisco CMTS does not check the hardware or software
versions of the two cable interfaces before performing a switchover. To return to normal HCCP
operations, so that version checks are made for a group, use the hccp check version command.
Note Two cable interface line cards are compatible when the Protect card has at least the same number of
upstreams or downstreams as the Working card. The exceptions to this are that the Cisco uBR-MC16E
card can be protected only by another Cisco uBR-MC16E card. Also, the DOCSIS versions of the
Cisco uBR-MC16 card can be protected only by another Cisco uBR-MC16C card. You cannot use the
Cisco uBR-MC28C card to protect a Cisco uBR-MC16B/C/S card.
Examples The following example shows how to cancel a previous hccp bypass version command for HCCP
group 1 and to return to normal HCCP operations:
Router# hccp 1 check version
Router#
hccp ds-switch
To specify the downstream upconverter module for a Working CMTS or Protect CMTS, use the hccp ds-
switch command in cable interface configuration mode. To negate a downstream upconverter
assignment, use the no form of this command.
Note This command has been deprecated in current Cisco IOS releases and has been replaced by the hccp
channel-switch command.
Syntax Description group The group number for the specified interface. Valid values are any number
from 1 to 255, inclusive.
member The member number within the specified group.
make The maker of the specified upconverter. Currently, only the Wavecom
upconverter is supported (wavecom).
host-ipaddr The IP address of the upconverter module1 to which the host CMTS is
connected.
host-module The upconverter module number to which the host CMTS is connected. This
location is expressed as a simple numeric designation.
peer-ipaddr The IP address of the upconverter module to which the peer (or remote)
CMTS is connected.
peer-module The upconverter module number1 to which the peer (or remote) CMTS is
connected. This location is expressed as a simple numeric designation.
1. The identification of the upconverter module is important to define when the host or peer CMTS is connected to a channel
switch housing multiple modules. For example, the Wavecom MA4040D upconverter chassis offers a maximum of 10
independent frequency agile upconverters.
Defaults Upconverter specification and activation is disabled by default and must be specified before switching
can take place.
Usage Guidelines It is necessary to configure the downstream upconverter module for all Protect CMTS and Working
CMTS systems. If you do not specify the downstream upconverter module for all Protect CMTS and
Working CMTS systems, you cannot switch between a Protect CMTS and Working CMTS.
Examples The following excerpt from a configuration file specifies module 2 on a Wavecom upconverter at IP
address 1.1.11.3 as the host switch module connected to Working CMTS 1 and module 1 on the same
Wavecom upconverter (with the same IP address location) as the peer or remote switch module
connected to the Protect CMTS:
hccp 1 working 1
hccp ds-switch 1 wavecom 1.1.11.3 2 1.1.11.3 1
hccp lockout
To prevent a Working CMTS from automatically switching to a Protect CMTS in the same group, use
the hccp lockout command in privileged EXEC mode.
Note This command is applicable only to Working CMTS in a given group. Issuing this command on a Protect
CMTS has no effect.
Syntax Description group The group number for the specified interface. Valid values are any number
from 1 to 255, inclusive.
member The member number within the specified group.
Usage Guidelines Typically the hccp lockout command is used to disable HCCP switchovers before removing the HCCP
configuration on the Working interface. Otherwise, when you remove the HCCP configuration from the
Working interface, the Protect interface assumes the Working interface has failed and switches over.
You might also want to prevent a Working CMTS from automatically switching back to a Protect CMTS
for testing or additional configuration purposes. For example, you might want to fully test protecting
cable interfaces on your Cisco CMTS before returning it to protect status.
Examples The following example shows how to activate the lockout feature of a Working CMTS in group 1:
router# hccp 1 lockout
hccp protect
To configure a particular cable interface to protect another cable interface in the same group, use the
hccp protect command in cable interface configuration mode. To undo a particular host cable interface
protection assignment, use the no form of this command.
Syntax Description group The group number of both the Working and Protect cable interfaces. Valid
values are any number from 1 to 255, inclusive.
member The member number of the specified Working cable interface. Valid values
are any number from 1 to 255, inclusive.
ipaddr An IP address for any working interface (other than protected cable
interfaces) installed in the Working CMTS that can transmit and receive
redundancy status messages.
Usage Guidelines The protect cable interface must be configured identically to the working cable interface, which typically
means the interfaces must be the same card type. However, when the Cisco uBR-MC16S card is used, it
can be used with either another Cisco uBR-MC16S card or a Cisco uBR-MC16C card.
Table 2-15 shows how a switchover affects the enhanced spectrum management features of the
Cisco uBR-MC16S card.
Examples The following example configures host cable interface 4/0 to protect member 2 of group 2 at
IP address 1.1.11.2:
Router(config)# interface cable 4/0
Router(config-if)# hccp 2 protect 2 1.1.11.2
hccp resync
To manually synchronize the Inter-database between the Working and Protect interfaces for a particular
member in an Hot Standby Connection-to-Connection Protocol (HCCP) group, use the hccp resync
command in privileged EXEC mode.
Syntax Description group The group number for the specified interface. The valid range is 1 to 255.
member The member ID to be resynchronized. The valid range is 1 to 255.
Usage Guidelines The Cisco CMTS automatically synchronizes the Working and Protect interfaces to ensure that when a
switchover occurs, the Protect interface will run with a configuration that is identical to that of the
Working interface. However, if you are troubleshooting HCCP problems, you can manually
resynchronize the databases using the hccp resync command before performing any switchover tests.
Note When a SYNC event command is occurring, CLI commands might be very slow to respond. In particular,
if you enter a show command at the same time a SYNC event is occurring, the command might respond
produce a blank display, or it might display an error message similar to the following:
Examples The following example shows how to manually resynchronize the Inter-database between the Working
and Protect interfaces for member 4 in HCCP group 13:
Router# hccp 13 resync 4
Router#
hccp revertive
To configure a cable interface on a Protect CMTS that has assumed working capacity to automatically
revert back to the Working CMTS, use the hccp revertive command in cable interface configuration
mode. To disable the ability for the specified cable interface to automatically revert back to protect
status, use the no form of this command.
Syntax Description group The group number for the specified interface. Valid values are any number
from 1 to 255, inclusive.
Defaults Disabled
Note This command is disabled by default because some customers may want to perform testing or other such
activity on the Protect CMTS working peer before restoring it to working status.
Usage Guidelines Using this command in conjunction with the hccp reverttime command gives you the ability to set up
your protecting cable interfaces to automatically switch between working and protecting capacity
without your intervention. Otherwise, whenever a switchover has occurred, you must manually
reactivate the failed Working CMTS and manually return the Protect CMTS to protect status using the
hccp switch command.
Tip If you are using the hccp revertive command on a cable interface, do not also configure the hccp track
command. Configuring both commands on the same interface can cause multiple switchovers on the
same fault.
Examples The following example shows cable interface 4/0 on a Protect CMTS in group 2 being configured to
automatically revert to protect status after the Working CMTS peer has returned to active duty:
router(config)# interface cable 4/0
router(config-if)# hccp 2 revertive
hccp reverttime
To specify the amount of time a Protect interface waits before automatically reverting back to a Working
interface following a system switchover, use the hccp reverttime command in cable interface
configuration mode on the Working CMTS. To set the revert-time back to its default value, use the no
form of this command.
Syntax Description group The group number for the specified interface. Valid values are any number
from 1 to 255, inclusive.
revert-time The amount of time (in minutes) that a Protect interface waits before
automatically switching back to a Working interface following a system
switchover. The allowable range is 1 to 65,535 minutes, with a default of 30
minutes.
Defaults 30 minutes
Command Modes Interface configuration (cable interface only, on the Working CMTS)
Usage Guidelines Use this command to configure the revert-time on the cable interfaces on the Working CMTS so that the
Working CMTS will automatically resume normal operations and the Protect CMTS will automatically
resume normal protect operations, in case an operator forgets to manually switch the Working CMTS
back into operation after fixing the original problem.
The Working CMTS first counts down two minutes of suspend time before starting to count down the
revert-time. Any failures that occur within this two-minute suspend time are considered part of the same
failure.
This means that the actual time that the Working CMTS will attempt to switch back after a switchover
is two minutes plus the revert-time. For example, if the revert-time is set to its default of 30 minutes, the
Working CMTS will attempt to switch back into operation 32 minutes after the initial switchover to the
Protect CMTS.
After the suspend time has occurred, a failure in the Protect CMTS will cause a switchover to the
Working CMTS, regardless of whether the revert-time has expired or not. You can force such a failure
in the Protect CMTS, and restore the Working CMTS to operation without waiting for the revert-time,
by using the cable power off and cable power on commands to turn off and turn on the protect interface
on the Protect CMTS.
When choosing a revert-time, take into account all possible sources of failures, including third-party
equipment. For example, an upconverter failure can trigger a switchover to the Protect CMTS. You
should configure the revert-time so that the Working CMTS does not switch back into operation until
technicians have had sufficient time to fix the equipment failure.
Tip To disable the revert-time feature, use the no version of the hccp revertive command on the Protect
CMTS.
Examples The following example shows cable interface 3/0 on a Working CMTS in group 2 being configured to
wait 15 minutes before automatically reverting back to working status after a system switchover:
router(config)# interface cable 3/0
router(config-if)# hccp 2 reverttime 15
The following example shows how to give the no form of this command, which resets the interface back
to its default value of 30 minutes.
router(config)# interface cable 5/1/0
router(config-if)# no hccp 2 reverttime
hccp switch
To manually switch a Protect CMTS with its Working CMTS peer (or vice versa), use the hccp switch
command in privileged EXEC mode.
Syntax Description group The group number for the specified interface. Valid values are any number
from 1 to 255, inclusive.
member The member number for the specified interface. Valid values are any
number from 1 to 255, inclusive.
Usage Guidelines This command overrides any configuration you may have made on your Protect CMTS and Working
CMTS using the hccp revert and hccp reverttime commands. In addition, you can issue the hccp
switch command on either a Protect CMTS or a Working CMTS to force it to change places with its peer.
Examples The following example shows the host Protect CMTS being configured to assume traffic responsibility
for member 2 Working CMTS in group 2:
router# hccp 2 switch 2
hccp timers
To configure HELLO packet interval and hold time for a specified group on a Protect CMTS, use the
hccp timers command in cable interface configuration mode. To erase the HELLO interval and hold
time configuration and to assume the default values for each parameter, use the no form of this
command.
Note Issuing the no form of this command erases any manual HELLO interval and hold time values and
automatically resets them to their default values.
Syntax Description group The group number for the specified interface. Valid values are any number
from 1 to 255, inclusive.
hello-time The HELLO packet interval (in milliseconds) between subsequent HELLO
packet transmissions. The acceptable range is 1666 to 5,000 milliseconds,
inclusive.
hold-time The time (in milliseconds) that a Protect CMTS will wait before assuming
control of voice traffic for a Working CMTS that has failed to acknowledge
a series of HELLO packets. The acceptable range is 5,000 to 25,000
milliseconds, inclusive.
Defaults The default HELLO interval is 2,000 milliseconds, and the default hold time is 6,000 milliseconds.
Examples The following example shows the HELLO interval and hold time on a Protect CMTS in group 2 being
configured to 1,750 and 3,000 milliseconds, respectively:
router(config)# interval c4/0
router(config-if)# hccp 2 timers 1750 3000
hccp track
To configure a cable interface on a Working CMTS or Protect CMTS to enable automatic switchover
based on the interface state, use the hccp track command in cable interface configuration mode. To
disable the automatic switchover based on interface state, use the no form of this command.
Syntax Description group The group number for the specified interface. Valid values are any number
from 1 to 255, inclusive.
interface Specifies another cable interface (the default is the current cable interface).
Usage Guidelines This command enables automatic switchover of one interface when a tracked interface switches over
from “up” to “down.”
Typically, this command is used to allow all interfaces on one card to track one another, so that if one
interface goes down and switches over to the Protect, all other interfaces can also switch over, allowing
the Protect card to assume full operation for these interfaces. This allows support engineers to
troubleshoot the problem on the Working interface, or to remove and replace the Working card, if
necessary, without interfering with traffic.
Examples The following example shows switchover behavior being enabled on a Cisco CMTS in group 2:
Router(config)# interface c3/0
Router(config-if)# hccp 2 track
Router(config-if)# keepalive
Router(config-if)#
The following example shows two Cisco uBR-LCP2-MC28C cards being used in a Cisco uBR10012
router, with each downstream being configured for a separate HCCP group. The card in slot 5/1 is being
configured as the Working interfaces and the card in slot 6/1 is being configured as the Protect interfaces.
The two downstreams on each card track each other, so if one downstream fails and switches over, the
other can do so as well, allowing the Protect card to assume full control of both interfaces. Similarly,
when the Working interfaces come back into service, both Protect interfaces switch back at the same
time.
Router(config)# interface cable c5/1/0
Router(config-if)# hccp 1 working 1
Router(config-if)# hccp 1 track c5/1/1
Router(config-if)# keepalive 3
Router(config-if)# exit
Router(config)# interface cable c5/1/1
Router(config-if)# hccp 2 working 1
Router(config-if)# hccp 2 track c5/1/0
Router(config-if)# keepalive 3
Router(config-if)# exit
Router(config)# interface cable c6/1/0
Router(config-if)# hccp 1 protect 1 ip-address-of-mgmt-lan
Router(config-if)# hccp 1 track c6/1/1
Router(config-if)# keepalive 3
Router(config-if)# exit
Router(config)# interface cable c6/1/1
Router(config-if)# hccp 2 protect 1 ip-address-of-mgmt-lan
Router(config-if)# hccp 2 track c6/1/0
Router(config-if)# keepalive 3
Router(config-if)#
hccp unlockout
To reverse the effects of the hccp lockout command—that is, to make a Working CMTS available for
automatic switchover to Protect CMTS, use the hccp unlockout command in privileged EXEC mode.
Syntax Description group The group number for the specified interface. Valid values are any number
from 1 to 255, inclusive.
member The member number within the specified group.
Defaults By default, the hccp unlockout command is active for all groups and members.
Usage Guidelines This command reverses the effect of the hccp lockout command. Once you have reconfigured or tested
your Protect CMTS, issuing this command manually reintroduces the CMTS back into your 1+1
redundancy protection scheme.
Note This command is applicable only on a Working CMTS in a given group. Issuing this command on a
Protect CMTS has no effect.
Examples The following example shows the lockout feature of a Working CMTS in group 1 being deactivated:
hccp 1 unlockout
hccp working
To designate a cable interface on a CMTS in the specified group to be a Working CMTS, use the hccp
working command in cable interface configuration mode. To remove a Working CMTS assignment, use
the no form of this command.
Syntax Description group The group number for the specified interface. Valid values are any number
from 1 to 255, inclusive.
member The member number for the specified interface. Valid values are any
number from 1 to 255, inclusive.
Usage Guidelines When N+1 HCCP redundancy is configured, the Protect interface switches over and becomes the active
interface when it detects a situation similar to the following:
• The Working interface is removed from the chassis, is powered down, or is reset
• The Working interface crashes
• The Working interface no longer sends out regular keepalive messages
• The Working interface loses connectivity with the cable network
The Protect cable interface must be configured identically to the Working cable interface, which
typically means the interfaces should be the same card type. However, when the Cisco uBR-MC16S is
used, it can be used with either another Cisco uBR-MC16S card or a Cisco uBR-MC16C card.
Table 2-15 shows how a switchover affects the enhanced spectrum management features of the
Cisco uBR-MC16S card.
Examples The following example shows cable interface 4/0 being designated as a Working CMTS interface as
member number 2 of group 2:
Router(config)# interface cable 4/0
Router(config-if)# hccp 2 working 2
Usage Guidelines This functionality enables a DHCP server to identify the user (CM) sending the request. When this
option is enabled, the CMTS inserts the DHCP relay agent information option (also called option 82),
which contains the CM or host MAC address, in forwarded BOOTREQUEST messages.
Examples The following example shows how to enable the insertion of DHCP relay agent information into DHCP
packets:
Router# configure terminal
Router(config)# ip dhcp relay information option
Command Description
cable relay-agent-option Enables the system to insert the CM MAC address into a DHCP
packet received from a CM or host and forward the packet to a DHCP
server.
cable source-verify Turns on CM upstream verification.
cable telco-return spd dhcp- Enforces the telco-return CM to use a specific Dynamic Host
authenticate Configuration Protocol (DHCP) server.
cable telco-return spd dhcp- Identifies the IP address of the Dynamic Host Configuration Protocol
server (DHCP) server that the telco-return CM must access.
ip dhcp smart-relay Monitors client retransmissions when the IP DHCP address pool
depletion occurs.
ip dhcp smart-relay
To monitor client retransmissions when address pool depletion occurs, use the ip dhcp smart-relay in
global configuration mode. To disable this function, use the no form of this command.
ip dhcp smart-relay
no ip dhcp smart-relay
Usage Guidelines When relay detects excessive retransmissions, it changes the GIADDR, which in turn causes the server
to index a different address pool.
Examples The following example shows how to enable the insertion of DHCP smart relay agent information into
DHCP packets:
Router# configure terminal
Router(config)# ip dhcp smart-relay
Command Description
cable telco-return spd dhcp- Identifies the IP address of the DHCP server that the telco-return CM
server must access.
ip dhcp relay information Enables the system to insert the CM MAC address into a DHCP
option packet received from a CM or host and forward the packet to a DHCP
server.
monitoring-duration
To specify the time period and sample rate to be used for monitoring subscribers, use the monitoring-
duration command in enforce-rule configuration mode. To reset an enforce-rule to its default values,
use the no form of this command.
no monitoring-duration
Syntax Description minutes The valid range is 10 to 10080 minutes, with a default of 360 minutes
(6 hours).
sample-rate minutes (Optional) Rate of sampling, in minutes. The valid range is 1 to 30
minutes, with a default value of 15 minutes.
Note The sample-rate minutes must be less than or equal to the
monitoring-duration minutes period.
Defaults The monitoring-duration value defaults to 360 minutes (6 hours), and the sample-interval value
defaults to 15 minutes.
Usage Guidelines When you an enable an enforce-rule, the CMTS periodically checks the bandwidth being used by
subscribers, so as to determine whether any subscribers are consuming more bandwidth than that
specified by their registered QoS profile. The CMTS keeps track of the subscribers using a sliding
window that begins at each sample-rate interval and continues for the monitoring-duration period.
For example, with the default sample-rate interval of 15 minutes and the default monitoring-duration
window of 360 minutes, the CMTS samples the bandwidth usage every 15 minutes and determines the
total bytes transmitted at the end of each 360 minute period. Each sample-rate interval begins a new
sliding window period for which the CMTS keeps track of the total bytes transmitted.
Note The sample-rate interval must be less than or equal to the monitoring-duration period. If you attempt
to set the sample-rate to a value greater than the monitor-duration period, the command is ignored and
the parameters are unchanged.
Figure 1 illustrates how this process works, with a new sliding window beginning at the beginning of
each sample-rate interval period.
Sample-Rate Intervals
Monitoring-Duration
Window 1
Monitoring-Duration
Window 2
Monitoring-Duration
Window 3
Monitoring-Duration
Window 4
88817
...
When you change the configuration of a currently active enforce-rule, that rule begins using the new
configuration immediately to manage the cable modems tracked by this enforce-rule.
Examples The following example shows an enforce-rule being configured for a monitoring window that is 20
minutes in length, with a sampling rate of every 10 minutes.
Router# configure terminal
Router(config)# cable qos enforce-rule residential
Router(enforce-rule)# monitoring-duration 20 sample-interval 10
Router(enforce-rule)# exit
Router(config)#
The following example shows the error message that is displayed when the sample-rate period is
configured to be greater than the monitoring-duration period. In this situation, the command is ignored
and the parameters remain unchanged:
Router# configure terminal
Router(config)# cable qos enforce-rule residential
Router(enforce-rule)# monitoring-duration 20 sample-interval 30
Monitoring duration cannot be less than the Sampling interval -- so the values
would remain unchanged
Router(enforce-rule)#
Command Description
enabled Activates an enforce-rule and begins subscriber traffic management.
enforced qos-profile Specifies the quality of service (QoS) profile that should be enforced when
users violate their assigned QoS profiles.
penalty-period Specifies the time period that an enforced quality of service (QoS) profile
should be used for subscribers that violate their registered QoS profile.
registered qos-profile Specifies the registered Quality of Service (QoS) profile that should be used
for this enforce-rule.
show cable qos Displays the quality of service (QoS) enforce-rules that are currently
enforce-rule defined.
show cable Displays subscribers that are violating their registered quality of service
subscriber-usage (QoS) profiles.
option
To create a DOCSIS configuration file that specifies vendor-specific information fields, or other options
that are not available through the other cable config-file commands, use the option command in cable
config-file configuration mode. To remove the entry for this option, use the no form of this command.
no option n
Syntax Description n Specifies the configuration file option code. Valid range is 5 to 254.
Note Certain values between 5 and 254 are not allowed. See Table 2-19 for
more information.
instance inst-num (Optional) Specifies the instance of this option, so that you can give the same
option multiple times. Valid range is 0 to 255.
ascii string Specifies that the data is a network verification tool (NVT) ASCII string. If
the string contains white space, you must surround it with quotation marks.
hex hexstring Specifies the data as a raw hexadecimal string. Each byte in the hexadecimal
string is two hexadecimal digits—each byte can be separated by a period,
colon, or white space. A maximum of 254 bytes can be specified.
Note The hex option must be used to specify the data in the DOCSIS
Type/Length/Value (TLV) format when using the vendor-specific
option (option 43).
ip ip-address Specifies an IP address.
Usage Guidelines The DOCSIS specification provides for a great many options and parameters in the DOCSIS
configuration files. In particular, it allows unspecified vendor-specific options that can vary from vendor
to vendor and from model to model. To create a DOCSIS configuration file that references these options,
use the option command.
The option command allows you to specify configuration file parameters that are not defined by the
other cable config-file options. These options are defined in the DOCSIS Radio Frequency (RF)
Interface Specification. However, certain options are not allowed because they are either reserved for
DOCSIS use or because they are specified using other cable config-file commands.
Table 2-19 lists the options that cannot be specified by the cable config-file option command. Where
applicable, the table shows the cable config-file command you can use to specify that option.
Table 2-19 Invalid Option Codes for the cable config-file option Command
Note For complete information on the other parameters and fields in DOCSIS configuration files, see
Appendix C in the DOCSIS 1.1 Radio Frequency (RF) Interface Specification, available on the DOCSIS
Cable Labs official web site at http://www.cablemodem.com/specifications.html.
Note Each option 43 command must specify one and only one vendor ID, and the vendor ID must be the first
TLV in the hex data string.
Tip The Institute of Electrical and Electronics Engineers (IEEE) is the official issuer of OUI values. The
IEEE OUI web site is at http://standards.ieee.org/regauth/oui/index.shtml.
Note When using the option 43 command, you must manually calculate the length value for each TLV that
you specify in the hex data string. However, you do not have to calculate the length for entire option 43
command, because that is calculated automatically by the CMTS.
Caution Be certain that you have correctly entered the TLV data when using the hex option. Incorrectly entered
data could cause CMs to reset, go offline, or hang, requiring a power cycle before being able to continue.
Tip Use the instance keyword to construct a DOCSIS configuration file that contains multiple option 43
commands. The multiple commands can be for the same vendor or for different vendors. Specifying
multiple commands for the same vendor is necessary when the total length of all data is greater than 254
bytes, which is the maximum length of the hex data field.
Examples The following example shows how to specify a static downstream frequency for a Cisco uBR905,
Cisco uBR924, Cisco uBR925, or Cisco CVA, using the option 43 command to specify Cisco vendor-
specific option 1.
router(config)# cable config-file statfreq.cm
router(config-file)# option 43 hex 08:03:00:00:0C:01:04:05:7F:9F:90
router(config-file)# exit
router(config)#
The hexadecimal data shown in this command consists of the two TLVs shown in Table 2-20:
Note Both the Cisco vendor-specific option for a static downstream frequency and the frequency command
instruct the CM to move to a specific downstream frequency, overriding the frequency the CM found
during its initial downstream scanning. However, the vendor-specific option requires the CM to use the
specified frequency—if the CM loses its lock on that frequency or can never lock on to that specific
frequency, the CM cannot go online. In contrast, the frequency command allows the CM to scan the
downstream for the next available frequency if the CM loses its lock on the originally specified
frequency.
The following example shows how to configure a Cisco uBR924, Cisco uBR925, or Cisco CVA122 so
that it downloads a Cisco IOS configuration file named ios.cfg and configures the router for two voice
ports. Three vendor-specific options are included: suboption 8, which specifies the vendor ID, suboption
128, which specifies the configuration file name, and suboption 10, which specifies the number of active
voice ports.
router(config)# cable config-file iosfile.cm
router(config-file)# option 43 hex 08:03:00:00:0C:80:07:69:6F:73:2E:63:66:67:0A:01:02
router(config-file)# exit
router(config)#
The hexadecimal data shown in this command consists of the three TLVs shown in Table 2-21:
Cisco CMs also support giving a limited number of Cisco IOS configuration mode commands in the
DOCSIS configuration file, using vendor-specific suboption 131. The following example shows how to
use the option 43 command to specify that the Cisco CM should execute the ip http cable-monitor
advance command to enable its onboard Cable Monitor web server.
router(config-file)# option 43 hex 08:03:00:00:0C:83:1D:69:70:20:68:74:74:70:20:63:61:62:
6C:65:2D:6D:6F:6E:69:74:6F:72:20:61:64:76:61:6E:63:65
router(config-file)#
The following example shows the instance keyword being used to give multiple option 43 commands.
This example uses the same commands shown in the previous three examples.
router(config-file)# option 43 instance 1 hex 08:03:00:00:0C:01:04:05:7F:9F:90
router(config-file)# option 43 instance 2 hex 08:03:00:00:0C:80:07:69:6F:73:2E:63:66:67:
0A:01:02
router(config-file)# option 43 instance 3 hex
08:03:00:00:0C:83:1D:69:70:20:68:74:74:70:20:63:61:62:6C:65:2D:6D:6F:6E:69:74:6F:72:20:61:
64:76:61:6E:63:65
router(config-file)#
The following example shows an attempt to specify two options that cannot be specified through the
DOCSIS configuration file. Option 12 is reserved for the DOCSIS registration process, and Option 9
must be specified using the download command.
router(config-file)# option 12 ip 10.11.12.13
%Option 12 must not be specified manually
router(config-file)# option 9 ascii newsoftware.file
%Option 9 must be specified directly (not as raw option)
router(config-file)#
packetcable
To enable PacketCable operations on the Cisco CMTS, use the packetcable command in global
configuration mode. To disable PacketCable operations, use the no form of this command.
packetcable
no packetcable
Usage Guidelines This command enables PacketCable operations on all cable interfaces and takes effect immediately. If
you do not need to change any parameters from their default values, this is the only command needed to
enable PacketCable operations.
In Cisco IOS Release 12.2(11)BC1 and later releases, this command also automatically creates a random
Element ID for the CMTS that is in the range of 0 and 99,999. To ensure that this Element ID is unique
across the entire PacketCable domain, you should use the packetcable element-id command.
Note PacketCable operations can be configured together with HCCP N+1 redundancy, but the PacketCable
states are not synchronized between the Working and Protect interfaces. If a switchover occurs, existing
voice calls continue, but when the user hangs up, PacketCable event messages are not generated because
the Protect interface is not aware of the previous call states. However, new voice calls can be made and
proceed in the normal fashion.
Defaults Non-PacketCable UGS service flows are not allowed when PacketCable operations are enabled.
Usage Guidelines By default, when PacketCable operations are enabled (using the packetcable command), CMs must
follow the PacketCable protocol when requesting UGS service flows. This prevents DOCSIS CMs that
do not support PacketCable operations from using DOCSIS-style UGS service flows.
If you have a mixed network that contains both PacketCable and non-PacketCable DOCSIS CMs, you
can allow DOCSIS CMs to request UGS service flows by using the packetcable authorize vanilla-
docsis-mta command. If, however, your CMTS is providing PacketCable services, use the no
packetcable authorize vanilla-docsis-mta command to disable DOCSIS-style service flows. This is the
default configuration when PacketCable operations are enabled, and it requires that CMs must provide
a validly authorized gate ID before being granted a UGS service flow.
Examples The following example shows PacketCable operation being enabled, while still allowing DOCSIS-style
UGS service flows:
Router# configure terminal
Router(config)# packetcable
Router(config)# packetcable authorize vanilla-docsis-mta
Router(config)#
The show packetcable global command has also been enhanced to display whether non-PacketCable
DOCSIS-style UGS service flows are allowed:
Router# show packetcable global
packetcable element-id
To configure the PacketCable Event Message Element ID on the Cisco CMTS, use the packetcable
element-id command in global configuration mode. To reset the counter to its default value, use the no
form of this command.
packetcable element-id n
no packetcable element-id
Syntax Description n PacketCable Event Message Element ID for the Cisco CMTS. The valid
range is 0 through 99999, with a default that is a random number in that
range.
Usage Guidelines The PacketCable Event Message specification (PKT-SP-EM-I03-011221) requires that each trusted
PacketCable network element that generates an Event Message MUST identify itself with a static
Element ID that is unique across an entire PacketCable domain. This command allows you to configure
the CMTS with an Element ID that is unique for your particular network. If you do not manually
configure this parameter with the packetcable element-id command, it defaults to a random value
between 0 and 99,999 when PacketCable operations is enabled.
The CMTS includes the Element ID in its Event Messages, along with its timezone information. You can
display the current value using the show packetcable global command.
Examples The following example shows the Event Message Element ID for this particular CMTS being set to
12456:
Router# configure terminal
Router(config)# packetcable element-id 12456
Pktcbl: Configured element ID 12456
Router(config)#
Syntax Description n Maximum number of gate IDs to be allocated in the gate database on the
CMTS. The valid range is 512 through 2097152, with a default value of
2097152 (8 * 512 * 512), which is sufficient to support 8 cable interface line
cards.
Usage Guidelines This command configures the number of gate IDs that the Cisco CMTS can store in its gate database.
Because each PacketCable gate ID typically refers to both an upstream gate and a downstream gate,
multiple this number by 2 to get the maximum number of gates that can be created on the CMTS.
Note Each cable interface line card supports a maximum of 512*512 (262,144) PacketCable gates, so ensure
that you set the maximum number of gates to accommodate all installed cable interface line cards.
Examples The following example shows the maximum number of gate IDs being set to 524288, which is sufficient
for two cable interface line cards:
Router# configure terminal
Router(config)# packetcable gate maxcount 524288
Router(config)#
packetcable timer
To change the value of the different PacketCable Dynamic Quality of Service (DQoS) timers, use the
packetcable timer command in global configuration mode. To reset a timer to its default value, use the
no form of this command.
Syntax Description T0 timer-value Sets the T0 timer in milliseconds. The valid range is 1 to 1,000,000,000
milliseconds, with a default value of 30000 milliseconds (30 seconds).
T1 timer-value Sets the T1 timer in milliseconds. The valid range is 1 to 1,000,000,000
milliseconds, with a default value of 200000 milliseconds (200 seconds).
Usage Guidelines This command sets the following timers, which are defined in the PacketCable™ Dynamic Quality-of-
Service Specification (PKT-SP-DQOS-I03-020116):
• T0 specifies the amount of time that a gate ID can remain allocated without any specified gate
parameters. The timer begins counting when a gate is allocated with a Gate-Alloc command. The
timer stops when a Gate-Set command marks the gate as Authorized. If the timer expires without a
Gate-Set command being received, the gate is deleted.
• T1 specifies the amount of time that an authorization for a gate can remain valid. It begins counting
when the CMTS creates a gate with a Gate-Set command and puts the gate in the Authorized state.
The timer stops when the gate is put into the committed state. If the timer expires without the gate
being committed, the CMTS must close the gate and release all associated resources.
Note The new timer values apply to all gates that are created after giving the command. Existing gates are not
affected.
Examples The following example shows the T0 timer being set to 20 seconds (20,000 milliseconds):
Router# configure terminal
Router(config)# packetcable timer T0 20000
Router(config)#
penalty-period
To specify the time period that an enforced quality of service (QoS) profile should be in force for
subscribers that violate their registered QoS profile, use the penalty-period command in enforce-rule
configuration mode. To reset an enforce-rule to its default penalty period, use the no form of this
command.
penalty-period minutes
no penalty-period
Syntax Description minutes The valid range is 1 to 10080 minutes (7 days), with a default value of
10080 minutes (7 days).
Usage Guidelines When a subscriber over-consumes the maximum bandwidth that is specified in their enforce-rule, the
CMTS can automatically switch them to an enforced QoS profile for the penalty period specified with
the penalty-period command. When the penalty period expires, the CMTS restores the subscriber to
their registered QoS profile.
The penalty period continues across reboots of the cable modem, so a user cannot avoid the enforced
QoS profile by trying to reset their modem and reregister on the cable network. This allows service
providers to set an appropriate penalty for those users that consistently exceed the maximum bandwidth
they have been allocated.
Note To manually move a cable modem back to its registered profile before the end of the penalty period, use
the cable modem mac-address qos profile id command.
When you change the configuration of a currently active enforce-rule, that rule begins using the new
configuration immediately to manage the cable modems tracked by this enforce-rule.
Note If a cable modem has multiple service flows, and the cable modem enters the penalty period because one
of its service flows has exceeded its allowable bandwidth, monitoring on the other service flows stops
until the modem exits the penalty period.
Examples The following example shows an enforce-rule being configured for a penalty period of 1440 minutes
(1 day):
Router# configure terminal
Router(config)# cable qos enforce-rule test
Router(enforce-rule)# penalty 1440
Router(enforce-rule)# exit
Router(config)#
ping docsis
To determine whether a specific CM is reachable from the CMTS at the DOCSIS MAC layer, use the
ping docsis command in privileged EXEC mode.
Syntax Description mac-addr Specifies the 48-bit hardware (MAC) address of the CM. If you specify the MAC
address of a CPE device, the command will resolve it to the MAC address of the
CM servicing that CPE device and send the DOCSIS ping to the CM.
ip-addr Specifies the IP address of the CM. If you specify the IP address of a CPE device,
the command will resolve it to the IP address of the CM servicing that CPE
device and send the DOCSIS ping to the CM.
count Specifies the number of ping packets to be sent.
verbose Specifies verbose mode for the output, giving additional details about the packets
transmitted and received.
Usage Guidelines The DOCSIS ping is a unique Cisco patented technology that allows a cable operator to quickly diagnose
the health of a channel between the CMTS and any particular DOCSIS cable CPE device. The DOCSIS
ping is similar in concept to the IP ping but uses the lower MAC layer instead of the datalink or transport
layers. Using the MAC layer has two major advantages:
• A DOCSIS ping uses only 1/64 of the bandwidth of an IP ping.
• A DOCSIS ping can be used with CMs that have not yet acquired an IP address. This allows cable
operators to “ping” CMs that weren't able to complete registration or that were improperly
configured at the IP layer.
In addition to providing connectivity information, the ping docsis command provides a real-time view
and plot of requested power adjustments, frequency, timing offset adjustments, and a measure of optimal
headend reception power.
If a CM responds to the ping docsis command, but does not respond to an IP ping, the problem could be
one of the following:
• The CM is still in the registration process and has not yet come completely online. In particular, the
CM could be waiting for the DHCP server to assign it an IP address.
• Severe interference or other faults on the physical layer (either the upstream or downstream).
• Significant upstream signal error, distortion, or amplitude errors, often resulting in frequent power
adjustments (which are shown in the cable flap list).
• A non-DOCSIS compliant upstream carrier-to-noise power ratio (C/N) that is between 14 and
21 dB, along with a mixed modulation profile, such as ranging request/response messages being sent
in QPSK mode and short and long data grants in 16-QAM mode.
Note The ping docsis command is a DOCSIS-compliant process that can be used with any two-way DOCSIS-
compliant CM; the CM does not require any special features or code. The ping docsis command cannot
be used with telco-return CMs.
Table 2-23 explains the different characters that can appear in the output for the ping docsis command:
Note If a CM is already in the flap list, the ping docsis command increments the hit, miss, and power-
adjustment fields for it in the cable flap list.
Examples The following example shows a default ping docsis command that sends five packets to the CM with the
MAC address of 00d0.ba77.7595, with a response being received for each:
Router# ping docsis 00d0.ba77.7595
Router#
The following example shows the verbose output for the same command:
Router# ping docsis 00d0.ba77.7595 verbose
Router#
The following example shows that the CM at 192.168.100.10 is connected to the network and is
operational, but that one ping packet was lost and that several power adjustments were made during the
ping process:
router# ping docsis 192.168.100.10
A CM that displays output such as that above (a higher percentage of successful pings but with a number
of power-adjustment readings) is most likely experiencing a problem that is not bad enough to force the
modem offline but that should be addressed.
If this problem is consistent for just a small number of CMs on an upstream receiver (such as a fiber node
within a combining group), then the problem is likely related to in-home wiring at those modem
locations. It could also be due to a cable TV network element that is on the same HFC segment.
If the problem occurs for all CMs on a single fiber node, then changing the upstream frequency or
reducing the number of homes passed per combining group might improve conditions. If this does not
help the situation, the problem could be due to a faulty cable drop, dirty optical connector on the node,
or other physical plant problem.
The ping docsis command cannot be used with a CM that has not yet registered with the CMTS. The
following example shows the responses for a CM that has not yet registered with the CMTS.
router# ping docsis 192.168.100.111
Cable modem with IP address 192.168.100.111 not registered.
Please try using MAC address instead.
privacy
To create a DOCSIS configuration file that enables and configures the DOCSIS Baseline Privacy
Interface (BPI) option, use the privacy command in cable config-file configuration mode. To disable BPI
for the CM, use the no form of this command.
privacy timeout {authorize value| operational value| re-authorize value| reject value| rekey
value}
Syntax Description authorization value Authorization grace time in seconds. Valid values are 1 to 1800 seconds.
Default value is 600 seconds.
tek value TEK grace time in seconds. Valid range is 1 to 1800 seconds. Default is 600
seconds.
authorize value Authorize wait timeout in seconds. Valid range is 1 to 30 seconds. Default
value is 10 seconds.
operational value Operational Wait timeout in seconds. Valid range is 1 to 10 seconds. Default
is 1 second.
re-authorize value Re-authorize wait timeout in seconds. Valid range is 1 to 20 seconds.
reject value Authorize reject wait timeout in seconds. Valid range is 1 to 600 seconds.
Default is 60 seconds.
rekey value Rekey wait timeout in seconds. Valid range is 1 to 10 seconds. Default is 1
second.
Usage Guidelines Specifying the privacy command without any of the keywords and arguments enables BPI encryption
and decryption for the CM. In addition to this command, you must also specify the service-class privacy
command to enable BPI operations on the cable modem.
Note The privacy command appears and is supported only in images with support for BPI or BPI+ encryption.
This option configures the CM for BPI or BPI+ encryption. To use BPI encryption, the Cisco CMTS
must also be configured for BPI or BPI+ encryption, using the cable privacy command.
Examples The following example shows how to set the CM privacy TEK gracetime to 1200 seconds and enables
BPI operations for the cable modem.
router(config)# cable config-file bpi.cm
router(config-file)# privacy grace-time tek 1200
router(config-file)# service-class 1 privacy
router(config-file)# exit
router(config)#
registered qos-profile
To specify the registered Quality of Service (QoS) profile that should be used for this enforce-rule, use
the registered qos-profile command in enforce-rule configuration mode. To remove the registered QoS
profile from the enforce-rule, use the no form of this command.
Syntax Description profile-id Specifies the QoS profile to be monitored. This profile must be created
on the Cisco CMTS. If you want to manage a cable modem that uses a
modem-created QoS profile, you must first create that exact QoS
profile on the CMTS before using this command. The valid range is 0
to 16383, with a default of 0.
Defaults 0
Usage Guidelines You must specify a registered QoS profile for each enforce-rule. The CMTS then uses the registered
profile ID to match subscribers’ service flows to the proper enforce-rules.
When you change the registered QoS profile for an active rule, the cable modems that had been using
the previous registered QoS profile are no longer managed by the Subscriber Traffic Management
feature. Instead, the rule begins managing those cable modems that use the new registered QoS profile.
Note The registered QoS profile must be created on the Cisco CMTS before you can assign it to an enforce-
rule. If the rule does not exist, the system displays an error message. If you want to manage a CM that
is using a CM-created QoS profile, you must first create a QoS profile on the Cisco CMTS that matches
the CM-created profile exactly. Then use the registered qos-profile command to assign that profile to
this enforce fule.
Examples The following example shows profile 50 being assigned as the registered QoS profile to an enforce-rule:
Router# configure terminal
Router(config)# cable qos enforce-rule enforce-rule
Router(enforce-rule)# registered qos-profile 50
Router(enforce-rule)# exit
Router(config)#
The following example shows the error message that is displayed when the specified QoS profile does
not exist on the CMTS:
Router# configure terminal
Router(config)# cable qos enforce-rule test
Router(enforce-rule)# registered qos-profile 99
Router(enforce-rule)#
service-class
To create a DOCSIS configuration file that specifies the quality-of-service (QoS) service-class options
for the CM configuration file, use the service-class command in cable config-file configuration mode.
To disable the specification, use the no form of this command.
no service-class
Syntax Description class Specifies service class number. Valid range is 1 to 16. Default value is 1.
guaranteed-upstream Specifies the guaranteed upstream bandwidth in kbps. Valid range for us-
us-bandwidth bandwidth is 0 to 100000 kbps. Default value is 0.
max-burst burst-size Specifies the maximum upstream burst size in bytes. Valid range for burst-
size is 0 to 65535. Default value is 0, unlimited burst length. Recommended
value range is 1600 to 1800 bytes. Using a value of 0 or greater than 1800 bytes
can cause latency issues for Voice-over-IP. A value of less than 1500 bytes
prevents upstream transmission of large Ethernet frames for any modem or
CMTS not implementing fragmentation (an optional feature in DOCSIS 1.0).
max-downstream Specifies the downstream bandwidth in kbps. Valid range for max-
max-dsbandwidth dsbandwidth is 0 to 100000 kbps. Default value is 0.
max-upstream max- Specifies the upstream bandwidth in kbps. Valid range for max-usbandwidth
usbandwidth is 0 to 100000 kbps. Default value is 0.
priority priority-num Specifies the service class priority. Valid range for priority-num is 0 to 7,
where 7 is the highest-priority service-class setting.
privacy Enables baseline privacy interface (BPI).
Defaults Service-class is not set by default. A CM cannot register on a Cisco CMTS unless at least one parameter in
a service class is specified.
Usage Guidelines Default values can be used only if service-class class is specified. A single configuration file should not
contain multiple service-class ID numbers. Thus, all parameters should be set using a single service-class ID.
However, different configuration files can reuse the same service-class ID.
Note To enable Baseline Privacy Interface (BPI) operations on the cable command, you must specify both the
service-class privacy and privacy commands for the cable modem’s DOCSIS configuration file.
Examples The following example shows how to specify the service-class command for a DOCSIS configuration
file:
router(config)# cable config-file upgrade.cm
router(config-file)# service-class 1 priority 0
router(config-file)# service-class 1 max-upstream 3247
router(config-file)# service-class 1 max-downstream 10000
router(config-file)# service-class 1 max-burst 1600
router(config-file)# service-class 1 privacy
router(config-file)# privacy
router(config-file)# exit
router(config)#
snmp manager
To create a DOCSIS configuration file that specifies the IP address for the Simple Network Management
Protocol (SNMP) manager, use the snmp manager command in cable config-file configuration mode.
To disable this function, use the no form of this command.
no snmp manager
Usage Guidelines For SNMP commands that affect the operation of the CMTS, see the Cisco IOS Configuration
Fundamentals Command Reference Guide.
Examples The following example shows how to specify the IP address of the SNMP manager in a DOCSIS
configuration file:
router(config)# cable config-file snmp.cm
router(config-file)# snmp manager 10.10.1.1
router(config-file)# exit
router(config)#
Command Description
privacy Specifies privacy options for baseline privacy images.
service-class Specifies service class definitions for the configuration file.
timestamp Enables time-stamp generation.
Syntax Description cm-chover Enables traps that are sent upon completion of CMTS channel override
operations, as defined in CISCO-DOCS-EXT-MIB.
cm-onoff Enables traps for CM online/offline status changes, as defined in CISCO-
DOCS-EXT-MIB.
cm-remote-query Enables traps that are sent when the remote polling of CMs has been
completed, as defined in CISCO-DOCS-REMOTE-QUERY-MIB.
dmic-lock Enables traps that are sent when a cable modem fails the dynamic shared-
secret security checks, as defined in CISCO-DOCS-EXT-MIB.
enfrule-violation Enables traps that are sent when a user violates their quality of service (QoS)
profile, as defined in the CISCO-CABLE-QOS-MONITOR-MIB.
hccp-failover Enables traps for Hot Standby Connection-to-Connection Protocol (HCCP)
redundancy switchover events, as defined in CISCO-CABLE-
AVAILABILITY-MIB.
hopping Enables traps for spectrum hopping events, as defined in CISCO-CABLE-
SPECTRUM-MIB.
usage Enables traps for usage-based billing, as configured with the cable usage
commands and defined in CISCO-CABLE-BILLING-MIB.
Defaults No SNMP traps for cable-related events are enabled. You can specify one type of trap or any combination
of traps. When the snmp-server enable traps cable command is given without any options, all cable-
related traps are enabled.
Release Modification
12.2(4)BC1 This command was supported on the Cisco uBR10012 universal broadband
router. The cmts-event option was also removed as redundant.
12.2(8)BC1 The hccp-failover option was supported on the Cisco uBR10012 router.
12.2(11)BC1 The hccp-failover option was supported on the Cisco uBR7200 series
router.
12.2(15)BC1 The enforce-rule option was added to generate traps for subscribers who
violate their enforce-rule QoS profile.
12.2(15)BC21 The dmic-lock and usage options were added.
Usage Guidelines For other SNMP commands that affect the operation of the CMTS, see the Cisco IOS Configuration
Fundamentals Command Reference Guide.
Examples The following example shows how to enable all traps for cable-related events except HCCP switchovers
on the CMTS:
Router# configure terminal
Router(config)# snmp-server enable traps cable cm-chover cm-onoff cm-remote-query hopping
Router(config)#
The following example shows how to enable traps for any HCCP switchovers that occur on the CMTS:
Router# configure terminal
Router(config)# snmp-server enable traps cable hccp-failover
Router(config)#
The following example shows how to enable traps for when a user violates the maximum bandwidth for
the quality of service (QoS) profile specified by their enforce-rule.
Router# configure terminal
Router(config)# snmp-server enable traps cable enforce-rule
Router(config)#
Syntax Description docsis-events Specifies one or more of the following DOCSIS event types:
• bpi—Enables traps for BPI initialization failure events.
• bpkm—Enables traps for BPKM failure events.
• dccack—Enables traps for the failure of Dynamic Channel Change
Acknowledgement (DCC-ACK) requests.
• dccreq—Enables traps for the failure of Dynamic Channel Change
Request (DCC-REQ) requests.
• dccrsp—Enables traps for the failure of Dynamic Channel Change
Response (DCC-RSP) requests.
• dsac—Enables traps for the failure of Dynamic Service
Acknowledgement (DSx-ACK) requests.
• dsreq—Enables traps for the failure of Dynamic Service Request (DSx-
REQ) requests.
• dsrsp—Enables traps for the failure of Dynamic Service Response
(DSx-RSP) requests.
• dynsa—Enables traps for the failure of Dynamic Service Addition
(DSA-ACK) requests.
• regack—Enables traps for the failure of Registration Acknowledgement
(REG-ACK) requests.
• regreq—Enables traps for the failure of Registration Request (REG-
REQ) requests.
• regrsp—Enables traps for the failure of Registration Response (REG-
RSP) requests.
Defaults No SNMP traps for DOCSIS-related events are enabled. When the snmp-server enable traps docsis-
cmts command is given without any options, all DOCSIS-related traps are enabled.
Usage Guidelines This command enables traps that are defined in the DOCS-CABLE-DEVICE-TRAP-MIB MIB.
For other SNMP commands that affect the operation of the CMTS, see the Cisco IOS Configuration
Fundamentals Command Reference Guide.
Examples The following example shows how to enable traps for the failure of DOCSIS registration-related events
on the CMTS:
router(config)# snmp-server enable traps docsis-cmts reqack reqreq regrsp
router(config)#
timestamp
To create a DOCSIS configuration file that enables timestamp generation, use the timestamp command
in cable config-file configuration mode. To disable this function, use the no form of this command.
timestamp
no timestamp
Usage Guidelines The DOCSIS specification supports the optional time-stamping of DOCSIS configuration files by
adding a field to the file that shows the time that the file was sent to the CM. This prevents someone from
trying to subvert DOCSIS security by replaying a valid DOCSIS configuration file to another CM. The
timestamp is expressed as the number of seconds since midnight on January 1, 1900.
Examples The following example shows how to enable timestamp generation for the DOCSIS configuration file.
router(config)# cable config-file upgrade.cm
router(config-file)# timestamp
router(config-file)# exit
router(config)#
Command Description
privacy Specifies privacy options for baseline privacy images.
service-class Specifies service class definitions for the configuration file.
snmp manager Specifies Simple Network Management Protocol (SNMP) options.
upstream freq-range
To configure the Cisco CMTS router for the range of frequencies that are acceptable on upstreams, use
the upstream freq-range command in global configuration mode. To restore the default value of North
American ranges, use the no form of this command.
no upstream freq-range
Syntax Description european Configures the Cisco CMTS router to accept upstream frequency ranges
that conform with the EuroDOCSIS specifications (5 MHz to 65 MHz).
japanese Configures the Cisco CMTS router to accept upstream frequency ranges
that conform to the expanded range used in Japan (5 MHz to 55 MHz).
north american Configures the Cisco CMTS router to accept upstream frequency ranges
that conform to the DOCSIS specifications (5 MHz to 42 MHz).
Usage Guidelines In Cisco IOS Release 12.2(15)BC2 and later, the Cisco CMTS router supports three different modes of
operation, depending on the cable interface line cards being used. The range of frequencies that are
allowed in each mode are as follows:
• North American DOCSIS (Annex B)—Upstreams use frequencies between 5 MHz and 42 MHz.
• European EuroDOCSIS (Annex A)—Upstreams use frequencies between 5 MHz and 65 MHz.
• Japanese Expanded Range (Annex B)—Upstreams use frequencies between 5 MHz and 55 MHz.
To configure the router so that it supports the proper range of upstream frequencies, use the upstream
freq-range command. After you have configured the router with the upstream freq-range command,
the cable upstream frequency command then accepts only frequencies that are in the configured range.
Note This command configures only the range of frequencies that can be configured on an upstream. It does
not configure the upstreams for the DOCSIS (Annex B) or EuroDOCSIS (Annex A) modes of operation,
which is done using the cable downstream annex interface command. (Annex C mode is not supported.)
The allowable range for the upstream channel frequency depends on the cable interface line card and
Cisco IOS software release being used. See Table 2-11 on page 2-315 for the currently supported values.
Examples The following example shows how to configure the Cisco CMTS router to support the EuroDOCSIS
upstream frequency range of 5 MHz to 65 MHz:
Router# configure terminal
Router(config)# upstream freq-range european
Router(config)#
The following example shows how to configure the Cisco CMTS router to support the expanded
Japanese upstream frequency range of 5 MHz to 55 MHz:
Router# configure terminal
Router(config)# upstream freq-range japanese
Router(config)#
The following example shows how to configure the Cisco CMTS router for its default configuration
(DOCSIS upstream frequency range of 5 MHz to 42 MHz):
Router# configure terminal
Router(config)# upstream freq-range north american
Router(config)#
The following example shows all of the commands that are needed to configure the cable interface and
upstream on a Cisco uBR-MC28U/X cable interface line card to support a frequency in the EuroDOCSIS
upstream frequency range of 5 MHz to 65 MHz:
Router# configure terminal
Router(config)# upstream freq-range european
Router(config)# interface 3/0
Router(config-if)# cable downstream annex a
Router(config-if)# cable upstream 0 frequency 62500000
Router(config-if)#
This section describes the cable-specific show commands for the Cisco Cable Modem Termination
System (CMTS) universal broadband routers. Refer to the following sections for more information:
• Supported Platforms and Cisco IOS Releases, page 3-1—Describes the Cisco CMTS routers and
Cisco IOS releases that support the commands listed in this section.
• Overview of the Operation of the Cable Show Commands, page 3-3—Provides an overview of how
the show commands operate on the Cisco CMTS routers using different cable interface line cards.
• CMTS Show Commands, page 3-4—Describes the cable-specific show commands that are used to
configure and maintain the Cisco CMTS features.
Tip This section documents only cable-specific show commands. For non-cable-specific commands, see the
command reference documentation for Cisco IOS Release 12.2, available on Cisco.com and the
Documentation CD-ROM. For information about debugging commands for the Cisco CMTS routers, see
Chapter 5, “Cisco CMTS Debugging Commands.”
Note Not all Cisco IOS releases support all Cisco CMTS platforms. See the release notes for each Cisco IOS
release for details on which platforms are supported.
Tip This section documents only cable-specific show commands. For non-cable-specific commands, see the
command reference documentation for Cisco IOS Release 12.2, available on Cisco.com.
Syntax Description cable slot/port Displays information for all CMs on the specified cable interface and
downstream port on the Cisco uBR7246VXR router.
On the Cisco uBR7246VXR router, slot can range from 3 to 6, and port can
be 0 or 1, depending on the cable interface.
cable slot/subslot/port Displays information for all CMs on the specified cable interface on the
Cisco uBR10012 router. The following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
[ip-requests-filtered (Optional) Displays the Service IDs (SIDs) that are generating or forwarding
number] more filtered ARP requests for IP packets than the specified minimum
number of packets. The valid range for number is 1 to 65535, with no default.
Note This field shows the modems that are forwarding IP traffic that could
be an part of an attack, such as TCP SYN floods, ping scans, and so
forth.
[requests-filtered (Optional) Displays the Service IDs (SIDs) that are generating or forwarding
number] more filtered ARP requests than the specified minimum number of packets.
The valid range for number is 1 to 65535, with no default.
[replies-filtered (Optional) Displays the Service IDs (SIDs) that are generating or filtering
number] more filtered ARP replies than the specified minimum number of packets.
The valid range for number is 1 to 65535, with no default.
Usage Guidelines The cable arp filter command enables the filtering of ARP request and reply packets on a cable
interface. ARP packets might need to be filtered when a user on the cable network generates a large
volume of ARP traffic as part of a theft-of-service or denial-of-service attack, or when a virus is using
ARP requests to find other computers that it might infect.
The show cable arp-filter command displays the total number of ARP reply packets that have been
received and the number of ARP request packets that have been sent on the cable interface, as well as
the number of such packets that have been filtered.
Tip To clear the counters on all interfaces, use the clear counters command. To clear the counters on a
specific interface, use the clear counters cable interface command.
Examples The following example shows the typical output from the show cable arp-filter command on a
Cisco uBR10012 router. The displays for other Cisco CMTS platforms are similar.
Router# show cable arp-filter Cable5/0/0
Router#
Field Description
Replies Rcvd
Total Total number of ARP reply packets received on the cable interface since
power-on.
Unfiltered Number of ARP reply packets that the cable interface received and accepted
while filtering was enabled using the cable arp filter reply-accept
command.
Filtered Number of ARP reply packets that the cable interface dropped while filtering
was enabled, because they would have otherwise exceeded the allowable
threshold value that was configured for the interface using the cable arp
filter reply-accept command.
Requests Sent For IP
Total Total number of ARP request packets that the cable interface was asked to
forward since power-on.
Unfiltered Number of ARP request packets that the cable interface sent while filtering
was enabled using the cable arp filter request-send command.
Filtered Number of ARP request packets that the cable interface dropped, because
they would have otherwise exceeded the allowable threshold value that was
configured for the interface using the cable arp filter request-send
command.
Field Description
Requests Forwarded
Total Total number of ARP request packets that the cable interface was asked to
forward to the ARP proxy since power-on.
Unfiltered Number of ARP request packets that the cable interface sent to the ARP
proxy while filtering was enabled using the cable arp filter request-send
command.
Filtered Number of ARP request packets for the ARP proxy that the cable interface
dropped, because they would have otherwise exceeded the allowable
threshold value that was configured for the interface using the cable arp
filter request-send command.
Note All counters are 16-bit counters, with a maximum value of 65,535 packets. If the number of
packets exceeds this amount, the counter wraps back to zero and begins incrementing again.
Note The Total counts in the show cable arp-filter command continue to increment, regardless of whether
ARP filtering has been enabled. The Unfiltered and Filtered counts increment only when ARP filtering
has been enabled using the cable arp filter command. When cable ARP filtering is disabled, these
counters retain their current values until manually reset, using the clear counters command.
The following example shows how to display the devices that are generating or filtering more than 100
ARP requests per reporting period. Repeat the command to see how quickly the device is generating
ARP packets.
Router# show cable arp-filter c7/0/0 requests-filtered 100
Router#
The following example shows how to display the devices that are generating or filtering more than 200
ARP replies per reporting period. Repeat the command to see how quickly the device is generating ARP
packets.
Router# show cable arp-filter c5/0/0 replies-filtered 200
Router#
The following example shows how to display the devices that are generating or filtering more than 10
ARP requests for IP packets per reporting period. Repeat the command to see how quickly the device is
generating ARP packets.
Router# show cable arp-filter c3/0 ip-requests-filtered 10
Router#
Field Description
SID Service ID (SID) of the device.
MAC Address Hardware (MAC-layer) address of the cable modem or CPE device.
IP Address IP address of the cable modem or CPE device.
Req-Filtered Total number of ARP requests that the device has generated or forwarded.
Req-For-IP-Filtered Total number of ARP requests that the device has generated or forwarded for
IP packets.
Rep-Filtered Total number of ARP replies that the device has generated or forwarded.
Note The Req-Filter and Rep-Filtered counters are 16-bit counters, with a maximum value of 65,535
packets. If the number of packets exceeds this amount, the counter wraps back to zero and
begins incrementing again.
Router#
Note The clear counters command clears all of the packet counters on an interface, not just the ARP packet
counters.
Syntax Description n Specifies the bundle identifier. Valid range is from 1 to 255.
forwarding-table Displays the forwarding table for the specified interface.
Examples The following is a typical example of the show cable bundle command:
Router# show cable bundle 1 forwarding-table
Router#
Table 3-4 describes the fields shown in the show cable bundle command display.
Field Description
MAC address Identifies the MAC (hardware) address for each interface in the
bundle.
Interface Identifies the cable interface slot and port number.
Flag The current value of the flag byte for this bundle entry. The
following bits can be set:
• Bit 0 (0x01) = Bundle is active.
• Bit 1 (0x02) = Bundle is a static multicast group.
Note If more than one bit is set, add the values together. For
example, 3 indicates an active, static multicast group.
Location The location in the router’s memory for the flags byte for this
bundle entry. This value is useful only to TAC engineers during
debugging.
link The value of the link pointer for this bundle entry. This value is
useful only to TAC engineers during debugging.
sublink The value of the sublink pointer for this bundle entry. This value is
useful only to TAC engineers during debugging.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Note This command has been deprecated and removed in the current versions of the Cisco IOS software for
all Cisco CMTS routers.
Usage Guidelines This command displayed configuration of the cable burst profiles, which were what DOCSIS initially
used to control the data, ranging, and station maintenance bursts. The Cisco CMTS routers now support
a more comprehensive set of modulation profiles, which are displayed by the show cable modulation-
profile command.
Note The show cable burst-profile command displayed fields and values that were supported only in the
initial versions of the DOCSIS specification. The current DOCSIS 1.0 and 1.1 specifications use
different parameters and values, as shown by the show cable modulation-profile command.
Examples The following example shows typical output from the show cable burst-profile command:
Router# show cable burst-profile
Burst Type Preamb Diff FEC err FEC Scrambl Max Guard Last Scrambl profile
number length size size shortened
1 1 48 no 0x0 0x6 0x152 1 16 1 yes
2 1 48 no 0x0 0x6 0x152 1 12 1 no
3 1 48 no 0x5 0x2C 0x152 0 48 1 yes
4 1 48 no 0x5 0x2C 0x152 0 48 1 yes
5 1 48 no 0x5 0x32 0x152 0 20 1 yes
6 1 48 no 0x0 0x32 0x152 0 20 1 no
Router#
Table 3-5 describes the fields shown in the show cable burst-profile command display.
Field Description
Burst profile number The number of the burst profile.
Type Type of burst profile.
Preamb length Length of the preamble.
Diff encode Shows if there is a diff encode.
FEC err correct Shows the forward error correction.
FEC codeword length Shows the length of the forward error correction codeword.
Scrambl seed Shows the seed of the scrambler.
Max size Designates the maximum burst size.
Guard size Indicates the guard time size.
Last codeword shortened Shows the last codeword shortened.
Scrambl Indicates whether scramble is enabled (yes) or not (no).
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Usage Guidelines This command supports the Cisco CMTS clock feature set, which provides a synchronized clock for
improved Voice-over-IP (VoIP) operations. The clock feature set requires one of the following
configurations:
• A Cisco uBR10012 router with one or two TCC+ cards that are connected to an external national
clock source.
• A Cisco uBR7246 VXR router using a Cisco uBR-MC16S, Cisco uBR-MC16E, Cisco uBR-
MC28C, or Cisco uBR-MC28C-BNC cable interface line card. The router must also be equipped
with a Cisco cable clock card and be running Cisco IOS 12.1(1a)T1, 12.1(2)EC1, or a later release.
The Cisco cable clock card should be connected to an external national clock source.
Only these cable interface cards support the external clock card reference from a clock card to distribute
that signal to CMs or set-top boxes (STBs) attached to the specific network segments. You can use other
cable interface cards, such as the Cisco uBR-MC16C, with the clock card, but these other cable
interfaces will not synchronize their downstream SYNC messages with the external clock source.
Each CM or STB must also support VoIP applications and the clock feature set. For example, the
Cisco uBR924, running Cisco IOS Release 12.0(7)T or later, supports clock card feature automatically.
Note This command does not appear if a clock card is not installed in the system.
Examples The following sample output from the show cable clock command on a Cisco uBR7246VXR router
shows that both external sources are available and the clock card is providing the clock reference:
Router# show cable clock
The following sample output from the show cable clock command on a Cisco uBR10012 router shows
that both external sources are available and that the TCC+ card in slot 1/1 is providing the clock
reference:
Router# show cable clock
Number of TCCplus Cards in the Chassis: 2
Active TCCplus Card is in slot: 1 subslot: 1
Backup TCCplus Card is in slot: 2 subslot: 1
Clock reference used by the active card is Primary T1
External T1 References:
Card: 1/1
Primary T1 : Available
Secondary T1: Available
Card: 2/1
Primary T1 : Available
Secondary T1: Available
The following sample output from the show cable clock command on a Cisco uBR10012 router shows
that the TCC+ card in slot 1/1 is in maintenance mode, and that the TCC+ card in slot 2/1 is providing
the clock reference:
Router# show cable clock
Number of TCCplus Cards in the Chassis: 2
TCCplus card in 1/1 under maintenance
Active TCCplus Card is in slot: 2 subslot: 1
Clock reference used by the active card is Primary T1
External T1 References:
Card: 2/1
Primary T1 : Available
Secondary T1: Available
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Note The show cable device access-group command is not supported on the Cisco uBR10012 universal
broadband router.
Syntax Description ip-addr (Optional) Specifies the IP address for a particular CM or host.
Usage Guidelines This command displays information about both CMs and their associated CPE devices. To display
information only for hosts and other CPE devices, use the show cable host access-group command. To
display information only for CMs, use the show cable modem access-group command.
If an SNMP manager is requesting information about CM or CPE devices at the same time that this
command is given, the command displays the following error message:
No information is available, please try later.
Wait until the SNMP retrieval is done and retry the CLI command.
Examples The following example shows how to display a list of the CMs and their hosts:
Router# show cable device access-group
Router#
Table 3-6 describes the fields that are shown in the show cable device access-group display:
Table 3-6 Descriptions for the show cable device access-group Fields
Field Description
MAC Address The MAC address for the CM or CPE device.
IP Address The IP address that the DHCP server has assigned to the CM or CPE device.
Type Identifies the type of device:
• host = CPE device
• modem = cable modem
Access-group Displays the access group name or number in use (if any) for this CM or CPE
device.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Command Description
clear cable host Clears the host from the table.
show cable host access-group Displays the hosts behind the CMs in the network, along with
their access groups.
show cable modem access-group Displays the access groups for the CMs on a particular cable
interface.
Syntax Description stats Displays configuration and run-time statistics about the currently-
defined DSG tunnels.
tunnel Displays the mapping of DSG tunnels to vendors or well-known MAC
addresses.
vendor CA-vendor-name (Optional) Displays information about a specific Conditional Access
(CA) vendor. This parameter can be any arbitrary string up to 8
characters in length.
tunnel-MAC-address (Optional) Displays information for the specified well-known MAC
address for the DSG tunnel. If you specify a MAC address of
0000.0000.0000, the command displays information for all DSG
tunnels, which is the default display.
Examples The following example shows a typical display for the show cable dsg tunnel command:
Router# show cable dsg tunnel
Router#
The following example shows a typical display for the show cable dsg stats command:
Router# show cable dsg stats
Router#
The following example shows a typical display for the show cable dsg stats command for an individual
vendor:
Router# show cable dsg stats vendor CCC
Router#
Note The packet counters for both the stats and tunnel options for a particular DSG tunnel continue to
increase as long as traffic is received over that tunnel. If the tunnel does not receive any traffic for three
minutes or more, the counters are automatically reset to 0.
The following example shows a typical display for the show cable dsg stats command for an individual
vendor when the associated cable interface is shut down. The Received, Forwarded, and Dropped
counters are not displayed when an interface is shut down.
Router(config)# interface c5/1
Router(config-if)# shutdown
Router(config-if)# exit
Router(config)# exit
Router# show cable dsg stats vendor CCC
Router#
Table 3-7 describes the major fields shown in the show cable dsg command:
Field Description
DSG keepalive is set If keepalive messages have been enabled for an IP multicast group,
using the cable dsg keepalive command, this message is displayed.
Dest-ip, Group address Multicast group IP address for the DSG stream.
Src-ip, Source address Source IP address for the DSG stream. If an asterisk (*) appears as
the source IP address, it indicates that the source IP address is
0.0.0.0, which allows any IP address as the source IP address.
Mapped-MAC, Tunnel-MAC Well-known MAC address used for the DSG tunnel. If you
configured the DSG tunnel with a MAC address of 0000.0000.0000
using the cable dsg command, this field shows the MAC address
that the CMTS derived using the MAC to IP multicast addressing
mapping that is specified in RFC 1112.
Interface Cable interface on which this DSG tunnel is configured.
mapping entry is used Number of times that this particular DSG tunnel mapping has been
used to resolve the well-known MAC address from the tunnel’s
group address. This can be used as a very rough approximation of
the number set-top boxes (STBs) that have been mapped to this
DSG tunnel since the last time the counter was cleared.
Note Use the clear cable dsg command to clear this counter.
Packets Number of packets transmitted over the DSG tunnel.
CA-vendor Name for the Conditional Access (CA) vendor that owns this tunnel.
Received Number of packets received by the multicast group. This counter
includes all interfaces that are receiving traffic for the multicast
group. The field is not shown when an interface is shut down, but
the counter continues to increase as long as the multicast group is
receiving traffic. When the interface is reenabled, the counter shows
the latest number of packets received.
Field Description
Forwarded Number of packets forwarded on the cable interface for the
multicast group. This counter is reset to 0 whenever an interface is
shut down and reenabled. The field is not shown when an interface
is shut down.
Dropped Number of packets that were dropped that were for the multicast
group. This counter includes all interfaces that are receiving traffic
for the multicast group. The field is not shown when an interface is
shut down, but the counter continues to increase as long as the
multicast group is receiving traffic and dropping packets. When the
interface is reenabled, the counter shows the latest number of
packets dropped.
Note The Received and Dropped counters reflect activity for the multicast group and are not affected when a
cable interface is shut down and reenabled, as long as the multicast group continues to receive traffic.
The Forwarded counter reflects activity for the particular cable interface and is reset to zero whenever
the interface is shut down and reenabled. All packet counters are also automatically reset to zero if the
DSG tunnel does not receive traffic for three minutes or more.
Syntax Description group group-id (Optional) Specifies the filter group to be displayed. The valid range is
1 to 256.
index index-num (Optional) Specifies the index of the particular filter within a group to
be displayed. The valid range is 1 to 128.
verbose (Optional) Displays complete information about the filter groups in a
format that is easier to read than the default display.
Examples The following example shows a typical display of the show cable filter command:
Router# show cable filter
Filter SrcAddr/Mask DestAddr/Mask Prot ToS SPort DPort TCP Action Status
Grp Id Flags
The following shows typical output for the verbose form of this command:
Router# show cable filter group 10 index 10 verbose
Filter Group : 1
Filter Index : 1
Matches : 0
Match action : accept
Status : active
Filter Group : 10
Filter Index : 10
Matches : 0
Source IP Address : 7.7.7.7/16
Destination IP Address : 8.8.8.8/16
IP Protocol type : 256
IP ToS (Mask, Value) : 1, 2
TCP/UDP Source Port : 2000
TCP/UDP Destination Port : 3000
TCP Flags (mask, value) : 0, 0
Match action : accept
Status : active
Router#
Note For a description of each field, see the cable filter group command.
show cable flap-list cable {slot/port | slot/subslot/port} [upstream port] [sort-flap | sort-int | sort-
mac | sort-time]
Syntax Description cable slot/port (Optional) Displays the flap list for a particular cable interface on the
Cisco uBR7100 series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can
be 0 or 1, depending on the cable interface.
cable slot/subslot/port (Optional) Displays the flap list for a particular cable interface on the
Cisco uBR10012 router. The following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
upstream port (Optional) Displays the flap list for a particular upstream on the
selected cable interface.
sort-interface (Optional) Displays the flap list for all cable interfaces, sorted by
interface.
sort-flap (Optional) Sorts the list by the number of times the CM has flapped.
sort-int (Optional) Sorts the list first by the Cisco CMTS cable interface.
sort-mac (Optional) Sorts the list first by the Cisco CMTS cable interface and
then by the CM MAC (hardware) address.
sort-time (Optional) Sorts the list by the most recent time the CM is detected to
have flapped.
Release Modification
12.0(7)XR and The output of this command was enhanced to show that the Cisco CMTS has
12.1(1a)T1 detected an unstable return path for a particular CM and has compensated
with a power adjustment. An asterisk (*) appears in the power adjustment
field for a modem when a power adjustment has been made; an exclamation
point (!) appears when the CM has reached its maximum power transmit
level and cannot increase its power level further.
12.3(9a)BC The sort-int and sort-mac options were added.
Usage Guidelines The sort options operate differently on the different Cisco CMTS routers. On the Cisco uBR7100 series
and Cisco uBR7200 series routers, the sort options apply to all cable interface line cards and merge the
output into a single display.
On the Cisco uBR10012 router, the sort options apply to individual cable interface line cards. For
example, the sort-time option sorts all of the flap entries on the first cable interface line card (c5/0/0),
then the entries on the second card (c5/1/0), and so forth.
Note Occasionally, the show cable flap-list command might temporarily show duplicate entries for the same
cable modem. This can occur after a cable modem has gone offline and before it has completed the
registration process and come back online. When the cable modem does reach the online state, the
duplicate entries disappear.
Examples The following example shows the output of the show cable flap-list command:
router# show cable flap-list
MAC Address Upstream Ins Hit Miss CRC P-Adj Flap Time
0010.7bb3.fd19 Cable5/0/U1 0 2792 281 0 *45 58 Jul 27 16:54:50
0010.7bb3.fcfc Cable5/0/U1 0 19 4 0 !43 43 Jul 27 16:55:01
0010.7bb3.fcdd Cable5/0/U1 0 19 4 0 *3 3 Jul 27 16:55:01
Note The asterisk (*) in the P-Adj field indicates that a power adjustment has been made for that CM. The
exclamation point (!) indicates that the CM has reached its maximum power transmit level and cannot
increase its power level further.
The following example shows the display of flap-list tables sorted by MAC address:
router# show cable flap-list sort-flap
Mac Addr CableIF Ins Hit Miss CRC P-Adj Flap Time
0010.1eab.2c0b C6/0 U0 108 318 27 0 0 108 Sep 10 15:26:56
0010.1eb2.bb07 C6/0 U0 0 293 31 1 1 1 Sep 10 15:15:49
0010.7b6b.71cd C6/0 U0 1 288 32 0 0 1 Sep 10 15:12:13
0010.1eb2.bb8f C6/0 U0 1 295 30 0 0 1 Sep 10 15:11:44
The following example shows the display of flap-list tables sorted by time:
Router# show cable flap-list sort-time
Mac Addr CableIF Ins Hit Miss CRC P-Adj Flap Time
00e0.2222.2202 C4/0 U0 464 2069 242 0 421 885 Oct 16 22:47:23
0010.7b6b.57e1 C4/0 U0 0 2475 43 0 1041 1041 Oct 16 22:47:04
Table 3-8 describes the fields displayed by the show flap-list command.
Field Description
Mac Addr The MAC address for the CM.
CableIF The cable interface line card, including upstream, for this CM.
Ins The number of times the CM comes up and inserts itself into the
network. It can indicate intermittent downstream sync loss or
DHCP or modem registration problems.
Hit The number of times the CM responds to MAC layer keepalive
messages. (The minimum hit rate is once per 30 seconds. It can
indicate intermittent upstream, laser clipping, or common-path
distortion.
Miss The number of times the CM misses the MAC layer keepalive
message. An 8 percent miss rate is normal for the Cisco cable
interface line cards. It can indicate intermittent upstream, laser
clipping, or common-path distortion.
CRC The number of cyclic redundancy check (CRC) errors from this
CM. It can indicate intermittent upstream, laser clipping, or
common-path distortion.
P-Adj The number of times the headend instructed the CM to adjust
transmit (TX) power more than 3 dB. It can indicate amplifier
degradation, poor connections, or thermal sensitivity.
Flap The sum of P-Adj and Ins values. CMs with high flap counts have
high SIDs and might not register.
Time The most recent time that the CM dropped the connection.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Command Description
debug cable flap Displays information about the operation of the CM flap list that is
maintained for the cable interfaces.
ping docsis Sends a DOCSIS ping to a CM and increments the flap-list counters as
appropriate.
show cable modem Displays information about all CMs on an interface or about a particular CM.
show cable modem Displays flap list statistics for one or more cable modems.
flap
Syntax Description cable slot/port (Optional) Specifies a cable interface on the Cisco uBR7100 series
and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On
the Cisco uBR7200 series router, slot can range from 3 to 6, and port
can be 0 or 1, depending on the cable interface.
cable slot/subslot/port (Optional) Specifies a cable interface on the Cisco uBR10012 router.
The following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
upstream portnum (Optional) Specifies an upstream port for which to display the
frequency hop status.
Examples The following examples show typical output from the show cable hop and show cable hop upstream
commands:
Router# show cable hop
Upstream Port Poll Missed Min Missed Hop Hop Corr Uncorr
Port Status Rate Poll Poll Poll Thres Period FEC FEC
(ms) Count Sample Pcnt Pcnt (sec) Errors Errors
Cable4/0/U0 down 1000 * * * frequency not set * * * 0 0
Cable4/0/U1 down 1000 * * * frequency not set * * * 0 0
Cable4/0/U2 down 1000 * * * frequency not set * * * 0 0
Cable4/0/U3 down 1000 * * * frequency not set * * * 0 0
Cable4/0/U4 down 1000 * * * frequency not set * * * 0 0
Cable4/0/U5 down 1000 * * * frequency not set * * * 0 0
Cable5/0/U0 down 1000 * * * interface is down * * * 0 0
Cable5/0/U1 down 1000 * * * frequency not set * * * 0 0
Cable5/0/U2 down 1000 * * * interface is down * * * 0 0
Cable5/0/U3 down 1000 * * * interface is down * * * 0 0
Cable5/0/U4 down 1000 * * * interface is down * * * 0 0
Cable5/0/U5 down 1000 * * * interface is down * * * 0 0
Upstream Port Poll Missed Min Missed Hop Hop Corr Uncorr
Port Status Rate Poll Poll Poll Thres Period FEC FEC
(ms) Count Sample Pcnt Pcnt (sec) Errors Errors
Cable2/0/U2 admindown 1000 * * * frequency not set * * * 0 0
Router#
Table 3-9 describes the fields displayed by the show cable hop and show cable hop upstream
commands.
Field Description
Upstream Port The upstream port for this information line.
Port Status Lists the status of the port. Valid states are down if frequency is
unassigned or admindown if the port is shut down. If the port is up,
this column shows the center frequency of the channel.
Poll Rate The rate that station maintenance polls are generated (in
milliseconds).
Missed Poll Count The number of missing polls, per codeword/FEC block.
Min Poll Sample The number of polls in the sample, per codeword/FEC block.
Missed PollPcnt The ratio of missing polls to the number of polls, expressed as a
percentage.
Hop Thres Pcnt The level that the missed poll percentage must exceed to trigger a
frequency hop, expressed as a percentage.
Hop Period The maximum rate that frequency hopping will occur (in seconds).
Corr FEC Errors The number of correctable forward error corrections (FEC) errors
on this upstream port, per codeword/FEC block.
Uncorr FEC Errors The number of uncorrectable FEC errors on this upstream port, per
codeword/FEC block.
Note The show cable hop and show controllers cable commands display FEC errors per
codewords, while the show interface cable upstream command displays FEC errors per
packets, where a packet could contain multiple codewords.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Note The show cable host command is not supported on the Cisco uBR10012 universal broadband router.
Syntax Description mac-addr (Optional) Specifies the 48-bit hardware address for a particular CM or host.
ip-addr (Optional) Specifies the IP address for a particular CM or host.
Usage Guidelines This command displays information only for hosts and other CPE devices. To display information for
CMs and their associated CPE devices, use the show cable device access-group command. To display
information only for CMs, use the show cable modem access-group command.
If an SNMP manager is requesting information about CM or CPE devices at the same time that this
command is given, the command displays the following error message:
No information is available, please try later.
Wait until the SNMP retrieval is done and retry the CLI command.
Examples The following example shows how to display all the hosts behind the CMs in the network:
router# show cable host access-group
Router#
Table 3-10 describes the fields that are shown in the show cable host access-group display:
Field Description
MAC Address The MAC address for the CPE device.
IP Address The IP address that the DHCP server has assigned to the CPE device.
Type Identifies the type of device. With this command, this field should always be
host to indicate a CPE device. Use the show cable device access-group or
show cable modem access-group command to display information for CMs.
Access-group Displays the access group name or number in use (if any) for this CPE device.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description mac-address (Optional) Displays the mapping for the cable modem with the specified
hardware (MAC).
verbose (Optional) Displays additional information about the Layer 2 mapping,
including the number of packets and bytes received on the upstream and
downstream.
customer cust-name (Optional) Displays the VLAN mappings for this particular customer name.
Defaults Displays information for all cable modems that have a defined IEEE 802.1Q VLAN mapping.
Usage Guidelines This command displays the cable modem to VLAN mappings that have been defined using the cable
dot1q-vc-map command. It displays the MAC address, service ID (SID), and cable interface being used
by the cable modem, and the interface and VLAN ID to which it has been mapped.
Tip The customer option displays only those VLAN mappings that have been configured with a particular
customer name, using the cable dot1q-vc-map command.
Examples The following example shows typical output for the show cable l2-vpn dot1q-vc-map command for all
cable modems that are mapped to IEEE 802.1Q VLANs:
Router# show cable l2-vpn dot1q-vc-map
MAC Address Ethernet Interface VLAN ID Cable Intf SID Priv Bits
0010.7bed.9c95 FE0/0.2 3 Cable4/0 3 0
0007.0e03.69f9 FE0/0.1 4 Cable4/0 1 0
Router#
The following example shows typical output for a particular cable modem with the MAC address of
0010.7bed.9c91:
Router# show cable l2-vpn dot1q-vc-map 0001.0203.0405
MAC Address Ethernet Interface VLAN ID Cable Intf SID Priv Bits
0010.7bed.9c91 GE2/0 5 Cable5/0 7 0
Router#
The following example shows a typical example for the verbose option:
Router# show cable l2-vpn dot1q-vc-map 0001.0203.0405 verbose
Router#
Field Description
MAC Address Hardware (MAC) address for the CM being mapped.
Ethernet Interface Destination interface (Ethernet, Fast Ethernet, or Gigabit Ethernet) for the
VLAN being used for the mapping.
VLAN ID Destination VLAN on the Ethernet, Fast Ethernet, or Gigabit Ethernet interface
for the traffic coming from the CM.
Cable Intf Cable interface to which the CM is connected.
SID Primary service ID (SID) for this cable modem.
Priv Bits Identifies the current settings of the two privacy bits in the extended header (EH)
that is used for BPI-encrypted packets.
• First bit = Enable bit. Set to 1 when BPI or BPI+ is enabled.
• Second bit = Toggle bit. Matches the least-significant bit (LSB) of the key
sequence number (KSN) in the EH.
For example, a value of “0” indicates that BPI is not enabled. A value of “10”
indicates that BPI is enabled and that the KSN is an even number. A value of “11”
indicates that BPI is enabled and that the KSN is an odd number.
Note For more information on these bits, see the DOCSIS Baseline Privacy
Interface Plus Interface Specification (SP-BPI+-I08-020301 or later).
Total US pkts/bytes Total number of packets and bytes sent on the upstream to the Layer 2 tunnel by
this cable modem.
Total DS pkts/bytes Total number of packets and bytes received on the downstream from the Layer 2
tunnel by this cable modem.
Syntax Description mac-address (Optional) Displays the mapping for the cable modem with the specified
hardware (MAC).
customer cust-name (Optional) Displays the PVC mappings for this particular customer name.
Defaults Displays information for all cable modems that have a defined ATM PVC mapping.
Usage Guidelines This command displays the cable modem to ATM PVC mappings that have been defined using the cable
vc-map command. It displays the MAC address, service ID (SID), and cable interface being used by the
cable modem, and the ATM interface and PVC/PVI to which it has been mapped.
Tip The customer option displays only those PVC mappings that have been configured with a particular
customer name, using the cable vc-map command.
Examples The following example shows typical output for the show cable l2-vpn vc-map command for all cable
modems that are mapped to ATM PVCs:
Router# show cable l2-vpn vc-map
MAC Address ATM Intf VPI/VCI Cable Intf SID Priv Bits
0010.7bed.9c95 ATM2/0.2 1/2 Cable4/0 3 0
0007.0e03.69f9 ATM2/0.1 1/1 Cable4/0 1 0
Router#
The following example shows typical output for a particular cable modem with the MAC address of
0001.0203.0405:
Router# show cable l2-vpn vc-map 0001.0203.0405
MAC Address ATM Intf VPI/VCI Cable Intf SID Priv Bits
Router#
Field Description
MAC Address Hardware (MAC) address for the CM being mapped.
ATM Intf Destination ATM interface that contains the VPI/VCI being used for the
mapping.
VPI/VCI Destination VPI/VCI on the ATM interface for the traffic coming from the CM.
Cable Intf Cable interface to which the CM is connected.
SID Primary service ID (SID) for this cable modem.
Priv Bits Identifies the current settings of the two privacy bits in the extended header (EH)
that is used for BPI-encrypted packets.
• First bit = Enable bit. Set to 1 when BPI or BPI+ is enabled.
• Second bit = Toggle bit. Matches the least-significant bit (LSB) of the key
sequence number (KSN) in the EH.
For example, a value of “0” indicates that BPI is not enabled. A value of “10”
indicates that BPI is enabled and that the KSN is an even number. A value of “11”
indicates that BPI is enabled and that the KSN is an odd number.
Note For more information on these bits, see the DOCSIS Baseline Privacy
Interface Plus Interface Specification (SP-BPI+-I08-020301 or later).
Syntax Description cable slot/port (Optional) Displays information for all CMs on the specified cable interface
and downstream port on the Cisco uBR7246VXR router.
On the Cisco uBR7246VXR router, slot can range from 3 to 6, and port can
be 0 or 1, depending on the cable interface.
cable slot/subslot/port (Optional) Displays information for all CMs on the specified cable interface
on the Cisco uBR10012 router. The following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
requests-filtered (Optional) Displays the number of DHCP LEASEQUERY requests that have
[minimum-requests] been filtered for each particular cable modem on a cable interface.
• minimum-requests—(Optional) Displays only those cable modems for
which the router has filtered at least this minimum number of lease
queries. The valid range for minimum-requests is 1 to 65535, with a
default of 1.
Usage Guidelines The show cable leasequery-filter command displays the total number of DHCP LEASEQUERY
requests that have been filtered on a Cisco Cable Modem Termination System (CMTS) router and on a
particular cable interface. This command can also optionally display details for each particular cable
modem on an interface that has had DHCP lease queries filtered.
Examples The following example shows how to display the total number of DHCP LEASEQUERY requests that
have been filtered on the router and on a particular cable interface:
Router# show cable leasequery-filter
The following example shows how to display a list of cable modems on a cable interface and the number
of DHCP LEASEQUERY messages that have been filtered for each:
Router# show cable leasequery-filter cable 8/1/0 requests-filtered
Router#
The following example shows how to display a list of cable modems on a cable interface that have had
10 or more DHCP LEASEQUERY messages that have been filtered:
Router# show cable leasequery-filter cable 8/1/0 requests-filtered 10
Router#
Syntax Description group n (Optional) Specifies the number of the load-balance group to be displayed.
The valid range is 1 to 20. The default is to display information for all load-
balance groups.
all (Optional) Display all information listed below.
load (Optional) Displays current interface load and load-balance group
assignments.
pending (Optional) Displays list of cable modems that are currently being moved
from one downstream or upstream to another.
statistics (Optional) Displays cumulative statistics for load-balancing operations.
target (Optional) Displays the current and target interfaces (upstreams and
downstreams) that are being used for load balancing.
Defaults Displays information for all load-balance groups for each cable interface and its current load and load-
balancing status.
Usage Guidelines Use the show cable load-balance command to display the current, real-time statistics for load-balancing
operations.
Examples The following example shows typical output for the default display for the show cable load-balance
command:
Router# show cable load-balance
Cable3/0/U0 up 1 0% 0% 8 8 5.1
Cable3/0/U1 up 1 1% 0% 8 9 5.1
Cable3/0/U2 up 1 1% 0% 7 7 2.5
Cable3/0/U3 up 1 1% 0% 8 10 2.5
Router#
The following example shows typical output for the all option for the show cable load-balance
command. This option displays information that is displayed by all of the other options for this
command.
Router# show cable load-balance all
Current load:
Target assignments:
Statistics:
Pending:
Router#
Table 13 describes the fields shown in the show cable load-balance displays.
Field Description
Fields for the Default Displays and for the load Option
Interface Cable interface (downstream or upstream) that belongs to a load-balance group.
Group Number of the load-balance group to which this cable interface has been assigned.
Field Description
Utilization Current load usage for the cable interface, expressed as a percentage of the total bandwidth.
For upstreams, this field shows a single percentage value, which shows the average percentage
of bandwidth being used on that upstream.
For downstreams, this field shows a set of three percentage values:
• The first percentage shows the load usage for the entire interface.
• The second percentage (within the parentheses) shows the load for the downstream.
• The third percentage (within the parentheses) shows the average load for all upstreams on
this downstream.
For example, if this field shows “18%(18%/12%)”, it indicates that the downstream and
upstreams on the interface are running at an average load of 18 percent, the downstream itself
is running at an average load of 18 percent, and all upstreams for this downstream are running
at an average load of 12 percent.
Note This field is a long-term average of the upstream utilization. To display a short-term
average of the utilization, use the show interface cable mac-scheduler command.
State Current state of the cable interface, as it affects load balancing operations. The following
indicate normal operational states, depending on the configuration:
• down—Interface is administratively shut down. The CMTS does not use the interface for
load balancing.
• initial—Interface is currently in the initialization phase. The CMTS will use the interface
for load balancing after the initialization completes.
• up—Interface is administratively up and should be passing traffic. The CMTS is actively
using the interface for load balancing.
• testing—Interface is currently under a load-balancing test. The CMTS will not use the
interface for normal load balancing operations until the test completes.
The following states indicate abnormal states. The CMTS is not using interfaces in these states
for load balancing operations, but continues to monitor them and update their status every time
the CMTS polls the interfaces for their current load usage:
• suspicious—Interface is in an unknown state. The interface might be up and passing
traffic, but is not consistent enough to include in load balancing operations. The CMTS
attempts to reinitialize the interface after a timeout period. If that fails, the CMTS moves
the interface to the unstable state if the maximum number of retries (10) has not been
exhausted. If the interface has failed initialization more than 10 times, the CMTS marks it
as disabled.
• disabled—Interface has been disabled because a load-balancing test is occurring or
because the interface could not be initialized after 10 attempts. If a test is not occurring
and the interface can still not be initialized, the CMTS marks the interface as unstable.
• unstable—Interface has failed repeated initialization attempts. The CMTS will attempt to
reinitialize the interface after a timeout period.
Reserved Percentage of bandwidth that is currently reserved by unsolicited grant service (UGS) service
flows.
Modems Number of cable modems currently online this cable interface.
Flows Number of active service flows currently on this cable interface.
Field Description
Weight Interface bandwidth, in megabits per second (mbps), for the downstream or upstream. The
system uses this value in calculating whether the loads on the interfaces are balanced.
Changing a channel parameter, such as modulation profile or channel width, that affects the
channel’s bandwidth also changes the weight value.
Additional Fields When Displaying Load-Balance Groups
Interval How often, in seconds, the Cisco CMTS determines the current load on each cable interface in
the load balance group, as configured using the cable load-balance group interval command.
Method Load balancing method being used for this load balance group, as configured using the cable
load-balance group (global configuration) command.
Threshold Thresholds configured for this load balance group, as configured using the cable load-balance
group threshold command:
• Minimum = Minimum difference in the number of cable modems or service flows that can
exist on two interfaces in the group before cable modems are moved between the
interfaces. If the imbalance between interfaces is below this value, cable modems are not
moved. This field contains a value only when the group is configured for the modems or
service-flows method of load balancing. (This value is configured using the load
minimum option of the cable load-balance group threshold command.)
• Static = Minimum difference in the percentage of total load that must exist between
interfaces in a load-balance group before the Cisco CMTS performs static load balancing.
When the load between interfaces is greater than this value, cable modems that are in the
process of registering with the CMTS are moved between interfaces until the load
difference is again below this value. (This value is configured using the load option of the
cable load-balance group threshold command.)
• Enforce = Minimum difference in the percentage of total load that must exist between
interfaces in a load-balance group before the Cisco CMTS performs dynamic load
balancing and begins moving cable modems that are currently online. When the difference
in load between two interfaces falls below this value, the CMTS stops dynamic load
balancing and performs static load balancing. (This value is configured using the enforce
option of the cable load-balance group threshold command.)
• Ugs = Percentage of the bandwidth that is allocated for Unsolicited Grant Services (UGS)
traffic, such as Voice-over-IP (VoIP), that is in use on an interface because the CMTS
moves cable modems that are online with active UGS service flows. (This value is
configured using the ugs option of the cable load-balance group threshold command.)
Additional Fields for the target Option
Interface Source downstream or upstream interface that is part of a cable load balance group. If the
Target field contains a value, this indicates that this source interface is currently
oversubscribed, and that the CMTS is trying to reduce its load by moving cable modems from
the source interface to the target interface.
Field Description
Target Downstream or upstream interface to which cable modems on the source interface are being
moved as part of load balancing operations. This field can shown the following information:
• If this is a downstream interface, the display also shows the center frequency for the
downstream within the parentheses.
• If only a frequency is shown, the CMTS is moving cable modems to a different center
frequency on the same downstream interface.
• When the display includes the words “enforce”, it indicates that the CMTS is performing
dynamic load balancing on the interfaces and is moving cable modems that are currently
online.
• If this field is blank, then the source interface is not currently oversubscribed, and the
CMTS is not trying to reduce its load.
Additional Fields for the statistics Option
Target interface Downstream or upstream interface. If this is a downstream interface, the display also shows the
center frequency for the downstream within the parentheses.
Transfers Counters that track the following statistics for the indicated target interface.
• Complete = Number of cable modems that were successfully moved to the target interface.
• Pending = Number of cable modems that are currently in the process of being moved to
the target interface.
• Retries = Number of times that the CMTS unsuccessfully tried to move the same cable
modem to the target interface. The reason for the retries could be that one or MAC-layer
messages to the cable modem were dropped because of RF noise, or because the cable
modem is not DOCSIS-compliant. If the number of retries exceeds five for a particular
cable modem, the CMTS counts this as a failure.
• Failures = Number of times that the CMTS exceeded the maximum number of allowable
retries (5) when trying to move a particular cable modem to the target interface. A large
number of failures could indicate one or more of the possible problems:
– The specific cable modems are not DOCSIS-compliant.
– One or both interfaces are having problems passing traffic.
– One or both interfaces are having persistent RF noise problems.
– The source and target interfaces are not combined in the same node and do not share
the same physical connectivity (which is required when interfaces are part the same
load-balance group).
Additional Fields for the pending Option
Modem Hardware (MAC) address for the cable modem that is current in the process of being moved as
part of load balancing operations.
Source interface Downstream or upstream cable interface on which the cable modem is currently online.
Field Description
Target interface Downstream or upstream cable interface to which the CMTS is trying to move the cable
modem, so as to load balance the interfaces in this load balance group. If the CMTS is moving
the cable modem to a different frequency on the same downstream interface, this field shows
only the new center frequency.
Retries Number of times that the CMTS has attempted to move this cable modem to the target
interface. The CMTS attempts to move the cable modem five times before stopping any further
attempts and counting this load balancing move as a failure.
Syntax Description badipsource Displays the contents of the error log buffer containing the error messages
for bad IP source addresses.
layer2events Displays the contents of the message log buffer for DOCSIS-layer (Layer-2)
events.
summary Displays the status of the logging feature and its buffer.
slot (Optional) Displays the log for a particular cable interface on the
Cisco uBR7200 series router. The slot parameter can range from 3 to 6,
depending on the cable interface.
Note This option is supported only on the Cisco uBR-MC16U/X,
Cisco uBR-MC5X20U, and Cisco uBR-MC28U/X cable interface
line card.
Usage Guidelines The cable logging badipsource command creates a circular buffer that contains the BADIPSOURCE
error messages that the Cisco CMTS generates when it discovers a CM or CPE device using an
unauthorized IP address. Similarly, the cable logging layer2events command creates a buffer to contain
the system messages that are generated for DOCSIS-layer (Layer2) events. If the BADIPSOURCE or
DOCSIS-layer buffer becomes full, the oldest messages are deleted to make room for the newer
messages.
Use the show cable logging command to display the current contents of the BADIPSOURCE or
DOCSIS-layer buffer. After you have viewed all of the error messages in the current buffer, use the clear
cable logging command to clear out the buffer to make room for newer messages.
Use the show cable logging summary command to check whether the logging feature is enabled and
the status of the logging buffer.
The Broadband Processing Engine (BPE) cable interface line cards (such as the Cisco uBR-MC16U/X
and Cisco uBR-MC28U/X) contain an onboard processor that also maintains its own log buffer. To
display the contents of this log, add the card’s slot number after the show cable logging command.
Note The BADIPSOURCE and DOCSIS-layer messages are stored in separate buffers. Enabling, clearing, or
displaying the one buffer does not affect the other buffer.
Tip Use the service timestamps log date local msec command to include a timestamp with the logging
messages.
Examples The following example shows a typical display of the show cable logging badipsource command. The
oldest messages are displayed first.
Router# show cable logging badipsource
The following example shows the display of the show cable logging badipsource command when
logging has not been enabled with the cable logging badipsource command:
Router# show cable logging badipsource
Router#
The following example shows a typical display for the summary option, showing whether logging is
enabled, the total size of the buffer, how many bytes are currently used, and how many error messages
have been logged since the buffer was last cleared.
Router# show cable logging summary
Router#
The following example shows typical output from the DOCSIS-layer buffer. This example shows the log
buffer on a BPE cable interface line card that is in slot 4:
Router# show cable logging layer2events slot 4
Router#
Related Commands cable logging badipsource Logs error messages about bad IP source addresses on the cable
interfaces.
cable logging layer2events Logs system messages about DOCSIS-layer events on the
Cisco CMTS router.
cable source-verify Enables verification of IP addresses for CMs and CPE devices on the
upstream.
clear cable logging Removes all error messages about bad IP source addresses on the
cable interfaces from the error log buffer.
Syntax Description ip-address Identifies the IP address of a specific CM to be displayed. If you specify the
IP address for a CPE device behind a CM, information for that CM is
displayed.
mac-address Identifies the MAC address of a specific CM to be displayed. You can also
specify the MAC address for a CPE device behind a CM, and information
for that CM will be displayed.
cable slot/port (Optional) Displays information for all CMs on the specified cable interface
and downstream port on the Cisco uBR7100 series and Cisco uBR7200
series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0
or 1, depending on the cable interface.
cable slot/subslot/port (Optional) Displays information for all CMs on the specified cable interface
on the Cisco uBR10012 router. The following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
upstream port (Optional) Displays information for all CMs using this specific upstream.
You can specify this option only when displaying information for a cable
interface. The valid range for port begins with 0 and ends with a value that
depends on the number of upstream ports on the cable interface line card.
verbose Displays detailed information for the CMs.
Release Modification
12.0(7)XR and The output of this command was enhanced to show that the Cisco CMTS
12.1(1a)T1 has detected an unstable return path for a particular CM and has
compensated with a power adjustment. An asterisk (*) appears in the power
adjustment field for a modem when a power adjustment has been made; an
exclamation point (!) appears when the CM has reached its maximum power
transmit level and cannot increase its power level further.
12.1(4)CX and Support was added for the Cisco uBR10012 router.
12.2(4)BC1
12.1(10)EC1 Adds an exclamation point to CMs that have exceeded the maximum
delay/timing offset specified by the cable map-advance command.
12.1(11b)EC1, The output for the Online State field was updated for the cable tftp-enforce
12.2(8)BC2 command. A pound sign (#) appears next to the state value when a CM was
allowed to come online without attempting to download a DOCSIS
configuration file through the cable interface with the Cisco CMTS.
12.2(15)BC1 Additional lines were added to the show cable modem verbose displays,
for one or all cable modems, to show information about the dynamic shared-
secret feature. Cable modems that fail the dynamic secret authentication
checks and then come online are marked with an exclamation point (!), so
that this situation can be investigated.
12.2(15)CX The verbose option displays the sysDescr field for each cable modem, when
the cable modem remote-query command has been configured. Other
fields have also been added to support DOCSIS 2.0 (ATDMA) operation.
12.2(15)BC1c The verbose option displays whether dynamic service change requests
(DSX) are allowed from cable modems.
12.2(15)BC2 Two new states—cc(r1) and cc(r2)—have been added to the CM MAC state
field (see Table 3-15) to indicate the CM status when it has been instructed
to change channels and is ranging to obtain a new downstream or upstream
channel.
Also, three new states—online(pkd), online(ptd), and expire(pkd)—were
added to clarify the BPI state when network access has been disabled in the
CM’s DOCSIS configuration file.
In addition, the show cable modem verbose command now displays the
total amount of time that a CM has been online since last registering.
12.1(20)EC1 The three new states—online(pkd), online(ptd), and expire(pkd)—were
added to the Cisco IOS Release 12.1 EC train.
Usage Guidelines This command displays information for all CMs, for all CMs attached to a specific CMTS cable
interface, or for a particular CM, identified by its IP address or MAC address. The output is sorted by
the cable interface and the CM MAC address.
Tip Several options in the show cable modem command do not pause the screen to display the information
page by page, even if the terminal length command has been used to set the page size of your terminal.
Paging and pausing the display could result in outdated or stale information for CMs, and thus produce
an incorrect snapshot of the system’s current CM state. To capture or review this information, use your
terminal program’s capture buffer to save the information to a file, and then review it offline.
Tip You can also specify the MAC address or IP address for a CPE device, and the Cisco CMTS will display
the information for the CM that is associated with that CPE device in its internal database.
Operation of the show cable modem Commands with Different Cable Interface Line Cards
The show cable modem commands display the most current information for standard cable interface
line cards, such as the Cisco uBR-MC16C, Cisco uBR-MC16S, and Cisco uBR-MC28C cards. If the
card itself is down, the show cable modem commands still show whatever information is appropriate
(such as offline cable modems and flap list information).
The show cable modem commands function slightly differently when used on routers that are using
Broadband Processing Engine (BPE) cable interface line cards (such as the Cisco uBR-MC16U/X,
Cisco uBR-MC28U/X, or Cisco uBR-MC5X20S/U). When BPE cards are the only cable interface cards
installed, the show cable modem commands do not display any output until at least one BPE card is up
and communicating with the router processor. If the BPE cards are not yet up, the show cable modem
command does not display any output.
Examples The following sample output from the show cable modem command shows the default CM displays for
individual CMs.
Router# show cable modem
MAC Address IP Address I/F MAC Prim RxPwr Timing Num BPI
State Sid (db) Offset CPEs Enbld
0010.7b6b.58c1 0.0.0.0 C4/0/U5 offline 5 -0.25 2285 0 yes
0010.7bed.9dc9 0.0.0.0 C4/0/U5 offline 6 -0.75 2290 0 yes
0010.7bed.9dbb 0.0.0.0 C4/0/U5 offline 7 0.50 2289 0 yes
0010.7b6b.58bb 0.0.0.0 C4/0/U5 offline 8 0.00 2290 0 yes
0010.7bb3.fcd1 10.20.113.2 C5/0/U5 online 1 0.00 1624 0 yes
0010.7bb3.fcdd 0.0.0.0 C5/0/U5 init(r1) 2 -20.00 1624 0 no
0010.7b43.aa7f 0.0.0.0 C5/0/U5 init(r2) 3 7.25 1623 0 no
MAC Address IP Address I/F MAC Prim RxPwr Timing Num BPI
State Sid (db) Offset CPEs Enbld
0010.7bb3.fcd1 10.20.113.2 C5/0/U5 online 1 0.00 1624 0 Y
MAC Address IP Address I/F MAC Prim RxPwr Timing Num BPI
State Sid (db) Offset CPE Enb
0010.9507.01db 144.205.151.130 C5/1/0/U5 online(pt) 1 0.25 938 1 N
0080.37b8.e99b 144.205.151.131 C5/1/0/U5 online 2 -0.25 1268 0 N
0002.fdfa.12ef 144.205.151.232 C6/1/0/U0 online(pt) 13 -0.25 1920 1 N
0002.fdfa.137d 144.205.151.160 C6/1/0/U0 online 16 -0.50 1920 1 N
0003.e38f.e9ab 144.205.151.237 C6/1/0/U0 online 3 -0.50 1926 1 N
0003.e3a6.8173 144.205.151.179 C6/1/1/U2 offline 4 0.50 1929 0 N
0003.e3a6.8195 144.205.151.219 C6/1/1/U2 online(pt) 22 -0.50 1929 1 N
0006.28dc.37fd 144.205.151.244 C6/1/1/U2 online(pt) 61 0.00 1925 2 N
0006.28e9.81c9 144.205.151.138 C6/1/1/U2 online(pt) 2 !0.75 1925 1 N
0006.28f9.8bbd 144.205.151.134 C6/1/1/U2 #online 25 -0.25 1924 1 N
0006.28f9.9d19 144.205.151.144 C6/1/1/U2 online(pt) 28 0.25 1924 1 N
Router#
The following example shows sample output when the cable interface line cards are up, but no cable
modems are yet online:
Router# show cable modem
MAC Address IP Address I/F MAC Prim RxPwr Timing Num BPI
State Sid (db) Offset CPE Enb
Router#
The following example shows sample output when the Cisco CMTS router contains only Broadband
Processing Engine (BPE) cable interface line cards and none of the cable interface line cards are up:
Router# show cable modem
Router#
The following example shows sample output for the verbose option for a particular CM:
Router# show cable modem 0010.7bb3.fcd1 verbose
Router#
Note The “Number of CPES” field shows the value set for the CM, not the value for the CMTS that is set by
the cable modem max-cpe command. In Cisco IOS Release 12.2(15)BC1 and later releases, the verbose
display also includes information about the dynamic shared-secret feature (see the cable dynamic-
secret command).
Note An asterisk (*) in the Receive Power column indicates that a power adjustment has been made for that
CM. An exclamation point (!) in the Receive Power column indicates that the CM has reached its
maximum power transmit level and cannot increase its power level further. An exclamation point (!) in
the Timing Offset column indicates that the CM has exceeded the maximum delay and timing offset
specified by the cable map-advance command.
A pound sign (#) in the MAC State column indicates that the cable tftp-enforce mark-only command
has been used to require that a CM attempt a TFTP download of the DOCSIS configuration file before
registering, but the CM did not do so (Cisco IOS Release 12.1(11b)EC1 and Cisco IOS
Release 12.2(8)BC2 or later releases).
Tip The show cable modem command displays the CM timing offset in DOCSIS ticks, while other
commands, such as cable map-advance, display the offset in microseconds. Use the following method
to convert microseconds to DOCSIS ticks: ticks = microseconds*64/6.25.
Table 3-14 describes the major fields shown in the show cable modem displays:
Field Description
MAC Address The MAC address for the CM.
IP Address The IP address that the DHCP server has assigned to the CM.
I/F, Interface The cable interface line card providing the upstream for this CM.
sysDescr Identifies the vendor and model of the cable modem, as reported by the cable
modem. This field displays a value only when the cable modem remote-
query command has been configured.
Upstream Power The Upstream and Downstream Power fields are displayed only if the
CM remote-query feature has been enabled using the cable modem remote-
Downstream Power
query command. Upstream Power displays the CM transmit level in dBmV,
and Downstream Power displays the dBmV level received at the CM, as
measured by the CMTS.
MAC State The current state of the MAC layer (see Table 3-15).
Table 3-14 Descriptions for the show cable modem Fields (continued)
Field Description
Prim SID The primary SID assigned to this CM.
RxPwr, Received The average power in dBmV for the upstream channel symbol rate for the CM.
Power With default settings, 0 dBmV is considered optimal, but a range of -1 to 1
dBmV is allowable. When CMs exceed this range, older Cisco IOS releases
supported a drop to as low as -2 dBmV. Recent Cisco IOS releases support a
drop to as low as -4 dBmV.
This field supports a resolution of 0.25 dBmV, but the dB resolution level for
CMs and for the Cisco CMTS are slightly higher—approximately 1.0 and 1.4 dB.
Note An asterisk (*) in the RxPwr column indicates that a power
adjustment has been made for that CM. An exclamation point (!)
indicates that the CM has reached its maximum power transmit level
and cannot increase its power level further.
Timing Offset and The timing offset for the CM, in ticks, as recognized on the CMTS. (A tick,
Initial Timing Offset as used here, is 6.25/64 microseconds.) This is the delay between when a
particular cable modem is scheduled to make a transmission and when the
CMTS actually receives it.
Note An exclamation point (!) in the Timing Offset column indicates that
the CM has exceeded the maximum delay and timing offset specified
by the cable map-advance command.
Note The timing offset shown here is typically smaller than the TX Time
Offset value shown by the show cable modem remote-query
command, because the latter value is the offset as recognized on the
CM (which will include any internal delay between when the CM
software begins the transmission and when the bits actually appear on
the local cable interface).
Num CPEs, CFG Indicates the number of CPE devices for which the CM is providing services.
Max-CPE
Number of CPE IPs Indicates the maximum number of IP addresses assigned to CPE devices
behind this CM, as configured by the cable max-hosts command.
Ver, MAC Version Displays the maximum supported version of DOCSIS that the CM supports
(DOCSIS 1.0, DOCSIS 1.1, DOCSIS 2.0).
QoS Prov, QoS Displays the version of DOCSIS that the CM currently is provisioned for
Provisioned Mode (DOCSIS 1.0, DOCSIS 1.1, DOCSIS 2.0).
Enable DOCSIS 2.0 Indicates whether the CM is capable of DOCSIS 2.0 (ATDMA) operation, as
Mode determined by the presence and value of the Enable 2.0 Mode (TLV39) field
in the CM’s Registration Request message or in the DOCSIS configuration
file. The valid values are:
• Y = TLV 39 was set to 1, indicating that the CM has enabled DOCSIS 2.0
mode. The CM could still be registered for DOCSIS 1.1 operations,
however, on DOCSIS 1.X interfaces.
• N = Either the TLV 39 field was not present in the CM’s Registration
Request message, indicating that the CM is not capable of DOCSIS 2.0
operations, or the TLV 39 field was set to 0 in the DOCSIS configuration
file, preventing the CM from using the DOCSIS 2.0 mode.
Table 3-14 Descriptions for the show cable modem Fields (continued)
Field Description
Phy Operating Mode Indicates the type of PHY-layer modulation that the CM is using: tdma or
atdma.
BPI Enbld Indicates whether Baseline Privacy Interface (BPI) or BPI Plus (BPI+)
encryption is enabled for the CM.
Capabilities Indicates what the CM reported as its capabilities in its Registration Request
message: DOCSIS fragmentation, concatenation, packet header suppression
(PHS), and BPI encryption.
Optional Filtering Indicates whether 802.1P or 802.1Q packet filtering is enabled for this CM.
Support
Transmit Equalizer Number of taps being used for transmit equalization.
Support
Flaps Number of flaps reported by this CM, with the date and time of the last flap
within the parentheses.
Errors Number of frame CRC and HCS errors reported for this CM.
Stn Mtn Failures Number of station maintenance (cable keepalive) messages that the CMTS
sent to this CM but did not receive any reply.
Total US Flows Total number of upstream service flows, with the number of active service
flows within the parentheses.
Total DS Flows Total number of downstream service flows, with the number of active service
flows within the parentheses.
Total US Data Total data this CM has transmitted on the upstream, in packets and bytes.
Total US Throughput Calculated throughput for this CM on the upstream, if available.
Total DS Data Total data this CM has received on the downstream, in packets and bytes.
Total DS Throughput Calculated throughput for this CM on the downstream, if available.
Active Classifiers Current number of active classifiers for this CM, with the maximum number
of allowable classifiers for this CM within the parentheses.
DSA/DSX messages Indicates whether dynamic service changes (DSX) from the cable modem are
permitted (permit all) or disallowed (reject all).
Dynamic Secret Dynamically-generated shared secret (a 16-byte hexadecimal value) that was
used in the cable modem’s previous registration cycle. If the cable modem is
currently offline, this field shows all zeroes. If a cable modem has been
excluded from being processed by the dynamic shared secret feature, using
the cable dynamic-secret exclude command, this field shows “Excluded”.
Note This field displays a value only when the cable dynamic-secret
command has been used on the CMTS interface.
Table 3-14 Descriptions for the show cable modem Fields (continued)
Field Description
Spoof attempt Displays the status of the dynamic shared secret checks for this CM. If the
• Dynamic secret check failed = The DOCSIS configuration file did not
contain the proper shared secret, indicating a possible theft-of-service
attempt.
• Did not TFTP config file = The CM failed to download a DOCSIS
configuration file from the TFTP server.
Note This field displays a value only when the cable dynamic-secret
command has been used on the CMTS interface.
Total Time Online Amount of time in days, hours, and minutes that this CM has been
continuously online since it last registered with the CMTS. This field begins
incrementing whenever the CM enters one of the online(x) MAC states, and
is reset to 0 whenever the CM enters any other MAC state.
Table 3-15 shows the possible values for the MAC state field:
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Command Description
show cable modem Displays the CPE devices accessing the cable interface through a particular
cpe CM.
show cable modem Displays error statistics for one or more CMs.
errors
show cable modem Displays flap list statistics for one or more CMs.
flap
show cable modem Displays MAC layer information for one or more CMs.
mac
show cable modem Displays station maintenance (SM) error statistics for one or more CMs.
maintenance
show cable modem Displays a list of the CMs that are marked as offline with the Cisco CMTS.
offline
show cable modem Displays the DOCSIS PHY layer information for one or more CMs.
phy
show cable modem Displays quality of service (QoS) and service flow information for a
qos particular CM.
show cable modem Displays a list of the CMs that are marked as registered with the
registered Cisco CMTS.
show cable modem Displays information collected by the remote-query feature.
remote-query
show cable modem Displays a summary of CMs on one or more cable interfaces.
summary
show cable modem Displays a list of the CMs that are marked as unregistered with the
unregistered Cisco CMTS.
show cable modem Displays the vendor name or Organizational Unique Identifier (OUI) for the
vendor CMs on each cable interface.
show cable Displays modulation profile group information.
modulation-profile
show interface cable Displays information about the CMs connected to a particular cable
modem interface.
show interface cable Displays cable interface information.
sid
show cable modem [ip-address | cable slot/port [upstream port] | mac-address] access-group
Syntax Description ip-address (Optional) Displays access-group information for the CM with the
specified IP address. (Cisco uBR7100 series and Cisco uBR7200
series routers only.)
mac-address (Optional) Displays access-group information for the CM with the
specified MAC address. (Cisco uBR7100 series and Cisco uBR7200
series routers only.)
cable slot/port (Optional) Identifies the cable interface and downstream port on the
Cisco uBR7100 series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On
the Cisco uBR7200 series router, slot can range from 3 to 6, and port
can be 0 or 1, depending on the cable interface.
cable slot/subslot/port Identifies the cable interface on the Cisco uBR10012 router. The
following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
upstream port (Optional) Displays information for all CMs using this specific
upstream. You can specify this option only when displaying
information for a cable interface. The valid range for port begins with
0 and ends with a value that depends on the number of upstream ports
on the cable interface line card.
Usage Guidelines This command displays information only for CMs. To display information for both CMs and their
associated hosts and other customer premises equipment (CPE) devices, use the show cable device
access-group command. To display information only for hosts, use the show cable host access-group
command.
If an SNMP manager is requesting information about CM or CPE devices at the same time that this
command is given, the command displays the following error message:
No information is available, please try later.
Wait until the SNMP retrieval is done and retry the CLI command.
Note Also see the information about this command’s behavior in a Hot Standby Connection-to-Connection
Protocol (HCCP) configuration, see the “Operation with Hot Standby Connection-to-Connection
Protocol (HCCP) Configuration” section on page 3-54.
Examples The following example shows sample output for the show cable modem access-group command on a
Cisco uBR7200 series router for a particular CM:
Router# show cable modem 0010.7bb3.fcd1 access-group
Router#
Note The upstream and downstream power fields will be displayed only if the CM remote-query feature has
been enabled using the cable modem remote-query command.
The following example shows sample output for the show cable modem access-group command for a
particular cable interface on a Cisco uBR10012 router:
Router# show cable modem c8/1/0 access-group
Router#
Table 3-16 describes the fields that are shown in the show cable modem access-group display:
Table 3-16 Descriptions for the show cable modem access-group Fields
Field Description
MAC Address The MAC address for the CM.
IP Address The IP address that the DHCP server has assigned to the CM.
Access-group Displays the access group name or number in use (if any) for this CM.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description ip-address Displays classifier information for the CM with the specified IP address.
mac-address Displays classifier information for the CM with the specified MAC address.
cache (Optional) Displays the classifiers in the cache maintained for each CM.
(This cache is based on IP header field values and speeds up classifier
lookups and reduces per-packet processing overhead.)
verbose (Optional) Displays detailed information for the CM classifiers.
Usage Guidelines This command displays classifier information for a particular CM, identified either by its IP address or
MAC address.
Note Also see the information about this command’s behavior in a Hot Standby Connection-to-Connection
Protocol (HCCP) configuration, see the “Operation with Hot Standby Connection-to-Connection
Protocol (HCCP) Configuration” section on page 3-54.
Examples The following example shows sample output for the default classifiers option for a particular CM:
Router# show cable modem 10.4.0.81 classifiers
Router#
Table 3-17 describes the fields that are shown in the show cable modem classifiers display:
Table 3-17 Descriptions for the show cable modem classifiers Fields
Field Description
CfrID Classifier ID for the classifier that is being displayed.
SFID Service flow ID (SFID) for this classifier.
CM MAC Address MAC address for the CM.
Direction Identifies whether this classifier applies to the downstream or the upstream
direction.
State Classifier activation state: active or inactive.
Priority Classifier rule priority value for this classifier.
Matches Number of packets that have been matched to this service flow.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Note This command can be used for cable modems that are using interfaces on a Cisco uBR-MC16S,
Cisco uBR-MC16U/X, Cisco uBR-MC28U/X, and Cisco uBR-MC5X20S/U cable interface line cards
only.
Usage Guidelines This command displays information on the current CNR value for cable modems that are using interfaces
on the Cisco uBR-MC16S, Cisco uBR-MC16U/X, Cisco uBR-MC28U/X, and Cisco uBR-MC5X20S/U
cable interface line cards. For cable modems on all other interfaces, this command displays information
on the modem’s current SNR value.
Tip If you are using Hot Standby Connection-to-Connection Protocol (HCCP) 1+1 or 1:n (N+1) redundancy,
the new primary processor after a switchover automatically creates a new database of the online cable
modems. This means that the show cable modem ip-address cnr commands might not show a particular
cable modem until the CMTS receives IP traffic from that cable modem. You can force IP traffic by using
the ping ip-address command, and then the show cable modem ip-address cnr command will show the
cable modem. Also see the “Operation with Hot Standby Connection-to-Connection Protocol (HCCP)
Configuration” section on page 3-54.
Examples The following example shows sample output for the show cable modem cnr command for a CM:
Router# show cable modem 10.20.114.34 cnr
Router#
The following example shows the output of the show cable modem cnr command after an HCCP
switchover. The CNR value is missing until traffic is sent to the cable modem (in this case using the ping
command).
Router# show cable modem 10.10.10.46 cnr
Router#
Table 3-18 describes the information shown in the show cable modem cnr display:
Table 3-18 Descriptions for the show cable modem cnr Fields
Field Description
MAC Address The MAC address for the CM.
IP Address The IP address that the DHCP server has assigned to the CM.
I/F The cable interface line card providing the upstream for this CM.
MAC State The current state of the MAC layer (see Table 3-15 on page 3-60).
Table 3-18 Descriptions for the show cable modem cnr Fields (continued)
Field Description
Prim SID The primary SID assigned to this CM.
snr/cnr The current upstream carrier-to-noise ratio (CNR) or signal-to-noise ratio
(SNR) for this particular CM, in decibels (dB). In Cisco IOS Release
12.2(15)BC1 and later releases, this field shows “-----” for offline cable
modems.
Note You can also use the show controllers cable command to display the
signal-to-noise ration (SNR) or CNR for a cable interface line card,
but this value is only an estimate because it uses a random sampling
of modems to determine the average for the card at any particular
time. The CNR value shown by the show controllers cable command
can therefore appear to fluctuate compared to the individual values
shown by the show cable modem cnr command.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
show cable modem cable slot/port [upstream port] connectivity [rate [threshold] ]
show cable modem cable slot/subslot/port [upstream port] connectivity [rate [threshold] ]
Syntax Description ip-address (Optional) Displays information for the specific CM with the specified IP
address.
mac-address (Optional) Displays information for the specific CM with the specified
MAC address.
cable slot/port (Optional) Displays information for all CMs on the specified cable interface
and downstream port on the Cisco uBR7100 series and Cisco uBR7200
series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0
or 1, depending on the cable interface.
cable slot/subslot/port (Optional) Displays information for all CMs on the specified cable interface
on the Cisco uBR10012 router. The following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
upstream port (Optional) Displays information for all CMs using this specific upstream.
You can specify this option only when displaying information for a cable
interface. The valid range for port begins with 0 and ends with a value that
depends on the number of upstream ports on the cable interface line card.
rate [threshold] (Optional) Displays a graphical representation of the connect rates for CMs.
• threshold—(Optional) Specifies that the graphical display should show
only those time periods when this number of CMs, or more, came
online. The valid range is 2 to 20, with no default (the graph shows
when each CM came online).
Usage Guidelines This command displays connectivity information for all CMs, for all CMs attached to a specific CMTS
cable interface, or for a particular CM, as identified by its IP address or MAC address.
Note The show cable modem connectivity command replaces the connectivity option for the show interface
cable sid command, because the connectivity statistics are better managed on a per-modem basis than
on a per-SID basis.
Note Also see the information about this command’s behavior in a Hot Standby Connection-to-Connection
Protocol (HCCP) configuration, see the “Operation with Hot Standby Connection-to-Connection
Protocol (HCCP) Configuration” section on page 3-54.
Examples The following example shows sample output for the show cable modem connectivity command for all
online CMs:
Router# show cable modem connectivity
Router#
The following example shows sample output for the show cable modem connectivity command for all
online CMs for a particular cable interface:
Router# show cable modem c8/1/0 connectivity
Router#
The following example shows sample output for the show cable modem connectivity command for a
particular CM:
Router# show cable modem 0010.7bb3.fcd1 connectivity
Router#
Table 3-19 describes the information shown in the show cable modem connectivity displays:
Table 3-19 Descriptions for the show cable modem connectivity Fields
Field Description
Prim SID The primary SID assigned to this CM.
1st time online First time at which the modem with this SID connected.
Times online Number of times the modem with this SID connected.
% online Percentage of time the modem with this SID has been connected.
Online time The minimum, average, and maximum number of days, hours, and minutes
the modem with this SID has been connected.
Note A CM is considered online when it has completed the registration
process and has communicated with the DHCP, TFTP, and TOD
servers.
Offline time The minimum, average, and maximum number of days, hours, and minutes
the modem with this SID has been disconnected.
Note A CM is considered offline after it has missed 16 consecutive station
maintenance messages.
The following shows typical output for the rate option, where the threshold is set to 2, so that the output
shows only those time periods when two or more CMs came online:
Router# show cable modem connectivity rate 2
Online Time
(Relative to first modem online) Count
00:00|########....................................................2
00:01|############................................................3
00:02|################............................................4
00:03|####################........................................5
00:04|################............................................4
00:05|####################........................................5
~
00:07|############################................................7
~
00:09|####################################################........13
00:10|####################........................................5
00:11|########################################################....14
00:12|################............................................4
00:13|########....................................................2
~
00:17|############................................................3
~
00:19|################################............................8
00:20|############................................................3
00:21|########....................................................2
~
00:23|########....................................................2
~
00:37|############................................................3
~
00:39|########....................................................2
00:40|############................................................3
~
00:42|############................................................3
~
00:58|########....................................................2
~
01:01|########....................................................2
~
01:13|############................................................3
~
01:15|############................................................3
01:16|########################....................................6
~
01:27|################............................................4
~
01:30|########....................................................2
01:31|############................................................3
~
01:34|################............................................4
~
01:38|########....................................................2
01:39|########....................................................2
01:40|########....................................................2
01:41|############................................................3
01:42|############................................................3
01:43|########....................................................2
01:44|############................................................3
~
01:52|############................................................3
~
01:55|####################........................................5
01:56|########....................................................2
01:57|########....................................................2
01:58|########....................................................2
01:59|########....................................................2
~
02:01|############................................................3
02:02|############................................................3
02:03|################............................................4
02:04|################............................................4
02:05|############################................................7
02:06|################............................................4
02:07|########################....................................6
02:08|########################################....................10
02:09|############................................................3
02:10|############................................................3
Router#
The following shows typical output when the threshold parameter is set to 10, so that each line in the
graph shows only the time periods when 10 or more cable modems came online.
Router# show cable modem connectivity rate 10
Online Time
(Relative to first modem online) Count
00:09|####################################################........13
~
00:11|########################################################....14
~
02:08|########################################....................10
Router#
When using the rate option, each line of the display shows the following information:
• A timestamp showing the number of minutes and seconds from which the first CM came online.
• A graphical display, using pound signs (#), of the number of CMs that came online at this particular
point in time. Each CM is presented by four pound signs.
• A numerical count of the number of CMs that came online at this particular point in time.
• A tilde (~) represents a gap of more than one second appears between two lines.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description ip-address (Optional) Displays counter information for the CM with the specified IP
address.
mac-address (Optional) Displays counter information for the CM with the specified
MAC address.
cable slot/port (Optional) Displays counter information for all CMs on the specified cable
interface and downstream port on the Cisco uBR7100 series and
Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0
or 1, depending on the cable interface.
cable slot/subslot/port (Optional) Displays counter information for all CMs on the specified cable
interface on the Cisco uBR10012 router. The following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
upstream port (Optional) Displays information for all CMs using this specific upstream.
You can specify this option only when displaying information for a cable
interface. The valid range for port begins with 0 and ends with a value that
depends on the number of upstream ports on the cable interface line card.
Usage Guidelines
Note Also see the information about this command’s behavior in a Hot Standby Connection-to-Connection
Protocol (HCCP) configuration, see the “Operation with Hot Standby Connection-to-Connection
Protocol (HCCP) Configuration” section on page 3-54.
Examples The following example shows sample output for the show cable modems counters command for all
CMs:
Router# show cable modem counters
Router#
The following example shows sample output for the show cable modems counters command for all
CMs on a particular cable interface:
Router# show cable modem c8/1/0 counters
Router#
The following example shows sample output for the show cable modems counters command for a
particular CM, as identified by its MAC address:
Router# show cable modem 0010.7bb3.fcd1 counters
Router#
The following example shows sample output for the show cable modems counters command for a
particular CM, as identified by its IP address:
Router# show cable modem 23.1.1.10 counters
Router#
Table 3-20 describes the fields shown in the show cable modem counters displays:
Table 3-20 Descriptions for the show cable modem counters Fields
Field Description
MAC Address MAC address for the CM.
US Packets Number of packets this CM has transmitted on the upstream.
Table 3-20 Descriptions for the show cable modem counters Fields (continued)
Field Description
US Bytes Number of bytes this CM has transmitted on the upstream.
DS Packets Number of packets this CM has received on the downstream.
DS Bytes Number of byte this CM has received on the downstream.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description ip-address Displays the CPE devices for the CM with the specified IP address.
mac-address Displays the CPE devices for the CM with the specified MAC address.
Usage Guidelines This command lists the CPE devices that are accessing the cable network through a particular CM. You
can identify the CM either by its IP address or by its MAC address.
Note Also see the information about this command’s behavior in a Hot Standby Connection-to-Connection
Protocol (HCCP) configuration, see the “Operation with Hot Standby Connection-to-Connection
Protocol (HCCP) Configuration” section on page 3-54.
Examples The following example shows sample output for the show cable modem cpe command, listing the CPE
devices by their MAC and IP addresses:
Router# show cable modem 10.14.1.20 cpe
10.14.30.100 00b0.4a9b.bc8c
10.14.30.101 00b0.4a9b.bc8d
Router#
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description ip-address (Optional) Displays error information for a specific CM with the specified
IP address.
mac-address (Optional) Displays error information for a specific CM with the specified
MAC address.
cable slot/port (Optional) Displays information for all CMs on the specified cable interface
and downstream port on the Cisco uBR7100 series and Cisco uBR7200
series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0
or 1, depending on the cable interface.
cable slot/subslot/port (Optional) Displays information for all CMs on the specified cable interface
on the Cisco uBR10012 router. The following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
upstream port (Optional) Displays information for all CMs using this specific upstream.
You can specify this option only when displaying information for a cable
interface. The valid range for port begins with 0 and ends with a value that
depends on the number of upstream ports on the cable interface line card.
Usage Guidelines This command displays packet header error information for all CMs, for all CMs attached to a specific
CMTS cable interface, or for a particular CM, as identified by its IP address or MAC address.
Tip In Cisco IOS Release 12.2(15)BC1 and later releases, use the clear cable modem flap-counters
command to clear these counters.
Note Also see the information about this command’s behavior in a Hot Standby Connection-to-Connection
Protocol (HCCP) configuration, see the “Operation with Hot Standby Connection-to-Connection
Protocol (HCCP) Configuration” section on page 3-54.
Examples The following example shows sample output for the show cable modem errors command for all CMs
on a particular cable interface.
Router# show cable modem c8/1/0 errors
Router#
Table 3-21 describes the fields shown in the show cable modem errors displays:
Table 3-21 Descriptions for the show cable modem errors Fields
Field Description
MAC Address The MAC address for the CM.
I/F The cable interface line card, including the upstream, for this CM.
CRC Number of times the CMTS upstream receiver flagged a packet with a cyclic
redundancy check (CRC) error from this CM. CRC errors usually indicate
downstream signal interruption or interference noise on a plant. Occasional
CRC errors can always be expected, but a high number of CRC errors could
indicate plant problems such as intermittent upstream problems, laster
clipping, common-path distortion, or impulsive noise or interference.
HCS Number of times the CMTS upstream receiver flagged a packet with a header
checksum (HCS) error from this CM. HCS errors could indicate the same sort
of plant problems as CRC errors.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Command Description
show cable modem Displays flap list statistics for one or more cable modems.
flap
show cable modem Displays station maintenance (SM) error statistics for one or more cable
maintenance modems.
show interface cable Displays information about the CMs connected to a particular cable
modem interface.
Syntax Description ip-address (Optional) Displays flap list information for a specific CM with the
specified IP address.
mac-address (Optional) Displays flap list information for a specific CM with the
specified MAC address.
cable slot/port (Optional) Displays information for all CMs on the specified cable interface
and downstream port on the Cisco uBR7100 series and Cisco uBR7200
series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0
or 1, depending on the cable interface.
cable slot/subslot/port (Optional) Displays information for all CMs on the specified cable interface
on the Cisco uBR10012 router. The following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
upstream port (Optional) Displays information for all CMs using this specific upstream.
You can specify this option only when displaying information for a cable
interface. The valid range for port begins with 0 and ends with a value that
depends on the number of upstream ports on the cable interface line card.
Usage Guidelines This command displays information about the flap-list activity for one or more cable modems. This
information is similar to that shown by the show cable flap-list command, except that the show cable
modem flap command displays it on a per-modem basis.
Note Also see the information about this command’s behavior in a Hot Standby Connection-to-Connection
Protocol (HCCP) configuration, see the “Operation with Hot Standby Connection-to-Connection
Protocol (HCCP) Configuration” section on page 3-54.
Examples The following example shows sample output for the show cable modem flap command for all cable
modems on a specific cable interface:
Router# show cable modem c8/1/0 flap
MAC Address I/F Ins Hit Miss CRC P-Adj Flap Time
0050.7366.1243 C8/1/0/U1 6 29770 79 0 0 11 Apr 28 13:08:06
0002.b970.0027 C8/1/0/U4 6 29737 109 0 1 14 Apr 28 13:08:44
0006.5314.858d C8/1/0/U4 2 29635 41 0 0 4 Apr 28 13:09:21
Router#
The following example shows sample output for the show cable modem flap command for a particular
CM:
Router# show cable modem 0010.7bb3.fcd1 flap
MAC Address I/F Ins Hit Miss CRC P-Adj Flap Time
0010.7bb3.fcd1 C5/0/U5 0 36278 92 0 369 372 Jun 1 13:05:23
Router#
Table 3-22 describes the fields shown in the show cable modem flap displays:
Table 3-22 Descriptions for the show cable modem flap Fields
Field Description
MAC Address The MAC address for the CM.
I/F The cable interface line card, including upstream, for this CM.
Ins The number of times the CM comes up and inserts itself into the network. It
can indicate intermittent downstream sync loss or DHCP or modem
registration problems.
Hit The number of times the CM responds to MAC layer keepalive messages.
(The minimum hit rate is once per 30 seconds. It can indicate intermittent
upstream, laser clipping, or common-path distortion.
Miss The number of times the CM misses the MAC layer keepalive message. An 8
percent miss rate is normal for the Cisco cable interface line cards. It can
indicate intermittent upstream, laser clipping, or common-path distortion.
CRC The number of cyclic redundancy check (CRC) errors from this CM. It can
indicate intermittent upstream, laser clipping, or common-path distortion.
P-Adj The number of times the headend instructed the CM to adjust transmit (TX)
power more than 3 dB. It can indicate amplifier degradation, poor
connections, or thermal sensitivity.
Flap The sum of P-Adj and Ins values. CMs with high flap counts have high SIDs
and might not register.
Time The most recent time that the CM dropped the connection.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description summary [total] (Optional) Displays a summary of MAC layer information for each cable
interface. If you add the optional total keyword, the display includes a total
of CMs that are included in each of the displayed fields.
ip-address (Optional) Displays MAC layer information for the CM with the specified
IP address.
mac-address (Optional) Displays MAC layer information for the CM with the specified
MAC address.
cable slot/port (Optional) Displays MAC layer information for all CMs on the specified
cable interface and downstream port on the Cisco uBR7100 series and
Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0
or 1, depending on the cable interface.
cable slot/subslot/port (Optional) Displays MAC layer information for all CMs on the specified
cable interface on the Cisco uBR10012 router. The following are the valid
values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
upstream port (Optional) Displays information for all CMs using this specific upstream.
You can specify this option only when displaying information for a cable
interface. The valid range for port begins with 0 and ends with a value that
depends on the number of upstream ports on the cable interface line card.
Usage Guidelines
Note Also see the information about this command’s behavior in a Hot Standby Connection-to-Connection
Protocol (HCCP) configuration, see the “Operation with Hot Standby Connection-to-Connection
Protocol (HCCP) Configuration” section on page 3-54.
Examples This section contains examples for the different forms of the show cable modem mac command.
Default Displays
The following example shows typical output for the default form of the show cable modem mac
command:
Router# show cable modem mac
MAC Address MAC Prim Ver QoS Frag Concat PHS Priv DS US
State Sid Prov Saids Sids
0050.7366.1243 online 1 DOC1.0 DOC1.0 no no no BPI 0 0
0002.b970.0027 online 2 DOC1.1 DOC1.0 no yes yes BPI+ 0 4
0006.5314.858d online 3 DOC1.1 DOC1.1 yes yes yes BPI+ 0 4
0010.64ff.e4ad online 1 DOC1.1 DOC1.0 yes yes yes BPI+ 0 4
0010.f025.1bd9 init(rc) 2 DOC1.0 DOC1.0 no no no BPI 0 0
0010.9659.4447 online(pt) 3 DOC1.0 DOC1.0 no yes no BPI 0 0
0010.9659.4461 online(pt) 4 DOC1.0 DOC1.0 no yes no BPI 0 0
0010.64ff.e459 online 5 DOC1.0 DOC1.0 no yes no BPI 0 0
0020.4089.7ed6 online 6 DOC1.0 DOC1.0 no no no BPI 0 0
0090.9607.3831 online(pt) 7 DOC1.0 DOC1.0 no no no BPI 0 0
0090.9607.3830 online(pt) 1 DOC1.0 DOC1.0 no no no BPI 0 0
0050.7366.12fb init(i) 2 DOC1.0 DOC1.0 no no no BPI 0 0
0010.fdfa.0a35 online(pt) 3 DOC1.1 DOC1.1 yes yes yes BPI+ 0 4
Router#
The following example shows sample output for the show cable modem mac command for a particular
cable interface:
Router# show cable modem c3/0 mac
MAC Address MAC Prim Ver QoS Frag Concat PHS Priv DS US
State Sid Prov Saids Sids
0050.7366.1243 online 1 DOC1.0 DOC1.0 no no no BPI 0 0
0002.b970.0027 online 2 DOC1.1 DOC1.0 no yes yes BPI+ 0 4
0006.5314.858d online 3 DOC1.1 DOC1.1 yes yes yes BPI+ 0 4
Router#
The following example shows sample output for the show cable modem mac command for a particular
CM, as identified by its MAC address:
Router# show cable modem 0010.7bb3.fcd1 mac
MAC Address MAC Prim Ver QoS Frag Concat PHS Priv DS US
State Sid Prov Saids Sids
0010.7bb3.fcd1 online 91 DOC1.1 DOC1.1 yes yes yes BPI+ 1 4
Router#
The following example shows sample output for the show cable modem mac command for a particular
CM, as identified by its IP address:
Router# show cable modem 10.1.1.10 mac
MAC Address MAC Prim Ver QoS Frag Concat PHS Priv DS US
State Sid Prov Saids Sids
0002.b970.0027 online 2 DOC1.1 DOC1.0 no yes yes BPI+ 0 4
Router#
Table 3-23 describes the fields shown in the default forms of the show cable modem mac displays:
Table 3-23 Descriptions for the Default show cable modem mac Fields
Field Description
MAC Address The MAC address for the CM.
MAC State The current state of the MAC layer (see Table 3-15 on page 3-60).
Prim SID The primary SID assigned to this CM.
Ver Displays the maximum supported version of DOCSIS that the CM supports
(DOCSIS 1.0, DOCSIS 1.1, DOCSIS 2.0).
QoS Prov Displays the version of DOCSIS that the CM currently is provisioned and
registered for (DOCSIS 1.0, DOCSIS 1.1, DOCSIS 2.0).
Frag Indicates whether DOCSIS 1.1 or 2.0 MAC-layer fragmentation is enabled
for this CM.
Concat Indicates whether DOCSIS 1.1 or 2.0 MAC-layer concatenation is enabled
for this CM.
PHS Indicates whether DOCSIS 1.1 or 2.0 packet header suppression (PHS) is
enabled for this CM.
Priv Indicates whether Baseline Privacy Interface (BPI) or BPI Plus (BPI+)
encryption is enabled for the CM.
DS Saids Number of downstream security association IDs (Saids) used by this CM.
US Sids Number of upstream service IDs (SIDs) used by this CM.
-------------------
Mac Version QoS Provision Mode
Interface Total DOC2.0 DOC1.1 DOC1.0 Reg/Online DOC2.0 DOC1.1 DOC1.0
Cable8/1/0/U1 1 1 0 0 1 0 0 1
Cable8/1/0/U4 2 2 0 2 2 1 1 0
Router#
The following example shows the summary display when the total option is added:
Router# show cable modem mac summary total
Total: 32 0 1 31 25 0 0 25
Router#
Table 3-24 describes the fields shown in the show cable modem mac summary displays:
Table 3-24 Descriptions for the show cable modem mac summary Fields
Field Description
I/F The cable interface line card providing the upstream for this CM.
Total Total number of CMs currently active on this cable interface.
MAC Version Total number of CMs on this interface that reported in their registration
DOC 2.0 request as having DOCSIS 2.0 capabilities.
MAC Version Total number of CMs on this interface that reported in their registration
DOC 1.1 request as having DOCSIS 1.1 capabilities.
MAC Version Total number of CMs on this interface that reported in their registration
DOC 1.0 request as having DOCSIS 1.0 capabilities.
Reg/Online Total number of CMs on this interface that have completed registration and
are currently online.
QoS Provisioned Mode Total number of CMs on this interface that have been provisioned and
DOC 2.0 registered for DOCSIS 2.0 operations.
QoS Provisioned Mode Total number of CMs on this interface that have been provisioned and
DOC 1.1 registered for DOCSIS 1.1 operations.
QoS Provisioned Mode Total number of CMs on this interface that have been provisioned and
DOC 1.0 registered for DOCSIS 1.0 operations.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Usage Guidelines This command displays information about the number of times that a CM has exhausted its maximum
retry attempts to respond to a Station Maintenance (SM) request, as well as the number of times that the
CMTS has aborted ranging with a CM during a Station Maintenance interval. This information can be
used to determine whether a particular cable modem or interface is experiencing plant or network
difficulties.
You can display this information for all online cable modems, all online cable modems for a specific
cable interface, or for one particular cable modem.
Note Also see the information about this command’s behavior in a Hot Standby Connection-to-Connection
Protocol (HCCP) configuration, see the “Operation with Hot Standby Connection-to-Connection
Protocol (HCCP) Configuration” section on page 3-54.
Examples The following example shows sample output for the show cable modem maintenance command for all
online cable modems:
Router# show cable modem maintenance
The following example shows sample output for the show cable modem maintenance command for all
cable modems on a specific cable interface:
Router# show cable modem c8/1/0 maintenance
Router#
The following example shows sample output for the show cable modem maintenance command for a
particular CM:
Router# show cable modem 0010.7bb3.fcd1 maintenance
Router#
Table 3-25 describes the fields shown in the show cable modem maintenance displays:
Table 3-25 Descriptions for the show cable modem maintenance Fields
Field Description
MAC Address The MAC address for the CM.
I/F The cable interface line card, including upstream, for this CM.
Prim SID The primary SID assigned to this CM.
SM Exhausted Number of times this CM has repeatedly timed out and exhausted the
Count maximum allowable retry attempts when it was sent a Station Maintenance
request. The CMTS responds by taking the CM offline, forcing the CM to
reinitialize and reregister.
SM Exhausted The last time that this CM repeatedly timed out and exhausted the maximum
Time allowable retry attempts when it was sent a Station Maintenance request.
SM Aborted Number of times the CMTS has aborted ranging for a CM during a Station
Count Maintenance period, typically because the CM has been reset.
SM Aborted The last time the CMTS aborted ranging for a CM during a Station
Time Maintenance period, typically because the CM has been reset.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description ip-address (Optional) Displays information for the offline CM with the specified IP
address.
mac-address (Optional) Displays information for the offline CM with the specified MAC
address.
cable slot/port (Optional) Displays information for all offline CMs that last used the
specified cable interface and downstream port on the Cisco uBR7100 series
and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0
or 1, depending on the cable interface.
cable slot/subslot/port (Optional) Displays information for all offline CMs that last used the
specified cable interface on the Cisco uBR10012 router. The following are
the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
upstream port (Optional) Displays information for all CMs using this specific upstream.
You can specify this option only when displaying information for a cable
interface. The valid range for port begins with 0 and ends with a value that
depends on the number of upstream ports on the cable interface line card.
Defaults Displays a list of all offline CMs known by the Cisco CMTS router.
Usage Guidelines This command displays a list of CMs that had either been online previously or had attempted to register
with the CMTS, but that are now considered offline. Offline cable modems remain in the CMTS
databases for 24 hours and then are deleted.
Note Also see the information about this command’s behavior in a Hot Standby Connection-to-Connection
Protocol (HCCP) configuration, see the “Operation with Hot Standby Connection-to-Connection
Protocol (HCCP) Configuration” section on page 3-54.
Examples The following example shows sample output for the default form of the show cable modem offline
command.
Router# show cable modem offline
Router#
The following example shows sample output for the show cable modem offline command for a
particular upstream on a cable interface:
Router# show cable modem c3/0 upstream 0 offline
Router#
The following example shows sample output for the show cable modem offline command for a single
CM, as identified by its IP address:
Router# show cable modem 22.1.1.10 offline
Router#
The following example shows sample output for the show cable modem offline command for a single
CM, as identified by its MAC address:
Router# show cable modem 0030.946a.5d61 offline
Router#
Table 3-26 describes the major fields shown in the show cable modem offline displays:
Table 3-26 Descriptions for the show cable modem offline Fields
Field Description
Interface The cable interface line card that this CM last used when it was online.
MAC address Hardware MAC address for this CM.
Prim SID The primary SID that had been last assigned to this CM before it went offline.
Previous State The last known state of the MAC layer for this CM before it went offline (see
Table 3-15 on page 3-60).
Note A pound sign (#) in the Previous State column indicates that the cable
tftp-enforce mark-only command has been used to require that a CM
attempt a TFTP download of the DOCSIS configuration file before
registering, but the CM did not do so (Cisco IOS Release
12.1(11b)EC1 and Cisco IOS Release 12.2(8)BC2 or later releases).
Offline Time The time and date that this CM last went offline.
Rx Power The last known received power level (in dB) for the CM before it went offline.
Note An asterisk (*) in the Rx Power column indicates that a power
adjustment was made for that CM. An exclamation point (!) indicates
that the CM had reached its maximum power transmit level and could
not increase its power level further.
Rx SNR The last known signal-to-noise ratio (SNR) value for this CM before it went
offline.
SM Exhaust Count Number of times that this CM has exhausted the maximum allowable retries
for not responding to the regular Station Maintenance (SM) messages sent to
it by the CMTS.
Note Using the clear counters command to reset a cable interface’s counters also resets the SM
Exhaust Count field for all offline CMs to zero and resets the Offline Time field for all offline
CMs to the current time.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Command Description
show cable modem Displays information about the classifiers for a particular CM.
classifiers
show cable modem Displays connectivity statistics for one or more CMs.
connectivity
show cable modem Displays the CPE devices accessing the cable interface through a particular
cpe CM.
show cable modem Displays a list of the CMs that are marked as registered with the
registered Cisco CMTS.
show cable modem Displays a list of the CMs that are marked as unregistered with the
unregistered Cisco CMTS.
show cable modem Displays the vendor name or Organizational Unique Identifier (OUI) for the
vendor CMs on each cable interface.
show interface cable Displays information about the CMs connected to a particular cable
modem interface.
show interface cable Displays cable interface information.
sid
Syntax Description ip-address (Optional) Displays PHY information for the CM with the specified IP
address.
mac-address (Optional) Displays PHY information for the CM with the specified MAC
address.
cable slot/port (Optional) Displays PHY information for all CMs on the specified cable
interface and downstream port on the Cisco uBR7100 series and
Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0
or 1, depending on the cable interface.
cable slot/subslot/port (Optional) Displays PHY information for all CMs on the specified cable
interface on the Cisco uBR10012 router. The following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
upstream port (Optional) Displays information for all CMs using this specific upstream.
You can specify this option only when displaying information for a cable
interface. The valid range for port begins with 0 and ends with a value that
depends on the number of upstream ports on the cable interface line card.
Usage Guidelines This command displays information about the DOCSIS PHY layer for one or more CMs. You can display
information for all CMs, for all CMs on a particular cable interface, or for a particular CM, as identified
by its IP or MAC address.
Note Also see the information about this command’s behavior in a Hot Standby Connection-to-Connection
Protocol (HCCP) configuration, see the “Operation with Hot Standby Connection-to-Connection
Protocol (HCCP) Configuration” section on page 3-54.
Examples The following example shows sample output for the show cable modem phy command for all CMs on
the Cisco CMTS router:
Router# show cable modem phy
MAC Address I/F Sid USPwr USSNR Timing MicroReflec DSPwr DSSNR Mode
(dBmV) (dBmV) Offset (dBc) (dBmV) (dBmV)
Router#
The following example shows sample output for the show cable modem phy command for all CMs on
a particular cable interface:
Router# show cable modem cable 3/0 phy
MAC Address I/F Sid USPwr USSNR Timing MicroReflec DSPwr DSSNR Mode
(dBmV) (dBmV) Offset (dBc) (dBmV) (dBmV)
Router#
The following example shows sample output for the show cable modem phy command for a particular
CM:
Router# show cable modem 0050.7366.1243 phy
MAC Address I/F Sid USPwr USSNR Timing MicroReflec DSPwr DSSNR Mode
(dBmV) (dBmV) Offset (dBc) (dBmV) (dBmV)
Router#
Table 3-27 describes the fields shown in the show cable modem phy displays:
Table 3-27 Descriptions for the show cable modem phy Fields
Field Description
MAC Address The MAC address for the CM.
I/F The cable interface on the CMTS that is providing services for this CM.
SID Service ID that this CM is using.
Table 3-27 Descriptions for the show cable modem phy Fields (continued)
Field Description
USPwr (dBmV) Displays the CM transmit level in dBmV, as measured by the CMTS.
USSNR (dBmV) Upstream signal-to-noise ratio (SNR) or carrier-to-noise ratio (CNR), in dB,
as measured by the CMTS. This field shows the CNR value for cable
interfaces that support onboard hardware-based spectrum management, such
as the Cisco uBR-MC16S card, and shows the SNR value for other cable
interfaces.
Note Although the field name shows the value as being given in dBmV, the
actual value should be interpreted in dB.
Timing Offset The timing offset for the CM, in ticks, as recognized on the CMTS. (A tick,
as used here, is 6.25/64 microseconds.) This is the delay between when a
particular cable modem is scheduled to make a transmission and when the
CMTS actually receives it.
Note An exclamation point (!) in the Timing Offset column indicates that
the CM has exceeded the maximum delay and timing offset specified
by the cable map-advance command.
Note The timing offset shown here is typically smaller than the TX Time
Offset value shown by the show cable modem remote-query
command, because the latter value is the offset as recognized on the
CM (which will include any internal delay between when the CM
software begins the transmission and when the bits actually appear on
the local cable interface).
Microreflec (dBc) The approximate value of microreflections on the downstream, measured in
dBc below the signal level, as seen by the CM. Microreflections are a type of
impairment that is caused by impedance mismatches between amplifiers,
couples, cables, and other equipment in the cable plant. Microreflections
create copies of a signal that arrive at the receiver with different amounts of
delay and attenuation, generating intersymbol interference (ISI) that can
cause the receiver to improperly detect the amplitude and phase of the
incoming signal.
Note This value is not exact but provides an approximate indication of the
microreflections that have been received.
DSPwr (dBmV) Downstream receive power level, in dBmV, as reported by the CM.
DSSNR (dBmV) Downstream signal-to-noise ratio (SNR), in dB, as reported by the CM.
Note This command displays values for the downstream power and SNR values only if you have
configured the cable modem remote-query command on the CMTS, and if the CM supports
providing those options.
Mode DOCSIS operating mode for the CM:
• tdma=DOCSIS 1.X, TDMA-only mode
• atdma=DOCSIS 2.0 A-TDMA mode
A hyphen (-) indicates the mode is unknown or the CM has not yet registered.
Note This field is the same as that returned by the
docsIfCmtsCmStatusModulationType object in the DOCS-IF-MIB.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description ip-address Displays the QoS information for the specific CM, as identified by its IP
address.
mac-address Displays the QoS information for the specific CM, as identified by its MAC
address.
verbose (Optional) Displays detailed information for each service flow ID (SFID)
for the CM.
Usage Guidelines This command displays the service flows currently in use by a CM. The default form of the display
shows one service flow per line, while the verbose form displays complete information for each flow.
Note Also see the information about this command’s behavior in a Hot Standby Connection-to-Connection
Protocol (HCCP) configuration, see the “Operation with Hot Standby Connection-to-Connection
Protocol (HCCP) Configuration” section on page 3-54.
Examples The following example shows sample output for the show cable modem qos command for a particular
CM, as identified by its MAC address:
Router# show cable modem 0010.7bb3.fcd1 qos
Sfid Dir Curr Sid Sched Prio MaxSusRate MaxBrst MinRsvRate Throughput
State Type
3 US act 1 BE 7 2000000 1522 100000 0
4 DS act N/A BE 0 4000000 1522 0 0
Router#
The following example shows sample output for the show cable modem qos command for a particular
CM, as identified by its IP address:
Router# show cable modem 22.1.1.10 qos
Sfid Dir Curr Sid Sched Prio MaxSusRate MaxBrst MinRsvRate Throughput
State Type
7 US act 3 BE 0 0 3044 0 0
Router#
The following example shows sample output for the verbose form of the show cable modem qos
command for a particular CM, as identified by its IP address:
Router# show cable modem 22.1.1.10 qos verbose
Sfid : 7
Current State : Active
Sid : 3
Traffic Priority : 0
Maximum Sustained rate : 0 bits/sec
Maximum Burst : 3044 bytes
Mimimum Reserved rate : 0 bits/sec
Minimum Packet Size : 64 bytes
Admitted QoS Timeout : 200 seconds
Active QoS Timeout : 0 seconds
Maximum Concatenated Burst : 1522 bytes
Scheduling Type : Best Effort
Request/Transmission policy : 0x0
IP ToS Overwrite[AND-mask, OR-mask] : 0xFF, 0x0
Current Throughput : 0 bits/sec, 0 packets/sec
Sfid : 9
Current State : Active
Sid : 4
Traffic Priority : 0
Maximum Sustained rate : 1000000 bits/sec
Maximum Burst : 65224 bytes
Mimimum Reserved rate : 0 bits/sec
Minimum Packet Size : 64 bytes
Admitted QoS Timeout : 0 seconds
Active QoS Timeout : 0 seconds
Maximum Concatenated Burst : 1522 bytes
Scheduling Type : Best Effort
Request/Transmission policy : 0x0
IP ToS Overwrite[AND-mask, OR-mask] : 0xFF, 0x0
Current Throughput : 0 bits/sec, 0 packets/sec
Sfid : 10
Current State : Active
Sid : 5
Traffic Priority : 0
Maximum Sustained rate : 1000000 bits/sec
Maximum Burst : 65224 bytes
Mimimum Reserved rate : 0 bits/sec
Minimum Packet Size : 64 bytes
Admitted QoS Timeout : 0 seconds
Active QoS Timeout : 0 seconds
Maximum Concatenated Burst : 1522 bytes
Scheduling Type : Best Effort
Request/Transmission policy : 0x0
IP ToS Overwrite[AND-mask, OR-mask] : 0xFF, 0x0
Current Throughput : 0 bits/sec, 0 packets/sec
Sfid : 8
Current State : Active
Sid : N/A
Traffic Priority : 0
Maximum Sustained rate : 0 bits/sec
Maximum Burst : 3044 bytes
Mimimum Reserved rate : 0 bits/sec
Minimum Packet Size : 64 bytes
Admitted QoS Timeout : 200 seconds
Active QoS Timeout : 0 seconds
Maximum Latency : 0 usecs
Current Throughput : 0 bits/sec, 0 packets/sec
Router#
Table 3-28 describes the major fields shown in the show cable modem qos displays:
Table 3-28 Descriptions for the show cable modem qos Fields
Field Description
Sfid Identifies the Service Flow ID (SFID) for this service flow.
Dir Identifies whether the service flow applies to the downstream (DS) or
upstream (US) direction.
Curr State Current State—Identifies the current state of the service flow: Active or
Inactive.
Sid Identifies the Service ID (SID) associated with this SFID.
Sched Type Identifies this service flow’s scheduling type:
• BE = Best-Effort
• NRTPS = Non-Real-Time Polling Service
• RTPS = Real-Time Polling Service
• RSVD = Reserved but not yet in use
• UGS_AD = Unsolicited Grant Service with Activity Detection
• UGS = Unsolicited Grant Service
• UNDEF = Not yet defined.
Prio Traffic priority (0 to 7) given to this service flow.
MaxSusRate Maximum sustained rate value, in bits per second.
MaxBrst Maximum burst value, in bytes.
MinRsvRate Minimum reserved rate, in bits per second.
Throughput Current Throughput for this service flow, in packets per second.
Minimum Packet Size Assumed minimum reserved rate packet size on this service flow, in bytes.
Admitted QoS Timeout Timeout for admitted QoS parameters, in seconds, which specifies the length
of time that the CMTS must reserve resources for a service flow’s admitted
Qos parameter set, when they exceed the resources allowed by the active QoS
parameter set.
Active QoS Timeout Timeout for active Qos parameters, in seconds, which specifies the maximum
amount of time that resources can remained unused on an active service flow.
Maximum Latency Maximum downstream latency allowed for packets using this service flow, in
microseconds.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description ip-address (Optional) Displays information for the registered CM with the specified IP
address.
mac-address (Optional) Displays information for the registered CM with the specified
MAC address.
cable slot/port (Optional) Displays information for all registered CMs on the specified
cable interface and downstream port on the Cisco uBR7100 series and
Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0
or 1, depending on the cable interface.
cable slot/subslot/port (Optional) Displays information for all registered CMs on the specified
cable interface on the Cisco uBR10012 router. The following are the valid
values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
upstream port (Optional) Displays information for all CMs using this specific upstream.
You can specify this option only when displaying information for a cable
interface. The valid range for port begins with 0 and ends with a value that
depends on the number of upstream ports on the cable interface line card.
Defaults Displays a list of all registered CMs on the Cisco CMTS router.
Usage Guidelines
Note Also see the information about this command’s behavior in a Hot Standby Connection-to-Connection
Protocol (HCCP) configuration, see the “Operation with Hot Standby Connection-to-Connection
Protocol (HCCP) Configuration” section on page 3-54.
Examples The following example shows sample output for the default form of the show cable modem registered
command.
Router# show cable modem registered
Interface Prim Online Timing Rec QoS CPE IP address MAC address
Sid State Offset Power
Cable3/0/U0 1 online 2812 -0.25 5 1 3.18.1.5 0030.80bc.2303
Cable3/0/U0 2 online 2804 0.50 5 0 3.18.1.9 0006.2854.73f5
Router#
The following example shows sample output for the show cable modem registered command for a
particular cable interface:
Router# show cable modem c8/1/0 registered
Interface Prim Online Timing Rec QoS CPE IP address MAC address
Sid State Offset Power
C8/1/0/U1 1 online 1548 0.00 5 0 22.1.1.11 0050.7366.1243
C8/1/0/U4 2 online 1925 0.00 5 0 23.1.1.10 0002.b970.0027
C8/1/0/U4 3 online 1918 -0.50 2 0 22.1.1.10 0006.5314.858d
Router#
The following example shows sample output for the show cable modem registered command for a
single CM, as identified by its IP address:
Router# show cable modem 22.1.1.10 registered
Interface Prim Online Timing Rec QoS CPE IP address MAC address
Sid State Offset Power
C8/1/0/U4 3 online 1918 -0.75 2 0 22.1.1.10 0006.5314.858d
Router#
The following example shows sample output for the show cable modem registered command for a
single CM, as identified by its MAC address:
Router# show cable modem 0006.5314.858d registered
Interface Prim Online Timing Rec QoS CPE IP address MAC address
Sid State Offset Power
C8/1/0/U4 3 online 1918 -0.25 2 0 22.1.1.10 0006.5314.858d
Router#
Note An asterisk (*) in the Receive Power column indicates that a power adjustment has been made for that
CM. An exclamation point (!) in the Receive Power column indicates that the CM has reached its
maximum power transmit level and cannot increase its power level further. An exclamation point (!) in
the Timing Offset column indicates that the CM has exceeded the maximum delay and timing offset
specified by the cable map-advance command.
A pound sign (#) in the MAC State column indicates that the cable tftp-enforce mark-only command
has been used to require that a CM attempt a TFTP download of the DOCSIS configuration file before
registering, but the CM did not do so (Cisco IOS Release 12.1(11b)EC1 and Cisco IOS
Release 12.2(8)BC2 or later releases).
Tip The show cable modem command displays the CM timing offset in DOCSIS ticks, while other
commands, such as cable map-advance, display the offset in microseconds. Use the following method
to convert microseconds to DOCSIS ticks: ticks = microseconds*64/6.25.
Table 3-29 describes the major fields shown in the show cable modem registered displays:
Table 3-29 Descriptions for the show cable modem registered Fields
Field Description
Interface The cable interface line card providing the upstream for this CM.
Prim SID The primary SID assigned to this CM.
Online State The current state of the MAC layer (see Table 3-15 on page 3-60).
Timing Offset The timing offset for the CM, in ticks, as recognized on the CMTS. (A tick,
as used here, is 6.25/64 microseconds.) This is the delay between when a
particular cable modem is scheduled to make a transmission and when the
CMTS actually receives it.
Note An exclamation point (!) in the Timing Offset column indicates that
the CM has exceeded the maximum delay and timing offset specified
by the cable map-advance command.
Note The timing offset shown here is typically smaller than the TX Time
Offset value shown by the show cable modem remote-query
command, because the latter value is the offset as recognized on the
CM (which will include any internal delay between when the CM
software begins the transmission and when the bits actually appear on
the local cable interface).
Rec Power The received power level (in dB) for the CM.
Note An asterisk (*) in the RxPwr column indicates that a power
adjustment has been made for that CM. An exclamation point (!)
indicates that the CM has reached its maximum power transmit level
and cannot increase its power level further.
QoS Displays the QoS profile assigned to the CM (DOCSIS 1.1 and DOCSIS 2.0
CMs only).
CPE Indicates the number of CPE devices for which the CM is providing services.
IP Address The IP address that the DHCP server has assigned to the CM.
MAC Address The MAC address for the CM.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Usage Guidelines This command shows the statistics collected when the remote-query feature has been enabled and
configured by the cable modem remote-query command.
Note In Cisco IOS Release 12.1 CX, Cisco IOS Release 12.2 BC, and later, use the show cable
modem phy command instead of the show cable modem remote-query command.
Tip The information shown by this command can also be displayed by querying the attributes in the CISCO-
DOCS-REMOTE-QUERY-MIB.
Note Also see the information about this command’s behavior in a Hot Standby Connection-to-Connection
Protocol (HCCP) configuration, see the “Operation with Hot Standby Connection-to-Connection
Protocol (HCCP) Configuration” section on page 3-54.
Examples The following example shows typical output from the show cable modem remote-query command. In
this example, the final CM (IP address of 10.200.71.2) has not been configured with an SNMP
community string that allows access to the remote-query feature.
Router# show cable modem remote-query
Remote Query Polling State : Active
Router#
Table 3-30 shows the fields displayed by the show cable modem remote-query command.
Table 3-30 Descriptions for the show cable modem remote-query Fields
Field Description
IP Address The IP address that the DHCP server has assigned to the CM.
MAC Address The MAC address for the CM.
S/N Ratio The current signal-to-noise ratio (SNR) on the downstream, as seen by the
CM.
US Power The current operational transmit power level, in dBmV, as seen by the CM.
DS Power The received power level, in dBmV, as seen by the CM. This field is set to
zero if the CM does not support power level measurements.
TX Time Offset The timing offset for the CM, in ticks, as recognized on the CM. (A tick, as
used here, is 6.25/64 microseconds.) This is the delay between when a
particular cable modem is scheduled to make a transmission and when the
CMTS actually receives it. The CM value includes any internal delay between
when the CM software begins the transmission and when the bits actually
appear on the local cable interface.
Note The timing offset shown here is typically larger than the Time Offset
value shown by the show cable modem command, because the latter
value is the offset as recognized on the CMTS (which does not
include the internal delay on the CM).
Micro (dB) Reflection The approximate number of total microreflections (including in-channel
responses) on the downstream, measured in dBc below the signal level, as
seen by the CM. Microreflections are a type of impairment that is caused by
impedance mismatches between amplifiers, couples, cables, and other
equipment in the cable plant. Microreflections create copies of a signal that
arrive at the receiver with different amounts of delay and attenuation,
generating intersymbol interference (ISI) that can cause the receiver to
improperly detect the amplitude and phase of the incoming signal.
Note This value is not exact but provides an approximate indication of the
microreflections that have been received.
Modem State The current state of the MAC layer for the CM (see Table 3-15 on page 3-60).
The following example shows typical output from the show cable modem remote-query command.
Router# show cable modem remote-query
Router#
The following example shows typical output from the show cable modem remote-query command
when the remote-query feature has not been configured.
Router# show cable modem remote-query
Router#
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Usage Guidelines This command displays a list of cable modems that attempted to register with a DOCSIS configuration
file that does not pass the authentication required by the cable dynamic-secret command. After a cable
modem is added to the rogue list, it remains in the rogue list until one of the following occurs:
• The cable modem remains offline, without attempting to reregister, for 24 hours. It is then removed
from all of the CMTS internal databases, including the rogue list.
• An administrator manually deletes the cable modem from the CMTS internal databases, using the
clear cable modem delete command.
• An administrator unlocks the cable modem using the clear cable modem lock command.
Note Also see the information about this command’s behavior in a Hot Standby Connection-to-Connection
Protocol (HCCP) configuration, see the “Operation with Hot Standby Connection-to-Connection
Protocol (HCCP) Configuration” section on page 3-54.
Examples The following sample output from the show cable modem rogue command.
Router# show cable modem rogue
Spoof TFTP
MAC Address Vendor Interface Count Dnld Dynamic Secret
Router#
Table 3-31 describes the fields shown by the show cable modem rogue command.
Field Description
MAC Address The MAC address for the CM.
Vendor Vendor name for this cable modem, as configured using the cable modem
vendor command.
Interface The cable interface line card providing the upstream for this CM.
Spoof Count Number of times that this cable modem has attempted to register with an
invalid dynamic shared-secret value.
Note To account for possible network problems, such as loss of packets and
congestion, the Cisco CMTS will allow a cable modem to attempt to
register twice before marking it as having failed the dynamic shared-
secret authentication checks.
TFTP Dnld Whether TFT downloads are enforced, as configured by the cable tftp-
enforce command.
Dynamic Secret The dynamic shared-secret for this cable modem.
Tip You can also add a timestamp to show commands using the exec prompt timestamp command in line
configuration mode.
Command Description
show interface cable Displays information about the CMs connected to a particular cable
modem interface.
show interface cable sid Displays cable interface information.
show cable modem summary interface1 [interface2] upstream port1 port2 total
Syntax Description total (Optional) Displays a footer line showing the totals for each column.
interface1 (Optional) Cable interface to be summarized. The interface1 parameter can
take the following forms:
• cable slot/port—On the Cisco uBR7100 series router, the only valid
value is 1/0. On the Cisco uBR7200 series router, slot can range from 3
to 6, and port can be 0 or 1, depending on the cable interface.
• cable slot/subslot/port—On the Cisco uBR10012 router, slot can range
from 5 to 8, subslot can be either 0 or 1, and port can range from 0 to 4
(depending on the interface).
interface2 (Optional) Second cable interface, specifying a range of cable interfaces to
be summarized. The interface2 parameter has the same form as interface1.
Note When specifying a range of cable interfaces, interface1 must be the
lower-numbered interface and interface2 must be the higher-
numbered interface.
upstream port1 port2 (Optional) Specifies a range of upstream ports on the cable interfaces to be
summarized. The port1 and port2 parameters can start at 0, and port2 must
be a higher-numbered port than port1.
upstream port (Optional) Specifies a specific upstream port to be summarized. This option
can be specified only when summarizing a single cable interface.
Release Modification
12.2(8)BC1 The total option was supported for the Cisco uBR10012 universal
broadband router.
12.2(15)BC2 The upstream Description field was added to the show cable modem
summary display in Cisco IOS Release 12.2 BC.
Usage Guidelines This command displays a summary of CMs for a single cable interface or upstream, or for a range of
cable interfaces or upstreams. The following possible combinations are possible for this command:
• show cable modem summary total—Displays a summary and a total for all CMs on the chassis.
• show cable modem summary cable x/0 total—Displays a summary of CMs on a specified card.
• show cable modem summary cable x/0 upstream port1 port2 total—Displays a summary of CMs
on the specified card and specified range of ports. The port1 value must be less than the port2 value.
• show cable modem summary cable x/0 cable y/0 total—Displays a summary of CMs on the
specified range of cards.
• show cable modem summary cable x/0 cable y/0 upstream port1 port2 total—Displays a
summary of CMs on the specified range of ports on the specified range of cards.
Note Also see the information about this command’s behavior in a Hot Standby Connection-to-Connection
Protocol (HCCP) configuration, see the “Operation with Hot Standby Connection-to-Connection
Protocol (HCCP) Configuration” section on page 3-54.
Examples The following example shows typical output for the default form of the show cable modem summary
command on a Cisco uBR7200 series router:
Router# show cable modem summary
Router#
Note The Description field appears in Cisco IOS Release 12.1(11b)EC, 12.2(15)BC2, and later releases, and
shows the string configured for the upstream using the cable upstream description command.
The following example shows typical output for the show cable modem summary command with the
total option on a Cisco uBR7200 series router:
Router# show cable modem summary total
Router#
The following example shows sample output for the show cable modem summary total command for
all enabled upstreams on a specific cable interface line card on a Cisco uBR7200 series router:
Router# show cable modem summary c5/0 total
Router#
The following example shows typical output for the default form of the show cable modem summary
command on a Cisco uBR10012 router:
Router# show cable modem summary
Interface Cable Modem
Total Registered Unregistered Offline
Cable5/1/0/U5 2 2 0 0
Cable6/1/0/U0 14 13 1 0
Cable6/1/1/U2 14 14 0 0
Cable7/0/0/U0 2 2 0 0
Cable7/0/0/U5 4 3 1 1
Router#
The following example shows sample output for the show cable modem summary command with the
total option for a Cisco uBR10012 router:
Router# show cable modem summary total
Interface Cable Modem
Total Registered Unregistered Offline
Cable5/1/0/U5 1 1 0 0
Cable6/1/0/U0 11 8 3 1
Cable6/1/1/U2 17 16 1 0
Cable7/0/0/U0 2 1 1 0
Cable7/0/0/U5 1 0 1 0
Total: 32 26 6 1
Router#
The following example shows sample output for the show cable modem summary total command for
a range of interfaces on the Cisco uBR10012 router:
Router# show cable modem summary c6/1/1 c7/0/0 total
Total: 27 22 2 2
Router#
The following example shows sample output for the show cable modem summary total command for
a range of interfaces and upstreams on the Cisco uBR10012 router:
Router# show cable modem summary c6/1/1 c7/0/0 upstream 0 2 total
Total: 23 20 2 3
Router#
Note When displaying a summary for a range of ports or cable interfaces, the first port or cable interface (for
example, u0 or c4/0) must be lower-numbered than the second port or interface (for example, u6 or c6/0).
If you specify the higher-numbered port or interface first, the display shows no CMs connected.
Table 3-32 describes the fields shown in the show cable modem summary displays:
Table 3-32 Descriptions for the show cable modem summary Fields
Field Description
Interface The cable interface line card providing the upstream for the CMs.
Total Modems Total number of CMs, registered and unregistered (but active and currently in
the process of registering), for this interface. This field does not include the
number of offline CMs.
Active Modems Total number of CMs that have registered and are currently active on this
interface.
Registered Modems Total number of CMs that have registered on this interface. This number
might be different from the Active Modems number if some modems are not
responding to Station Maintenance messages.
Unregistered Modems Total number of CMs that are active on the upstream and communicating with
the CMTS, but but have not yet completed registration.
Offline Total number of CMs that were online or attempted to register but are no
longer communicating with the CMTS.
Description Description entered for this upstream using the cable upstream description
command.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description ip-address (Optional) Displays information for the unregistered CM with the specified
IP address.
mac-address (Optional) Displays information for the unregistered CM with the specified
MAC address.
cable slot/port (Optional) Displays information for all unregistered CMs on the specified
cable interface and downstream port on the Cisco uBR7100 series and
Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0
or 1, depending on the cable interface.
cable slot/subslot/port (Optional) Displays information for all unregistered CMs on the specified
cable interface on the Cisco uBR10012 router. The following are the valid
values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
upstream port (Optional) Displays information for all CMs using this specific upstream.
You can specify this option only when displaying information for a cable
interface. The valid range for port begins with 0 and ends with a value that
depends on the number of upstream ports on the cable interface line card.
Defaults Displays a list of all unregistered CMs on the Cisco CMTS router.
Usage Guidelines
Note Also see the information about this command’s behavior in a Hot Standby Connection-to-Connection
Protocol (HCCP) configuration, see the “Operation with Hot Standby Connection-to-Connection
Protocol (HCCP) Configuration” section on page 3-54.
Examples The following example shows sample output for the default form of the show cable modem
unregistered command.
Router# show cable modem unregistered
Interface Prim Online Timing Rec QoS CPE IP address MAC address
Sid State Offset Power
Cable3/0/U0 1 online 2812 -0.25 5 1 3.18.1.5 0030.80bc.2303
Cable3/0/U0 2 online 2804 0.50 5 0 3.18.1.9 0006.2854.73f5
Router#
The following example shows sample output for the show cable modem unregistered command for a
particular cable interface:
Router# show cable modem c8/1/0 unregistered
Interface Prim Online Timing Rec QoS CPE IP address MAC address
Sid State Offset Power
C8/1/0/U1 1 online 1548 0.00 5 0 22.1.1.11 0050.7366.1243
C8/1/0/U4 2 online 1925 0.00 5 0 23.1.1.10 0002.b970.0027
C8/1/0/U4 3 online 1918 -0.50 2 0 22.1.1.10 0006.5314.858d
Router#
The following example shows sample output for the show cable modem unregistered command for a
single CM, as identified by its IP address:
Router# show cable modem 22.1.1.10 unregistered
Interface Prim Online Timing Rec QoS CPE IP address MAC address
Sid State Offset Power
C8/1/0/U4 3 online 1918 -0.75 2 0 22.1.1.10 0006.5314.858d
Router#
The following example shows sample output for the show cable modem unregistered command for a
single CM, as identified by its MAC address:
Router# show cable modem 0006.5314.858d unregistered
Interface Prim Online Timing Rec QoS CPE IP address MAC address
Sid State Offset Power
C8/1/0/U4 3 online 1918 -0.25 2 0 22.1.1.10 0006.5314.858d
Router#
Note An asterisk (*) in the Receive Power column indicates that a power adjustment has been made for that
CM. An exclamation point (!) in the Receive Power column indicates that the CM has reached its
maximum power transmit level and cannot increase its power level further. An exclamation point (!) in
the Timing Offset column indicates that the CM has exceeded the maximum delay and timing offset
specified by the cable map-advance command.
A pound sign (#) in the MAC State column indicates that the cable tftp-enforce mark-only command
has been used to require that a CM attempt a TFTP download of the DOCSIS configuration file before
registering, but the CM did not do so (Cisco IOS Release 12.1(11b)EC1 and Cisco IOS
Release 12.2(8)BC2 or later releases).
Tip The show cable modem command displays the CM timing offset in DOCSIS ticks, while other
commands, such as cable map-advance, display the offset in microseconds. Use the following method
to convert microseconds to DOCSIS ticks: ticks = microseconds*64/6.25.
Table 3-33 describes the major fields shown in the show cable modem unregistered displays:
Table 3-33 Descriptions for the show cable modem unregistered Fields
Field Description
Interface The cable interface line card providing the upstream for this CM.
Prim SID The primary SID assigned to this CM.
Online State The current state of the MAC layer (see Table 3-15 on page 3-60).
Timing Offset The timing offset for the CM, in ticks, as recognized on the CMTS. (A tick,
as used here, is 6.25/64 microseconds.) This is the delay between when a
particular cable modem is scheduled to make a transmission and when the
CMTS actually receives it.
Note An exclamation point (!) in the Timing Offset column indicates that
the CM has exceeded the maximum delay and timing offset specified
by the cable map-advance command.
Note The timing offset shown here is typically smaller than the TX Time
Offset value shown by the show cable modem remote-query
command, because the latter value is the offset as recognized on the
CM (which will include any internal delay between when the CM
software begins the transmission and when the bits actually appear on
the local cable interface).
Rec Power The received power level (in dB) for the CM.
Note An asterisk (*) in the RxPwr column indicates that a power
adjustment has been made for that CM. An exclamation point (!)
indicates that the CM has reached its maximum power transmit level
and cannot increase its power level further.
QoS Displays the QoS profile assigned to the CM (DOCSIS 1.1 and DOCSIS 2.0
CMs only).
CPE Indicates the number of CPE devices for which the CM is providing services.
IP Address The IP address that the DHCP server has assigned to the CM.
MAC Address The MAC address for the CM.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description summary (Optional) Displays the total numbers for each vendor and OUI, along with
the total numbers of those vendor’s CMs that are currently registered with
the CMTS, unregistered, or offline.
Usage Guidelines This command displays the vendor name for each CM. If the vendor name has not been defined by the
cable modem vendor command, the command displays the OUI value for the modem’s vendor.
Note The Institute of Electrical and Electronics Engineers (IEEE) is the official issuer of OUI values. The
IEEE OUI web site is at http://standards.ieee.org/regauth/oui/index.shtml.
Note Also see the information about this command’s behavior in a Hot Standby Connection-to-Connection
Protocol (HCCP) configuration, see the “Operation with Hot Standby Connection-to-Connection
Protocol (HCCP) Configuration” section on page 3-54.
Examples The following example shows typical output for the show cable modem vendor command:
Router# show cable modem vendor
Vendor MAC Address I/F MAC Prim RxPwr Timing Num BPI
State Sid (db) Offset CPE Enb
Cisco 0001.9659.519f C1/0/U0 init(rc) 16 0.75 2738 0 N
Cisco 0002.b96f.fdbb C1/0/U0 online 20 1.00 2738 1 N
Cisco 0002.b96f.fdf9 C1/0/U0 online 21 0.50 2737 1 N
Cisco 0002.b96f.fff7 C1/0/U0 online 12 0.50 2737 1 N
Cisco 0002.fdfa.1163 C1/0/U0 online 1 0.00 2734 1 N
Cisco 0002.fdfa.12d5 C1/0/U0 online 14 0.00 2737 1 N
Cisco 0002.fdfa.12db C1/0/U0 online 18 0.25 2736 1 N
Cisco 0002.fdfa.12e9 C1/0/U0 online 13 0.25 2737 1 N
Cisco 0006.28dc.37fd C1/0/U0 offline 7 0.25 2734 0 N
Cisco 0006.28e9.81c9 C1/0/U0 online 2 0.75 2735 1 N
Motorola 0020.28f9.9d19 C1/0/U0 online 28 -0.25 2733 1 N
Motorola 0020.4006.b010 C1/0/U0 online 19 0.00 2728 1 N
Router#
The following example shows typical output for the show cable modem vendor command on the
Cisco uBR10012 router:
Router# show cable modem vendor
Vendor MAC Address I/F MAC Prim RxPwr Timing Num BPI
State Sid (db) Offset CPE Enb
Thomson 0010.9507.01db C5/1/0/U5 online 1 0.00 938 1 N
Ericsson 0080.37b8.e99b C5/1/0/U5 online 2 -0.25 1268 0 N
Cisco 0002.fdfa.12ef C6/1/0/U0 online 13 0.00 1920 1 N
Cisco 0002.fdfa.137d C6/1/0/U0 online 16 -0.50 1920 1 N
Cisco 0003.e38f.e9ab C6/1/0/U0 online 3 -0.25 1926 1 N
Cisco 0003.e3a6.7f69 C6/1/0/U0 online 15 0.50 1927 1 N
Cisco 0003.e3a6.816d C6/1/0/U0 online 4 0.00 1929 1 N
Cisco 0006.28f9.8be5 C6/1/0/U0 online 12 0.75 1922 1 N
Cisco 0001.9659.519f C6/1/1/U2 online 26 0.25 1930 1 N
Cisco 0002.b96f.fdbb C6/1/1/U2 online 29 -0.75 1929 1 N
Cisco 0002.b96f.fdf9 C6/1/1/U2 online 39 -0.50 1931 1 N
Cisco 0002.b96f.fff7 C6/1/1/U2 online 38 0.00 1928 1 N
Cisco 0002.fdfa.1163 C6/1/1/U2 online 15 0.00 1923 1 N
Cisco 0002.fdfa.12d5 C6/1/1/U2 online 35 0.25 1923 1 N
Cisco 0002.fdfa.12e9 C6/1/1/U2 online 5 -0.25 1925 1 N
Cisco 0050.7302.3d73 C6/1/1/U2 online 58 0.25 1553 1 N
Cisco 0002.fdfa.12db C7/0/0/U0 online 15 -0.75 1914 1 N
Cisco 0002.fdfa.138d C7/0/0/U5 online 4 0.25 1917 1 N
Cisco 0003.e38f.e85b C7/0/0/U5 online 17 0.25 1919 1 N
Cisco 0003.e38f.f4cb C7/0/0/U5 online 16 0.00 1922 1 N
Cisco 0003.e3a6.7fd9 C7/0/0/U5 online 1 0.25 1922 0 N
Motorola 0020.4005.3f06 C7/0/0/U0 online 2 0.00 1901 1 N
Motorola 0020.4006.b010 C7/0/0/U5 online 3 0.25 1901 1 N
Cisco 0050.7302.3d83 C7/0/0/U0 online 18 -0.25 1543 1 N
Cisco 00b0.6478.ae8d C7/0/0/U5 online 44 0.50 1920 21 N
Cisco 00d0.bad3.c0cd C7/0/0/U5 online 19 0.00 1543 1 N
Cisco 00d0.bad3.c0cf C7/0/0/U0 online 13 0.00 1546 1 N
Cisco 00d0.bad3.c0d5 C7/0/0/U0 online 12 -0.50 1546 1 N
Router#
Tip The show cable modem vendor command displays the CM timing offset in DOCSIS ticks, while other
commands, such as cable map-advance, display the offset in microseconds. Use the following method
to convert microseconds to DOCSIS ticks: ticks = microseconds*64/6.25.
Table 3-34 describes the major fields shown in the show cable modem vendor displays:
Table 3-34 Descriptions for the show cable modem vendor Fields
Field Description
Vendor The vendor name for the indicated CM, as specified by the cable modem
vendor command. If no name for this vendor has been specified, displays the
modem’s OUI value.
MAC Address The MAC address for the CM.
Table 3-34 Descriptions for the show cable modem vendor Fields (continued)
Field Description
I/F The cable interface line card providing the upstream for this CM.
MAC State The current state of the MAC layer (see Table 3-15 on page 3-60).
Prim SID The primary SID assigned to this CM.
RxPwr The received power level (in dB) for the CM.
Note An asterisk (*) in the RxPwr column indicates that a power
adjustment has been made for that CM. An exclamation point (!)
indicates that the CM has reached its maximum power transmit level
and cannot increase its power level further.
Timing Offset The timing offset for the CM, in ticks, as recognized on the CMTS. (A tick,
as used here, is 6.25/64 microseconds.) This is the delay between when a
particular cable modem is scheduled to make a transmission and when the
CMTS actually receives it.
Note An exclamation point (!) in the Timing Offset column indicates that
the CM has exceeded the maximum delay and timing offset specified
by the cable map-advance command.
Note The timing offset shown here is typically smaller than the TX Time
Offset value shown by the show cable modem remote-query
command, because the latter value is the offset as recognized on the
CM (which will include any internal delay between when the CM
software begins the transmission and when the bits actually appear on
the local cable interface).
Num CPE Indicates the number of CPE devices for which the CM is providing services.
BPI Enbld Indicates whether Baseline Privacy Interface (BPI) or BPI Plus (BPI+)
encryption is enabled for the CM.
Note An asterisk (*) in the RxPwr column indicates that a power adjustment has been made for that CM. An
exclamation point (!) in the Receive Power column indicates that the CM has reached its maximum
power transmit level and cannot increase its power level further. An exclamation point (!) in the Timing
Offset column indicates that the CM has exceeded the maximum delay and timing offset specified by the
cable map-advance command.
A pound sign (#) in the MAC State column indicates that the cable tftp-enforce mark-only command
has been used to require that a CM attempt a TFTP download of the DOCSIS configuration file before
registering, but the CM did not do so (Cisco IOS Release 12.1(11b)EC1 and Cisco IOS
Release 12.2(8)BC2 or later releases).
The following example shows typical output for the show cable modem vendor summary command,
displaying the total numbers for each vendor and OUI, along with the total numbers of those vendor’s
CMs that are currently registered with the CMTS, unregistered, or offline.
Router# show cable modem vendor summary
Router#
Tip You can add a timestamp to this command using the exec prompt timestamp command in line
configuration mode.
Syntax Description profile (Optional) Profile number. Valid values start with 1.
verbose (Optional) Displays detailed information for an individual profile.
iuc-code (Optional) Internal usage code (IUC). Valid options are:
a-long—Advanced Phy Long Grant Burst (IUC 10)
a-short—Advanced Phy Short Grant Burst (IUC 9)
a-ugs—Advanced Phy Unsolicited Grant Burst (IUC 11)
initial—Initial Ranging Burst (IUC 3)
long—Long Grant Burst (IUC 6)
reqdata—Request/Data Burst (IUC 2) 1
request—Request Burst (IUC 1)
short—Short Grant Burst (IUC 5)
station—Station Ranging Burst (IUC 4)
cable slot/port Identifies a cable interface and downstream port on the Cisco uBR7100
series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can
be 0 or 1, depending on the cable interface.
cable slot/subslot/port Identifies a cable interface on the Cisco uBR10012 router. The
following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
upstream port (Optional) Displays information for a particular upstream on the
selected cable interface. The port value starts with 0 and continues up,
depending on the type of cable interface card.
1. The Cisco CMTS recognizes the reqdata burst type but does not use it.
Release Modification
12.1(3a)EC This reqdata type was added as a placeholder for scripts that might
reference it, but the DOCSIS MAC scheduler on the Cisco CMTS does not
use this type of burst.
12.2(15)CX Support was added for the Cisco uBR-MC28U/X cable interface line card,
including support for DOCSIS 2.0 A-TDMA and mixed modulation profiles.
This includes adding additional information to the command’s display, as
well as adding the a-long, a-short, a-ugs, and verbose options.
12.2(15)CX1 Added the ability to display the modulation profiles being used by a
particular cable interface and upstream.
12.2(15)BC2 This command displays all default modulation profiles 1, 21, 41, 101, 121,
201, 221, and 241), even when the cable interface card that is associated with
those profiles is not installed. Previous releases displayed only the default
modulation profiles that were in use.
Usage Guidelines The show cable modulation-profile command displays modulation profile group information. A
modulation profile is a collection of burst profiles that are sent out in a Upstream Channel Descriptor
(UCD) message to configure a modem’s transmit parameters for an upstream message burst type.
Table 3-35 shows the IUC codes for each burst type:
Cable Interface DOCSIS 1.X (TDMA) Mixed DOCSIS 1.X/2.0 DOCSIS 2.0 (A-TDMA)
1
Cisco uBR7100 series 1 to 10 , default=1 N/A N/A
Cisco uBR-MC16C 1 to 10, default=1 N/A N/A
Cisco uBR-MC16S 1 to 10, default=1 N/A N/A
Cisco uBR-MC28C 1 to 10, default=1 N/A N/A
Cable Interface DOCSIS 1.X (TDMA) Mixed DOCSIS 1.X/2.0 DOCSIS 2.0 (A-TDMA)
Cisco uBR-MC5X20S, 21 to 30, default=21 121 to 130, default=121 221 to 230, default=221
Cisco uBR-MC5X20U
Cisco uBR-MC16U/X, 41 to 50, default=41 141 to 150, default=141 241 to 250, default=241
Cisco uBR-MC28U/X
1. Only 8 modulation profiles are supported in Cisco IOS software releases before 12.2(15)BC1, so in these releases the valid
range is 1 to 8.
Note Default modulation profiles are created for each type of card and operation mode. You cannot delete the
default modulation profiles (1, 21, 41, 101, 121, 201, 221, and 241). In Cisco IOS Release 12.2(15)BC2
and later, all default modulation profiles are displayed, even when that particular cable interface is not
installed. In previous versions, only the default modulation profiles that were in use were displayed.
Examples The following is sample output from the show cable modulation-profile command in Cisco IOS
Release 12.2(11)BC3 and earlier releases:
CMTS01# show cable modulation-profile
Mo IUC Type Preamb Diff FEC FEC Scrambl Max Guard Last Scrambl Preamb
length enco T CW seed B time CW offset
bytes size size size short
1 request qpsk 64 no 0x0 0x10 0x152 1 8 no yes 56
1 initial qpsk 128 no 0x5 0x22 0x152 0 48 no yes 0
1 station qpsk 128 no 0x5 0x22 0x152 0 48 no yes 0
1 short qpsk 72 no 0x5 0x4B 0x152 0 8 no yes 48
The following is sample output from the show cable modulation-profile command in Cisco IOS
Release 12.2(15)CX and later releases:
Router# show cable modulation-profile
141 long 16qam 160 no 0x8 0xE7 0x152 0 8 yes yes 0 16qam na
141 a-short 32qam 160 no 0x9 0x4C 0x152 6 8 yes yes 0 qpsk1 no
141 a-long 64qam 196 no 0xC 0xE7 0x152 0 8 yes yes 0 qpsk1 no
241 request qpsk 68 no 0x0 0x10 0x152 0 8 no yes 0 qpsk0 no
241 initial qpsk 128 no 0x5 0x22 0x152 0 48 no yes 0 qpsk0 no
241 station qpsk 128 no 0x5 0x22 0x152 0 48 no yes 0 qpsk0 no
241 a-short 32qam 160 no 0x9 0x4C 0x152 6 8 yes yes 0 qpsk1 no
241 a-long 64qam 196 no 0xC 0xE7 0x152 0 8 yes yes 0 qpsk1 no
241 a-ugs 16qam 80 no 0x3 0xE7 0x152 0 8 yes yes 0 qpsk1 no
242 request qpsk 68 no 0x0 0x10 0x152 0 8 no yes 0 qpsk0 no
242 initial qpsk 128 no 0x5 0x22 0x152 0 48 no yes 0 qpsk0 no
242 station qpsk 128 no 0x5 0x22 0x152 0 48 no yes 0 qpsk0 no
242 a-short qpsk 80 no 0x4 0x4C 0x152 12 8 yes yes 0 qpsk0 no
242 a-long qpsk 68 no 0x8 0xEC 0x152 0 8 yes yes 0 qpsk0 no
242 a-ugs qpsk 80 no 0x0 0xEC 0x152 0 8 yes yes 0 qpsk0 no
243 request 64qam 132 no 0x4 0x10 0x152 0 8 no yes 0 qpsk1 no
243 initial 64qam 128 no 0x5 0x22 0x152 0 48 no yes 0 qpsk1 no
243 station 64qam 128 no 0x5 0x22 0x152 0 48 no yes 0 qpsk1 no
243 a-short 64qam 160 no 0x9 0x4C 0x152 5 8 yes yes 0 qpsk1 no
243 a-long 64qam 196 no 0xC 0xE7 0x152 0 8 yes yes 0 qpsk1 no
243 a-ugs 64qam 100 no 0x7 0xE7 0x152 0 8 yes yes 0 qpsk1 no
244 request 64qam 132 no 0x4 0x10 0x152 0 8 no yes 0 qpsk1 no
244 initial 64qam 128 no 0x5 0x22 0x152 0 48 no yes 0 qpsk1 no
244 station 64qam 128 no 0x5 0x22 0x152 0 48 no yes 0 qpsk1 no
244 a-short 64qam 160 no 0x9 0x4C 0x152 5 8 yes yes 0 qpsk1 no
244 a-long 64qam 196 no 0xC 0xE7 0x152 0 8 yes yes 0 qpsk1 no
244 a-ugs 64qam 32 no 0xA 0xC8 0x152 255 32 yes yes 0 qpsk1 yes
245 initial qpsk 32 no 0xA 0xC8 0x152 32 32 no yes 0 qpsk1 yes
245 station qpsk 32 no 0xA 0xC8 0x152 32 32 yes yes 0 qpsk1 yes
245 a-short 64qam 64 no 0xA 0xC8 0x152 32 32 yes yes 0 qpsk1 yes
245 a-long 64qam 32 no 0xA 0xC8 0x152 252 32 yes yes 0 qpsk1 yes
245 a-ugs 64qam 32 no 0xA 0xC8 0x152 32 32 yes yes 0 qpsk1 yes
Router#
The following shows sample output from the show cable modulation-profile command for a mixed
mode modulation profile (TDMA/A-TDMA) on the Cisco uBR-MC5X20S cable interface line card:
Router# show cable modulation-profile 121
Mod IUC Type Pre Diff FEC FEC Scrmb Max Guard Last Scrmb Pre Pre RS
len enco T k seed B time CW offst Type
BYTE BYTE siz size short
121 request qpsk 32 no 0x0 0x10 0x152 0 20 no yes 0 qpsk na
121 initial qpsk 64 no 0x5 0x22 0x152 0 48 no yes 64 qpsk na
121 station qpsk 64 no 0x5 0x22 0x152 0 48 no yes 64 qpsk na
121 short qpsk 64 no 0x5 0x4B 0x152 6 20 yes yes 64 qpsk na
121 long qpsk 64 no 0x8 0xDC 0x152 0 20 yes yes 64 qpsk na
121 a-short 64qam 128 no 0x5 0x63 0x152 10 20 yes yes 192 qpsk0 no
121 a-long 64qam 128 no 0xF 0xC8 0x152 0 20 yes yes 192 qpsk0 no
Router#
The following shows sample output from the show cable modulation-profile command for two
DOCSIS 2.0 modulation profiles (A-TDMA) on the Cisco uBR-MC5X20S cable interface line card:
Router# show cable modulation-profile 221
Mod IUC Type Pre Diff FEC FEC Scrmb Max Guard Last Scrmb Pre Pre RS
len enco T k seed B time CW offst Type
BYTE BYTE siz size short
221 request qpsk 64 no 0x0 0x10 0x152 0 8 no yes 184 qpsk0 na
221 initial qpsk 128 no 0x5 0x22 0x152 0 48 no yes 0 qpsk0 na
221 station qpsk 128 no 0x5 0x22 0x152 0 48 no yes 0 qpsk0 na
221 short qpsk 72 no 0x5 0x4B 0x152 6 8 yes yes 176 qpsk0 na
221 long qpsk 80 no 0x8 0xDC 0x152 0 8 yes yes 168 qpsk0 na
221 a-short 64qam 128 no 0x5 0x63 0x152 10 20 yes yes 192 qpsk0 no
221 a-long 64qam 128 no 0xF 0xC8 0x152 0 20 yes yes 192 qpsk0 no
Mod IUC Type Pre Diff FEC FEC Scrmb Max Guard Last Scrmb Pre Pre RS
len enco T k seed B time CW offst Type
BYTE BYTE siz size short
241 request qpsk 68 no 0x0 0x10 0x152 0 8 no yes 0 qpsk0 no
241 initial qpsk 2 no 0x0 0x10 0x0 0 0 no no 0 qpsk1 no
241 station qpsk 128 no 0x5 0x22 0x152 0 48 no yes 0 qpsk0 no
241 a-short 32qam 160 no 0x9 0x4C 0x152 6 8 yes yes 0 qpsk1 no
241 a-long 64qam 132 no 0xC 0xE7 0x152 0 8 yes yes 0 qpsk1 no
241 a-ugs 16qam 80 no 0x3 0xE7 0x152 0 8 yes yes 0 qpsk1 no
Router#
The following shows sample output for the upstream option, which displays the modulation profile
currently being used by a particular upstream:
Router# show cable modulation-profile cable 4/1 upstream 1
Mod IUC Type Pre Diff FEC FEC Scrmb Max Guard Last Scrmb Pre Pre RS
len enco T k seed B time CW offst Type
BYTE BYTE siz size short
41 request qpsk 64 no 0x0 0x10 0x152 0 8 no yes 396 qpsk na
41 initial qpsk 128 no 0x5 0x22 0x152 0 48 no yes 6 qpsk na
41 station qpsk 128 no 0x5 0x22 0x152 0 48 no yes 6 qpsk na
41 short qpsk 88 no 0x5 0x4C 0x152 35 42 yes yes 396 qpsk na
41 long qpsk 76 no 0x6 0xE8 0x152 135 143 yes yes 396 qpsk na
Router#
The following example shows typical detailed output for an individual modulation profile that is
displayed when using the verbose option. Each IUC is described in detail.
Router# show cable modulation-profile 1 verbose
Scrambler: enabled
Preamble offset: 168
Preamble type: qpsk0
RS interleaver on: na
RS interleaver depth: 0
RS interleaver block size: 0
Router#
Table 3-37 describes the significant fields displayed by the show cable modulation-profile command.
.
Table 3-37 show cable modulation-profile Field Descriptions
Field Description
Mo Modulation profile group number. A modulation profile group is the set
of burst profiles that defines upstream transmit characteristics for the
various types of upstream transmission classes.
IUC Interval usage code. Each upstream transmit burst belongs to a class that
is given a number called the interval usage code (IUC). Bandwidth maps
messages (MAP) by IUC codes used to allocate upstream time slots. The
following types are currently defined:
• Request—Bandwidth request slot
• Request Data—Bandwidth request and short data burst slot
• Initial Maintenance—Initial link registration contention slot
• Station Maintenance—Link keepalive slot
• Short Data Grant—Short data burst slot
• Long Data Grant—Long data burst slot
Type Modulation type.
Preamb length Preamble length.
Diff enco Differential encoding enabled (yes) or not enabled (no).
FEC T bytes Number of bytes that can be corrected for each forward error correction
(FEC) code word.
FEC CW size Size, in bytes, of the FEC code word.
Scrambl seed Scrambler seed value in hex format.
Max B size Maximum burst size.
Guard time size Time between successive bursts measured in symbols.
Last CW short Handling of FEC for shortened last code word.
Scrambl Scrambler enabled (yes) or not enabled (no).
Preamb offset (DOCSIS 1.0 and DOCSIS 1.1 modulation profiles) The bits to be used
for the preamble value.
Pre offst (DOCSIS 2.0 modulation profiles) The bits to be used for the preamble
value.
Pre Type (DOCSIS 2.0 modulation profiles) The A-TDMA preamble type (qpsk0
or qpsk1).
RS (DOCSIS 2.0 modulation profiles) The A-TDMA RS encoding type.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description slot/port Identifies the cable interface and downstream port on the
Cisco uBR7100 series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On
the Cisco uBR7200 series router, slot can range from 3 to 6, and port
can be 0 or 1, depending on the cable interface.
slot/subslot/port Identifies the cable interface on the Cisco uBR10012 router. The
following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
Usage Guidelines This command is not supported on Cisco IOS Release 12.1(3a)EC1 or later releases.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description manufacturer-cert-list Displays the BPI manufacturer certificate verification list.
root-cert-list Displays the BPI root certificate verification list.
Usage Guidelines This command appears and is available only in images that support BPI and BPI+ encryption.
Examples The following examples show how to display BPI+ certificate information using the show cable privacy
command:
Router# show cable privacy manufacturer-cert-list
Cable Manufacturer certificate chain:
<certificate dump>
<certificate dump>
Router#
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Examples The following example shows typical output for the default version of the show cable qos enforce-rule
command:
Router# show cable qos enforce-rule
Name Dur Dir byte-cnt Auto rate penalty Reg Enf Ena Persist
(min) (kbytes) enf (min) (min) QoS QoS
residential 10 us 5 act 1 10080 5 10 Yes Yes
ef-q11d 30 ds 150 act 1 20 11 99 Yes Yes
ef-q11u 30 us 60 act 1 20 11 99 Yes Yes
ef-q21 720 us 60 act 1 10 21 81 Yes Yes
ef-q21d 300 ds 150 act 1 10 21 81 Yes Yes
ef-q22 720 us 60 act 1 10 22 82 Yes Yes
ef-q22d 300 ds 150 act 1 10 22 82 Yes No
ef-q23 720 us 60 act 1 10 23 83 Yes Yes
ef-q23d 300 ds 150 act 1 10 23 83 Yes Yes
ef-q24 720 us 60 act 1 10 24 84 Yes Yes
ef-q24d 300 ds 150 act 1 10 24 84 Yes Yes
ef-q25 720 us 60 act 1 10 25 85 Yes Yes
ef-q25d 300 ds 150 act 1 10 25 85 Yes Yes
ef-q26 720 us 60 act 1 10 26 86 Yes Yes
ef-q26d 300 ds 150 act 1 10 26 86 Yes Yes
ef-q27 720 us 60 act 1 10 27 87 Yes Yes
ef-q27d 300 ds 150 act 1 10 27 87 Yes Yes
ef-q28 720 us 60 act 1 10 28 88 Yes Yes
ef-q28d 300 ds 150 act 1 10 28 88 Yes No
ef-q5d 300 ds 150 act 1 10 5 99 Yes Yes
ef-q5u 720 us 600 act 1 10 5 99 Yes Yes
Router#
The following example shows sample output from the show cable qos enforce-rule command for one
particular enforce-rule:
Router# show cable qos enforce-rule residential
Name Dur Dir byte-cnt Auto rate penalty Reg Enf Ena Persist
(min) (kbytes) enf (min) (min) QoS QoS
residential 10 us 5 act 1 10080 5 10 Yes Yes
Router#
Table 3-38 describes the significant fields displayed by the show cable qos enforce-rule command.
.
Table 3-38 show cable qos enforce-rule Field Descriptions
Field Description
Name Name of the enforce-rule.
Dur (min) Monitor-duration time period, in minutes.
Dir Direction in which the byte-count is applied:
• DS = downstream direction
• US = upstream direction
byte-cnt (kbytes) Maximum number of bytes, in kilobytes, that subscribers using this
enforce-rule can transmit during the monitoring-duration window before
being considered to be over-consuming.
Auto enf Displays whether the enforce-rule QoS profile is automatically activated
when a subscriber exceeds their allowed bandwidth.
rate (min) Size of the sample rate interval, in minutes.
penalty (min) Size of the penalty period, in minutes.
Reg QoS Profile ID for the registered QoS profile.
Enf QoS Profile ID for the enforced QoS profile.
Ena Displays whether this enforce-rule is currently enabled and active.
Persist Displays whether this enforce-rule keeps the enforced QoS profile in
force across cable modem reboots:
• Yes = Enforced QoS profiles remain in effect across cable modem
reboots.
• No = Enforced QoS profiles do not remain in effect when a cable
modem reboots. See the no-persistence option for the enforced qos-
profile command.
Command Description
monitoring-duration Specifies the time period and sample rate to be used for monitoring
subscribers.
penalty-period Specifies the time period that an enforced quality of service (QoS) profile
should be used for subscribers that violate their registered QoS profile.
registered qos-profile Specifies the registered Quality of Service (QoS) profile that should be used
for this enforce-rule.
show cable Displays subscribers that are violating their registered quality of service
subscriber-usage (QoS) profiles.
Examples The following example displays the output of the show cable qos permission command:
CMTS01# show cable qos permission
Table 3-39 describes the fields displayed by the show cable qos permission command.
Field Description
Create by SNMP Indicates permission setting for creation of QoS table entries by the
Simple Network Management Protocol (SNMP).
Update by SNMP Indicates permission setting for creation of QoS table entries by
modem registration requests.
Create by modems Indicates permission setting for dynamic updating of QoS table
entries by the SNMP.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description profile-index Displays cable QoS table. Valid range is 1 to 255.
verbose Displays detailed information about the QoS profiles.
Examples The following example shows how to display the existing QoS profiles on the CMTS:
Router# show cable qos profile
ID Prio Max Guarantee Max Max TOS TOS Create B IP prec.
upstream upstream downstream tx mask value by priv rate
bandwidth bandwidth bandwidth burst enab enab
1 0 0 0 0 0 0x0 0x0 cmts(r) no no
2 0 64000 0 1000000 0 0x0 0x0 cmts(r) no no
3 7 31200 31200 0 0 0x0 0x0 cmts yes no
4 7 87200 87200 0 0 0x0 0x0 cmts yes no
5 2 256000 0 128000 1503 0x0 0x0 cm no no
Profiles 1 and 2 are always created by the CMTS at initial startup. The CMTS dynamically creates
profiles 3 and 4, as shown above, to support Voice over IP (VoIP) codecs G.711 and G.729 when a CM
configures phone lines and uses dynamic service requests to request VoIP service. The remaining
profiles, such as profile 5 above, are typically created by a CM when it comes online.
Profile 3 creates a grant-size of 31.22 KiloBytes per second for G.729 service, and profile 4 creates a
grant-size of 87.2 KiloBytes per second for G.711 service. Both profiles use a default grant-interval of
20 milliseconds. For more information on these profiles, see the TAC technical note at the following
URL:
http://www.cisco.com/warp/public/109/uBR7200_QoSMAC.html
Profile Index 1
Name Default
Upstream Traffic Priority 0
Upstream Maximum Rate (bps) 0
Upstream Guaranteed Rate (bps) 0
Unsolicited Grant Size (bytes) 0
Unsolicited Grant Interval (usecs) 0
Upstream Maximum Transmit Burst (bytes) 0
IP Type of Service Overwrite Mask 0x0
IP Type of Service Overwrite Value 0x0
Downstream Maximum Rate (bps) 0
Created By cmts(r)
Baseline Privacy Enabled no
Table 3-40 describes the fields displayed by the show cable qos profile command.
Field Description
ID Profile number.
Prio Priority level.
Max upstream bandwidth Maximum upstream bandwidth.
Guarantee upstream bandwidth Guaranteed minimum upstream bandwidth.
Max downstream bandwidth Maximum downstream bandwidth.
Max tx burst Maximum transmit burst size in bytes.
Tos mask Hex value of the mask bits.
Tos value Value of the mask byte.
Create by Identity of who created the profile:
• cmts = Created by the CMTS with read-write properties. The
profile can be modified but not deleted.
• cmts(r) = Created by the CMTS with read-only properties. The
profile cannot be modified or deleted.
• cm = Created by the CM DOCSIS configuration file.
• mgmt = Created by an operator using CLI commands.
B priv enab Describes whether Baseline Privacy Interface (BPI) encryption is
enabled (yes) or disabled (no) for this QoS profile.
IP prec. rate enab Describes whether IP precedence rate limiting enabling is enabled
(yes) or disabled (no) for this QoS profile. When a profile is created
by a CM, this value is set by the Type Length Value (TLV) 11 fields
in the DOCSIS configuration file, unless overwritten using the
cable qos profile command.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description sclass-index Identifies the index for a service class that has already been defined
(1 to 255).
verbose Displays all of the defined attributes for the service class.
Usage Guidelines You can display a summary of either one service class or all service classes. You can also display a
complete listing of each service class and of all the defined service classes.
Examples The following sample output shows the standard and verbose formats of the show cable service class
command:
Router# show cable service-class
Index: 1
Name: UP_UGS
Direction: Upstream/Downstream
Traffic Priority: 0
Maximum Sustained Rate: 0 bits/sec
Max Burst: 1522 bytes
Minimum Reserved Rate: 0 bits/sec
Minimum Packet Size 100 bytes
Admitted QoS Timeout 30 seconds
Active QoS Timeout 30 seconds
Index: 1
Name: UP_UGS
Direction: Upstream/Downstream
Traffic Priority: 0
Maximum Sustained Rate: 0 bits/sec
Max Burst: 1522 bytes
Minimum Reserved Rate: 0 bits/sec
Minimum Packet Size 100 bytes
Admitted QoS Timeout 30 seconds
Active QoS Timeout 30 seconds
Scheduling Type: Unsolicited Grant Service
Request/Transmission Policy: 0x1FF
Unsolicited Grant Size: 100 bytes
Nominal Grant Interval: 20000 usecs
Tolerated Grant Jitter: 4000 usecs
Grants per Interval: 1
IP ToS Overwrite [AND-mask,OR-mask]: 0xE0,0xA0
Max Latency: 0 usecs
Parameter Presence Bitfield: {0xE08, 0xBCC000}
Index: 2
Name: UP_UGSAD
Direction: Upstream/Downstream
Traffic Priority: 0
Maximum Sustained Rate: 0 bits/sec
Max Burst: 1522 bytes
Minimum Reserved Rate: 0 bits/sec
Minimum Packet Size 100 bytes
Admitted QoS Timeout 30 seconds
Active QoS Timeout 30 seconds
Scheduling Type: Unsolicited Grant Service(AD)
Request/Transmission Policy: 0x1FF
Nominal Polling Interval: 10000 usecs
Tolerated Poll Jitter: 4000 usecs
Unsolicited Grant Size: 100 bytes
Nominal Grant Interval: 20000 usecs
Tolerated Grant Jitter: 4000 usecs
Grants per Interval: 1
IP ToS Overwrite [AND-mask,OR-mask]: 0xE0,0xA0
Max Latency: 0 usecs
Parameter Presence Bitfield: {0xE08, 0xBFC000}
Index: 3
Name: UP_RTPS
Direction: Upstream/Downstream
Traffic Priority: 0
Maximum Sustained Rate: 128000 bits/sec
Max Burst: 2000 bytes
Minimum Reserved Rate: 64000 bits/sec
Minimum Packet Size 64 bytes
Admitted QoS Timeout 30 seconds
Index: 4
Name: UP_BE
Direction: Upstream/Downstream
Traffic Priority: 5
Maximum Sustained Rate: 128000 bits/sec
Max Burst: 2000 bytes
Minimum Reserved Rate: 0 bits/sec
Minimum Packet Size 64 bytes
Admitted QoS Timeout 30 seconds
Active QoS Timeout 30 seconds
Maximum Concatenated Burst: 1522 bytes
Scheduling Type: Best Effort
Request/Transmission Policy: 0x0
IP ToS Overwrite [AND-mask,OR-mask]: 0xE0,0x0
Max Latency: 0 usecs
Parameter Presence Bitfield: {0xDE8, 0x80E000}
Index: 5
Name: DOWN_BE
Direction: Upstream/Downstream
Traffic Priority: 5
Maximum Sustained Rate: 1000000 bits/sec
Max Burst: 3000 bytes
Minimum Reserved Rate: 0 bits/sec
Minimum Packet Size 64 bytes
Admitted QoS Timeout 30 seconds
Active QoS Timeout 30 seconds
Maximum Concatenated Burst: 0 bytes
Scheduling Type: Best Effort
Request/Transmission Policy: 0x0
IP ToS Overwrite [AND-mask,OR-mask]: 0xFF,0x0
Max Latency: 0 usecs
Parameter Presence Bitfield: {0xDE8, 0x0}
Router#
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Related Commands cable service class Defines and modifies a service class.
show interface cable Displays the parameters in one or more service templates.
qos paramset
Syntax Description groupnum (Optional) Displays information about the specified group number
(1–32). If no group number is specified, information for all spectrum
groups is displayed.
detail (Optional) Displays whether the groups are allocated, free, or in-use.
Examples The following is sample output from the show cable spectrum-group command for all upstream
spectrum groups:
CMTS01# show cable spectrum-group
1 5.000-42.000 0 No
1 17.328 [1.60] Cable3/0 U0 0
1 5.808 [1.60] Cable3/0 U1 0
1 5.808 [1.60] Cable3/0 U2 0
1 15.792 [1.60] Cable3/0 U3 0
1 6.096 [1.60] Cable3/0 U4 0
1 5.808 [1.60] Cable3/0 U5 0
2 5.000-42.000 0 No
2 6.608 [3.20] Cable6/0 U1 0
2 5.808 [1.60] Cable6/0 U2 0
2 5.808 [1.60] Cable6/0 U3 0
2 5.808 [1.60] Cable6/0 U4 0
2 5.808 [1.60] Cable6/0 U5 0
3 5.000-42.000 0 No
3 17.488 [1.60] Cable5/0 U1 0
3 6.160 [1.60] Cable5/0 U2 0
3 36.912 [1.60] Cable5/0 U3 0
3 36.560 [1.60] Cable5/0 U4 0
3 16.240 [1.60] Cable5/0 U5 0
4 6.000- 8.600 0 No
4 16.000-18.000 0 No
4 17.168 [1.60] Cable5/0 U0 0
5 5.000-42.000 0 No
6 5.000-42.000 0 No
7 5.000-42.000 0 No
8 5.000-42.000 0 No
9 5.000-42.000 0 No
10 5.000-42.000 0 No
11 5.000-42.000 0 No
12 10.000-13.000 0 No
CMTS#
The following is sample output from the show cable spectrum-group detail command:
CMTS# show cable spectrum-group detail
1 10.000 1 Yes
1 10.000 2 Yes
1 11.000 3 Yes
1 11.000 4 Yes
1 15.000-20.000 0 Yes
A 8.400-12.600
A 15.000-20.000
1 11.008 [0.80] Cable3/0 U2 4
1 15.808 [1.60] Cable3/0 U3 0
1 Unassigned Cable3/0 U4
1 17.408 [1.60] Cable3/0 U5 0
I 10.600-11.400 4
I 15.000-16.600 0
I 16.600-18.200 0
F 8.400-10.600
F 11.400-12.600
F 18.200-20.000
C Width [3.20]
C Width [1.60]
C Width [0.80]
O 19.000 [1.60] 0
O 10.000 [0.80] 2
O 18.600 [0.80] 0
O 19.400 [0.80] 0
O 10.000 [0.80] 1
CMTS#
Table 3-41 describes the fields shown in the show cable spectrum-group displays.
Field Description
Group No. Identifies the spectrum group. When using the detail keyword, the
following also appear:
• A = Signifies that the band is allocated.
• F = Signifies that the band is free.
• I = Signifies that the band is in-use.
• C = Identifies the channel width.
• O = Identifies the offered list bands (based on the current
channel widths).
Frequency Band (MHz) Identifies the upper and lower ranges of the frequency for this
spectrum group.
Upstream Port Identifies the upstream port number.
Weekly Scheduled Availability Identifies the day and time of day when this group is available. If
no values appear in the From and To Time fields, this group is
available at all times.
Input PowerLevel Identifies the assigned decibels per millivolt (dBmV) input level.
Shared Spectrum Indicates if upstreams are physically combined (share the same
combiner group). Y or yes values indicate that upstreams that are
members of the spectrum group are combined and cannot be
assigned overlapping frequency bands.
N or no values indicate that upstreams that are members of the
spectrum group are not combined and can be assigned overlapping
frequency bands.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description over-consume (Optional) Displays only those subscribers who have exceeded their
maximum allowed bandwidth.
cable slot/port (Optional) Identifies a cable interface and downstream port on the
Cisco uBR7100 series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can
be 0 or 1, depending on the cable interface.
cable slot/subslot/port (Optional) Identifies a cable interface on the Cisco uBR10012 router.
The following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
upstream port (Optional) Displays information for a particular upstream on the
selected cable interface. The port value starts with 0 and continues up,
depending on the type of cable interface card.
sort-byte-count (Optional) Sort the list by the subscriber byte count, with the highest
byte counts listed first. The default is to sort the list by Service Flow
ID (SFID).
Defaults All subscribers are shown, with the display sorted by SFID.
Usage Guidelines The show cable subscriber-usage command displays the current usage statistics for all subscribers on
the Cisco CMTS, all subscribers on a particular cable interface, or for only those subscribers that are
marked as over-consuming bandwidth.
Examples The following example shows typical output for the default version of the show cable subscriber-usage
command:
Router# show cable subscriber-usage
Router#
The following example shows typical output for subscribers on a particular cable interface:
Router# show cable subscriber-usage c6/0/0
Router#
The following example shows typical output for the show cable subscriber-usage command for one
upstream on a particular cable interface:
Router# show cable subscriber-usage c6/0/1 upstream 0
Router#
The following example shows typical output for the sort-byte-count option for the show cable
subscriber-usage command:
Router# show cable subscriber-usage sort-byte-count
Sfid Mac Address Enforce-rule Total-Kbyte Last-detect Last-penalty Pen
Name Count time time Flag
7 0007.0e03.2cad test1 65157114 Feb24 11:36:34 Mar3 11:36:34 Act
9 0007.0e03.2c45 test1 16381014 -
5 0007.0e03.2c25 test1 13440960 -
Router#
Table 3-42 describes the fields shown by the show cable subscriber-usage command.
Field Description
SFID Number of the Service Flow ID.
Mac Address Hardware address (MAC address) of the subscriber’s cable modem.
Enforce-rule Name Name of the enforce-rule being applied to this subscriber.
Total Kbyte count Total number of kilobytes consumed by the subscriber’s cable
modem during the last monitoring-duration window.
Note The total byte count is reset to 0 whenever an enforce-rule’s
configuration is changed.
Last-detect Time Last time period, if any, at which it was determined that the cable
modem was using more bandwidth than allowed by their QoS
profile. This value also shows the time at which the enforced QoS
profile was automatically applied, if this option has been enabled.
Last-penalty Time If an enforced QoS profile is currently in effect, this field shows the
time period at which the subscriber’s current penalty time expires,
at which point their original registered QoS profile is restored.
Penalty Flag Identifies whether a penalty enforce-rule has been applied to this
cable modem.
Command Description
registered qos-profile Specifies the registered Quality of Service (QoS) profile that should be used
for this enforce-rule.
show cable qos Displays the quality of service (QoS) enforce-rules that are currently
enforce-rule defined.
Syntax Description cable slot/port (Optional) Displays information only for the specified cable interface
on the Cisco uBR7100 series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can
be 0 or 1, depending on the cable interface.
cable slot/subslot/port (Optional) Displays information only for the specified cable interface
on the Cisco uBR10012 router. The following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
Syntax Description slot/port (Optional) Cisco IOS Release 12.3(9a)BC allows you to display
information about one specific cable interface.
Identifies the cable interface and downstream port on the Cisco uBR7100
series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0
or 1, depending on the cable interface.
slot/subslot/port (Optional) Cisco IOS Release 12.3(9a)BC allows you to display
information about one specific cable interface.
Identifies the cable interface on the Cisco uBR10012 router. The following
are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
Usage Guidelines The show cable tech-support command displays a large amount of configuration, run-time status, and
other information about the cable interfaces on the Cisco CMTS. The output of this command can be
provided to technical support representatives when reporting a problem.
Note The show tech-support includes most of the information shown in the show cable tech-support
command. Unless the problem is clearly cable-specific, TAC personnel will typically request the show
tech-support output to troubleshoot any problems.
The show cable tech-support command displays the output of a number of different show commands.
The exact output depends on the platform, configuration, and type of protocols being used. Typically, in
Cisco IOS Release 12.2(15)BC2 and earlier releases, the output includes the output from the following
commands:
• show cable modem
• show cable flap-list
• show cable qos profile
• show cable modulation-profile
• show cable spectrum-group
• show cable hop
• show interface cable sid (for each cable interface)
• show interface cable sid connectivity (for each cable interface)
• show interface cable downstream
• show interface cable upstream
• show interface cable mac-scheduler
• show interface cable modem
Other commands could be included in the show cable tech-support output, depending on the CMTS
platform, the Cisco IOS software being used, and the cards that are installed in the chassis.
On the Cisco uBR10012 router, the following commands also appear in Cisco IOS Release 12.2(15)BC2
and later releases:
• show pxf cpu statistics
• show pxf cpu subblocks
• show pxf cpu buffer
• show pxf dma
• show pxf cpu cef memory
• show pxf cpu queue
• show pxf cpu statistics drop
Tip Depending on the platform and configuration, the output from the show cable tech-support command
can easily exceed the buffers found in most communications programs. To capture this output so it can
be sent to Cisco TAC, use a Telnet program that allows you to capture the output directly to disk.
In Cisco IOS Release 12.3(9a)BC and later releases, the output of the show cable tech-support
command was considerably shortened, so that users with large numbers of online cable modems can
collect the necessary information without monopolizing the console for dozens of minutes. The
following commands appear in this smaller output:
• show cable modem
• show interface cable sid (for each cable interface)
• show interface cable sid connectivity (for each cable interface)
• show interface cable modem
In addition, in Cisco IOS Release 12.3(9a)BC and later releases, you can specify the output for only one
cable interface.
Examples The following abbreviated example illustrates the cable modem and interface information for the
Cisco uBR10012 router on which Cisco IOS Release 12.3(9a)BC is installed.
Router# show cable tech-support
MAC Address IP Address I/F MAC Prim RxPwr Timing Num BPI
State Sid (dB) Offset CPE Enb
Sid Prim MAC Address IP Address Type Age Admin Sched Sfid
State Type
MAC Address IP Address I/F MAC Prim RxPwr Timing Num BPI
State Sid (dB) Offset CPE Enb
Sid Prim MAC Address IP Address Type Age Admin Sched Sfid
State Type
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
show checkpoint
To display information about the Checkpoint Facility (CF) subsystem on a Cisco CMTS, use the show
checkpoint command in privileged EXEC mode.
Usage Guidelines The Checkpoint Facility (CF) subsystem manages the passing of messages from the Active to Standby
interfaces. It also handles sequencing and throttling, as needed during redundancy operations.
Checkpoint clients, such as line cards and other subsystems, register with the CF subsystem so that they
can update the Protect card or standby processor with state changes as necessary.
The show checkpoint command displays information about the clients (other processes on the CMTS
that are sending checkpoint messages) and run-time status for checkpoint operations.
Examples The following shows typical output for the show checkpoint clients command:
Router# show checkpoint clients
Router#
The following shows typical output for the show checkpoint statistics command:
Router# show checkpoint statistics
Router#
Syntax Description slot/port Identifies the cable interface and downstream port on the
Cisco uBR7100 series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can
be 0 or 1, depending on the cable interface.
slot/subslot/port Identifies the cable interface on the Cisco uBR10012 router. The
following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
downstream (Optional) Displays downstream interface status.
upstream (Optional) Displays upstream interface status.
port (Optional) Specifies the desired upstream port. Valid values start with
0 for the first upstream port on the cable interface line card.
mem-stat (Optional) Displays the output from the show memory statistics
command to display a summary of memory statistics for a Broadband
Processing Engine (BPE) cable interface line card.
memory (Optional) Displays the output from the show memory command to
display a summary of memory statistics, including the memory as it is
allocated per process, for a Broadband Processing Engine (BPE) cable
interface line card.
proc-cpu (Optional) Displays the output from the show processes cpu command
to display the processor status for a Broadband Processing Engine
(BPE) cable interface line card.
tech-support (Optional) Cisco IOS Release 12.3(9a)BC adds the optional tech-
support keyword. This change allows users with large numbers of
online cable modems to collect the necessary line card information
without consuming the console session for a long period of time.
tech-support (Optional, privileged EXEC mode only) Displays the output from the
show tech-support command for a Broadband Processing Engine
(BPE) cable interface line card.
Command Modes User EXEC (all options except tech-support), Privileged EXEC
Usage Guidelines The mem-stat, memory, and proc-cpu keywords execute the related command on the processor that
runs on added to obtain the relevant information from the onboard processor on Broadband Processing
Engine (BPE) cable interface line cards, such as the Cisco uBR-MC16U/X, Cisco uBR-MC28U/X, and
Cisco uBR-MC5X20S/U cards. This allows you to obtain information that is specific for that particular
cable interface card, as opposed to having to run these commands on the entire router.
Note The mem-stat, memory, and proc-cpu options are not available for cable interface line cards that do not
contain an onboard processor (for example, the Cisco uBR-MC16C card).
Examples The following abbreviated example illustrates the initial information for the tech-support option for the
Cisco uBR10012 router on which Cisco IOS Release 12.3(9a)BC is installed:
Router# show controllers c8/1/0 tech-support
Table 3-43 describes the fields displayed by the show controllers cable downstream command.
Field Description
Cable Slot number/port number indicating the location of the Cisco cable
interface line card.
Downstream is up Indicates that the RF downstream interface is enabled.
Frequency Transmission frequency of the RF downstream. (This information
may not match the current transmission frequency, which is
external on CMTS platforms that use an external upconverter.)
Channel Width Indicates the width of the RF downstream channel.
QAM Indicates the modulation scheme.
Symbol Rate Indicates the transmission rate (in number of symbols per second).
FEC ITU-T Indicates the Motion Picture Experts Group (MPEG) framing
standard.
R/S Interleave I/J Indicates Reed Solomon framing based on ITU S.83-B.
For cable interfaces that include an integrated upconverter, the show controllers cable command
includes the frequency and power settings for the integrated upconverter. The following example shows
typical output for the show controllers cable command that includes the information for the integrated
upconverter:
ubr7100# show controllers cable 1/0
Interface Cable1/0
Hardware is IMC11
BCM3210 revision=0x56B2
Cable1/0 Upconverter is Enabled Output is Enabled
Model: 74-2094-01 Serial Number: 0WAV04480010 CLEI Code: CLEI#
HW Rev: PC2D0107 SW Rev: 007, NVRAM Rev: 006 ECI number 123456
Downstream Frequency 525.0000 MHz
IF Power 0.3 dBmv RF Power 51.0 dBmv
...
The following is typical output for a downstream on the Cisco uBR-MC28U cable interface line card, or
other cable interface card with integrated upconverter:
ubr7246vxr# show controllers cable 6/0 downstream
Interface Cable6/0
Hardware is MC28U (F-connector) with Integrated Up-converter
Primary rommon version is: 11.4
Secondary rommon version is: 6553.5
Current rommon is Primary
Late input drops = 0
Output queue: 0/1000/64/0 (size/max total/threshold/drops)
JIB version 372
H/W Spectrum Management Information:
BCM3138 Chip State: 1 1 1 1, Serial Port State 1, Busy Count: 0 25 0 0
Spectrum Management IPC Statistics:
Tx Statistics
Pkts: 48413, Lock Errs: 0, MB not Empty: 0, No Buffs: 0
Rx Statistics
Pkts: 46097, Timeout: 1, Unexpected: 0, No Buffs: 0, Lock Errs: 0
Inuse band lower=0 upper=0 CNR=56
candidate band lower=0 upper=0 Mod=0
Inuse band lower=0 upper=0 CNR=52
candidate band lower=0 upper=0 Mod=0
Inuse band lower=0 upper=0 CNR=55
candidate band lower=0 upper=0 Mod=0
Inuse band lower=23000 upper=26200 CNR=55
candidate band lower=23000 upper=26200 Mod=0
Cable6/0 Upconverter is Enabled Output is Enabled
Model: 74-2094-05 Serial Number: 0WAV06530029 CLEI Code: FFFFFFFFFF
HW Rev: PC2D0108 SW Rev: 010, NVRAM Rev: 006 ECI number FFFFFF
Downstream Frequency 471.0000 MHz
RF Power 54.9 dBmv
Router#
Table 3-44 describes the fields related to the integrated upconverter that are displayed by the show
controllers cable downstream command.
Field Description
Downstream Frequency Indicates the center frequency (in MHz) for which the integrated
upconverter has been configured.
IF Power Indicates the power level (in dBmV) of the signal that the
integrated upconverter is receiving from the cable interface line
card in the Cisco uBR7100 series router.
RF Power Indicates the power level (in dBmV) of the RF output signal that
the integrated upconverter is transmitting on the DS0 RF port.
The following is sample output from the show controllers cable upstream command for a Cisco CMTS
router with a cable interface card located in slot 4, port 0:
CMTS01# show controllers cable 4/0 upstream 2
Router#
The following example shows typical output for a cable interface line card that includes onboard
hardware-based spectrum management capabilities (such as the Cisco uBR-MC16S and Cisco uBR-
MC28U/X cards):
Router# show controllers cable 3/0 upstream 3
Cable6/0 Upstream 3 is up
Frequency 24.600 MHz, Channel Width 3.200 MHz, 64-QAM Symbol Rate 2.560 Msps
This upstream is mapped to physical port 3
Spectrum Group 14, Last Frequency Hop Data Error: NO(0)
MC28U CNR measurement - better than 50 db
Nominal Input Power Level 0 dBmV, Tx Timing Offset 2815
Ranging Backoff automatic (Start 0, End 3)
Ranging Insertion Interval automatic (60 ms)
Tx Backoff Start 0, Tx Backoff End 4
Modulation Profile Group 241
Concatenation is enabled
Fragmentation is enabled
part_id=0x3138, rev_id=0x02, rev2_id=0x00
nb_agc_thr=0x0000, nb_agc_nom=0x0000
Range Load Reg Size=0x58
Request Load Reg Size=0x0E
Minislot Size in number of Timebase Ticks is = 2
Minislot Size in Symbols = 32
Bandwidth Requests = 0x23C800
Piggyback Requests = 0x489FB8
Invalid BW Requests= 0x0
Minislots Requested= 0x4499EBE
Minislots Granted = 0x6C67B7
Minislot Size in Bytes = 24
Map Advance (Dynamic) : 2454 usecs
UCD Count = 429798
ATDMA mode enabled
Multicast/Broadcast RateLimit Dropped Pkts : 0
Router#
For Broadband Processing Engine (BPE) cards, and other cable interfaces that include onboard
upconverters, the show controllers cable command also displays information about the upconverter’s
status and configuration. The following excerpt from the command output shows the information that is
displayed for the Cisco uBR-MC5X20S cable interface line card:
Router# show controllers cable 5/1/4
Interface Cable5/1/4
Hardware is MC520S
JIB version 66
Cable5/1/4 Upconverter is Enabled Output is Enabled
Model: 74-2094-04 Serial Number: 0WAV0649000L CLEI Code: FFFFFFFFFF
HW Rev: PC2D0108 SW Rev: 010, NVRAM Rev: 006 ECI number FFFFFF
Downstream Frequency 255.0000 MHz
RF Power 49.8 dBmv
...
Router#
Table 3-45 describes the fields shown in the show controllers cable upstream display.
Field Description
Cable Slot number/port number indicating the location of the Cisco cable
interface line card.
Upstream is up/administratively Indicates the administrative state of the upstream (whether it is
down shutdown or not).
Channel Width Indicates the width of the RF upstream channel.
QPSK Symbol Rate Indicates the modulation technique for upstream transmission.
Spectrum Group 4 Indicates the spectrum group associated with this slot and port.
Frequency Transmission frequency of the RF upstream channel.
Note Cisco cable interface line cards always program the
upstream’s center frequency in 16 KHz increments, and
this is the frequency displayed by the lines added to the
router’s configuration and by the show controllers cable
upstream command. For example, if you use the cable
upstream frequency command to specify a center
frequency of 27 MHz (cable upstream x frequency
27000000), the actual center frequency will be 27.008
MHz, which is the next highest 16 KHz boundary.
SNR measurement Estimate for the overall signal-to-noise ratio (SNR) for cable
interfaces that do not include onboard hardware-based spectrum
management. For most cable interface line cards, this value reflects
the Modulation Error Rate (MER) value for the upstream (as
calculated according to the IEEE 802.14 PHY layer specifications).
The MER is sometimes incorrectly referred to as the carrier-to-
noise ratio (CNR), and the SNR value is generally lower than the
CNR value.
Note In Cisco IOS Release 12.1(10)EC1 and Cisco IOS Release
12.2(4)BC1b, the algorithm for calculating the SNR
estimate was refined for a more accurate value. Depending
on the plant characteristics, the new SNR estimate could be
up to 6 dB lower than the values shown in earlier software
releases. This value is only an estimate—for the most
accurate value, use a spectrum analyzer.
Table 3-45 show controllers cable upstream Command Field Descriptions (continued)
Field Description
<card-name> CNR measurement Estimate for the overall carrier-to-noise ratio (CNR) for the
upstream for cable interfaces that include onboard hardware-based
spectrum management (such as the Cisco uBR-MC16S or
Cisco uBR-MC5X20S). When the CNR measurement exceeds
40 dB, this line states “better than 40 dB.” As a general rule, the
CNR is greater than the SNR value.
Note This value is only an estimate—for the most accurate
value, use a spectrum analyzer or use the show controllers
cable upstream spectrum command. For individual cable
modems, you can also use the show cable modem cnr
command.
Nominal Input Power level Indicates the desired power level coming into the receiver.
Tx Timing Offset Indicates the largest ranging offset reported by CMs on the
upstream.
Ranging Backoff Start/End Indicates how many ranging slots (expressed as an exponent of 2)
to back off before resending the ranging bursts after an upstream
collision. These values are configured using the cable upstream
range-backoff start end command.
Ranging Backoff Automatic Start and End Ranging Backoff exponents, which are set
automatically, using the cable upstream range-backoff
automatic command.
Note These counters are not accurately updated on the
Cisco uBR-MC5X20S cable interface line card, which
should manually configure ranging backoff instead.
Tx Backoff Start Indicates the starting exponential backoff value for data collisions.
Tx Backoff End Indicates the ending exponential backoff value for data collisions.
Modulation Profile Group A set of burst profiles defining an upstream range.
part_id= The part number of the PHY chip. FFFF means the PHY chip is
turned off.
rev_id= The PHY chip revision number.
rev2_id= The PHY chip subrevision number.
nb_agc_thr= Threshold used to control gain.
nb_agc_nom= Used to accelerate convergence of input power level.
Range Load Reg Size= Size, indicated by number of symbols, for range request bursts.
Request Load Reg Size= Size, indicated by number of symbols, for request bursts.
Minislot Size in number of Size in tick units of upstream minislot. A tick is 6.25 microseconds.
Timebase Ticks is
Minislot Size in Symbols Size in symbols of the upstream minislot.
Bandwidth Requests Number of successful bandwidth requests received in the
contention minislots.
Piggyback Requests Number of successful bandwidth requests piggybacked with
regular data transmissions.
Table 3-45 show controllers cable upstream Command Field Descriptions (continued)
Field Description
Invalid BW Requests Number of invalid bandwidth (BW) requests. (An example of an
invalid bandwidth request is a modem using a nonexistent service
identifier (SID) to request bandwidth.
Minislots Requested Total number of minislots requested.
Minislots Granted Total number of minislots granted.
Minislot Size in Bytes Size of the minislot in bytes.
UCD Count Number of Upstream Channel Descriptors (UCDs) sent for this
upstream.
DES Ctrl Reg # = Interval data encryption standard (DES) controller register dump.
Null Modem RateLimit Dropped (Cisco uBR-MC16U/X, Cisco uBR-MC28U/X only) Number of
Pkts packets that were dropped because they had a Service Flow ID
(SFID) of 0, which typically happens because the packets were
dropped due to rate-limiting on their original service flow.
Additional Information for Broadband Processing Engine (BPE) Cable Interface Line Cards
JIB Version Revision of the JIB circuitry, which is the custom processor
onboard the BPE cards that handles the MAC-layer processing.
Upconverter is Enabled Status of the upconverter and whether it is currently outputting a
Output is Enabled signal. If this field shows that the output is disabled, use the
no cable downstream rf-shutdown command to reenable it.
Downstream Frequency Configured frequency, in MHz, for the integrated upconverter (if
present).
RF Power Current RF power, in dBmV, as measured by the upconverter on the
cable interface line card. The upconverter’s circuitry is accurate to
a few tenths of a dBmV, but might vary +/- 1 dBmV depending on
the transient noise that is occuring when the power is measured.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Command Description
show controllers cable Displays the noise levels for a particular CM or displays the background
upstream spectrum noise for an entire upstream (Cisco uBR-MC16 line card only).
show interface cable Displays information about interface controllers for a specific cable access
sid router card slot.
Syntax Description slot/port Identifies the cable interface and downstream port on the
Cisco uBR7100 series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can
be 0 or 1, depending on the cable interface.
slot/subslot/port Identifies the cable interface on the Cisco uBR10012 router. The
following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
n Port number for the desired upstream (0 to 5).
ip-address (Optional) IP address, in dotted decimal notation, for a CM on the
specified upstream.
mac-address (Optional) MAC address, in dotted hexadecimal notation, for a CM on
the specified upstream.
start-freq Starting frequency for the frequency range that is being reported
(5 to 42 MHz; can also be specified as 5000 to 42000 KHz or
5000000 to 42000000 Hz).
end-freq Ending frequency for the frequency range that is being reported
(5 to 42 MHz).
Note The ending frequency must be greater than the starting
frequency and must be specified using the same units as the
starting frequency (MHz, KHz, Hz).
res-freq Resolution frequency to determine the number of data points for the
report (12 to 37000 KHz).
Note The resolution frequency must be specified in the same units as
the starting and ending frequency (MHz, KHz, Hz). To use a
resolution value less than 1 MHz, you must specify the other
parameters in either Hz or KHz.
Usage Guidelines Cisco IOS Release 12.3(9a)BC adds the tech-support keyword to the show controllers cable command.
This change allows users with large numbers of online cable modems to collect the necessary line card
information without consuming the console session for a long period of time.
Additional and related improvements are also available for the show cable tech-support command.
For all supported releases, the show controllers cable upstream spectrum command displays the
power in dBmV for a given frequency range for the specified upstream. The frequency range can cover
any portion of the DOCSIS upstream frequency range (5 to 42 MHz), and the frequency range can be
divided into a resolution as small as 12 KHz.
If a CM is specified by its IP address or MAC address, the power information for that particular CM is
given. If no IP or MAC address is given, the command displays the background noise for the entire
upstream. All displays use historical averaging of data collected at the time the command is used;
historical information is not saved.
Note Cisco cable interface line cards always program the upstream’s center frequency in 16-KHz increments,
and this is the frequency displayed by the show controller cable upstream command. For example, if
you use the cable upstream frequency command to specify a center frequency of 27 MHz (cable
upstream x frequency 27000000), the actual center frequency will be 27.008 MHz, which is the next-
highest 16-KHz boundary.
Tip By default, the show controller cable upstream command displays its output to the router’s console
port. To display the command’s output when logged in during a Telnet session over an Ethernet port, use
the terminal monitor command before giving the show controller cable upstream command.
Examples The following example shows the show controllers cable upstream command displaying the power
information for a particular CM on upstream 5 of cable interface slot 3/0. The power information is
displayed over the entire upstream (5–42 MHz), with a resolution of 5 MHz:
Router# show cable modem
MAC Address IP Address I/F MAC Prim RxPwr Timing Num BPI
State Sid (db) Offset CPEs Enbld
...
00d0.ba77.7595 10.20.114.34 C3/0/U5 online 1 0.25 2740 1 yes
00d0.ba77.7621 10.20.114.17 C3/0/U5 online 2 0.25 2740 2 yes
00d0.ba77.7533 10.20.114.55 C3/0/U5 online 3 0.25 2740 1 yes
...
Note The output for each frequency range includes a time-stamp, the ending frequency for each range
(in KHz), the historical average power level for that range (in dBmV), and a series of asterisks that
provides a graphical representation of the noise floor level for the signal (a stronger signal is indicated
by more asterisks).
The following example shows a partial display of the background noise data for upstream 4 of cable
interface slot 6/0. The command covers the entire upstream spectrum (5–42 MHz) at the minimum
resolution of 12 KHz.
Router# show controller cable 6/0 upstream 4 spectrum 5000 42000 12
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Usage Guidelines To reset the counters that are displayed with the show controllers clock-reference command, use the
cable clock clear-counters command.
This command supports the Cisco CMTS clock feature set, which provides a synchronized clock for
improved Voice-over-IP (VoIP) operations. The clock feature set requires one of the following
configurations:
• A Cisco uBR10012 router with one or two TCC+ cards that are connected to an external national
clock source.
• A Cisco uBR7246 VXR router using a Cisco uBR-MC16S, Cisco uBR-MC16E, Cisco uBR-
MC28C, or Cisco uBR-MC28C-BNC cable interface line card. The router must also be equipped
with a Cisco cable clock card and be running Cisco IOS 12.1(1a)T1, 12.1(2)EC1, or a later release.
The Cisco cable clock card should be connected to an external national clock source.
Only these cable interface cards support the external clock card reference from a clock card to distribute
that signal to CMs or set-top boxes (STBs) attached to the specific network segments. You can use other
cable interface cards, such as the Cisco uBR-MC16C, with the clock card, but these other cable
interfaces will not synchronize their downstream SYNC messages with the external clock source.
Each CM or STB must also support VoIP applications and the clock feature set. For example, the
Cisco uBR924, running Cisco IOS Release 12.0(7)T or later, supports clock card feature automatically.
Examples The following is sample output from the show controllers clock-reference command for a
Cisco uBR7246 VXR router with a national clock card:
The following is sample output from the show controllers clock-reference command for a
Cisco uBR10012 router with two TCC+ cards.
Note Each TCC+ card—Active and Backup—has its own separate set of registers.
Router#
Note The show controllers clock-reference command might display compare errors on the Cisco uBR10012
router because there could be a slight delay at system startup before the TCC+ cards synchronize with
each other. These initial compare errors can be ignored and cleared with the cable clock clear-counters
command.
Most of the information shown by the show controllers clock-reference command is in the form of a
hexadecimal bitfield that is not meaningful for normal operations, but the following fields can be useful
in troubleshooting problems with the TCC+ and cable interface line cards:
• UCPC Bus Control Status Reg—Displays the status of both TCC+ cards and whether the LCD
Display Panel is present.
• Line Card Presence Status Reg—Provides a software view of whether a cable interface line card is
physically present in the Cisco uBR10012 chassis.
• LC Presence Input Reg—Provides a hardware view of whether a cable interface line card is
physically present in the Cisco uBR10012 chassis.
• LC Power off Status Reg—Indicates whether a cable interface line card slot has been powered off
using the cable power command.
Table 3-46 shows how to interpret these fields.
Field Description
UCPC Bus Control Status Reg Displays the status of both TCC+ cards and of the LCD
Display Panel. Each TCC+ card displays this field from its
own point of view, where “this card” refers to itself and “the
other card” refers to the other TCC+ card slot.
• Bits 2–0 display the status of the other TCC+ card:
– 0x00=No card.
– 0x03=The other card is the backup card.
– 0x05=The other card is the active card.
• Bit 3 is set to 1 upon a state change for the other TCC+
card.
• Bits 6–4 display the status of this TCC+ card:
– 0x00=No card.
– 0x03=This card is the backup card.
– 0x05=This card is the active card.
– 0x06=This card has assumed the active card role,
because the other card had been active but is now
unresponsive.
• Bit 7 is set to 1 upon a state change for this TCC+ card.
• Bits 13–8 are unused.
• Bit 14 is set to 1 if the LCD Display Panel is present.
• Bit 15 is set to 1 if the presence of the LCD Display Panel
has changed since the counters were last cleared.
The most common bit patterns for the UCPC Bus Control Status Reg field are:
• 0x4003—This TCC+ card is not present, the other card is the active card, and an LCD Display is
present.
• 0x4030—This TCC+ card is the active card, the other card is not present, and an LCD Display is
present.
• 0x4035—This TCC+ card is the backup card, the other card is the active card, and an LCD
Display is present.
• 0x4053—This TCC+ card is the active card, the other card is the backup card, and an LCD
Display is present.
• 0x4065—This TCC+ card has assumed the active card role, because the other card had been active
but is now unresponsive. The LCD Display is present.
Field Description
Line Card Presence Status Reg The first eight bits indicate whether the line card is physically
present, and the high eight bits indicate whether the card’s
physical state has changed since the counters were last cleared
using the cable clock clear-counters command.
0x0001=slot 5/0 contains a cable interface card
0x0002=slot 5/1 contains a cable interface card
0x0004=slot 6/0 contains a cable interface card
0x0008=slot 6/1 contains a cable interface card
0x0010=slot 7/0 contains a cable interface card
0x0020=slot 7/1 contains a cable interface card
0x0040=slot 8/0 contains a cable interface card
0x0080=slot 8/1 contains a cable interface card
0x0100=slot 5/0 has changed physical state
0x0200=slot 5/1 has changed physical state
0x0400=slot 6/0 has changed physical state
0x0800=slot 6/1 has changed physical state
0x1000=slot 7/0 has changed physical state
0x2000=slot 7/1 has changed physical state
0x4000=slot 8/0 has changed physical state
0x8000=slot 8/1 has changed physical state
LC Presence Input Reg The lower eight bits of this register indicate whether a cable
interface line card is physically present in the chassis slot. The
bit meanings are the same as the lower eight bits the Line Card
Presence Status Reg.
The upper eight bits of this register are unused.
Note The Line Card Presence Status Reg displays the line card state as determined by the Cisco IOS
software, while the LC Presence Input Reg displays the state as determined by the chassis
hardware.
LC Power off Status Reg 0x01=slot 5/0 is powered off
0x02=slot 5/1 is powered off
0x04=slot 6/0 is powered off
0x08=slot 6/1 is powered off
0x10=slot 7/0 is powered off
0x20=slot 7/1 is powered off
0x40=slot 8/0 is powered off
0x80=slot 8/1 is powered off
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Usage Guidelines
Note You can use the unsupported command test cable generate in privileged EXEC mode to force the Cisco
CMTS to register the root certificate.
For additional information about using the show crypto commands on the Cisco CMTS, refer to the
“Configuring DOCSIS 1.1 on the Cisco CMTS” chapter of the Cisco CMTS Feature Guide:
http://www.cisco.com/en/US/products/hw/cable/ps2217/products_feature_guide_chapter09186a00
8019b57f.html
Examples The following example illustrates the use of the show crypto ca certificates command:
Router# show crypto ca certificates
Usage Guidelines
Note The show crypto ca trustpoints command does not display the root certificate until after at least one
cable modem has registered with the Cisco CMTS using BPI+ encryption. Alternatively, you can use the
unsupported command test cable generate in privileged EXEC mode to force the Cisco CMTS to
register the root certificate.
Tip To display all certificates (Root, Manufacturers, CM) that the CMTS has learned, use the show crypto
ca certificates command.
For additional information about using the show crypto commands on the Cisco CMTS, refer to the
“Configuring DOCSIS 1.1 on the Cisco CMTS” chapter of the Cisco CMTS Feature Guide:
http://www.cisco.com/en/US/products/hw/cable/ps2217/products_feature_guide_chapter09186a00
8019b57f.html
Examples The following example illustrates the show crypto ca trustpoints command with
Cisco IOS Release 12.3(9a)BC:
Router# show crypto ca trustpoints
Root certificate
Status: Available
Certificate Serial Number: D54BB68FE934324F6B8FD0E41A65D867
Key Usage: General Purpose
Issuer:
CN = DOCSIS Cable Modem Root Certificate Authority
OU = Cable Modems
O = Data Over Cable Service Interface Specifications
C = US
Subject Name:
CN = "BPI Cable Modem Root Certificate Authority "
OU = DOCSIS
O = BPI
C = US
Validity Date:
start date: 07:00:00 UTC Mar 27 2001
end date: 06:59:59 UTC Jan 1 2007
show diag
To display the revision-level information for a Cisco CMTS cable interface, use the show diag command
in privileged EXEC mode.
Syntax Description slot (Optional) Identifies the Cisco CMTS chassis slot number to be
displayed.
Usage Guidelines This command displays information for the electrically erasable programmable read-only memory
(EEPROM), the motherboard, and the WAN interface cards (WICs) and voice interface cards
(VICs).This command also displays information about the cable clock card, if installed.
Examples The following is sample output from the show diag command displaying diagnostic information for the
cable clock card:
router# show diag
Clockcard:
National clock card with T1 controller
EEPROM contents at hardware discovery:
Hardware Revision :1.1
Part Number :800-05867-02
Board Revision :11
Deviation Number :0-0
Fab Version :02
PCB Serial Number :CAB04046NXV
RMA Test History :00
RMA Number :0-0-0-0
RMA History :00
EEPROM format version 4
EEPROM contents (hex):
0x00:04 FF 40 01 AC 41 01 01 C0 46 03 20 00 16 EB 02
0x10:42 31 31 80 00 00 00 00 02 02 C1 8B 43 41 42 30
0x20:34 30 34 36 4E 58 56 03 00 81 00 00 00 00 04 00
Table 3-47 describes the fields displayed by the show diag command.
Field Description
National clock card with T1 controller The system has identified the cable clock card.
EEPROM contents at hardware discovery EEPROM programmed data present when the system
identified the clock card.
Hardware Revision Version number of the card.
Part Number The part number of the card.
Board Revision Revision number (signifying a minor revision) of the
card.
Deviation Number Revision number (signifying a minor deviation) of the
card.
Fab Version Manufacturing fabrication version number.
PCB Serial Number Serial number of the printed circuit board.
RMA Test History Counter indicating how many times diagnostics have
been performed on this card.
RMA Number Return material authorization number, which is an
administrative number assigned if the card needs to be
returned for repair.
RMA History Counter indicating how many times the card has been
returned and repaired.
EEPROM format version Version number of the EEPROM format.
EEPROM contents (hex) Dumps of EEPROM programmed data.
The following is sample output from the show diag command that displays revision-level information
for the cable line card (slot 6):
CMTS01# show diag
Slot 6:
MC11 port adapter, 1 port
Port adapter is analyzed
Port adapter insertion time 02:37:10 ago
Hardware Revision : 1.2
Part Number : 800-02455-02
Board Revision : 03
Deviation Number : 0-3
Fab Version : 03
PCB Serial Number : 00004500239
RMA Test History : 00
RMA Number : 0-0-0-0
RMA History : 00
Calibration Data : Minimum: -8 dBmV, Maximum: 8 dBmV
Calibration values : 0x5D43 0x3F05 0x1794
Unknown Field (type 0083): 83 FF FF FF
EEPROM format version 4
EEPROM contents (hex):
0x00: 04 FF 40 00 F1 41 01 02 C0 46 03 20 00 09 97 02
0x10: 42 30 33 80 00 00 00 03 02 03 C1 8B 30 30 30 30
0x20: 34 35 30 30 32 33 39 03 00 81 00 00 00 00 04 00
0x30: C8 09 F8 08 03 5D 43 3F 05 17 94 83 83 FF FF FF
0x40: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x50: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x60: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
0x70: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
Table 3-48 describes the fields displayed by the show diag command.
Field Description
MC11 port adapter Line card type.
Port adapter is analyzed The system has identified the Cisco CMTS port adapter.
Port adapter insertion time Elapsed time since insertion.
Hardware Revision Version number of the Cisco CMTS port adapter.
Part Number In the Cisco CMTS, the part number of the port adapter.
Board Revision Revision number (signifying a minor revision) of the Cisco CMTS
port adapter.
Deviation Number Revision number (signifying a minor deviation) of the
Cisco CMTS port adapter.
Fab Version Manufacturing fabrication version number.
PCB Serial Number Serial number of the printed circuit board.
RMA Test History Counter indicating how many times diagnostics have been
performed on this port adapter.
RMA Number Return material authorization number, which is an administrative
number assigned if port adapter needs to be returned for repair.
RMA History Counter indicating how many times the port adapter has been
returned and repaired.
Calibration Data Input power calibration range.
Calibration values Upstream port gain calibration constant.
Unknown Field (type) Unrecognized EEPROM fields.
EEPROM format version Version number of the EEPROM format.
EEPROM contents (hex) Dumps of EEPROM programmed data.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
show frame-clocks
To display information about the midplane time-division multiplexing (TDM) clock reference, use the
show frame-clocks command in privileged EXEC mode.
show frame-clocks
Examples The following sample output from the show frame-clocks command shows that there are no clock
sources configured and the clock card is the default clock source:
Router# show frame-clocks
Table 3-49 describes the fields displayed by the show frame-clocks command:
Field Description
Priority 1-4 clock source The configuration of the four network clock sources.
Current clock source The current clock source, its input, and priority. In this
example, the clock card is providing the clock source.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
show hccp
To display information on groups associated with cable interfaces, use the show hccp command in user
EXEC or privileged EXEC mode.
show hccp group member [mac-address classifier | channel-switch | host | modem | qosparam |
service-flow sfid [classifier] | sid]
Syntax Description brief (Optional) Displays a brief summary of the groups, configuration types,
member numbers, and status for cable interfaces. You can also use this
option when displaying information for a specific group.
channel-switch (Optional) Displays information about the channel-switch configuration.
detail (Optional) Displays a detailed summary of the groups, configuration types,
member numbers, and status for cable interfaces, as well as the CLI
commands that are being synchronized across interfaces.
group (Optional) Specifies a group number to be displayed. The valid range is 1
to 255.
member (Optional, when displaying information for a particular group) Specifies the
member number of the Inter-database for the specified group. The valid
range is 1 to 255.
mac-address classifier (Optional) Displays classifier information for the specified MAC address.
channel-switch (Optional) Displays channel-switch information for this particular group
and member.
host (Optional) Displays host information for this particular group and member.
modem (Optional) Displays cable modem information for this particular group and
member.
qosparam (Optional) Displays quality of service (QoS) parameter information for this
particular group and member.
service-flow sfid (Optional) Displays service flow and classifier information for the specified
classifier service flow ID (SFID) for this particular group and member.
sid (Optional) Displays service ID (SID) information for this particular group
and member.
Release Modification
12.2(11)BC1 Support was added for the Cisco uBR-RFSW N+1 (1:n) RF Switch with the
Cisco uBR7246VXR router and Cisco uBR-MC16C, Cisco uBR-MC16S,
and Cisco uBR-MC28C cards.
12.2(15)BC2 The output of the show hccp detail command was changed to show separate
lists of the critical and non-critical CLI commands that are being
synchronized for each Working and Protect interface and subinterface.
Examples The following examples are from the show hccp and show hccp brief commands for the entire chassis:
Router# show hccp
In Cisco IOS Release 12.2(8)BC2 and later 12.2 BC releases, the brief option also shows the amount of
time left before the next resynchronization and the time left before a restore:
Router# show hccp brief
Router#
The following example shows typical output for the show hccp channel-switch command, displaying
the groups and module numbers for each configured member:
Router# show hccp channel-switch
module 5, normal
module 7, normal
module 11, normal
Grp 1 Mbr 5 Protect channel-switch:
"uc" - disabled, frequency 555000000 Hz
"rfswitch" - module 1, normal
module 3, normal
module 5, normal
module 7, normal
module 11, normal
Router#
The following example shows the first part of the display for the detail option of this command, which
first displays chassis-wide configuration information. The command then displays the CLI configuration
commands that are being synchronized for each subinterface.
Router# show hccp detail
Router#
In Cisco IOS Release 12.2(15)BC2 and later releases, the show hccp detail command shows the critical
and non-critical synchronized CLI commands in separate lists for each cable interface and subinterface:
Router# show hccp detail
authentication none
hello time 5000 msec, hold time 15000 msec, revertive
track interfaces: Cable6/0/0
sync time 1000 msec, suspend time 120000 msec
local state is Learn, tran 54
last switch reason is none
last HELLO tran 54, elapsed 3928 msec, hello timer expires in 00:00:01.068
data plane directly sends sync packets
statistics:
standby_to_active 0, active_to_standby 0
active_to_active 0, standby_to_standby 4
Member 6 standby
target ip address: protect 222.1.1.9, working 222.1.1.9
channel-switch "rfsw" (rfswitch-group, 1.10.52.33/0x40100000/7) enabled
channel-switch "uc" (wavecom-hd, 1.10.45.11/7, 1.10.45.11/6) enabled
tran #: SYNC 0, last SYNC_ACK 9
hold timer expires in 00:00:11.068
Interface Generic Critical Config
========================
int Cable6/0/0
mac-address 00e0.6666.1288
end
Member 5 standby
target ip address: protect 222.1.1.9, working 222.1.1.9
channel-switch "uc" (wavecom-hd, 1.10.45.11/7, 1.10.45.11/4) enabled
channel-switch "rfsw" (rfswitch-group, 1.10.52.33/0x40100000/8) enabled
tran #: SYNC 0, last SYNC_ACK 9
hold timer expires in 00:00:13.756
Interface Generic Critical Config
========================
int Cable6/0/0
mac-address 00e0.6666.1270
end
Router#
The following shows a typical example of the show hccp command to display QoS parameters for a
particular member of a particular group:
Router# show hccp 1 1 qosparam
Cable5/0/0:
Index Name Dir Sched Prio MaxSusRate MaxBurst MinRsvRate
1 US BE 0 64000 0 0
2 DS BE 0 1000000 0 0
3 US BE 7 1024000 1522 0
4 DS BE 0 10000000 1522 0
Router#
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
The following example shows a detailed display for the Cisco uBR-MC5X20S cable interface line card:
Router# show hccp detail
mac-address 0005.00e4.1236
cmts config:
resolve sid, dci-response success,
downstream - frequency 441000000, channel id 0
downstream - insertion_invl auto min = 60, max = 480
downstream - rf-shutdown, rf-power 48
upstream 0 - frequency 11408000, power level 0
upstream 0 - modulation-profile 1, channel-width 3200000
upstream 0 - cnr-profile1 25, cnr-profile2 15
corr-fec 1, uncorr-fec 1
Note For cable interfaces with an integrated upconverter, the line showing the RF power will show
rf-shutdown when the upconverter has been powered off.
Syntax Description interface The cable interface for which you want to display HCCP group information.
The information presented includes HCCP groups, configuration types,
member numbers, status, authentication algorithms, authentication key
chains, HCCP timers, Ip address assignments, and downstream switch
designations for the specified cable interface.
brief (Option) Displays a brief summary of the HCCP groups, configuration
types, member numbers, and status for a specified cable interface.
detail (Option) Displays a detailed summary of the HCCP groups, configuration
types, member numbers, and status for a specified cable interface.
Examples The following examples are from the show hccp interface cable 4/0 and show hccp interface cable 4/0
brief commands:
Router# show hccp interface cable 4/0
Router#
In Cisco IOS Release 12.2(8)BC2 and later 12.2 BC releases, the brief option also shows the amount of
time left before the next resynchronization and the time left before a restore:
Router# show hccp interface cable 4/0 brief
Router#
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description slot/port Identifies the cable interface and downstream port on the
Cisco uBR7100 series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On
the Cisco uBR7200 series router, slot can range from 3 to 6, and port
can be 0 or 1, depending on the cable interface.
slot/subslot/port Identifies the cable interface on the Cisco uBR10012 router. The
following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
options Cable-specific options are documented in their own command
reference pages:
• show interface cable downstream, page 3-209
• show interface cable intercept, page 3-212
• show interface cable mac-scheduler, page 3-214
• show interface cable monitor, page 3-222
• show interface cable qos paramset, page 3-226
• show interface cable service-flow, page 3-228
• show interface cable sid, page 3-234
• show interface cable signal-quality, page 3-241
• show interface cable upstream, page 3-243
A number of non-cable-specific options are also supported (but not all
are meaningful for cable interfaces):
accounting—Displays the number of packets of each protocol
type that was sent through the interface.
crb—Displays routing and bridging information.
description—Displays the description entered for the interface.
fair-queue—Displays distributed weighted fair queuing (DWFQ)
statistics.
irb—Displays integrated routing bridge information.
mac-accounting—Displays Ethernet MAC accounting
information.
random-detect—Displays weighted random early detection
(WRED) information.
rate-limit—Displays rate-limit information.
shape—Displays Traffic Shape information.
stats—Displays numbers of packets that were switched.
Note For information on the non-cable specific options, see the Cisco IOS Release 12.2 documentation on
Cisco.com and the Customer Documentation CD-ROM.
Examples The following is sample output from the show interface cable command:
CMTS01# show interface cable 6/0
Table 3-50 describes the fields shown in the show interface cable display.
Field Description
Cable slot/port is Indicates whether the interface hardware is currently active or
up/...administratively down taken down by the administrator.
line protocol is Indicates whether the software processes that handle the line
up/...administratively down protocol believe the interface is usable or if it has been taken down
by the administrator.
hardware Hardware type and address.
Internet address Internet address followed by subnet mask.
MTU Maximum transmission unit (MTU) of the interface.
BW Bandwidth of the interface in kilobits per second.
DLY Delay of the interface in microseconds.
Field Description
rely Reliability of the interface as a fraction of 255, calculated as an
exponential average over 5 minutes. (For example, 255/255 is 100
percent reliability.)
load Load on the interface as a fraction of 255, calculated as an
exponential average over 5 minutes. (For example, 255/255 is
complete saturation.)
Encapsulation Encapsulation method assigned to this interface.
ARP type Type of Address Resolution Protocol (ARP) and timeout value
assigned.
Last input Number of hours, minutes, and seconds since the last packet was
successfully received by an interface.
output Number of hours, minutes, and seconds since the last packet was
successfully sent by an interface.
Last clearing of “show interface” Time at which the counters that measure cumulative statistics (such
counters as number of bytes sent and received) were last reset to zero.
Queueing strategy Displays the type of queueing configured for this interface. In the
following example output, the type of queueing configured is first-
in first-out (FIFO).
Output queue Number of packets in the output queue. The format of this number
is A/B, where A indicates the number of packets in the queue, and
B indicates the maximum number of packets allowed in the queue.
drops Indicates the number of packets dropped because of a full queue.
input queue/drops Number of packets in the input queue. The format of this number
is A/B, where A indicates the number of packets in the queue, and
B indicates the maximum number of packets allowed in the queue.
drops Indicates the number of packets dropped because of a full queue.
Five minute input rate Average number of bits and packets sent per second in the last five
Five minute output rate minutes. The five-minute interval is the default time period for
statistics collection and can be changed for each individual cable
interface using the load-interval command in interface
configuration mode.
Note These statistics are calculated using a decayed averaging method, where only the average is
stored over the interval period, not the individual samples. Every time a sample average is
taken, a percentage of the sample and a percentage of the average are added together to create
the new average. If traffic stops for a time period, these statistics do not immediately go to
zero but drop with a decay rate of about 70 percent per time period.
For example, if the interface is passing 1,000 packets per second (pps) before traffic stops, the
show interface cable command shows the rate being 300 pps at the end of the first time
interval. The rate then drops to 90 pps at the end of the second time interval, and so forth.
packets input Total number of error-free packets received by the system.
bytes input Total number of bytes, including data and MAC encapsulation, in
the error-free packets received by the system.
Field Description
rely Reliability of the interface as a fraction of 255, calculated as an
exponential average over 5 minutes. (For example, 255/255 is 100
percent reliability.)
load Load on the interface as a fraction of 255, calculated as an
exponential average over 5 minutes. (For example, 255/255 is
complete saturation.)
Encapsulation Encapsulation method assigned to this interface.
ARP type Type of Address Resolution Protocol (ARP) and timeout value
assigned.
Last input Number of hours, minutes, and seconds since the last packet was
successfully received by an interface.
output Number of hours, minutes, and seconds since the last packet was
successfully sent by an interface.
Last clearing of “show interface” Time at which the counters that measure cumulative statistics (such
counters as number of bytes sent and received) were last reset to zero.
Queueing strategy Displays the type of queueing configured for this interface. In the
following example output, the type of queueing configured is first-
in first-out (FIFO).
Output queue Number of packets in the output queue. The format of this number
is A/B, where A indicates the number of packets in the queue, and
B indicates the maximum number of packets allowed in the queue.
drops Indicates the number of packets dropped because of a full queue.
input queue/drops Number of packets in the input queue. The format of this number
is A/B, where A indicates the number of packets in the queue, and
B indicates the maximum number of packets allowed in the queue.
drops Indicates the number of packets dropped because of a full queue.
Five minute input rate Average number of bits and packets sent per second in the last five
Five minute output rate minutes. The five-minute interval is the default time period for
statistics collection and can be changed for each individual cable
interface using the load-interval command in interface
configuration mode.
Note These statistics are calculated using a decayed averaging method, where only the average is
stored over the interval period, not the individual samples. Every time a sample average is
taken, a percentage of the sample and a percentage of the average are added together to create
the new average. If traffic stops for a time period, these statistics do not immediately go to
zero but drop with a decay rate of about 70 percent per time period.
For example, if the interface is passing 1,000 packets per second (pps) before traffic stops, the
show interface cable command shows the rate being 300 pps at the end of the first time
interval. The rate then drops to 90 pps at the end of the second time interval, and so forth.
packets input Total number of error-free packets received by the system.
bytes input Total number of bytes, including data and MAC encapsulation, in
the error-free packets received by the system.
Field Description
Note When using bundled cable interfaces on Cisco uBR7200 series routers, the input packet
counters for the master interface also include the packet counts for slave interfaces, except
when using a Broadband Processing Engine (BPE) cable interface (such as the
Cisco uBR-MC16U/X and Cisco uBR-MC28U/X). On BPE cards and on the Cisco uBR10012
router, the input counters for master and slave cable interfaces are not combined.
no buffer Number of received packets discarded because there was no buffer
space in the main system.
Received broadcast Total number of broadcast or multicast packets received by the
interface.
runts Number of packets that are discarded because they are smaller than
the medium’s minimum packet size.
giants Number of packets that are discarded because they are bigger than
the standard Ethernet Maximum Transmission Unit (MTU) size.
For Ethernet packets, RFC 1757 defines giants as “the total number
of packets received that were longer than 1518 octets (excluding
framing bits, but including FCS octets) and were otherwise well
formed.”
Note In addition, to account for the different Ethernet and other
packet encapsulations on the network, packets are
considered giants when they exceed the configured MTU
size plus 114 bytes.
input errors Total number of errors received on the interface. This count
includes runts and giants, which are shown above, as well as other
errors, such as no buffers, and CRC, frame, overrun, and ignored
counts. This count can also include DOCSIS protocol errors such
as an invalid SID in the DOCSIS frame, a bad extended header
length, corrupted concatenated packets, and invalid bandwidth
requests.
CRC Indicates the number of times the cyclic redundancy checksum
(CRC) generated by the originating LAN station or far-end device
does not match the checksum calculated from the data received.
frame Number of packets received incorrectly having a CRC error and a
non-integer number of octets.
overrun Number of times the receiver hardware was unable to forward
received data to a hardware buffer because the input rate exceeded
the receiver’s ability to handle the data.
ignored Number of received packets ignored by the interface because the
interface hardware ran low on internal buffers.
packets output Total number of messages sent by the system.
bytes Total number of bytes, including data and MAC encapsulation, sent
by the system.
underruns Number of times the sender has been running faster than the
receiving device can handle.
Field Description
output errors Sum of all errors that prevented the final transmission of packets
out of the interface being examined.
collisions Not applicable.
interface resets Number of times an interface has been completely reset.
output buffer failures Number of times the output buffer has failed.
output buffer swapped out Number of times the output buffer has been swapped out.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description slot/port Identifies the cable interface and downstream port on the
Cisco uBR7100 series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On
the Cisco uBR7200 series router, slot can range from 3 to 6, and
port can be 0 or 1, depending on the cable interface.
slot/subslot/port Identifies the cable interface on the Cisco uBR10012 router. The
following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
Examples The following example is sample output from the show interface cable downstream command for
Cisco IOS releases that support only DOCSIS 1.0 or 1.0+ operation:
CMTS01# show interface cable 6/0 downstream
Cable6/0: Downstream is up
111947771 packets output, 1579682655 bytes, 0 discarded
0 output errors
The following is sample output from the show interface cable downstream command for Cisco IOS
releases that support only DOCSIS 1.1 operation:
Router# show interface cable 4/0 downstream
Cable4/0:Downstream is up
Router#
Table 3-51 describes the fields shown in the show interface cable downstream display.
Field Description
Cable Indicates the location of the downstream interface.
Downstream is Indicates the administrative state of the interface.
up/...administratively down
packets output Total number of data packets that have been transmitted on this downstream cable
interface.
bytes The number of bytes for data packets that have been transmitted on this downstream cable
interface.
discarded Total number of packets that were not transmitted on the downstream, because of an error,
such as a buffer overrun, the Cisco CMTS running out of memory, or the frame being
larger than the cable interface’s MTU value.
output errors Total number of packets that could not be transmitted on this downstream cable interface
because of all errors.
total active devices Total number of active cable modems and customer premises equipment (CPE) devices
that are connected to this downstream cable interface.
active modems Total number of active cable modems that are connected to this downstream cable
interface.
Total downstream bandwidth Total bandwidth associated with this downstream cable interface, in bits per second.
Total downstream reserved Total bandwidth on this downstream cable interface that has been reserved by specifying
bandwidth a value for the Min Reserved Traffic Rate field for the downstream service flow in the
cable modems’ DOCSIS configuration files.
Worst case latency for low Worst case latency value, in microseconds, that is allowed on this downstream cable
latency queue interface, as determined by the Max DS Latency field for the downstream service flow in
the cable modems’ DOCSIS configuration files.
Current Upper limit for worst Lowest worst case latency value, in microseconds, that is allowed on this downstream
case latency cable interface. The Cisco CMTS uses the lowest specified Max DS Latency value that
has been specified for a downstream service flow in any of the DOCSIS configuration
files being used by cable modems on this downstream.
If a cable modem tries to register a downstream service flow that uses a worst case latency
that is greater than this value, the Cisco CMTS will refuse to admit that service flow.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description slot/port Identifies the cable interface and downstream port on the Cisco uBR7100
series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0
or 1, depending on the cable interface.
slot/subslot/port Identifies the cable interface on the Cisco uBR10012 router. The following
are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
Examples The following shows a display after a CM has been added to the intercept list:
router# configure terminal
router#(config) interface c6/0
router(config-if)# cable intercept 0080.fcaa.aabb 10.12.13.8 512
router(config-if)# exit
router(config)# exit
router# show interface c6/0 intercept
Destination Destination
MAC Address IP Address UDP Port
0080.fcaa.aabb 3.12.13.8 512
router#
The following shows a display when no CMs have been added to the intercept list:
router# show interface c6/0 intercept
No interception active
router#
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Note In previous releases, information for the MAC scheduler was displayed using the show interface cable
and show interface cable upstream commands. In Cisco IOS Release 12.2 BC, the MAC scheduler
information is moved to this command.
Syntax Description slot/port Identifies the cable interface and downstream port on the Cisco uBR7100
series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0
or 1, depending on the cable interface.
slot/subslot/port Identifies the cable interface on the Cisco uBR10012 router. The following
are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
n (Optional) Displays information for the indicated upstream port. Valid
values start with 0 for the first upstream port on the cable interface line card.
Defaults If no upstream port is identified, displays information for all upstreams on the specified cable interface.
Examples The following example shows typical output for upstream port 0 on the indicated cable interface:
Router# show interface c3/0 mac-scheduler 0
Router#
Table 3-52 describes the fields shown by the show interface cable mac-scheduler command.
Field Description
Queue... Displays the state of each of the scheduler’s first-in, first-out (FIFO)
priority queues. For each queue, the command displays the following:
• Name of the queue. The following queues are available:
– Rng Polls—Queue used for Ranging Requests.
– CIR Grants—Queue used for committed information rate (CIR)
grants, which is used for Unsolicited Grant Service (UGS) and
UGS with Activity Detection (UGS-AD) service flows.
– BE(x) Grants—One of the 8 queues used for best-effort service
flows.
• Number of currently occupied slots over the total number of slots
available (which is hardcoded to 64 for each queue). For example,
3/64 indicates that the queue has a depth of 64 slots available and
that 3 are currently in use.
• Number of packets dropped because the queue already had 64
requests pending and a free slot was therefore not available.
Field Description
Req Slots Counter showing the number of slots that have been advertised on this
upstream port for bandwidth request opportunities since the router last
reset or the counters were last cleared.
Req/Data Counter showing the number of slots that have been advertised on this
upstream port for request/data transmission opportunities since the
router last reset or the counters were last cleared.
Init Mtn Slots Number of slots that have been granted on this upstream port for initial
maintenance requests (initial ranging) since the router last reset or the
counters were last cleared.
Stn Mtn Slots Number of slots that have been granted on this upstream port for station
maintenance requests (unicast ranging) since the router last reset or the
counters were last cleared.
Short Grant Slots Number of slots that have been granted on this upstream port for short
data requests since the router last reset or the counters were last cleared.
Long Grant Slots Number of slots that have been granted on this upstream port for long
data requests since the router last reset or the counters were last cleared.
Fragmentation count Number of frames received by this upstream port that have been
fragmented according to the DOCSIS 1.1 fragmentation technique.
Fragmentation test Displays fragmentation statistics. If fragmentation is disabled, no
statistics are available. If fragmentation is enabled, the fragmentation
mode is displayed (multiple grant mode or piggyback mode), and the
display shows the fragmentation threshold in the number of bytes and
minislots.
Avg upstream channel Total upstream bandwidth that is currently being used for upstream data
utilization traffic and DOCSIS management traffic, expressed as a short-term
average percentage of total minislots being used.
Note See Table 3-53 on page 3-218 for the theoretical maximum
possible bandwidth for an upstream, based on the channel width
and modulation scheme.
Avg percent contention slots Approximate, average unused capacity in the network. This field shows
the total upstream bandwidth that is currently dedicated to providing
bandwidth request opportunities, expressed as an average percentage of
total minislots being used. This value is calculated by dividing the
number of scheduled contention slots by the total number of minislots.
Note This value is approximately 100 percent minus the percentage of
slots being used for upstream data, management traffic, and
initial ranging slots.
Avg percent initial ranging Total upstream bandwidth that is currently being used, on average, for
slots initial ranging requests for cable modems coming online, expressed as
an average percentage of total minislots being used.
Field Description
Avg percent minislots lost Total upstream bandwidth that is currently being lost and unused
on late MAPs because the bandwidth allocation MAP message was sent late. This field
shows how often “allocation gaps” occur in the MAP scheduler, where
the CMTS allows significant amounts of time to pass before it schedules
a new MAP.
Ideally, the CMTS should schedule MAPs consecutively, so that no gaps
occur between the MAPs. However, when a large number of cable
modems are using different service flow schedules, gaps can appear in
the MAP scheduler, resulting in wasted scheduling time.
Tip A typical value is only a few percentage points. If this field
shows larger values than this, use the debug cable startalloc
command to display the number of minislots that are skipped
every time the CMTS has to adjust its MAP scheduler timer.
Sched Table Adm-State Displays the current status of admitted service flows (which typically
indicates the number of voice grants):
• Grants = Number of admitted Unsolicited Grant Service (UGS)
style upstream service flows.
• Reqpolls = Number of admitted Real Time Polling Service (RTPS)
style upstream service flows.
• Percentage of channel utilization that is associated with these
service flows.
UGS Displays the number of service IDs (SIDs) being used for Unsolicited
Grant Service (UGS) service flows, and the current bandwidth reserved
by these SIDs, in bits per second.
UGS-AD Displays the number of service IDs (SIDs) being used for UGS with
Activity Detection (UGS-AD) service flows, and the current bandwidth
reserved by these SIDs, in bits per second.
RTPS Displays the number of service IDs (SIDs) being used for Real Time
Polling Service (RTPS) service flows, and the current bandwidth
reserved by these SIDs, in bits per second.
NRTPS Displays the number of service IDs (SIDs) being used for non-RTPS
(NRTPS) service flows, and the current bandwidth reserved by these
SIDs, in bits per second.
BE Displays the number of service IDs (SIDs) being used for Best-Effort
(BE) service flows, and the current bandwidth reserved by these SIDs,
in bits per second.
Table 3-53 shows the maximum usuable bandwidth (total bandwidth minus header and MAC-layer
overhead) for an upstream that is using a specific channel width and modulation scheme combination:
Modulation
Channel Width (MHz) Scheme Raw Speed (Mbps) Usable Bandwidth (Mbps)
1.6 QPSK 2.56 2.2
1.6 16-QAM 5.12 4.4
3.2 16-QAM 10.24 8.9
3.2 64-QAM 15.36 13.5
6.4 16-QAM 20.48 18
6.4 64-QAM 30.72 27.2
For example, if the upstream is configured for a 3.2 MHz channel width and is using 16-QAM
modulation, its maximum usable bandwidth is 8.9 Mbps. If the average channel utilization field shows
that the upstream is at 50 percent, it indicates that cable modems on that upstream are currently using
(0.5 * 8.9 Mbps) or 4.45 Mbps.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description slot/port Identifies the cable interface and downstream port on the Cisco uBR7100 series
and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0 or 1,
depending on the cable interface.
slot/subslot/port Identifies the cable interface on the Cisco uBR10012 router. The following are
the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
sid (Optional) Specifies the service ID (SID) to be displayed (1 to 8191).
Usage Guidelines The show interface cable modem command displays the cable modems that are known to be using or
were last using the specified cable interface. When a cable modem goes offline, it remains associated
with its last known cable interface and is shown as “offline” in the command’s display for 24 hours.
The CPE devices associated with offline cable modems remain in the command’s display either until
their cable modem has been offline for 24 hours or until the device’s Address Resolution Protocol (ARP)
entry times out (the default value is 4 hours), whichever comes first.
Examples The following is sample output from the show interface cable modem command for all SIDs on a
particular cable interface.
Router# show interface cable 6/0 modem
Router#
The following is sample output from the show interface cable modem command for an individual SID
on a particular cable interface.
Router# show interface cable 6/0 modem 9
Router#
Field Description
SID Identifies a SID currently defined and in use on this particular cable
interface.
Priv bits Identifies the current settings of the two privacy bits in the
Extended Header (EH) that is used for BPI-encrypted packets.
• First bit = Enable bit. Set to 1 when BPI or BPI+ is enabled.
• Second bit = Toggle bit. Matches the least significant bit (LSB)
of the Key Sequence Number (KSN) in the EH.
For example, a value of “00” indicates that BPI is not enabled. A
value of “10” indicates that BPI is enabled and that the KSN is an
even number. A value of “11” indicates that BPI is enabled and that
the KSN is an odd number.
Note For more information on these bits, see the DOCSIS
Baseline Privacy Interface Plus Interface Specification
(SP-BPI+-I08-020301 or later).
Type Identifies the use for this SID:
• host = SID is used for a CPE device.
• modem = SID is used for a CM.
• multicast = SID is used for a multicast broadcast.
State The current state of the MAC layer for this SID and CM (see
Table 3-15 on page 3-60). For hosts or multicast broadcasts, the
state will always be unknown.
IP address Identifies the IP address for the CM using this SID.
Field Description
method Identifies the way that the IP address was assigned:
• dhcp = The Cisco CMTS first learned of this IP address
through a DHCP packet that assigned the address to this
device. This IP address is therefore assumed to have been
dynamically assigned to the cable modem or CPE device by a
DHCP server. (Per the DOCSIS specifications, DHCP is the
only valid method for cable modems.)
• pppoe = (CPE device only) IP addressing for the CPE device
was handled by the Point-to-Point Protocol over Ethernet
(PPPoE) protocol.
• static = (CPE device only) The Cisco CMTS first learned of
this IP address from non-DHCP traffic sent to or from this CPE
device. This IP address is therefore assumed to be statically
assigned to this particular CPE device.
Note The Cisco CMTS could identify a CPE device as having a
static IP address, if the Cisco CMTS has been rebooted
after the CPE device received its IP address from the DHCP
server.
MAC address Identifies the hardware (MAC) address for the CM using this SID.
Note The show interface cable modem command shows similar information to the show cable modem
command, but adds information about the privacy bits and IP addressing method.
Table 3-15 on page 3-60 (see the show cable modem command) lists the possible values for the State
field.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description slot/port Identifies the cable interface and downstream port on the Cisco uBR7100 series
and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0 or 1,
depending on the cable interface.
slot/subslot/port Identifies the cable interface on the Cisco uBR10012 router. The following are
the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
Examples The following is sample output from the show interface cable monitor command:
CMTS01# show interface cable 5/0 monitor
US/ Time Outbound Flow Flow Type Flow Packet MAC MAC Encap
DS Stmp Interface Type Identifier Extn. Type Extn. Type Type
us no Et1/2 us-port 0 yes data no - docsis
all no Et1/2 acc-list 103 yes data no - docsis
all yes Et1/2 mac-addr 0050.0000.0000 yes mac no - -
Field Description
DS Downstream. Indicates that only downstream flows are monitored.
UP Upstream. Indicates that only upstream flows are monitored.
ALL Indicates that all flows are monitored.
Field Description
Time Stmp “Yes” indicates that forwarded packets have been time-stamped,
with appended 4 bytes. “No” indicates that forwarded packets have
not been time-stamped.
Outbound Interface Identifies the interfaces where the packets have been forwarded to
(Ethernet or Fast Ethernet).
Flow Type Identifies the selected flow type, MAC-address, access-list
number, or upstream port number.
Flow Type Identifier MAC address, access-list number, or service ID.
Flow Extn. “Yes” indicates that extended filters are configured, and “no”
indicates that no extended filters have been configured.
MAC Type Not applicable.
Encap DOCSIS encapsulation.
Type Forwarded packets with Ethernet encapsulation.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description slot/port Identifies the cable interface and downstream port on the Cisco uBR7100
series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0 or
1, depending on the cable interface.
slot/subslot/port Identifies the cable interface on the Cisco uBR10012 router. The following
are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
tek Displays the traffic encryption key values.
kek Displays the key encryption key values.
Usage Guidelines This command appears and is available only in images that support BPI and BPI+ encryption.
Examples The following are sample outputs for the show interface cable privacy command:
router# show interface cable 3/0 privacy tek
Configured TEK life-time value = 56000
Configured TEK grace-time value = 900
Table 3-56 describes the fields shown in the show interface cable privacy displays.
Field Description
Configured TEK life-time value = Number of seconds defining the length of the traffic encryption
life-time. Valid range is 1,800 to 6,048,000 seconds. Default is
43,200 seconds (12 hours).
Configured TEK grace-time value = Number of seconds defining the length of traffic encryption
grace-time. Valid range is 300 to 1,800 seconds. Default is 600
seconds (10 minutes).
Configured KEK life-time value = Number of seconds defining the length of the key encryption
life-time. Valid range is 86,400 to 6,048,000. Default is
604,800 seconds (7 days).
Configured KEK grace-time value = Number of seconds defining the length of key encryption grace-
time. Valid range is 300 to 1,800 seconds. Default is 600
seconds (10 minutes).
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Note Parameter sets that contain a service-class name string are in an “unexpanded” state and serve as
provisioning envelopes of class-based service flows. The actual attributes of such parameter sets depend
on the service class that is referenced at the time the parameter sets are expanded.
Syntax Description slot/port Identifies the cable interface and downstream port on the Cisco uBR7100
series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0
or 1, depending on the cable interface.
slot/subslot/port Identifies the cable interface on the Cisco uBR10012 router. The following
are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
paramset-index Identifies the desired service template index (1 to 255).
verbose Displays full details about the QoS parameter set.
Examples The following example shows typical output for the show interface cable qos paramset command:
Router# show interface c6/0 qos paramset
Router#
Note In Cisco IOS Release 12.2(11)BC3 and later releases, the Cisco CMTS automatically maps the non-
default DOCSIS 1.0 QoS profiles to profile numbers starting at 128, to facilitate their use in DOCSIS
1.1 networks.
The following example shows typical output for the verbose form of the show interface cable qos
paramset command:
Router# show interface c6/0 qos paramset 1 verbose
Index: 1
Name:
Direction: Upstream
Traffic Priority: 0
Maximum Sustained Rate: 64000 bits/sec
Max Burst: 0 bytes
Minimum Reserved Rate: 0 bits/sec
Minimum Packet Size 0 bytes
Maximum Concatenated Burst: 1522
Scheduling Type: Best Effort
Request/Transmission Policy: 0x0
Nominal Polling Interval: 0
Tolerated Poll Jitter: 0
Unsolicited Grant Size: 0 bytes
Nominal Grant Interval: 0 usecs
Tolerated Grant Jitter: 0 usecs
Grants per Interval: 0
IP ToS Overwrite [AND-mask,OR-mask]: 0x0,0x0
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Related Commands show cable qos Displays the status of permissions for changing QoS tables.
permission
show cable modem qos Displays quality of service (QoS) and service flow information for a
particular CM.
show cable qos profile Displays the QoS profiles that have been defined.
show interface cable {slot/port | slot/subslot/port} service-flow sfid [classifiers | counters | phs |
qos] [verbose]
Syntax Description slot/port Identifies the cable interface and downstream port on the Cisco uBR7100
series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0
or 1, depending on the cable interface.
slot/subslot/port Identifies the cable interface on the Cisco uBR10012 router. The following
are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
sfid (Optional) Identifies the service flow index (1 to 65535).
classifiers [clid] (Optional) Displays all classifiers associated with this service flow or
optionally display information only for the specified classifier ID (clid,
1 to 65535).
counters (Optional) Displays the real-time counters for the service flow for a specific
SFID.
phs (Optional) Displays packet header suppression rules and packet counters for
the service flow for a specific SFID.
Note The PHS packet counters are not supported on the Cisco uBR-
MC5X20 card and always shows 0 or N/A, depending on the
software release.
qos (Optional) Displays QoS information for the service flow for a specific
SFID.
verbose (Optional) Displays detailed information on the service flow for a specific
SFID.
Release Modification
12.2(4)BC1 The command was changed so that the optional keywords are supported
only when displaying information for a specific service flow index.
12.2(8)BC1 The command was changed to remove the ability to display all service
flows, and a service flow index must now be specified.
Usage Guidelines In Cisco IOS Release 12.2(4)BC1 and later, the optional keywords classifiers, counters, phs, qos, and
verbose can be used only when requesting information for a specific service flow ID. When a service
flow ID is specified, the verbose keyword can be used by itself or by any of the other optional keywords.
Examples The following examples show typical output for the show interface cable service-flow command.
Router# show interface c3/0 service-flow
Sfid Sid Mac Address QoS Param Index Type Dir Curr Active
Prov Adm Act State Time
4 N/A 0002.1685.ac63 5 5 5 prim DS act 8h09m
1258 N/A 0002.1685.ac63 6 6 6 sec(S) DS act 8h09m
3 1 0002.1685.ac63 3 3 3 prim US act 8h09m
1257 22 0002.1685.ac63 4 4 4 sec(S) US act 8h09m
6 N/A 0001.9659.51e1 5 5 5 prim DS act 10h30m
1254 N/A 0001.9659.51e1 6 6 6 sec(S) DS act 10h30m
5 2 0001.9659.51e1 3 3 3 prim US act 10h30m
1253 20 0001.9659.51e1 4 4 4 sec(S) US act 10h30m
8 N/A 0002.1685.ac3d 5 5 5 prim DS act 10h30m
1250 N/A 0002.1685.ac3d 6 6 6 sec(S) DS act 10h30m
7 3 0002.1685.ac3d 3 3 3 prim US act 10h30m
1249 18 0002.1685.ac3d 4 4 4 sec(S) US act 10h30m
10 N/A 0002.1685.ac5f 5 5 5 prim DS act 10h30m
1252 N/A 0002.1685.ac5f 6 6 6 sec(S) DS act 10h30m
9 4 0002.1685.ac5f 3 3 3 prim US act 10h30m
1251 19 0002.1685.ac5f 4 4 4 sec(S) US act 10h30m
16 N/A 0002.1685.ac67 2 2 2 prim DS act 00:28
15 5 0002.1685.ac67 1 1 1 prim US act 00:28
22 N/A 0050.f112.2224 5 5 5 prim DS act 40:11
1260 N/A 0050.f112.2224 6 6 6 sec(S) DS act 40:11
21 6 0050.f112.2224 3 3 3 prim US act 40:11
Table 3-57 shows the descriptions for the fields displayed by this command:
Field Description
Sfid Identifies the service flow identification number.
Note Primary service flow IDs are displayed even for offline
CMs because they are needed for modem re-registration.
Sid Identifies the service identification number (upstream service
flows only).
Mac Address Identifies the CM’s MAC address.
QoS Parameter Index Prov Identifies the QoS parameter index for the Provisioned state of this
flow.
Field Description
QoS Parameter Index Adm Identifies the QoS parameter index for the Admitted state of this
flow.
QoS Parameter Index Act Identifies the QoS parameter index for the Active state of this flow.
Type Indicates if the service flow is the primary flow or a secondary
service flow. Secondary service flows are also identified by an “S”
(created statically at the time of registration, using the DOCSIS
configuration file) or “D” (created dynamically by the exchange of
dynamic service messages between the CM and CMTS).
Dir Indicates if this service flow is downstream (DS) or upstream (US).
Curr State Indicates the current run-time state of the service flow.
Active Time Indicates the length of time this service flow has been active.
Note Per normal operation, the counter in Number of Matches field is not initialized for working dynamic
service flows. For upstream service flows, the classifier match count is not updated for upstream packet
classifiers, and displays no results.
Sfid : 30191
Mac Address : 000a.739e.140a
Type : Secondary(Dynamic)
Direction : Upstream
Current State : Active
Current QoS Indexes [Prov, Adm, Act] : [0, 24, 24]
Active Time : 00:55
Sid : 7140
Admitted QoS Timeout : 200 seconds
Active QoS Timeout : 0 seconds
Packets : 1824
Bytes : 466944
Rate Limit Delayed Grants : 0
Rate Limit Dropped Grants : 0
Current Throughput : 68356 bits/sec, 32 packets/sec
Classifiers:
Classifier Id : 41
Service Flow Id : 30191
CM Mac Address : 000a.739e.140a
Direction : upstream
Activation State : active
Classifier Matching Priority : 128
PHSI : 1
Number of matches : -
IP Classification Parameters:
IP Source Address : 10.8.230.3
Source IP Address Mask : 255.255.255.255
Destination IP Address : 172.16.2.35
Destination IP Address Mask : 255.255.255.255
IP Protocol Type : 17
Source Port Low : 53456
Source Port High : 53456
Destination Port Low : 7052
Destination Port High : 7052
Note Per the DOCSIS 1.1 specification, the show interface cable service-flow command uses bytes allocated
for a UGS service flow when calculating the throughput values for the service flow (see the Assumed
Minimum Reserved Rate Packet Size parameter, TLV 11 in the upstream and downstream service flow
configurations). Depending on the value of this parameter and the packet sizes of the actual traffic, this
could result in throughput values that appear to be greater than the maximum sustained rate. You can use
the stats option with the show interface cable command to display the actual byte counts.
Sfid : 12
Current State : Active
Sid : N/A
Traffic Priority : 0
Maximum Sustained rate : 1000000 bits/sec
Maximum Burst : 0 bytes
Mimimum Reserved rate : 0 bits/sec
Minimum Packet Size : 0 bytes
Maximum Latency : 0 usecs
Current Throughput : 0 bits/sec, 0 packets/sec
Sfid : 11
Current State : Active
Sid : 5
Traffic Priority : 0
Maximum Sustained rate : 64000 bits/sec
Maximum Burst : 0 bytes
Mimimum Reserved rate : 0 bits/sec
Minimum Packet Size : 0 bytes
Maximum Concatenated Burst : 1522
Scheduling Type : Best Effort
Unsolicited Grant Size : 0 bytes
Nominal Grant Interval : 20000 usecs
Grants per interval : 0
Tolerated Grant Jitter : 0 usecs
Nominal Polling Interval : 0 usecs
Tolerated Polling Jitter : 0 usecs
Request/Transmission policy : 0x0
IP ToS Overwrite[AND-mask, OR-mask] : 0x0, 0x0
Current Throughput : 0 bits/sec, 0 packets/sec
Tip When PacketCable services are enabled to allow PacketCable-based Voice over IP (VoIP) traffic, the
Nominal Grant Interval reflects the packetization interval that is configured on the VoIP call agent.
Sfid : 12
Packets : 154
Octets : 51656
RateLimit Delayed Pkts : 0
RateLimit Dropped Pkts : 0
Bits/sec : 0
Packets/Sec : 0
CfrId SFID cable modem Mac Address Direction State Priority Matches
Sfid : 14
Classifier Id : 2
Service Flow Id : 14
cable modem Mac Address : 00d0.bad3.c46b
Direction : upstream
Activation State : active
Classifier Matching Priority : 8
PHSI : 0
Number of matches : 0
IP Classification Parameters:
Destination Port Low : 1024
Destination Port High : 65535
Sfid : 20
PHSI : 1
PHSS : 22
PHSV : On
PHSM : 00 00 FF
PHSF : 08 00 45 00 00 56 00 00 00 00 3C 00 67 A7 0B 00 00 01 0C 00
00 01
Packet : N/A
Table 3-58 shows the descriptions for the fields displayed by the phs option for this command:
Field Description
Sfid Service flow identification number.
Note Primary service flow IDs are displayed even for offline
CMs because they are needed for modem re-registration.
PHSI PHS Index. Number that uniquely references the PHS rule.
PHSS PHS Size. 8-bit value specifying the number of header bytes to be
suppressed.
PHSV PHS Verify. Indicates whether PHS verification is enabled.
PHSM PHS Mask. 5-bit PHS mask that defines the header bytes that
should be suppressed.
PHSF PHS Field. 8-bit values that defines the header bytes that should be
suppressed.
Note The PHS packet counters are not supported on the Cisco uBR-MC5X20 card and always shows 0 or N/A,
depending on the software release.
Related Commands cable service class Sets the parameters for DOCSIS 1.1 cable service class.
cable service flow Sets the inactivity threshold value for service flows using Unsolicited Grant
inactivity-threshold Service with Activity Detection (UGS-AD).
cable service-flow Sets the amount of time a dynamic service-flow can be present in the system
inactivity-timeout without any activity.
show cable qos Displays the status of permissions for changing QoS tables.
permission
show cable qos profile Displays the QoS profiles that have been defined.
show interface cable {slot/port | slot/subslot/port} sid [association | counters | qos | secondary-ip]
[verbose]
Syntax Description slot/port Identifies the cable interface and downstream port on the Cisco uBR7100
series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0 or
1, depending on the cable interface.
slot/subslot/port Identifies the cable interface on the Cisco uBR10012 router. The following
are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
association Displays the virtual interfaces (VRF) or Interface Descriptor Blocks (IDBs).
connectivity Displays the values of the per-SID connectivity statistics. (This option
appears only in DOCSIS 1.0 and 1.0+ releases. Use the show cable modem
connectivity command in DOCSIS 1.1 releases.)
counters Displays the values of the per-SID usage counters. Same as the keyword stats
that appeared in Cisco IOS Release 11.3(5)NA and earlier releases.
qos Displays the QoS characteristics received by each SID.
secondary-ip Displays the secondary IP addresses associated with each SID.
verbose Displays detailed information for the counters and qos options.
Note The verbose option is supported by itself or with any of the other
options, but it displays additional information only for the counters
and qos options.
Release Modification
12.1(4)CX, 12.2(1)XF, The qos keyword was added to display information on the QoS values
and 12.2(4)BC1 received by the SID from the MAC scheduler. You an also use the verbose
option with the qos keyword to display detailed information.
Also, the connectivity option was removed and replaced by the show cable
modem connectivity command.
12.1(11b)EC, The association keyword was added.
12.2(8)BC1
12.2(8)BC2 An explicit error message was added if this command is used with a cable
subinterface, instructing the user to use the main interface instead.
12.1(13)EC The secondary-ip keyword was added for the Cisco uBR7100 series and
Cisco uBR7200 series universal broadband routers.
12.2(11)BC1 Support for the secondary-ip keyword was added for the Cisco uBR10012
universal broadband router.
12.2(11)CY, Three codeword fields were added to the verbose counters display to
12.2(11)BC3 support the Cisco uBR-MC5X20S cable interface line card. These fields
always display zero for the other cable interface line cards.
12.2(11)BC3 The counters option now displays the following counters:
• Concatenated headers received
• Fragmentation headers received
• Fragmentation headers discarded
Note The Cisco uBR-MC5X20S cable interface line card does not
currently support these particular counters.
Usage Guidelines Data transport over the radio frequency (RF) link uses the registered SID address rather than the Ethernet
address. This allows multiple hosts to access the network via a single CM.
The verbose keyword can be used with any of the other options or by itself, but it displays additional
information only when used with the counters and qos options.
Note You can specify only a main interface with this command, not a subinterface.
Examples The following sample output from the show interface cable sid command shows the various forms of
the command.
Router# show interface c4/0 sid
Sid Prim MAC Address IP Address Type Age Admin Sched Sfid
State Type
5 0010.7b6b.58c1 10.20.114.34 stat 2d1h36m enable BE 1
6 0010.7bed.9dc9 10.20.114.37 stat 2d1h36m enable BE 13
7 0010.7bed.9dbb 10.20.114.38 stat 2d1h36m enable BE 15
8 0010.7b6b.58bb 10.20.114.112 stat 2d1h34m enable BE 17
9 0010.7b6b.58bb 10.20.114.112 dyna 2d1h34m enable BE 19
Sid : 5
Traffic Priority : 0
Maximum Sustained Rate : 64000
Maximum Burst : 0
Minimum Reserved Rate : 0
Minimum Packet Size : 0
Maximum Concatenated Burst : 1522
Scheduling Type : Best Effort
Nominal Grant Interval : 0
Tolerated Grant Jitter : 0
Nominal Polling Interval : 0
Tolerated Polling Jitter : 0
Unsolicited Grant Size : 0
Grants per Interval : 0
Request/Transmission Policy : 0x0
IP ToS Overwrite [AND-mask, OR-mask] : 0x0, 0x0
Current Throughput : 0 bits/sec, 0 packets/sec
When using DOCSIS 1.1 software, such as Cisco IOS Release 12.2 BC, the show interface sid counter
command provides the following display:
Router# show interface c5/0 sid counter
When using DOCSIS 1.0 software, such as Cisco IOS Release 12.1 EC, the show interface sid counter
command provides the following display:
Router# show interface c5/0 sid counter
The following example shows typical verbose output for the SID counters on a Cisco uBR-MCxxC cable
interface line card:
Router# show interface c4/0 sid 3 counter verbose
Sid : 3
Request polls issued : 0
BW requests received : 1
Router#
The following example shows typical verbose output for the SID counters on the Cisco uBR-MC5X20S
cable interface line card:
Router# show interface c4/0 sid 3 counters verbose
Sid : 1
Request polls issued : 0
BWReqs {Cont,Pigg,RPoll,Other} : 0, 1052, 1052, 0
No grant buf BW request drops : 0
Rate exceeded BW request drops : 0
Grants issued : 1052
Packets received : 0
Bytes received : 0
Fragment reassembly completed : N/A
Fragment reassembly incomplete : N/A
Concatenated packets received : N/A
Queue-indicator bit statistics : 0 set, 0 granted
Good Codewords rx : 53
Corrected Codewords rx : 6110
Uncorrectable Codewords rx : 8540896
Concatenated headers received : 235
Fragmentation headers received : 0
Fragmentation headers discarded: 0
Router#
Note Because the Cisco uBR-MC16U/X, Cisco uBR-MC28U/X, and Cisco uBR-MC5X20S/U cable interface
line cards do not support the fragmentation and concatenation packet counters, these counters always
show zero for these particular cable interfaces. However, these interfaces do accurately count the number
of concatenation headers, as shown above.
The following example shows typical output for the association keyword:
Router# show interface cable5/0 sid association
Sid Prim Online IP Address MAC Address Interface VRF Name
1 online 195.151.129.20 0003.e38f.e993 Ca5/0.50 green
2 online 195.151.129.17 0003.e38f.e89d Ca5/0.50 green
3 init(t) 195.151.129.12 00d0.baa2.fb93 Ca5/0.50 green
Router#
The following example shows the error message that is displayed when you attempt to use this command
on a subinterface:
The following example shows sample output for the secondary-ip keyword:
Router# show interface cable5/0 sid secondary-ip
For sid 1 secondary ip list contains 2 address(es)
195.151.129.20
196.100.81.123
For sid 2 secondary ip list contains 2 address(es)
195.151.129.17
10.10.11.3
Router#
Tip One possible situation that might occur is if a CM first assigns a secondary IP address to one CPE device,
but later that same IP address is assigned to another CPE device behind a different CM. If this happens,
the IP address will continue to show up as a secondary IP address for the original CM until that CM
renews its public keys. This will not affect network connectivity for either CPE or CM. You can,
however, clear the unneeded secondary IP address from the CMTS database using the clear cable
secondary-ip command.
Table 3-59 describes the fields displayed by the show interface cable sid command.
Field Description
Sid Service identification number.
Prim Sid The primary service identifier (SID) assigned to the modem.
Type Indicates that this SID was created statically at the time of
registration or dynamically by the exchange of dynamic service
messages between the CM and CMTS.
Online State “Online” means that the modem owning this SID is processing
Offline State traffic. “Offline” means that the modem owning this SID is not
processing traffic.
Admin Status “Disable” means that the SID has been turned off. “Enable” is the
normal state.
QoS Quality of service.
Create time When the SID was created, number of seconds since the system
booted.
Input octets (In octets) Number of octets received by using this SID.
Input packets (In packets) Number of packets received by using this SID.
Output octets (Out octets) Number of octets sent from this SID.
Output packets (Out packets) Number of packets sent from this SID.
IP address IP address of the modem owning this SID.
MAC address MAC address of the modem owning this SID.
BW requests received Number of bandwidth requests received by this SID.
Grants issued Number of bandwidth requests granted by this SID.
Field Description
Rate exceeded BW request drops Number of bandwidth requests not granted by this SID.
Rate exceeded DS packet drops Number of downstream packets lost by this SID.
Ratelimit BWReqDrop Number of bandwidth requests not granted by this SID.
Ratelimit DSPktDrop Number of downstream packets lost by this SID.
1st time online Time at which the modem with this SID connected.
Times online Number of times the modem with this SID connected.
% online Percentage of time the modem with this SID has been connected.
Online time The minimum, average, and maximum number of hours and
minutes the modem with this SID has been connected.
Note A CM is considered online when it has completed the
registration process and has communicated with the DHCP,
TFTP, and TOD servers.
Offline time The minimum, average, and maximum number of hours and
minutes the modem with this SID has been disconnected.
Note A CM is considered offline after it has missed 16
consecutive station maintenance messages.
MaxSusRate The maximum rate (0 to 4,294,967,295 bps).
MinRsvRate The minimum guaranteed rate (0 to 4,294,967,295 bps).
Sched Type The service class schedule type:
2–Best-Effort Schedule Type
3–Non-Real-Time Polling Service Schedule Type
4–Real-Time Polling Service Schedule Type
5–Unsolicited Grant Service with Activity Detection Schedule
Type
6–Unsolicited Grant Service Schedule Type
Grant Size The grant size (0 to 65535 bytes).
Grant Interval The grant interval (0 to 4294967295 microseconds).
GPI The grants per interval (0 to 127 grants).
Poll Interval The poll interval (0 to 4294967295 microseconds).
Throughput The overall throughput for this SID.
VRF Name Name of the virtual interface that has been configured for
Multiprotocol Label Switching (MPLS) Virtual Private Network
(VPN) operation.
Fragment reassembly completed Number of packets that were subject to DOCSIS fragmentation that
were successfully reassembled.
Note This counter is not supported on the Cisco uBR-MC5X20
card and always shows 0 or N/A, depending on the software
release.
Field Description
Fragment reassembly Number of packets that were subject to DOCSIS fragmentation that
incomplete have not yet been successfully reassembled.
Note This counter is not supported on the Cisco uBR-MC5X20
card and always shows 0 or N/A, depending on the software
release.
Concatenated packets received Number of packets that were subject to DOCSIS concatenation that
were successfully received.
Note This counter is not supported on the Cisco uBR-MC5X20
card and always shows 0 or N/A, depending on the software
release.
Good Codewords rx Number of FEC codewords received without error.
Corrected Codewords rx Number of FEC codewords received with errors that could be
corrected.
Uncorrectable Codewords rx Number of FEC codewords received with errors that could not be
corrected.
Concatenated packets received Number of concatenation headers received on an upstream service
flow. (This field always shows 0 for the Cisco uBR10012 router,
but you can use the docsQosUpstreamConcatBursts attribute in
DOCS-QOS-MIB to get a current count.)
Fragmentation headers received Number of fragmentation headers received on an upstream service
flow, regardless of whether the fragment was correctly
reassembled into a valid packet. (See docsQosUpstreamFragments
in DOCS-QOS-MIB.)
Fragmentation headers discarded Number of upstream fragments discarded and not assembled into a
valid upstream packet. (See docsQosUpstreamFragDiscards in
DOCS-QOS-MIB.)
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description slot/port Identifies the cable interface and downstream port on the Cisco uBR7100 series
and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0 or 1,
depending on the cable interface.
slot/subslot/port Identifies the cable interface on the Cisco uBR10012 router. The following are
the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
n (Optional) Identifies a particular upstream on the selected interface.
Examples The following is sample output from the show interface cable signal-quality command:
CMTS01# show interface cable 6/0 signal-quality
Table 3-60 describes the fields shown in the show interface cable signal-quality display.
Field Description
Cable Interface name.
Upstream is up includes States whether this statement is true.
contention intervals
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description slot/port Identifies the cable interface and downstream port on the
Cisco uBR7100 series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On
the Cisco uBR7200 series router, slot can range from 3 to 6, and
port can be 0 or 1, depending on the cable interface.
slot/subslot/port Identifies the cable interface on the Cisco uBR10012 router. The
following are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
n (Optional) Identifies the specific upstream to be displayed. Valid
values start with 0 for the first upstream port on the cable interface
line card.
ugs statistics (Optional) Displays statistics related to Unsolicited Grant Service
(UGS) flows on the upstream.
Defaults If no upstream is specified, all upstreams on the given cable interface are shown.
Examples The following is sample output for the upstream cable interface located in slot 6/port 0 from the show
interface cable upstream command (DOCSIS 1.0 Cisco IOS software releases):
Router# show interface cable 6/0 upstream 0
Cable6/0: Upstream 0 is up
Received 855 broadcasts, 147 multicasts, 408833 unicasts
Router#
The following is sample output for the upstream cable interface located in slot 6/port 0 from the show
interface cable upstream command (DOCSIS 1.1 Cisco IOS software releases):
Router# show interface cable 6/0 upstream 0
Upstream 0 is up
Received 38085 broadcasts, 5758 multicasts, 17257229 unicasts
0 discards, 1451132592 errors, 0 unknown protocol
17301072 packets input, 48239157 uncorrectable
1071719720 noise, 0 microreflections
Total Modems On This Upstream Channel : 147 (142 active)
Router#
The following is sample output for the upstream cable interface located for the Cisco uBR-MC5X20S
and Cisco uBR-MC28U/X cards, which provides information about the error counters maintained by the
card’s onboard MAC controller for each upstream interface:
Router# show interface cable 6/1/0 upstream 0
Cable6/1/0: Upstream 3 is up
Received 140 broadcasts, 2075 multicasts, 134502 unicasts
0 discards, 144954 errors, 0 unknown protocol
136717 packets input, 0 uncorrectable
0 noise, 0 microreflections
Total Modems On This Upstream Channel : 37 (35 active)
JIB counters for ifInErrors:
us_error_frame_drop 72477
us_crc_error 4
us_hcs_error 72473
us_cont_collision 0
us_uncorr_cw_rcvd 14
Router#
The following shows sample output for the ugs statistics option:
Router# show interface cable 6/1/0 upstream 3 ugs statistics
Router#
Table 3-61 describes the fields shown in the show interface cable upstream display.
Field Description
Cable Indicates the location of the upstream interface.
Upstream is up/ Indicates the administrative state of the upstream interface.
...administratively down
Received broadcasts Number of broadcast packets received through this upstream
interface.
multicasts Number of multicast packets received through this upstream
interface.
unicasts Number of unicast packets received through this interface.
discards Number of packets discarded by this interface, typically because of
buffer overruns.
errors Total of all packets with errors that prevented the transmission of
the packets through this upstream interface. This figure could
include the following errored packets:
• Collisions of request and request/data packets
• Damaged frames received during request and request data
requests or slots (typically because they had bad forward error
correction (FEC) header checksums (HCS)
• Damaged frames received from ranging requests
• Data packets with unique word, collision or no energy
• Number of upstream bursts whose preamble or unique word
could not be correctly received
• Packets with at least one frame with an uncorrectable error
On Broadband Processing Engines (BPE) cable interface line
cards, such as the Cisco uBR-MC16U/X, Cisco uBR-MC28U/X,
and Cisco uBR-MC5X20S/U cards, this counter also counts
conditions such as HCS/CRC errors and collisions that occur
during initial ranging requests and bandwidth requests. Compare
this counter with the uncorrectable error counter from the show
cable hop command to determine whether a problem with noise
exists, or whether the counter is high only because a large number
of CMs are trying to register.
Field Description
unknown protocol Number of packets received that were using an unknown protocol
(the packet was not an IP, ARP, or PPPoE packet). This counter also
includes DOCSIS frames that could not be identified as DOCSIS
frames because of malformed headers or invalid header options.
packets input Number of frames received (broadcast, multicast, and unicast)
through this upstream interface that were free from errors.
corrected Number of frames received through this upstream interface that
had errors that were corrected.
uncorrectable Number of frames received through this upstream interface that
had errors that could not be corrected. This means the frame had at
least one uncorrectable FEC block, making the whole frame
uncorrectable. Nominally, you should expect at most 1
uncorrectable error per 10,000 packets, and typically, the
uncorrectable error rate is much less in good environments.
Note This counter is not supported on Broadband Processing
Engines (BPE) cable interface line cards, such as the
Cisco uBR-MC16U/X, Cisco uBR-MC28U/X, and
Cisco uBR-MC5X20S/U cards, because these cards count
only uncorrectable codewords, not frames. As a result, this
field always shows 0 or N/A for these cards, depending on
the software release. Instead of this field, use the show
cable hop command to display the number of
uncorrectable errors per codeword.
noise Number of upstream packets of any type that were corrupted by
line noise.
microreflections Approximate number of upstream packets corrupted by
microreflections. Microreflections are a type of impairment that is
caused by impedance mismatches between amplifiers, couples,
cables, and other equipment in the cable plant. Microreflections
create copies of a signal that arrive at the receiver with different
amounts of delay and attenuation, generating intersymbol
interference (ISI) that can cause the receiver to improperly detect
the amplitude and phase of the incoming signal.
Note This value is not exact but provides an approximate
indication of the microreflections that have been received.
Guaranteed-rate service queue Number of bandwidth requests queued up in the Guarantee-rate
depth queue. This queue is available only to CMs that have a reserved
minimum upstream rate in their class of service (CoS).
Best-effort service queue depth Number of bandwidth requests queued up in the Best-effort queue.
This queue is available to all CMs that do not have any reserved
rate on the upstream.
Total Modems On This Number of CMs currently sharing this upstream channel. This field
Upstream Channel also shows how many of these CMs are active.
Field Description
JIB counters for ifInErrors Error counters for the upstream interface that are maintained by the
MAC controller that is onboard certain cable interface line cards
(such as the Cisco uBR-MC5X20S and Cisco uBR-MC28U/X):
• us_error_frame_drop = Number of frames dropped from the
upstream’s errored frame queue because the queue was already
full with packets with various errors, such as CRC, HCS,
fragmentation, concatenation, and unrecognized frame errors.
• us_crc_error = Number of packets with CRC errors that were
received on the upstream.
• us_hcs_error = Number of packets with header checksum
(HCS) errors that were received on the upstream.
• us_cont_collision = Number of packets that were received
with a collision detected during contention transmit
opportunity.
• us_uncorr_cw_rcvd = Number of packets with uncorrectable
codewords that were received on the upstream.
Rng Polls The MAC scheduler queue showing number of ranging polls.
Cont Mslots MAC scheduler queue showing number of forced contention
request slots in MAPS.
CIR Grants MAC scheduler queue showing number of CIR grants pending.
BE Grants MAC scheduler queue showing number of Best-Effort grants
pending.
Grant Shpr MAC scheduler queue showing number of grants buffered for
traffic shaping.
Reserved slot table Number of slots that the MAC scheduler has placed in the reserved
slot table at the time that the command was made.
Req IEs Counter of Request lEs sent in MAPS.
Req/Data lEs Counter of Request/Data lEs sent in MAPS.
Init Mtn IEs Counter of Initial Maintenance lEs.
Stn Mtn IES Number of station maintenance (ranging poll) lEs.
Long Grant lEs Number of long grant lEs.
ShortGrmg lEs Number of short grantlEs.
Avg upstream channel utilization Average percent of the upstream channel bandwidth being used for
user (Ethernet) traffic. This does not include DOCSIS MAC-layer
packets.
Avg percent contention slots Average percent of slots available for CMs to request bandwidth
using contention mechanisms. Also indicates the amount of unused
capacity in the network.
Avg percent initial ranging slots Average percent of slots in the initial ranging state.
Avg percent minislots lost on Average percent of slots that were lost because a MAP interrupt
late Maps was too late.
Field Description
Current Total Bandwidth Total amount of bandwidth reserved by all CMs sharing this
Reserved upstream channel that require bandwidth reservation. The CoS for
these CMs specifies some nonzero value for the guaranteed-
upstream rate. When one of these CMs is admitted on the upstream,
this field value is incremented by this guaranteed-upstream rate
value.
CIR admission control Indicates the status of admission control on the upstream channel.
ENFORCED status allows users to enable admission control on a
per-port basis. This controls how limited bandwidth is allocated.
NOT ENFORCED status indicates that there is no admission
control. Every modem that registers with a class of service
specifying a minimum upstream rate is admitted by the CMTS,
regardless of how much aggregate bandwidth is actually available.
Users enable admission control via the admission control
command-line interface (CLI).
Subscription Level Amount of oversubscription to allow on this upstream channel, as
configured with the cable upstream admission-control command.
Oversubscription is expressed as a percentage of the raw capacity
of the channel. In the example shown, an oversubscription rate of
200 percent on a 2.56 Mbps channel allows the cumulative
bandwidth reservation on this channel to reach 5.12 Mbps before
CMs configured with nonzero reserved upstream rates are denied
service.
Reservation Limit (with Maximum cumulative bandwidth reservation allowable before
Oversubscription) rejecting new CMs. In the example shown, this reservation limit
with oversubscription is 5.12 Mbps.
Admission requests rejected Number of CMs that attempted to register on this interface but were
rejected because of the admission control policy that has been
configured with the cable upstream admission-control command.
Virtual channel bw Maximum virtual bandwidth of this capacity, in bits per second
(bps), when admission control is enabled.
Last Minislot Stamp Indicates the current minislot count at the CMTS. FLAG indicates
(current_time_base) the timebase reference. This field is used only by developers.
Last Minislot Stamp Indicates the furthest minislot count allocated at the indicated time.
(scheduler_time_base) FLAG indicates the timebase reference. This field is used by
developers.
# of Active UGS on the Number of Unsolicited Grant Service (UGS) flows that are
Upstream currently active on the upstream.
UGS Allocation Statistics (max, Maximum number of UGS service flows, minimum number of
min, avg) UGS service flows, and average number of UGS service flows that
have been allocated on the upstream over the last hour and last five
minute period.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Syntax Description df-group Displays information about the Communications Assistance for Law
Enforcement Act (CALEA) Delivery Function (DF) server groups that are
configured on the router.
radius-server Displays information about the EM Remote Authentication Dial In User
Service (RADIUS) servers that are configured on the router.
rks-group Displays information about the Record Keeping Server (RKS) groups that
are configured on the router.
Usage Guidelines This command displays information about the authentication, authorization, and accounting (AAA)
servers that are configured on the Cisco CMTS router for PacketCable operations. These include DF
servers (used for CALEA redirection of event messages and traffic), RADIUS servers (used for
authentication), and RKS servers (used for billing).
Examples The following example shows typical output for the show packetcable event df-group command, which
shows the IP address and UDP port of the DF server to which event messages are being forwarded for
CALEA electronic surveillance.
Router# show packetcable event df-group
CDC-address CDC-port
1.9.62.12 1816
Router#
The following example shows a typical display for the show packetcable event radius-server
command, which shows the IP address for each RADIUS server that is configured on the router for
PacketCable operations, along with the UDP port number that it is using.
Router# show packetcable event radius-server
‘
Server-address Port
10.9.62.12 1816
10.9.62.20 1813
10.9.62.12 1813
Router#
The following example shows a typical display for the show packetcable event rks-group command.
Router# show packetcable event rks-group
Router#
Table 3-62 describes the major fields shown in the show packetcable event rks-group display.
Field Description
Pri-addr IP address for the primary RKS server.
Pri-port UDP port for the primary RKS server.
Sec-addr IP address for the secondary RKS server.
Sec-port UDP port for the secondary RKS server.
Ref-cnt Number of times that the router send single event messages to the RKS
server.
Batch-cnt Number of times that the router sent batrch messages (multiple Event
Messages within a single RADIUS message) to the RKS server.
Tip For complete information about PacketCable event messaging, see the PacketCable Event Messages
Specification, which is available at the PacketCable web site at the following URL:
http://www.packetcable.com
Syntax Description downstream (Optional) Display information only for gates in the downstream direction.
upstream (Optional) Display information only for gates in the upstream direction.
summary Display a summary containing the gate ID, subscriber ID, subscriber IP
address, and current state information.
gate-id Display information for a specific gate ID. The valid range is 0 to
4294967295.
Defaults Displays information about gates on both upstreams and downstreams, if upstream or downstream is
not specified.
Usage Guidelines This command displays information about one or more gates in the gate database on the Cisco CMTS.
You can display a summary for all currently active gates, for all downstream or all upstream gates, or
you can display detailed information about a specific gate.
Examples The following example shows typical output for the show packetcable gate summary command, which
displays all current gates on the CMTS:
Router# show packetcable gate summary
The following example shows a typical display for a specific gate. Both downstream and upstream gates
are shown unless you also specify either the downstream or upstream option.
Router# show packetcable gate 196
GateID : 196
Subscriber ID : 4.4.1.22
GC Address : 192.168.80.15
State : COMMITTED
Gate specs [UPSTREAM]
Gate classifier : [protocol 17,
src addr/port 4.4.1.22/0,
dest addr/port 3.3.1.3/3456
diffserv dscp : 0x6000000
timer t1(ms) : 180000
timer t2(ms) : 2000
commit flags : 0x0
session class : 0x1
flowspec # 1 : [r/b/p/m/M 1176256512/1128792064/1176256512/200/200]
[R/S: 1176256512/0]
Gate specs [DOWNSTREAM]
Gate classifier : [protocol 17,
src addr/port 3.3.1.3/0,
dest addr/port 4.4.1.22/0
diffserv dscp : 0x9000000
timer t1(ms) : 180000
timer t2(ms) : 2000
commit flags : 0x0
session class : 0x1
flowspec # 1 : [r/b/p/m/M 1176256512/1128792064/1176256512/200/200]
[R/S: 1176256512/0]
Remote Gate
address/port : 172.22.79.22/1812
gate coord flag : 2
algo : 100
security key[16] : 30 31 32 33 34 35 36 37 38 39 30 31 32 33 34 35
Billing Info
primary RKS : [addr/port 1.9.62.12/1813]
secondary RKS : [addr/port 255.255.255.255/65535]
flags : 0
billing corr ID : [3D 38 96 CC 20 20 20 20 31 30 20 30 00 00 00 41 ]
Table 3-63 describes the major fields shown in the show packetcable gate display.
Field Description
GateID Unique number identifying the local gate.
Slot Cable interface on the Cisco CMTS.
Subscriber ID IP address for the subscriber for this service request.
GC-Addr IP address for the gate controller that is responsible for this gate.
Field Description
State Describes the current state of the gate in both the upstream and downstream
directions. The possible state values are:
• ALLOC = The CMTS has received a Gate-Alloc command from the gate
controller and has created the gate in response. The CMTS must now
wait for the request to be authorized.
• AUTH = The CMTS has received a Gate-Set command from the gate
controller that authorizes the resources needed for the gate request. The
CMTS must now wait for the actual resources to be reserved.
• RSVD = All required resources for the gate have been reserved.
• COMMIT = All resources have been committed at both the local CMTS
and remote CMTS. The local CMTS has also received a commit
notification from the local MTA and has finished all gate coordination
with the remote end. The gate can now pass traffic.
• INVLD = The gate is invalid, typically because of an error condition or
lack of resources. The CMTS will eventually delete the gate.
• UNKWN = The gate is an unknown state.
SFID (us) SFID for the upstream associated with this PacketCable gate.
SFID (ds) SFID for the downstream associated with this PacketCable gate.
Total number of gates Displays the total number of gates that are currently allocated, authorized,
reserved, or committed.
Total Gates committed Displays the total number of gates that the CMTS has committed since the
CMTS was last reset or since the counters were last cleared.
Tip For complete information about the State field, see section 5.4, Gate Control Protocol Operation, in the
PacketCable Dynamic Quality-of-Service Specification (PKT-SP-DQOS-I03-020116).
Usage Guidelines This command displays the total number of gates that have been committed since the Cisco uBR7200
series router was restarted or since the counter was last cleared with the clear packetcable gate counter
commit command.
Note This command displays only the count of committed gates. It does not include gates that were allocated,
authorized, and reserved but that were not put into the COMMITTED state.
Examples The following example shows that 132 gates have been committed since the Cisco CMTS was last reset
or since the counters were last cleared:
Router# show packetcable gate counter commit
Command Description
show packetcable gate Displays information about one or more gates in the gate database.
show packetcable Displays the current PacketCable configuration.
global
Examples The following example shows a typical PacketCable configuration that is enabled and has the default
values for all configurable parameters, except for the Element ID:
Router# show packetcable global
Router#
Table 3-64 describes the fields shown in the show packetcable global display.
Field Description
Enabled Displays whether PacketCable operation is enabled or disabled. (See the
packetcable command.)
Element ID Displays the Element ID for the CMTS. If you do not manually configure
this parameter with the packetcable element-id command, it defaults to a
random value between 0 and 99,999 when PacketCable operations is
enabled.
Max Gates Displays the maximum number of gates that the CMTS supports. (See the
packetcable gate maxcount command.)
Allow non-PacketCable Displays whether non-PacketCable, DOCSIS-style UGS service flows are
UGS or Not Allow non- allowed when PacketCable operations are enabled. (See the packetcable
PacketCable UGS authorize vanilla-docsis-mta command.)
Default Timer value Displays the current values of the following DQoS timers that the CMTS
maintains. (See the packetcable timer command.)
T0 T0 specifies the amount of time that a gate ID can remain allocated without
any specified gate parameters. The timer begins counting when a gate is
allocated with a Gate-Alloc command. The timer stops when a Gate-Set
command marks the gate as Authorized. If the timer expires without a Gate-
Set command being received, the gate is deleted.
The valid range is 1 to 1,000,000,000 milliseconds, with a default value of
30000 milliseconds (30 seconds).
T1 T1 specifies the amount of time that an authorization for a gate can remain
valid. It begins counting when the CMTS creates a gate with a Gate-Set
command and puts the gate in the Authorized state. The timer stops when the
gate is put into the committed state. If the timer expires without the gate
being committed, the CMTS must close the gate and release all associated
resources.
The valid range is 1 to 1,000,000,000 milliseconds, with a default value of
200000 milliseconds (200 seconds).
show tech-support
To display general information about the Cisco CMTS router when reporting a problem to Cisco
technical support, use the show tech-support command in privileged EXEC mode.
Syntax Description page (Optional) Causes the output to display a page of information at a
time. Use the Return key to display the next line of output or use the
space bar to display the next page of information. If not used, the
output scrolls (that is, does not stop for page breaks).
password (Optional) Leaves passwords and other security information in the
output. If not used, passwords and other security-sensitive
information in the output are replaced with the label "<removed>"
(this is the default).
cef (Optional) Displays information about the Cisco Express Forwarding
(CEF) protocol configuration and status.
ipmulticast (Optional) Displays information about the IP multicast configuration
and status.
isis (Optional) Displays information about the Connectionless Network
Service (CLNS) and Intermediate System-to-Intermediate System
(IS-IS) routing protocol configuration and status.
Note IS-IS support is provided only on CMTS platforms running
Cisco IOS images that have a “-p-” as part of the image name.
rsvp (Optional) Displays information about the IP Resource Reservation
Protocol (RSVP) configuration and status.
Defaults Display output without page breaks and remove passwords and other security information.
Usage Guidelines The show tech-support command displays a large amount of configuration, run-time status, and other
information about the Cisco CMTS for troubleshooting problems. The output of this command can be
provided to technical support representatives when reporting a problem.
Note The show tech-support includes most of the information shown in the show cable tech-support
command.
The show tech-support command automatically displays the output of a number of different show
commands. The exact output depends on the platform, configuration, and type of protocols being used.
Typically, the output includes the output from the following commands:
• show version
• show running-config
• show stacks
• show chassis
• show pxf microcode (Cisco uBR10012 only)
• show pxf cpu statistics (Cisco uBR10012 only)
• show pxf cpu subblocks (Cisco uBR10012 only)
• show pxf cpu buffer (Cisco uBR10012 only)
• show pxf dma (Cisco uBR10012 only)
• show pxf cpu cef memory (Cisco uBR10012 only)
• show pxf cpu queue (Cisco uBR10012 only)
• show pxf cpu statistics drop (Cisco uBR10012 only)
• show interfaces
• show controllers (for all cable interface)
• show cable modem
• show cable flap-list
• show cable qos profile
• show cable modulation-profile
• show cable spectrum-group
• show cable hop
• show interface cable sid (for each cable interface)
• show interface cable sid connectivity (for each cable interface)
• show interface cable downstream
• show interface cable upstream
• show interface cable mac-scheduler
• show interface cable modem
• show process memory
• show process cpu
• show controllers (for all non-cable interfaces)
Tip Depending on the platform and configuration, the output from the show tech-support command can
easily exceed the buffers found in most communications programs. To capture this output so it can be
sent to Cisco TAC, use a Telnet program that allows you to capture the output directly to disk.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
Examples The following example shows how to give the show tech-support command:
Router# show tech-support
show version
To display the configuration of the system hardware, the software version, the names and sources of
configuration files, and the boot images, use the show version command in user EXEC or privileged
EXEC mode.
show version
Defaults Display output without page breaks and remove passwords and other security information.
Examples The following is sample output from the show version command for a Cisco uBR7246 VXR with the
cable clock card installed:
Router# show version
Router#
Field Description
IOS (tm) 7200 Software (UBR7200- Always specify the complete version number when reporting a
P-M), Version xx.x possible software problem. In the example, the version number
is Cisco IOS Release 12.1(10)EC.
ROM: System Bootstrap Bootstrap version string.
Router uptime is The amount of time the system has been up and running.
System restarted at Also displayed is a log of how the system was last booted, as a
result of normal system startup or system error.
System image file is If the software was booted over the network, the Internet
address of the boot host is shown. If the software was loaded
from onboard ROM, this line reads “running default software.”
cisco uBR7246VXR (NPE300) The remaining output in each display shows the hardware
processor configuration and any nonstandard software options.
Configuration register is The configuration register contents, displayed in hexadecimal
notation.
The output of the show version command can also provide certain messages, such as bus error messages.
If such error messages appear, report the complete text of this message to your technical support
specialist.
Tip In Cisco IOS Release 12.1(12)EC, Release 12.2(8)BC1, and later releases, you can add a timestamp to
show commands using the exec prompt timestamp command in line configuration mode.
This chapter documents the following commands that are unique to the Cisco uBR10012 router and its
Performance Routing Engine (PRE1) modules. This chapter contains the following sections:
• Performance Routing Engine Overview, page 4-1
• Command Reference, page 4-4
Note Unless otherwise indicated, all references to PRE in this document refer to both the PRE and PRE1
models of the Performance Routing Engine modules.
Tip For information on the other, cable-specific commands for the Cisco uBR10012 router, see Chapter 2,
“Cisco CMTS Configuration Commands” and Chapter 3, “Cisco CMTS Show Commands.” For
information about debugging commands for the Cisco uBR10012 router and other Cisco CMTS routers,
see Chapter 5, “Cisco CMTS Debugging Commands.”
38240
Links to line cards
Forwarding Path
The forwarding path (FP) assembly is a unique blend of hardware and microcoded processors that
provides high forwarding rates with considerable flexibility for future growth in packet processing
features. The FP is centered around a pair of PXF network processors, which are custom Cisco-designed
multiprocessor ASICs. Each PXF processor provides a packet processing pipeline that contains
16 microcoded processors, arranged as multiple pipelines.
Each of the 16 processors in a PXF network processor is an eXpress Micro Controller (XMC), which is
an independent, high-performance processor that is customized for packet processing. Each XMC
processor provides a sophisticated dual-instruction-issue execution unit that is programmed to perform
a specific packet-processing task in the most efficient manner. The exact processing function assigned
to each XMC is flexible and can change as new features are added to the Cisco IOS software.
Within each PXF network processor, the 16 XMC processors are linked together in four parallel
pipelines, which each pipeline contains four XMC processors arranged as a systolic array. Each XMC
processor performs its own particular function and then passes its results to its neighboring downstream
processor.
The two PXF network processors are linked to form four parallel packet-processing pipelines, each
containing eight XMC processors in a row. See Figure 4-2:
The PXF network processor architecture in the PRE module allows all 32 XMC processors to process
multiple packets independently and efficiently, yielding high throughput while still allowing substantial
feature processing. The PRE module architecture centralizes the main packet processing, freeing up the
other line cards to perform localized processing.
Route Processor
The second component of the PRE is the route processor (RP), a high-speed, conventional
microprocessor that has special interfaces to the FP:
• A high-speed direct memory access (DMA) channel that sends packets back and forth between the
FP and the RP. Packets such as route updates that are not processed by the FP are sent through this
link to the RP. Similarly, the RP sends packets by passing them to the FP for transmission to line
cards.
• The RP also has memory-mapped access to all of the state information used by the XMCs on the FP.
The RP is responsible for configuring the tables and lists used by the XMCs.
The RP also includes such standard Cisco IOS facilities as Flash memory, NVRAM for storing
configuration files, and Ethernet connections for network management.
Command Reference
This section describes the following commands that are specific to the Cisco uBR10012 universal
broadband router:
• associate
• auto-sync
• clear facility-alarm
• clear pxf
• clear redundancy
• exception pxf
• facility-alarm
• hw-module reset
• hw-module shutdown
• hw-module slot pos
• hw-module slot srp
• main-cpu
• maintenance-mode
• microcode
• microcode reload
• redundancy
• redundancy force-failover main-cpu
• redundancy reload
• redundancy switch-activity
• secondary aux
• show cr10k-rp
• show cr10k-rp queue
• show facility-alarm status
• show hardware pxf
• show pxf cable
• show pxf cable interface
• show pxf cpu
• show pxf dma
• show pxf microcode
• show pxf xcm
• show redundancy
• switchover pxf restart
• switchover timeout
Tip For information on the other, cable-specific commands for the Cisco uBR10012 router, see Chapter 2,
“Cisco CMTS Configuration Commands” and Chapter 3, “Cisco CMTS Show Commands.” For
information about debugging commands for the Cisco uBR10012 router and other Cisco CMTS routers,
see Chapter 5, “Cisco CMTS Debugging Commands.”
associate
To logically associate two line cards within the router for Automatic Protection Switching (APS)
redundancy, use the associate command in redundancy configuration mode. To disable slot associations,
use the no form of this command.
Syntax Description slot Specifies that redundancy is being set between two full-height slots.
slot1 Specifies the slot that contains the working (primary) card. The valid range
is 1 to 8 (odd numbers only), but on the Cisco uBR10012 router, the only
usable numbers are 1 and 3, and the card must support APS redundancy.
slot2 (Optional) Specifies the slot that contains the redundant (backup) card. The
valid range is 1 to 8 (even numbers only), but on the Cisco uBR10012
router, the only usable numbers are 2 and 4. If not specified, the next higher
adjacent slot is automatically configured as the redundant slot.
Usage Guidelines The associate command associates the cards in two slots for APS redundancy protection. The two cards
must be in adjacent slots, with the working card in slot 1 or 3, and the backup card in slot 2 or 4,
respectively. The two cards must be identical cards and must support APS redundancy (such as the
OC-12 POS line card).
Note You cannot use the associate command with Performance Routing Engine (PRE1) modules or TCC+
cards, because these cards are automatically configured for redundant operation when two cards are
installed in the chassis.
Examples The following example shows how to associate the OC-12 POS card in slot 1/0 with the OC-12 POS card
in slot 2/0 on the Cisco uBR10012 router:
Router# config t
Router(config)# redundancy
Router(config-r)#
The following example does the same as above, but the router automatically assumes that the card in
slot 2 is the redundant card:
Router# config t
Router(config)# redundancy
Router(config-r)# associate slot 1
Router(config-r)#
The following example removes the association for redundant line cards:
Router# config t
Router(config)# redundancy
Router(config-r)# no associate slot 1
Router(config-r)#
The following example shows the error message that is displayed when you attempt to associate an even
slot as the working slot and an odd slot as the backup slot:
Router# config t
Router(config)# redundancy
Router(config-r)# associate slot 2 3
Router(config-r)#
The following example shows the error messages that are displayed when you attempt to associate line
cards that do not support APS redundancy:
Router(config-r)# associate slot 5 6
Router(config-r)#
The following example shows the error messages that are displayed when you attempt to associate a slot
that is either empty or that does not contain a supported line card:
Router(config-r)# associate slot 1 2
Router(config-r)#
auto-sync
To configure what system files the active and standby Performance Routing Engine (PRE1) modules
automatically synchronize, use the auto-sync command in redundancy configuration (main-cpu) mode.
To disable the synchronization of all or some files, use the no form of this command.
Syntax Description bootvar Specifies that the PRE1 modules should synchronize the following boot
variables:
• BOOT—Set by the boot system device:filename command
• CONFIG_FILE—Set by the boot config device:filename command
• BOOTLDR—Set by the boot bootldr device:filename command
config-register Specifies that the PRE1 modules should synchronize the configuration
register values.
standard Specifies that the PRE1 modules should synchronize all of the system files
(default).
running-config Specifies that the PRE1 modules should synchronize the run-time
configuration files.
startup-config Specifies that the PRE1 modules should synchronize the startup
configuration files.
Defaults The system defaults to synchronizing all system files (auto-sync standard).
Usage Guidelines By default, the system synchronizes all system files, which is the typical setting for most applications.
However, you might want to not synchronize certain files for specialized applications.
For example, if you have configured the active and standby PRE1 modules to run different versions of
Cisco IOS software, you might want to use different configuration files as well. In this case, you would
not synchronize the startup configuration file.
Examples The following example shows the system being configured to synchronize only the startup configuration
file:
router(config)# redundancy
router(config-r)# main-cpu
router(config-r-mc)# auto-sync startup-config
router(config-r-mc)# exit
router(config-r)# exit
router(config)#
The following example shows how to configure the system to synchronize all system files except for the
startup configuration file. This typically is done when the two PRE1 modules are running different
software images.
router(config)# redundancy
router(config-r)# main-cpu
router(config-r-mc)# no auto-sync startup-config
router(config-r-mc)# auto-sync config-register
router(config-r-mc)# auto-sync bootvar
router(config-r-mc)# exit
router(config-r)# exit
router(config)#
clear facility-alarm
To clear some or all of the facility alarms on the Cisco uBR10012 router, use the clear facility-alarm
command in privileged EXEC mode.
Usage Guidelines The clear facility-alarms command clears some or all of the facility alarms that have occurred on the
Cisco uBR10012 router. Facility alarms occur when the temperature thresholds that are configured with
the facility-alarm command are exceeded. These alarms are displayed by the show facility-alarm
status command.
Note The clear facility-alarms command also clears the contacts to an external alarm panel, but does not
affect the alarm indicator LEDs on the PRE module. The alarm LEDs remain lit as long as the alarm
condition continues (as indicated by the show facility-alarm status command).
Examples The following example shows how to clear all facility alarms on the router:
Router# clear facility-alarm
Clearing all alarms
Router#
The following example shows how to clear all critical facility alarms on the router:
Router# clear facility-alarm critical
Clearing critical alarms
Router#
The following example shows how to clear all alarms for both PEM modules on the router:
clear pxf
To clear the error counters for direct memory access (DMA) and error checking and correcting (ECC)
operation on the Parallel eXpress Forwarding (PXF) processor, use the clear pxf command in privileged
EXEC mode.
Syntax Description dma counters Clears the counters for the PXF processor’s DMA engine.
xcm counters Clears the ECC counters for the PXF processor’s External Column Memory
(XCM).
Usage Guidelines The clear pxf dma counters command clears the error counters that are maintained by the DMA engine
on the PXF processor. These counters are displayed by the show pxf dma command.
The clear pxf xcm counters command resets the counters for the PRE1 module’s ECC function for the
processor’s two XCM memory columns. These counters are displayed by the show pxf xcm command.
This command also clears any alarm conditions that might have been set by frequent ECC errors.
Note The clear pxf xcm counters command is supported only on the PRE1 and later processors for the
Cisco uBR10012 router. This command is not supported on the PRE processor.
Examples The following example shows how to clear the DMA counters for the PXF processor:
Router# clear pxf dma counters
The following example shows how to clear the ECC counters for the PRE1 module’s two XCM memory
columns:
Router# clear pxf xcm counters
Related Commands
Command Description
debug pxf Enables debugging of the PXF subsystems on the active PRE1 module on
the Cisco uBR10012 router.
show pxf cpu Displays the display different statistics about the operation of the CPU
processor during PXF processing.
show pxf dma Displays information for the current state of the PXF DMA buffers,
counters, and registers.
show pxf microcode Displays identifying information for the microcode being used on the
processor.
show pxf xcm Displays the current state of ECC for the External Column Memory (XCM)
on the PXF processor.
clear redundancy
To clear the counters and history information that are used by the Redundancy Facility (RF) subsystem,
use the clear redundancy command in privileged EXEC mode.
Syntax Description counters Clears the RF counters that are maintained by the RF subsystem.
history Clears the history of RF activity that is maintained by the RF subsystem.
Usage Guidelines The clear redundancy command clears the following information, which is shown by the show
redundancy command:
• counters—Maintain the number of messages sent and received, buffers used, and synchronization
errors.
• history—Shows the RF subsystem activity, such as checkpoint messages sent between RF clients.
Examples The following example shows how to clear the RF counters that are displayed by the show redundancy
command:
Router# clear redundancy counters
Router#
The following example shows how to clear the RF history information that is displayed by the show
redundancy command:
Router# clear redundancy history
Router#
exception pxf
To control the core dumps that are generated when an exception occurs in one of the Parallel eXpress
Forwarding (PXF) columns, use the exception pxf command in global configuration mode. To disable
the creation of core dumps during PXF exceptions, use the no form of this command.
exception pxf {core-file filename | flash device | style {full | localized | minimal | smart} }
Syntax Description core-file filename Sets the filename for the core-dump file generated during a PXF exception.
flash device Specifies the Flash memory device on which to save the core-dump file
generated during a PXF exception.
style Specifies the type of core-dump file to be generated during a PXF
exception.
full Creates a full core-dump file of all PXF columns.
localized Creates a core-dump file of the PXF column that failed, along with its
neighboring columns.
minimal Creates a minimal core-dump file of the PXF exception.
smart Creates a core-dump file that contains the data related to the PXF exception.
Usage Guidelines
Caution Use the exception pxf command only under the direction of a technical support representative. Creating
a core dump can disrupt network operations. The core dump is a large binary file that can be interpreted
only by technical personnel who have access to source code and detailed memory maps.
Examples The following example shows how to specify that the Cisco uBR10012 router should create a minimal
core-dump file for PXF exceptions, and that this file should be named ubr10k-pxf and be written to the
disk1 device:
Router# configure terminal
Router(config)# exception pxf style minimal
Router(config)# exception pxf core-file ubr10k-pxf
facility-alarm
To set the temperature thresholds at which the Performance Routing Engine (PRE1) module generates a
critical, major, or minor alarm to warn of potential equipment damage, use the facility-alarm command
in global configuration mode. To disable the temperature alarms, use the no form of this command.
Syntax Description core-temperature Specifies the temperature threshold for the temperature sensors near the
center of the PRE1 module.
intake-temperature Specifies the temperature threshold for the temperature sensors at the air
intake slots.
critical exceed-action In Cisco IOS Release 12.2(11)BC1 and later releases, specifies that a
shutdown critical temperature alarm should shut down the router after two minutes.
This was the default behavior in previous releases.
major [temp] Specifies the temperature, in degrees Centigrade, at which the PRE1
module generates a major alarm to warn of potential damage from excessive
temperatures.
The valid range for temp is 20 to 67 degrees Centigrade, with a default of
53 for the core temperature threshold and 49 for the intake temperature
threshold.
minor [temp] Specifies the temperature, in degrees Centigrade, at which the PRE1
module generates a minor alarm to warn of potential damage from excessive
temperatures.
The valid range for temp is 20 to 67 degrees Centigrade, with a default of
45 for the core temperature threshold and 40 for the intake temperature
threshold.
Defaults If no specific temperature is given, that particular facility alarm is reset to its default value. The default
core temperature thresholds are 85 (critical), 53 (major), and 45 (minor). The default intake temperature
thresholds are 67 (critical), 49 (major), and 40 (minor) degrees Centigrade.
In Cisco IOS releases previous to Cisco IOS Release 12.2(11)BC1, a critical alarm automatically shuts
down the router after two minutes to prevent temperature damage. In Cisco IOS Release 12.2(11)BC1
and later, a critical alarm by default does not shut down the router.
Note The default temperature thresholds for the critical core and intake temperatures were changed in
Cisco IOS Release 12.2(11)BC1.
Usage Guidelines The PRE1 module on the Cisco uBR10012 router contains temperature sensors that monitor the
temperature at the air intake slots and on the PRE1 module itself. The facility-alarm command
configures the router for the temperature thresholds that will generate a minor, major, or critical alarm,
so as to notify the system operators of the temperature problem before excessive heat can damage the
router or any of its components.
Before Cisco IOS Release 12.2(11)BC1, a critical alarm would also automatically shut down the router
after two minutes. Cisco IOS Release 12.2(11)BC1 made this automatic shutdown a configurable option,
so that the system operators can decide whether or not a critical alarm should power down the router.
As a general rule, do not disable the automatic shutdown of the router unless you have a systems operator
available to immediately respond to any critical temperature alarms, because this could result in system
damage. Typically, the primary reason to disable the automatic shutdown would be if you are replacing
the fan tray assembly and want to ensure that the router does not power down if the procedure takes
longer than expected.
Note A line card also automatically shuts itself down if the temperature exceeds operational levels. In
addition, the AC and DC PEMs also automatically power down if they exceed their operational
temperature. However, high temperatures could still cause damage to other components if the problem
is not quickly resolved.
Examples The following example shows how to configure the Cisco uBR10012 router so that it generates a minor
alarm when the intake temperature exceed 55°C:
Router# configure terminal
Router(config)# facility-alarm intake-temperature minor 55
Router(config)#
The following example shows how to configure the Cisco uBR10012 router to automatically shut down
if the high temperature continues for more than two minutes:
Router# configure terminal
Router(config)# facility-alarm core-temperature critical exceed-action shutdown
Router(config)#
The following example shows how to disable the automatic shutdown feature for both the core and intake
temperatures. A critical alarm is still generated when the default critical temperatures are exceeded, but
the router does not automatically shut itself down:
Router# configure terminal
Router(config)# no facility-alarm core-temperature critical exceed-action shutdown
Router(config)# no facility-alarm intake-temperature critical exceed-action shutdown
Router(config)#
The following commands disable major and minor alarms for both the core and intake temperature
thresholds (but critical alarms are still generated):
Router# configure terminal
Router(config)# no facility-alarm core-temperature major
Router(config)# no facility-alarm core-temperature minor
Router(config)# no facility-alarm intake-temperature major
Router(config)# no facility-alarm intake-temperature minor
Router(config)#
hw-module reset
To reset a particular Performance Routing Engine (PRE1) module or a particular line card, use the
hw-module reset command in privileged EXEC mode.
hw-module {main-cpu | pre {A|B} | sec-cpu | slot slot-number | subslot slot/card} reset
[hold | release]
Syntax Description main-cpu Resets the PRE1 module that is currently acting as the active PRE1 module.
pre {A|B} Resets the PRE1 module that is physically in either PRE slot A (left slot) or
PRE slot B (right slot).
sec-cpu Resets the PRE1 module that is currently acting as the standby PRE1
module.
slot slot-number Resets the line card that is physically present in the specified slot-number
(valid range is 1 to 8).
subslot slot/card Resets the line card that is physically present in the slot with the specified
slot number (valid range is 1 to 8) and card number (valid range is 0 to 1).
hold (Optional) The card should be held in its reset state, so that it does not begin
reinitialization procedures.
release (Optional) A previously held card should be released from the reset state,
allowing it to complete reinitialization procedures.
Usage Guidelines The hw-module reset command typically is used to reset a standby PRE1 module so that it can load a
new version of Cisco IOS software. However, this command can also be used to reset the active PRE1
module, as well as any other line card in the Cisco uBR10012 chassis.
Caution If the standby PRE1 module is installed and configured, resetting the active PRE1 module triggers a
switchover, so that the standby PRE1 module becomes the active PRE1 module.
Note The hold and release options are not needed for normal operations but are typically used for debugging
and lab tests.
Examples The following example shows the standby PRE1 module being reset:
Router# hw-module sec-cpu reset
Router#
The following example shows the active PRE1 module being reset and kept in the reset state (which will
trigger a switchover to the standby PRE1 module):
Router# hw-module main-cpu reset hold
Router#
The following example shows the PRE1 module in PRE slot B being reset:
Router# hw-module pre B reset
Router#
Note The hw-module pre B reset command resets the PRE1 module that is physically present in slot B,
regardless of whether the module is the active or standby PRE1 module.
The following example shows how to reset the cable interface line card in slot 5/1:
Router# hw-module subslot 5/1 reset
Router#
hw-module shutdown
To shut down a particular Performance Routing Engine (PRE1) module or a particular line card, use the
hw-module shutdown command in global configuration mode.
hw-module {main-cpu | pre {A|B} | sec-cpu | slot slot-number | subslot slot/card} shutdown
Syntax Description main-cpu Shuts down the PRE1 module that is currently acting as the active PRE1
module.
pre {A|B} Shuts down the PRE1 module that is physically in either PRE slot A (left
slot) or PRE slot B (right slot).
sec-cpu Shuts down the PRE1 module that is currently acting as the standby PRE1
module.
slot slot-number Shuts down the line cards that are physically present in the specified
slot-number (valid range is 1 to 8).
subslot slot/card Shuts down the line card that is physically present in the slot with the
specified slot (valid range is 1 to 8) and card (valid range is 0 to 1) numbers.
Usage Guidelines The hw-module shutdown command shuts down a PRE1 module or line card in a controlled manner.
The PRE1 module or line card resets shutdown until it is reset with the hw-module reset command.
Caution Shutting down the active PRE1 module will trigger a switchover, so that the standby PRE1 module
becomes the active PRE1 module.
Examples The following example shows the standby PRE1 module being shut down:
Router(config)# hw-module sec-cpu shutdown
Router(config)#
The following example shows the active PRE1 module being shut down (which will trigger a switchover
to the standby PRE1 module):
Router(config)# hw-module main-cpu shutdown
Router(config)#
The following example shows the PRE1 module in PRE1 slot B being shut down:
Router(config)# hw-module pre B shutdown
Router(config)#
Note The hw-module pre B shutdown command shuts down the PRE1 module that is physically present in
slot B, regardless of whether the module is the active or standby PRE1 module.
Syntax Description slot slot-number Resets the line cards that are physically present in the specified slot-number
(valid range is 1 to 8).
Usage Guidelines You must first use the hw-module slot pos command to preconfigure a line card slot for POS operation
of the Cisco uBR10012 OC-48 DPT card before you can configure the card with any further commands.
You must also use the card 1oc48dpt/pos-1 command to configure the card slot for the proper card type.
Note If you have previously used the hw-module slot srp command to configure line card slots for Spatial
Reuse Protocol (SRP) operation, you must first cancel that configuration using the no hw-module slot
srp command before you can configure the slots for POS operation using the hw-module slot pos
command.
Examples The following example shows the Cisco uBR10012 OC-48 DPT line card in slot 3 being configured for
POS operation:
Router# hw-module slot 3 pos
Router# card 3/0 1oc48dpt/pos-1
The following example shows the Cisco uBR10012 OC-48 DPT line cards in slots 3 and 4 being
reconfigured from SRP operation to POS operation:
Router# no hw-module slot 3 srp
Router# no hw-module slot 4 srp
Router# hw-module slot 3 pos
Router# card 3/0 1oc48dpt/pos-1
Router# hw-module slot 4 pos
Syntax Description slot slot-number Resets the line cards that are physically present in the specified slot-number
(valid range is 1 to 8).
Usage Guidelines You must first use the hw-module slot srp command to preconfigure a line card slot for SRP operation
of a pair of Cisco uBR10012 OC-48 DPT cards before you can configure the cards with any further
commands. You must also use the card 1oc48dpt/pos-1 command to configure each card slot for the
proper card type.
Tip The Cisco uBR10012 OC-48 DPT line cards support SRP operation only when installed in adjacent odd-
and even-numbered slots (such as slots 1 and 2 or 3 and 4). You need to use the hw-module slot srp
command only for the lower-numbered (odd-numbered) slot to preconfigure both slots of the SRP pair.
Note If you have previously used the hw-module slot pos command to configure line card slots for Packet
over SONET (POS) operation, you must first cancel that configuration using the no hw-module slot pos
command before you can configure the slots for POS operation using the hw-module slot srp command.
Examples The following example shows the Cisco uBR10012 OC-48 DPT line cards in slots 1 and 2 being
configured for POS operation:
Router# hw-module slot 1 srp
Router# card 1/0 1oc48dpt/pos-1
Router# card 2/0 1oc48dpt/pos-1
The following example shows the Cisco uBR10012 OC-48 DPT line cards in slots 3 and 4 being
reconfigured from POS operation to SRP operation:
Router# no hw-module slot 3 pos
Router# no hw-module slot 4 pos
Router# hw-module slot 3 srp
Router# card 3/0 1oc48dpt/pos-1
Router# card 4/0 1oc48dpt/pos-1
main-cpu
To enter main-CPU redundancy configuration mode, so that you can configure the synchronization of
the active and standby Performance Routing Engine (PRE1) modules, use the main-cpu command in
redundancy configuration mode.
main-cpu
Usage Guidelines When you enter main-CPU redundancy configuration mode, the prompt changes to the following:
Router(config-r-mc)#
After you enter main-CPU redundancy configuration mode, you can use the auto-sync command to
specify which files are synchronized between the active and standby PRE1 modules. In Cisco IOS
Release 12.2(11)BC3 and later releases, you can also use the switchover timeout command to specify
the amount of time that the standby PRE1 module should wait when it first detects that the active PRE1
module is not active and when it initiates a switchover and becomes the active PRE1 module.
To leave main-CPU redundancy configuration mode and to return to redundancy configuration mode, use
the exit command.
Examples The following example shows how to enter main-CPU redundancy mode and the commands that are
available there:
Router# config t
Router(config)# redundancy
Router(config-r)# main-cpu
Router(config-r-mc)# ?
Router(config-r-mc)#
maintenance-mode
To configure the PRE1 modules on the router for maintenance mode, use the maintenance-mode
command in redundancy configuration mode. To return to normal operations, use the no form of this
command.
maintenance-mode
no maintenance-mode
Usage Guidelines When the Cisco uBR10012 router is configured with redundant PRE1 modules, the active PRE1 module
automatically synchronizes the configuration, network state information, and other information with the
standby PRE1 module, so that if a switchover occurs, the standby module can restore normal operations
quickly. You can use the maintenance-mode command to disable this automatic synchronization of the
PRE1 modules, and to disable the reporting of any faults on the standby module to the active module.
Note The maintenance-mode command disables the ability of the Cisco uBR10012 router to switchover
PRE1 modules and should be used only while upgrading the router or troubleshooting network problems.
Examples The following example shows how to disable the automatic PRE1 module synchronization on the
Cisco uBR10012 router and enter maintenance mode:
Router# config t
Router(config)# redundancy
Router(config-r)# maintenance-mode
Router(config-r)# exit
Router(config)#
The following example shows how to leave maintenance mode and return to normal operations, which
includes the automatic synchronization of the PRE1 modules:
Router# config t
Router(config)# redundancy
Router(config-r)# no maintenance-mode
Router(config-r)# exit
Router(config)#
microcode
To reload the microcode software images on a Parallel eXpress Forwarding (PXF) processor or on all
line cards that support downloadable microcode, use the microcode command in global configuration
mode.
Syntax Description pxf Reloads the microcode for the PXF processors on the Performance Routing
Engine (PRE1) module.
filename Specifies the microcode software image for the PXF processors by device
name and filename.
reload Reloads the microcode for all PRE1 modules and other line cards that
support downloadable microcode software images.
Usage Guidelines By default, the Cisco uBR10012 router automatically loads all required microcode on to the PXF
processors and other line cards when it loads the Cisco IOS software image. Also, the PRE1 module
automatically reloads the microcode on a card when certain faults occur, allowing the card to recover
from the fault.
You can reload the microcode on the PRE1 module or on all line cards that support downloadable
microcode by using the microcode command. Typically, this is not needed and should be done only upon
the advice of Cisco TAC or field service engineers.
Tip You can also reload the microcode on the PXF processors or on all cards using the microcode reload
command in privileged EXEC mode. In particular, use the microcode reload command to reload the
PXF processors with the default microcode that was loaded along with the Cisco IOS software image.
Examples The following example shows how to reload the microcode on all PRE processors and line cards that
support downloadable microcode:
Router# configure terminal
Router(config)# microcode reload
Reload microcode? [confirm] yes
Router(config)#
The following example shows how to reload the microcode on the PXF processors on the PRE1 module,
using a specific image that is stored in the Flash memory:
Router# configure terminal
Router(config)# microcode pxf flash:pxf/ubr10k-ucode.122.1.2.3
Reload microcode? [confirm] yes
Router(config)#
microcode reload
To reload the microcode software images on one or all line cards that support downloadable microcode,
use the microcode reload command in privileged EXEC mode.
Syntax Description all Reloads the microcode for all Performance Routing Engine (PRE1)
modules and other line cards that support downloadable microcode
software images.
pxf Reloads the microcode for the Parallel eXpress Forwarding (PXF)
processors on the PRE1 module.
device:[filename] (Optional) Loads the PXF processors with the microcode software image
that has the specific filename on the specific device. If no filename is
specified, the first image found on the device is loaded by default.
Defaults For microcode reload pxf, defaults to loading the microcode image that was originally loaded when the
Cisco IOS software image was loaded.
Usage Guidelines By default, the Cisco uBR10012 router automatically loads all required microcode on to the PXF
processors and other line cards when it loads the Cisco IOS software image. Also, the PRE1 module
automatically reloads the microcode on a card when certain faults occur, allowing the card to recover
from the fault.
You can reload the microcode on the PRE1 module or on all line cards that support downloadable
microcode by using the microcode reload command. Typically, this is not needed and should be done
only upon the advice of Cisco TAC or field service engineers.
Tip You can also reload the microcode on the PXF processors or on all cards using the microcode command
in global configuration mode.
Examples The following example shows how to reload the microcode on all PRE processors and line cards that
support downloadable microcode:
Router# microcode reload all
Reload microcode? [confirm] yes
Router#
The following example shows a typical list of devices that you can use when loading microcode for the
PXF processors. This list might vary, depending on whether a standby PRE1 module is installed and
depending on the version of Cisco IOS software being used.
Router# microcode reload pxf ?
Router#
The following example shows how to reload the microcode on the PXF processors on the PRE1 module,
using a specific image that is stored in the Flash memory:
Router# microcode reload pxf flash:pxf/ubr10k-1-ucode.122.1.0.4
Reload microcode? [confirm] yes
Router#
redundancy
To enter redundancy configuration mode, use the redundancy command in global configuration mode.
redundancy
Usage Guidelines When you enter redundancy configuration mode, the prompt changes to the following:
Router(config-r)#
After you enter redundancy configuration mode, you can use the main-cpu command to enter main-CPU
redundancy configuration mode, which allows you to specify which files are synchronized between the
active and standby Performance Routing Engine (PRE1) modules.
To leave redundancy configuration mode and to return to global configuration mode, use the exit
command.
Examples The following example shows how to enter redundancy configuration mode and the commands that are
available in that mode:
Router# config t
Router(config)# redundancy
Router(config-r)# ?
Command Description
maintenance-mode Configures the PRE1 modules on the router for maintenance mode.
redundancy Forces a switchover so that the standby PRE1 module becomes the active
force-failover PRE1 module.
main-cpu
Note The terms failover and switchover are interchangeable, but switchover is the term used across all
Cisco platforms capable of high-availability operation.
Usage Guidelines The redundancy force-failover main-cpu command initiates a manual switchover, so that the standby
PRE1 module becomes the active PRE1 module and assumes full responsibilities for router operations.
This command requires that both PRE1 modules are running a Cisco IOS software image that supports
the Route Processor Redundancy (RPR) feature.
A manual switchover is typically done for one of the following reasons:
• You want to upgrade or replace the active PRE1 module.
• You have upgraded the Cisco IOS software on the standby PRE1 module and want the standby PRE1
module to begin using the new software image. This also allows you to upgrade the software on the
former active PRE1 module without interrupting systems operations.
• You want to test switchover operation on the system.
A switchover can also be manually initiated by removing the active PRE1 module from the chassis, but
using the redundancy force-failover main-cpu command provides a more graceful switchover, without
generating hardware alarms.
Tip Do not perform a switchover immediately after you change the configuration and save it to the NVRAM.
Instead, wait a few minutes to allow the two PRE1 modules to synchronize the new configuration, and
then perform the switchover.
Tip Wait two to three minutes after a switchover before switching the system back to the original PRE1
module, so as to allow the system to stabilize and so that both PRE1 modules are ready for the switch.
In Cisco IOS Release 12.2(11)BC3 and later releases, the active PRE1 module will not initiate a new
switchover until a current switchover is complete and the system has stabilized.
Note Pressing enter or y confirms the action and begins the switchover. Pressing any other key aborts the
switchover and returns control to the current active PRE1 module.
The following example shows a switchover being attempted but failing because the standby PRE1
module is either not ready, not available, or not installed:
Router# redundancy force-failover main-cpu
Note In some versions of Cisco IOS software, a failed software switchover will show the following message:
redundancy reload
To reset the standby PRE1 module or to reset both the active and standby PRE1 modules, use the
redundancy reload command in privileged EXEC mode.
Usage Guidelines The redundancy reload peer command reloads the Cisco IOS software on the standby PRE1 module,
which does not have an impact on router operations, assuming a switchover is not required while the
standby module is resetting. The redundancy reload shelf command reloads the Cisco IOS software on
both the active and standby PRE1 modules, which will interrupt services on the router until all PRE1
modules and line cards initialize and come back online.
Examples The following example shows a switchover being manually initiated, overriding any checks that might
prevent or delay the switchover:
Router# redundancy reload peer
Reload peer? [confirm] y
Preparing to reload peer
Note Pressing enter or y confirms the action and begins the reload. Pressing any other key aborts the reload
and returns control to the current active PRE1 module.
The following example shows the system’s response when a standby PRE1 module is not installed in the
router:
Router# redundancy reload peer
Router#
Note Pressing enter or y confirms the action and begins the reload of both modules. Pressing any other key
aborts the reload and returns control to the current active PRE1 module.
redundancy switch-activity
To force a switchover to the standby PRE module, use the redundancy switch-activity command in
privileged EXEC mode.
Note The terms failover and switchover are interchangeable, but switchover is the term used across all
Cisco platforms capable of high-availability operation.
Syntax Description force (Optional) Forces a switchover immediately, overriding any checks in the
code or configuration that might prevent or delay a switchover.
Usage Guidelines The redundancy switch-activity command is similar to the redundancy force-failover main-cpu
command, except that it includes an option to force the switchover, overriding any configuration checks
or other checks in the software that could prevent the switchover. In all cases, this command verifies that
the standby PRE module is available and capable of performing the switchover before it transfers control
to that PRE module. This command also synchronizes the current running-config and client data before
initiating the switchover.
Examples The following example shows a switchover being manually initiated, overriding any checks that might
prevent or delay the switchover:
Router# redundancy switch-activity force
Proceed with switchover to standby PRE? [confirm] y
Note Pressing enter or y confirms the action and begins the switchover. Pressing any other key aborts the
switchover and returns control to the current active PRE1 module.
secondary aux
To enable the auxiliary port on the standby PRE1 module, use the secondary aux command in
redundancy configuration (main-cpu) mode. To disable the auxiliary port, use the no form of this
command.
secondary aux
no secondary aux
Examples The following example shows how to enable the auxiliary port on the standby PRE1 module.
Router# config t
Router(config)# redundancy
Router(config-r)# main-cpu
Router(config-r-mc)# secondary aux
Router(config-r-mc)# exit
Router(config-f)# exit
Router(config)#
show cr10k-rp
To display packet processing information for a particular service ID (SID) on a cable interface, use the
show cr10k-rp command in user EXEC or privileged EXEC mode.
Syntax Description cable x/y/z Identifies the cable interface for which information should be displayed.
sid Identifies the service ID (SID) for which information should be displayed.
The valid range is 1 to 8191.
classifier Displays classifier information for the SID.
mac-rw-index Displays the MAC-layer read/write index for the SID.
queue Displays information about the versatile traffic management system
(VTMS) packet queues for the SID.
service-flow ds Displays the mapping of the downstream service-flow IDs (SFIDs) being
used on the processor card and cable interface line card for the SID.
service-flow us Displays the mapping of the upstream service-flow ID (SFID) and service
ID (SID) for the SID.
Usage Guidelines The show cr10k-rp command displays information that the PRE remote processor (RP) module has
about a particular SID. This information includes configuration information about the SID, as well as
internal status information that is useful only to Cisco engineers in troubleshooting problems.
Examples The following example shows typical output for the show cr10k-rp classifier command for a SID that
identifies a cable modem:
Router# show cr10k-rp c6/1/0 2 classifier
Mac Rw Index: 5CCB Index: 7
CM Classifiers:
id=4, sfid=14 CFR Index 16396 RP sfindex 16396,
prio=10, sip=0.0.0.0, sip mask=0.0.0.0
dip=0.0.0.0, dip mask=0.0.0.0, prot=17, tos=A0,E0
sport = 0,750, dport = 1024,10000 matches = 0
Router#
The following example shows typical output for the show cr10k-rp classifier command for a SID that
identifies a customer premises equipment (CPE) device:
Router# show cr10k-rp c6/0/0 70 classifier
CPE Classifiers:
Mac Rw Index: 390 CCB Index: 97
id=7, sfid=205 CFR Index 16484 RP sfindex 16484,
prio=255, sip=0.0.0.0, sip mask=0.0.0.0
dip=15.0.0.1, dip mask=255.255.255.255, prot=257, tos=0,FF
sport = 0,65535, dport = 1001,1001 matches = 0
CPE Classifiers:
Mac Rw Index: 387 CCB Index: 93
id=4, sfid=202 CFR Index 16481 RP sfindex 16481,
prio=255, sip=0.0.0.0, sip mask=0.0.0.0
dip=14.0.0.1, dip mask=255.255.255.255, prot=17, tos=0,FF
sport = 0,65535, dport = 0,65535 matches = 0
Router#
The following example shows typical output for the mac-rw-index option:
Router# show cr10k-rp c8/0/0 1 mac-rw-index
Router#
Tip To display more information about the max-rw-index, use the show pxf cpu cef command to display
information for a specific IP address. The output of this command shows the max-rw-index value in the
“rw_index” field.
The following example shows typical output for the show cr10k-rp queue command:
Router# show cr10k-rp c6/1/0 1 queue
Router#
The following example shows typical output for the show cr10k-rp service-flow command for both the
downstream and upstream directions:
Router# show cr10k-rp c8/0/0 1 service-flow ds
16385 4 0 0 261
SFID SID
3 1
Router#
Syntax Description cable x/y/z Identifies the cable interface for which information should be displayed.
be Displays information for the best effort (BE) packet queues.
cir Displays information for the committed information rate (CIR) packet
queues.
llq Displays information for low latency packet queues (llq).
Usage Guidelines The show cr10k-rp queue command displays information about the VTMS queues on the
Cisco uBR10012 router. VTMS is a predictive scheduler that uses traffic shaping and link bandwidth
usage to control the order and frequency in which output queues are serviced.
Examples The following example shows typical displays for each form of the show cr10k-rp queue command:
Router# show cr10k-rp c8/0/0 queue be
Queue Information:
------------------
BE Queues:
Queue Information:
------------------
CIR Queues:
Queue Index: 270 QID 270 VCCI 6160 ClassID 14 Refcount 1
Priority: Lo Rates:(Act/Conf) CIR 0/631 MIR 0/6302 EIR 0/630
Statsitics: Length 0 Pkts 0 Octets 0 TailDrops 0 BufferDrops 0
Queue Information:
------------------
LL Queues:
Router#
Examples The following example shows a typical display of the show facility-alarm status command:
Router# show facility-alarm status
Thresholds:
Intake minor 40 major 49 Core minor 45 major 53
SOURCE:RPR REDUNDANCY TYPE:Secondary failure SEVERITY:Minor ACO:Normal
Router#
Note The show facility-alarm status does not show the critical alarm temperature thresholds. You can display
these values using the show running-config | include facility command. If this does not display any
commands for critical alarms, then the temperature thresholds are set at their default values.
Syntax Description feature-table [cx/y/z] Displays the multicast echo and packet intercept status on the PXF
processor. If given without any options, displays the status for all cable
interfaces and subinterfaces. If given with an optional cable interface,
displays the status for that particular interface.
maptable cx/y/z [sid] Displays memory and service ID (SID) information for a particular cable
interface. If the optional sid parameter is specified, displays information
for that particular SID.
multicast-echo ds-group Displays the cable interfaces that are associated with each downstream
group, where each downstream group is a unique DOCSIS MAC domain.
(Interfaces that are bundled together are considered one MAC domain.)
multicast-echo Displays the service flow ID (SFID) information for all multicast addresses
mcast-addr that hash to the same index as the specified multicast IP address.
source-verify Displays the interface and SFID mapping tables that are maintained by the
[ip-address] source-verify feature. If the optional ip-address parameter is specified,
displays information only for that particular IP address.
Note The source-verify option is not supported on the PRE-2 module.
Instead, use the show pxf cpu cef verbose command to display the
primary SID information on the PRE-2 module.
Usage Guidelines The show pxf cable command displays information about whether multicast echo and packet intercept
are enabled on the cable interfaces. It can also be used to display the service flow ID (SFID) used for
each multicast address that is being processed by the router.
Examples The following example shows a typical display for the show pxf cable feature-table command for all
cable interfaces:
Router# show pxf cable feature-table
Router#
The following example shows a typical display for the show pxf cable feature-table option for a
particular cable interface:
Router# show pxf cable feature-table c5/0/0
Router#
The following example shows a typical display for the show pxf cable feature-table option when a cable
interface has a bundle interface configured without a corresponding master interface:
Router# show pxf cable feature-table
Interface SWInterface VCCI McastEcho Intercept DSGrp InterceptGrp
Cable5/0/0 <No Cable Bundle Master Configured>
Cable5/0/1 Cable5/0/1 4 On Off 11 -
Cable5/1/0 <No Cable Bundle Master Configured>
Cable5/1/1 Cable5/1/1 6 On Off 15 -
Cable6/0/0 Cable6/0/0 7 On Off 0 -
Cable6/0/1 Cable6/0/1 8 On Off 1 -
Cable6/1/0 Cable6/1/0 9 On Off 6 -
Cable6/1/1 Cable6/1/1 10 On Off 7 -
Cable7/0/0 Cable7/0/0 11 On Off 8 -
Cable7/0/1 Cable7/0/1 12 On Off 9 -
Cable7/1/0 Cable7/1/0 13 On Off 4 -
Cable7/1/1 Cable7/1/1 14 On Off 5 -
Cable8/0/0 Cable8/0/0 15 On Off 255 -
Cable8/0/1 Cable8/0/1 16 On Off 3 -
Cable8/1/0 Cable8/1/0 17 On Off 12 -
Cable8/1/1 Cable8/1/1 18 On Off 13 -
Router#
Table 4-1 describes the fields shown by both forms of the show pxf cable feature-table command:
Field Description
Interface Identifies the cable interface or subinterface.
SWInterface Identifies the master cable interface for bundled interfaces.
McastEcho Displays whether multicast echo is enabled (On) or disabled (Off).
Field Description
VCCI Displays the Virtually Cool Common Index (VCCI) for this cable interface
or subinterface. The VCCI is an index that uniquely identifies every interface
or subinterface on the PXF processor, and that quickly maps that interface to
the appropriate set of services and features.
Intercept Displays whether packet intercept, as per the Communications Assistance of
Law Enforcement Act (CALEA), is enabled (On) or disabled (Off).
DSGroup Displays the downstream group (unique MAC domain) that is associated
with this interface or subinterface. Interfaces that are bundled together are
considered one MAC domain.
Note A downstream group number of 255 indicates that the CMTS has not
assigned the interface to a MAC domain, typically because the
interface is shutdown.
InterceptGroup Displays the intercept packet group assigned to this cable interface.
The following example shows a typical display for the show pxf cable maptable command for a
particular cable interface:
Router# show pxf cable maptable c5/1/0
Router#
Table 4-2 describes the fields shown by the show pxf cable maptable command:
Field Description
SID Identifies the service ID (SID).
VCCI Displays the Virtually Cool Common Index (VCCI) for this cable interface
or subinterface. The VCCI is an index that uniquely identifies every interface
or subinterface on the PXF processor, and that quickly maps that interface to
the appropriate set of services and features.
FIB Index Identifies the forwarding information base (FIB) being used.
SrcVfy Identifies whether the source-verify feature (enabled with the cable
source-verify command) is On or Off for this SID and interface.
Pri SID Identifies the primary SID associated with this SID, in case this SID is a
secondary or dynamic SID.
CM IP Address Displays the IP address for the CM that is associated with this SID.
The following example shows a typical display for the show pxf cable multicast-echo ds-group
command, listing each downstream multicast group and its associated cable interface:
Router# show pxf cable multicast-echo ds-group
DS Group Interface
0 Cable5/0/0
1 Cable7/0/0
2 Cable7/0/1
Router#
The following example shows a typical display for the show pxf cable multicast-echo command for a
particular multicast address:
Router# show pxf cable multicast-echo 230.1.1.1
Router#
Table 4-3 describes the fields shown by the show pxf cable multicast-echo command:
Field Description
Src Multicast address being displayed.
I/F Cable interface being used for this multicast address.
SFID Displays the service flow ID (SFID) for this particular multicast address.
DS Jib Header Shows the bitmask used for this multicast address on the PRE’s MAC-layer
processor. The bitmask consists of ten hexadecimal bytes in the following
format (reading left to right, from most significant to least significant bit):
• Bytes 9:8 = Specifies the key index for the downstream.
• Bytes 7:6 = Identifies the rule number used for packet header
suppression (if enabled)
• Byte 5 = Bitmask that defines the type of packet transmitted:
– Bit 4 = 1 if padding CRC for data packets, 0 if not padding the CRC
– Bit 3 = 1 if inserting an extended header (EH) for PHS processing
– Bit 2 = 1 if inserting an extended header (EH) for BPI+ processing
– Bits 1:0 = Specifies the packet type:
00 = Data packet
01 = MAC management message for transmitted packets
10 = Internal MAP message on upstream
11 = Special packet
• Byte 4 = Bitmask that identifies the type of map control and key
sequence for the packet:
– Bits 6:4 = Destination upstream for the MAP message
– Bits 3:0 = BPI Key Sequence number
• Bytes 3:2 = Index to obtain the downstream modem statistics.
• Byte 1 = Specifies the assumed minimum size of a packet data unit.
Multiply this byte by 4 to get the actual minimum size in bytes.
• Byte 0 = Specifies the DOCSIS header size, with a maximum value of
0xE0 (248 decimal).
Field Description
Packets Number of packets sent to this address.
Bytes Number of bytes sent to this address.
The following example shows a typical display for the show pxf cable source-verify command:
Router# show pxf cable source-verify
Router#
Table 4-4 describes the fields shown by the show pxf cable source-verify command:
Field Description
IP Address Identifies the IP addresses that have been verified by the source-verify
feature.
Interface Identifies the cable interface or subinterface used for this IP address.
FIB Index Identifies the forwarding information base (FIB) being used.
Mac-Domain Identifies the MAC DOCSIS downstream domain for this IP address.
SID Identifies the service ID (SID).
show pxf cable interface cable x/y/z sid {classifiers | mac-rewrite | queue | service-flow ds |
service-flow us}
Syntax Description cable x/y/z Identifies the cable interface for which information should be displayed.
sid Identifies the service ID (SID) for which information should be displayed.
The valid range is 1 to 8191.
classifiers Displays the packet classifiers used for this SID.
mac-rewrite Displays the CPE MAC information for this SID.
queue Displays the status of the queues being used by this SID.
service-flow ds Displays the service flow IDs (SFID) associated with the given SID on the
downstream for the given cable interface.
service-flow us Displays the SFIDs associated with the given SID on the upstream for the
given cable interface.
Usage Guidelines The show pxf cable interface command displays the DOCSIS-related information for a particular
service ID (SID) on a particular cable interface.
Examples The following example shows a typical display for SID 1 on cable interface c8/0/0 for the show pxf cable
interface classifiers command:
Router# show pxf cable interface c8/0/0 1 classifiers
CM Classifiers:
Mac Rw Index: 18 CCB Index: 47
id=1, sfid=91 CFR Index 16461 RP sfindex 16461,
prio=7, sip=0.0.0.0, sip mask=0.0.0.0
dip=0.0.0.0, dip mask=0.0.0.0, prot=17, tos=0,FF
sport = 0,65535, dport = 0,65535 matches = 0
Router#
Note For a description of the fields that are displayed by this command, see section C.2.1., Packet
Classification Encodings, in Appendix C of the DOCSIS 1.1 specification (Data-Over-Cable Service
Interface Specifications Radio Frequency Interface Specification, SP-RFIv1.1-I08-020301).
The following example shows a typical display for SID 1 on cable interface c8/0/0 for the show pxf cable
interface mac-rewrite command:
Router# show pxf cable interface c8/0/0 1 mac-rewrite
Router#
The following example shows a typical display for SID 1 on cable interface c8/0/0 for the show pxf cable
interface queue command:
Router# show pxf cable interface c8/0/0 1 queue
Router#
The following example shows a typical display for SID 1 on cable interface c8/0/0 for the show pxf cable
interface service-flow ds command:
Router# show pxf cable interface c8/0/0 1 service-flow ds
16460 4 0 0 281
16461 91 0 0 282
16462 92 0 0 283
16463 93 0 0 284
16464 94 0 0 285
Router#
The following example shows a typical display for SID 1 on cable interface c8/0/0 for the show pxf cable
interface service-flow us command:
Router# show pxf cable interface c8/0/0 1 service-flow us
SFID SID
3 1
90 21
Router#
Syntax Description access-lists {qos | Displays information for either quality of service (QoS) access lists (ACLs)
security} or security access lists.
Note The PRE module automatically compiles all access lists into the
turbo ACL format, so that they can be efficiently processed by the
PXF processors. The only exception are very simple access lists that
would require more processing time to be compiled than to be
executed.
buffers Displays information about buffer usage on the processor.
cef [mem | verbose | vrf Displays information about the memory usage and routing tables in the PXF
ip-address mask] processors for Cisco Express Forwarding (CEF) operation. Optionally
displays detailed information about memory usage and about a particular
entry in the virtual private network (VPN) routing/forwarding (VRF) tables.
context Displays performance statistics on the processing of contexts on the
processors. (A context is a unit of packet processing time on the PXF
processor.)
Note The show pxf cpu context command displays more useful
information on the PXF processor’s performance than the show
processor cpu command that is used on other platforms.
mroute [ipaddress1] Displays multicast static route (mroute) information for all groups, for one
[ipaddress2] particular group, or for a range of groups.
Displays information about IP multicast routes in the PXF processor for a
specified IP prefix. For a more user-friendly display of the same
information, use the show ip mroute command.
queue [interface] Displays queue drop counters for all interfaces, or optionally for one
selected interface. This can be useful in determining if traffic is being
properly distributed among the correct interfaces.
schedule [interface | Displays the timing wheel dequeue schedule counters for all interfaces, or
summary] optionally for one interface, or optionally a summary of all interfaces.
statistics Displays statistics for the packets that the PXF has processed. The default
[diversion | drop is to display all packet statistics, or you can optionally specify one of the
[interface] | ip | mlp] following keywords to display a particular type of statistics:
• diversion—(Optional) Displays packets that the PXF diverted to the
main route processor for special handling.
• drop [interface]—(Optional) Displays dropped packets and bytes. You
can also optionally display the dropped packets for a particular
interface.
• ip—(Optional) Displays statistics for the processing of IP and ICMP
packets.
• mlp—(Optional) Displays statistics for multilink point-to-point
protocol (MLPPP) packets.
subblocks [interface] Displays subblocks information for all interfaces, or optionally for one
interface.
Examples See the following sections for typical displays for the different forms of the show pxf cpu command.
Access-Lists
The following example shows a typical display for the access-list qos option, which displays
information about the processing of quality-of-service (QoS) access-lists:
Router# show pxf cpu access qos
The following example shows a typical display for the access-list security option:
Router# show pxf cpu access security
Table 4-5 describes the fields shown in the show pxf cpu access-list command:
Table 4-5 Field Descriptions for the show pxf cpu access-list Command
Field Description
ACL Identifies the access list (ACL) in use, by either name or number.
State Displays the current state of the access list:
• Copying—The ACL is in the process of being created or compiled.
• Operational—ACL is active and filtering packets.
• Out of acl private mem—ACL has run out of the private memory that
was allocated exclusively to it.
• Out of shared mem—ACL has run out of the memory that it shares with
other ACLs.
• Unknown Failure—ACL has failed because of an uncategorized reason.
• Unneeded—ACL was allocated but is not currently in use.
Tables Displays the number of tables that the ACL is currently using.
Entries Displays the number of table entry slots for the fields or values that the ACL
is currently using to match packets.
Config Displays the number of simple or extended entries for this ACL.
Fragment Displays the number of entries that were configured with the fragments
keyword.
Redundant Displays the number of duplicate entries for this ACL.
Memory Displays the total amount of memory, rounded up to the nearest kilobyte, that
the ACL is currently using.
First level lookup tables Describes the blocks of memory that store the IP fields that are used to match
packets for access list processing.
Block Identifies the block of memory used for this particular lookup table.
Use Describes the IP packet field that is being matched.
Rows Describes the number of table rows currently in use and the total number of
rows.
Columns Describes the number of table columns currently in use and the total number
of columns.
Memory used Describes the total amount of memory, in bytes, currently being used by the
memory block.
Banknum Identifies the block of memory used for this particular lookup table.
Heapsize Identifies the total amount of memory, in bytes, allocated for this block of
memory.
Freesize Identifies the amount of memory, in bytes, that is currently available for use
by this block of memory.
%Free Identifies the percentage of memory that is free and available for use for this
block of memory.
Buffers
The following example shows a typical display for the buffers option:
Router# show pxf cpu buffers
FP buffers
pool size # buffer available allocate failures
---------------------------------------------------------
0 9216 3203 3203 0
1 1536 6406 6406 0
2 640 89432 89432 0
3 256 76872 76872 0
4 64 128120 128120 0
Router#
Table 4-6 describes the fields shown in the show pxf cpu buffers command:
Table 4-6 Field Descriptions for the show pxf cpu buffers Command
Field Description
pool Identifies the buffer pool.
size Displays the size, in bytes, of each buffer in this particular pool.
# buffer Displays the total number of buffers in this particular pool.
available Displays the number of buffers that are currently available.
allocate failures Displays the number of attempts to allocate a buffer that have failed since the
last reset.
CEF
The following example shows a typical display for the cef option:
Router# show pxf cpu cef
0.0.0.0/0 4512
1.10.0.0/16 1665 0.0.0.0/0
1.10.0.2/32 4 1.10.0.0/16
1.10.0.3/32 4 1.10.0.0/16
1.10.37.22/32 4 1.10.0.0/16
1.10.45.16/32 4 1.10.0.0/16
1.10.85.0/24 259 1.10.0.0/16
1.10.85.0/32 4 1.10.85.0/24
1.11.0.0/16 42 0.0.0.0/0
1.11.37.0/24 4 1.11.0.0/16
127.0.0.0/8 1601 0.0.0.0/0
127.0.0.0/32 4 127.0.0.0/8
144.205.188.0/24 259 0.0.0.0/0
144.205.188.0/32 4 144.205.188.0/24
144.205.188.1/32 4 144.205.188.0/24
144.205.188.2/32 4 144.205.188.0/24
144.205.188.255/32 4 144.205.188.0/24
Note If the value in the Alloc column is equal to the number in the Total column, then the PXF has run out of
its allocated memory for that level and the CEF entries for that particular level have been exhausted.
Table 4-7 describes the fields shown in the show pxf cpu cef command:
Table 4-7 Field Descriptions for the show pxf cpu cef Command
Field Description
Shadow 10-9-5-8 Header for the memory used by the CEF switching tables, which use the
Toaster Mtrie optimized multiway tree (Mtrie) data structure format.
leaves Number of leaves in the CEF Mtrie table.
leaf bytes Number of bytes used by the leaves in the Mtrie table.
nodes Number of nodes in the Mtrie table.
node bytes Number of bytes used by the nodes in the Mtrie table.
invalidations Number of times an existing entry in the adjacency table was invalidated
because of updated information.
prefix updates Number of updates made to the adjacency table.
refcounts Number of references (leaves and nodes) to an adjacency that are currently
stored in the adjacency table. There is one reference for each corresponding
entry in the CEF table, plus a few others for maintenance and system
purposes.
Prefix/Length IP prefix and length (IP network or host number, with subnet) that is in the
CEF adjacency table.
Refcount Number of times this prefix is referenced in the adjacency table.
Table 4-7 Field Descriptions for the show pxf cpu cef Command (continued)
Field Description
Parent Parent of this prefix’s leaf or node entry in the adjacency table.
FP CEF/MFIB/TFIB XCM Type usage—The following fields display the memory usage of the shadow forwarding
information base (FIB).
Type Level number of this particular memory block.
Name Identifier for this particular memory block.
Total Total number of nodes available on each level and changes to other data
structures.
Alloc Number of nodes currently allocated.
Start, End Starting and ending addresses for the memory block.
Error Number of errors discovered in the memory block.
Context
The following example shows a typical display for the context option, which displays performance
statistics for the PXF processors over the past 1-minute, 5-minute, and 60-minute periods:
Router# show pxf cpu context
Router#
Note The show pxf cpu context command displays more useful information on the processor’s performance
than the show processor cpu command that is used on other platforms.
This display shows statistics that are based on three counters on the PXF processors:
• feed_back—Incremented each time the processor requires another processor cycle to process a
packet. Each PXF processor contains 8 columns that perform different packet header processing
tasks, such as ACL processing or QoS processing. A typical IP packet passes through all 8 columns
only once, but some types of packets can require more than one pass through these columns, and
each additional pass through the PXF processor is referred to as feedback. This counter represents
the amount of traffic that cannot be processed in an optimal manner.
• new_work—Incremented for new packets that come into the PXF pipeline. This counter represents
a snapshot of the amount of incoming traffic being processed by the processor.
• null—Incremented for every context during which the PXF pipe is not processing traffic. This
counter represents the processor’s potential to handle additional traffic. As the processor becomes
more busy, the value for null decreases until it becomes 0, at which point the processor has reached
its maximum usage.
Table 4-8 describes the fields shown in the show pxf cpu context command:
Table 4-8 Field Descriptions for the show pxf cpu context Command
Field Description
FP context statistics
feed_back Displays the current value for the feed_back counter and the rate that the
counter is increasing per second (the difference between the current value
and the previous value divided by the time period between the two).
new_work Displays the current value for the new_work counter and the rate that the
counter is increasing per second (the difference between the current value
and the previous value divided by the time period between the two).
null Displays the current value for the null counter and the rate that the counter
is increasing per second (the difference between the current value and the
previous value divided by the time period between the two).
FP average context/sec
feed_back Displays the rate, in terms of the number of contexts per second (cps) for the
feed_back counter for the last 1-minute, 5-minute, and 60-minute time
periods.
new_work Displays the rate, in terms of the number of contexts per second (cps) for the
new_work counter for the last 1-minute, 5-minute, and 60-minute time
periods.
null Displays the rate, in terms of the number of contexts per second (cps) for the
null counter for the last 1-minute, 5-minute, and 60-minute time periods.
FP context utilization
Actual Displays the actual percentage of processor usage per second, compared to
the theoretical maximum, for the last 1-minute, 5-minute, and 60-minute
time periods. The value for Actual =
(new_work+feed_back)*100/(new_work+feed_back+null).
Theoretical Displays the percentage of processor usage compared to the ideal theoretical
capacities for the last 1-minute, 5-minute, and 60-minute time periods. The
value for Theoretical = (new_work+feed_back)*100/3125000. (The
theoretical maximum for the PXF processors is 3,125,000 contexts per
second.)
Maximum Displays the actual maximum percentage of processor usage that has
occurred for the last 1-minute, 5-minute, and 60-minute time periods. The
value for Actual = (new_work+feed_back+null)*100/3125000.
Mroute
The following example shows a typical display for the mroute option:
Router# show pxf cpu mroute
Router#
Table 4-9 describes the fields shown in the show pxf cpu mroute command:
Table 4-9 Field Descriptions for the show pxf cpu mroute Command
Field Description
Interface Cable interface or subinterface.
vcci Virtually Cool Common Index (VCCI) for this cable interface or
subinterface. The VCCI is an index that uniquely identifies every interface
or subinterface on the PXF processor, and that quickly maps that interface to
the appropriate set of services and features.
rw index Index used to read and write into the multicast table for this entry.
mac_header MAC header that is used when rewriting the packet for output.
Queue
The following example shows a typical display for the queue option, which displays the chassis-wide
counters for the PXF pipeline counters that show drops on the output side of the processor:
Router# show pxf cpu queue
wq_buffer_drop 0 wq_limit_drop 0
wq_invalid_enq_wqb_drop 0 wq_invalid_deq_wqb_drop 0
wq_rnd_pkt_drop 0 wq_rnd_byte_drop 0
wq_static_qlen_drop 0
wq_len 0
Router#
The following example shows a typical display for the queue option for a particular cable interface:
Router# show pxf cpu queue c6/0/0
Router#
Schedule
The following example shows a typical display for the schedule summary option:
Router# show pxf cpu schedule summary
Router#
The following example shows a typical display for the schedule option for a particular interface:
Router# show pxf cpu schedule c5/0/0
Router#
Table 4-10 describes the fields shown in the show pxf cpu schedule command:
Table 4-10 Field Descriptions for the show pxf cpu schedule Command
Field Description
Interface Identifies the cable interface or subinterface.
Level 1 Displays the number of occupied level 1 (port) wheel slots and the total
number of wheel slots for this interface or subinterface.
Level 2 Displays the number of occupied level 2 (channel) wheel slots and the total
number of wheel slots for this interface or subinterface.
maximum Displays the maximum number of packet dequeues per second.
1 min Displays the dequeue rate for the last 1-minute period.
5 min Displays the dequeue rate for the last 5-minute period.
60 min Displays the dequeue rate for the last 60-minute period.
Statistics
The following example shows a typical display for the statistics diversion option, which shows
chassis-wide statistics for PXF diversions, which occur whenever the PXF processor sends a packet to
the main route processor for special processing (such as errored packets, address resolution protocol
(ARP) packets, point-to-point protocol (PPP) control packets, an unsupported Layer 2 packet header, and
so forth).
Router# show pxf cpu statistics diversion
join_spt = 0
null_out = 0
igmp = 69
register = 0
no_fast = 136
ipc_resp = 0
keepalive = 0
min_mtu = 0
icmp_frag = 0
icmp_bad = 0
mpls_ttl = 0
tfib = 0
multicast = 69656
clns_isis = 0
fr_lmi = 0
ppp_cntrl = 0
Router#
Note As shown in this display, the majority of dropped packets should typically be either local (sent to the
router for routing), encap (encapsulated for another protocol), or multicast (IP multicast traffic).
The following example shows a typical display for the statistics drop option, which shows chassis-wide
PXF drop statistics:
Router# show pxf cpu statistics drop
FP drop statistics
packets bytes
icmp_on_icmp 0 0
ipc_cmd_invalid 0 0
icmp_unrch_interval 294 31164
bad_tag_opcode 0 0
bad_ch_handle 0 0
no_touch_from_rp 0 0
dst_ip_is_mcast 0 0
ib_re_bit 0 0
encap_too_big 0 0
no_tfib_route 0 0
mc_disabled 0 0
mc_rpf_failed 0 0
mc_prune_rate_limit 0 0
mc_null_oif 0 0
bad_drop_code 0 0
cobalt_re[00] 0 0
[01] 0 0
[02] 0 0
[03] 0 0
[04] 0 0
[05] 0 0
[06] 0 0
[07] 0 0
[08] 0 0
[09] 0 0
[10] 0 0
[11] 0 0
[12] 0 0
[13] 0 0
[14] 0 0
[15] 0 0
[16] 0 0
[17] 0 0
null_config[00] 0 0
[01] 0 0
[02] 0 0
[03] 0 0
[04] 0 0
[05] 0 0
[06] 0 0
[07] 1 362
[08] 0 0
[09] 0 0
[10] 0 0
[11] 0 0
[12] 0 0
[13] 0 0
[14] 0 0
[15] 0 0
[16] 0 0
[17] 0 0
inval_ib_resource[00] 0 0
[01] 0 0
[02] 0 0
[03] 0 0
[04] 0 0
[05] 0 0
[06] 0 0
[07] 0 0
[08] 0 0
[09] 0 0
[10] 0 0
[11] 0 0
[12] 0 0
[13] 0 0
[14] 0 0
[15] 0 0
[16] 0 0
[17] 0 0
[18] 0 0
[19] 0 0
[20] 0 0
[21] 0 0
[22] 0 0
[23] 0 0
[24] 0 0
[25] 0 0
[26] 0 0
[27] 0 0
[28] 0 0
[29] 0 0
[30] 0 0
[31] 0 0
master drop count 794
Router#
The following example shows a typical display for the statistics drop option for a particular cable
interface, which shows the input-side drop statistics for that particular interface:
Router# show pxf cpu statistics drop c7/1/0
Data Received 0 0
Router#
The following example shows a typical display for the statistics ip option, which displays chassis-wide
PXF forwarding statistics for IP, multicast, fragmented, and ICMP packets:
ROuter# show pxf cpu statistics ip
FP ip statistics
dropped 0
forwarded 1291
punted 11393
input_packets 14049
icmps_created 1365
noadjacency 0
noroute 300
unicast_rpf 0
unresolved 0
FP ip multicast statistics
mcast total 69665
mcast drops 0
mcast rpf 0
mcast inputacl 0
mcast outptacl 0
mcast punts 69665
mcast switched 0
mcast failed 0
FP ip frag statistics
packets 0
fragments 0
fragfail 0
dontfrag 0
mcdontfrag 0
FP icmp statistics
unreachsent 0
ttlsent 0
echorepsent 0
echorcv 0
checksumerr 0
Router#
Note The noroute counter increases whenever the router drops a packet because its destination IP address is
0.0.0.0. This counter also increases whenever the Cisco Express Forwarding (CEF) adjacency tables
drop a packet because it has a null, discard, or drop adjacency.
Subblocks
The following example shows a typical display for the subblocks option for all interfaces:
Router# show pxf cpu subblocks
Router#
The following example shows a typical display for the subblocks option for a particular cable interface:
Router# show pxf cpu subblocks c7/1/1
Cable7/1/1 is up
ICB = 1E100, WQB_ID = 4105, interface PXF, enabled
MAC Domain = 2
IOS encapsulation type 59 MCNS
Min mtu: 18 Max mtu: 1538
VCCI maptable location = 81809C00
VCCI C
icmp ipaddress 0.0.0.0 timestamp 0
Router#
Table 4-11 describes the fields shown in the display for the show pxf cpu subblocks command.
Field Description
Interface Identifies the interface or subinterface.
Status Displays the status of the interface:
• Administ—The interface has been shut down and is in the
administrative down state.
• Deleted—The subinterface has been removed from the router’s
configuration.
• Down—The interface is down because of a cable or other connectivity
problem.
• Initiali—The interface is in the process of initializing.
• Reset—The interface is currently being reset.
• Up—The interface is up and passing traffic.
ICB Displays the Interface Control Block (ICB) that is mapped to this interface.
MAC Domain Displays the DOCSIS-layer domain for this interface or subinterface.
WQB_ID Displays the Work Queue Block (WQB) identifier for this interface.
Fwding Displays whether traffic is being forwarded (PXF) or not (disable).
Encap Identifies the type of encapsulation being used on the interface. The most
common types of encapsulation are:
0 = None
1 = Ethernet ARPA
2 = Ethernet SAP
3 = 802.2 SNAP
5 = Serial, raw HDLC
8 = Serial, LAPB
9 = Serial, X.25
20 = Frame Relay
21 = SMDS
22 = MAC level packets
27 = LLC 2
28 = Serial, SDLC (primary)
30 = Async SLIP encapsulation
33 = ATM interface
35 = Frame Relay with IETF encapsulation
42 = Dialer encapsulation
46 = Loopback interface
51 = ISDN Q.921
59 = DOCSIS (previously known as MCNS)
61 = Transparent Mode
62 = TDM clear channel
64 = PPP over Frame Relay
65 = IEEE 802.1Q
67 = LAPB terminal adapter
68 = DOCSIS Cable Modem
Field Description
VCCI map Displays the memory address for the Virtually Cool Common Index (VCCI)
map table for this particular VCCI. The VCCI is an index that uniquely
identifies every interface or subinterface on the PXF processor and that
quickly maps that interface to the appropriate set of services and features.
VCCI Identifies the VCCI (in hexadecimal) that is assigned to the interface or
subinterface.
Syntax Description buffers (Optional) Displays information about the DMA buffers.
counters (Optional) Displays packet and error counters for the DMA engine.
registers (Optional) Displays information about the DMA registers.
Usage Guidelines The show pxf dma command displays technical information about the current state of the DMA engine
onboard the PXF processor. The buffers and registers options display information that is useful
primarily to Cisco TAC engineers that are troubleshooting problems. The counters option displays a set
of packet and error counters that can help diagnose and resolve problems with memory on the PXF
processor.
Examples The following example shows a typical display for the dma buffers option:
Router# show pxf dma buffers
Table 4-12 describes the fields shown in the show pxf dma buffers command:
Table 4-12 Field Descriptions for the show pxf dma buffers Command
Field Description
Descriptor Address Memory address pointing to the descriptor for this buffer.
Buffer Address Address of this buffer in memory.
Buffer Length Length, in bytes, of this particular buffer.
Descriptor Flags Internal flags identifying this buffer’s use and status.
Context Bit State of the context bit, which is set when the buffer is currently in use by a
context (the basic unit of packet processing).
The following example shows a typical display for the dma counters option:
Router# show pxf dma counters
The following example shows a typical display for the dma registers option:
Router# show pxf dma registers
Usage Guidelines The PXF processors onboard the Performance Routing Engine (PRE1) module automatically load their
microcode at the same time that the Cisco IOS image is loaded into the PRE1 module. A fault situation
can cause one or both of the PXF processors to reload the microcode as needed. You can use the show
pxf microcode command to display the version of microcode currently loaded, as well as the number of
times the microcode has been loaded since the Cisco IOS software was loaded at system bootup.
Examples The following example shows a typical display for the show pxf microcode command:
Router# show pxf microcode
Router#
Table 4-13 describes the fields shown in the show pxf microcode command:
Table 4-13 Field Descriptions for the show pxf microcode Command
Field Description
PXF complex Describes the number of PXF (Toaster) processors, their associate memory
columns, and their current status.
Loaded microcode Describes the source and filename for the microcode that is currently loaded
on the PXF processor.
Version Identifies the major and minor version numbers for the current release of
microcode.
Release Software Identifies the time and date the current microcode was compiled.
created
Microcode load Identifies the number of times the PXF processor has loaded the microcode
attempted since the Cisco IOS image was loaded at system bootup. Also shows the time
(in days and hours) since the last successful load of the microcode.
DISABLE_BOOTSTR Displays the current state of operation for the PXF processor. During normal
AP operation, this line shows “DISABLE_BOOTSTRAP_CLEAR”.
tmc0, tmc1 Identifies the current program counters and configuration for the two PXF
processors.
Cobalt registers Provides a hexadecimal dump of the current contents of the register for the
Cobalt support chip, which manages the interface between the PXF
processors and the backplane, and which also manages the memory for the
packet buffers.
Command Description
show pxf dma Displays information for the current state of the PXF DMA buffers, error
counters, and registers.
show pxf xcm Displays the current state of ECC for the External Column Memory (XCM)
on the PXF processor.
Usage Guidelines The show pxf xcm command displays the register contents and error counters for the ECC function on
the processor’s XCM memory columns. Each PXF processor contains four memory columns, and ECC
is enabled by default for each column.
Note The show pxf xcm command is supported only on the PRE1 and later processors for the
Cisco uBR10012 router. This command is not supported on the PRE module.
Examples The following example shows a typical display for the show pxf xcm command for a PRE1 module:
Router# show pxf xcm
Toaster 0:
Number of Columns: 4
Proc ID: 0x00000002 = TMC
ASIC Revision: 0x00000002 = T2-ECC
XCM0 type:SDRAM, size = 67108864
ECC is enabled for column 0
XCM Control Register: 0x00000001
XCM Exception Type Register: 0x00000000
SDRAM-A Counters
Number of ECC single bit errors: 0
SDRAM-B Counters
Number of ECC single bit errors: 0
XCM1 type:SDRAM, size = 67108864
Table 4-14 describes the fields displayed by the show pxf xcm command.
Field Description
The following fields appear for each PXF processor
Toaster 0, Toaster 1 Identifies the PXF processor.
Number of Columns Identifies the number of memory columns on the PXF processor.
Each PXF processor contains 4 columns of memory.
Proc ID: Identifies the type of processor (TMC=Toaster Memory Column).
ASIC Revision Identifies the internal version number of the PXF processor.
The following fields appear for each XCM memory column
XCM type Identifies the type and size, in bytes, of memory used in this
particular column.
ECC is enabled for column Identifies whether ECC checking is enabled or disabled for this
memory column.
XCM Control Register and Identifies the contents of these two registers for the memory
Exception Type Register column.
Number of ECC single bit errors Identifies the number of single-bit errors that have been detected in
the A and B banks of memory
The following example shows the error message that is displayed when this command is used on a PRE1
module:
Router# show pxf xcm
Router#
show redundancy
To display the current redundancy status, use the show redundancy command in user EXEC or
privileged EXEC mode.
Syntax Description clients (Optional) Displays the Redundancy Facility (RF) client list.
counters (Optional) Displays RF operational counters.
history (Optional) Summarizes RF history.
states (Optional) Displays RF states for active and standby modules.
Usage Guidelines The show redundancy command shows whether the PRE A slot or PRE B slot contains the active
(primary) Performance Routing Engine (PRE1) module, the status of the standby (secondary) PRE1
module, and the values for the standby PRE1 module’s boot variables and configuration register. In
Cisco IOS Release 12.2(13)BC1 and later releases, it also shows the version of Cisco IOS software that
is running on the standby PRE module.
Note The show redundancy command always shows the correct location of the active PRE1 module. The
other PRE slot will always be marked as Secondary, even if a standby PRE1 module is not installed.
Examples This section contains examples of typical displays for each of the options that are available for the show
redundancy command.
Default Displays
The following example shows a typical display from the show redundancy command in Cisco IOS
Release 12.2(15)BC2 and later releases:
PRE A : Secondary
Secondary version:
Cisco Internetwork Operating System Software
IOS (tm) 10000 Software (UBR10K-K8P6-M), Experimental Version 12.2(15)BC2
Copyright (c) 1986-2004 by cisco Systems, Inc.
Compiled Mon 01-Mar-04 12:01 by anxrana
Primary version:
Cisco Internetwork Operating System Software
IOS (tm) 10000 Software (UBR10K-K8P6-M), Released Version 12.2(15)BC2
Copyright (c) 1986-2004 by cisco Systems, Inc.
Compiled Mon 01-Mar-04 12:01 by anxrana
Router#
The following example shows a typical display from the show redundancy command in Cisco IOS
Release 12.2(15)BC1 and earlier releases. The active PRE1 module is in PRE slot A, and the standby
PRE1 module is in PRE slot B:
Router# show redundancy
Secondary version:
Cisco Internetwork Operating System Software
IOS (tm) 10000 Software (UBR10K-K8P6-M), Released Version 12.2(11)BC3
Copyright (c) 1986-2003 by cisco Systems, Inc.
Compiled Mon 03-Mar-03 11:28 by texbnt
Router#
The following example shows the same display but after a switchover has occurred. The show
redundancy command now shows that the active (primary) PRE has changed slots (in this case, moving
from slot A to slot B):
Router# show redundancy
PRE A : Secondary
PRE B (This PRE) : Primary
Secondary version:
Cisco Internetwork Operating System Software
IOS (tm) 10000 Software (UBR10K-K8P6-M), Released Version 12.2(13)BC2
Copyright (c) 1986-2003 by cisco Systems, Inc.
Compiled 26 08-Feb-03 11:28 by texbnt
Router#
The following example shows a typical display when the standby PRE1 module is not installed or is not
operational. The standby (secondary) PRE1 module is shown as not up, and its boot variables and
configuration register are not shown.
Router# show redundancy
Router#
Clients Display
The following example shows a typical display for the show redundancy clients command:
Router# show redundancy clients
Counters Display
The following example shows a typical display for the show redundancy counters command:
Router# show redundancy counters
invalid client tx = 0
null tx by client = 0
tx failures = 0
tx msg length invalid = 0
buffers tx = 1009
tx buffers unavailable = 0
buffers rx = 1006
buffer release errors = 0
History Display
The following example shows a typical display for the show redundancy history command:
Router# show redundancy history
States Display
The following example shows a typical display for the show redundancy states command:
Router# show redundancy states
my state = 13 -ACTIVE
peer state = 8 -STANDBY HOT
Mode = Duplex
Unit = Primary
Unit ID = 0
client count = 5
client_notification_TMR = 30000 milliseconds
RF debug mask = 0x0
Syntax Description number-of-crashes Maximum number of PXF crashes that are allowed within the specified time
period. If the PXF processors crash this many times within the given time
period, the router switches over to the redundant PRE1 module. The valid
range is 1 to 25, with a default of 2.
time-period Time period, in hours, that PXF crashes are monitored. The valid range is 0
to 120 hours, with a default of 5.
Defaults 2 PXF crashes within 5 hours are allowed (switchover pxf restart 2 5)
Usage Guidelines The PXF processors that are onboard the PRE1 module automatically restart themselves if a crash
occurs. Occasional crashes could be expected, but repeated crashes could indicate a hardware problem.
The switchover pxf restart command specifies the maximum number of times that a PXF processor can
crash during a specified time period before the router switches over to the redundant PRE1 module. If
the PXF processors crash this number of times, the router assumes a hardware problem and initiates a
switchover to the redundant PRE1 module.
Note When a switchover occurs because of repeated PXF crashes, the router displays the following system
message: C10KEVENTMGR-3-PXF_FAIL_SWITCHOVER: Multiple PXF failures, switchover to
redundant PRE initiated.
Examples The following example shows how to configure the router so that if five PXF crashes occur within a
one-hour period, the router should initiate a switchover to the redundant PRE1 module.
Router# config t
Router(config)# redundancy
Router(config-r)# main-cpu
Router(config-r-mc)# switchover pxf restart 5 1
Router(config-r-mc)# exit
Router(config-f)# exit
Router(config)#
switchover timeout
To configure the switchover timeout period of the PRE1 module, use the switchover timeout command
in redundancy configuration (main-cpu) mode. To reset the timeout period to its default value, use the
no form of this command.
no switchover timeout
Syntax Description timeout-period Specifies the timeout, in milliseconds. The valid range is 0 to 25000
milliseconds (25 seconds), where 0 specifies no timeout period.
Defaults 0
Usage Guidelines The switchover timeout command specifies how long the standby PRE module should wait when it does
not detect a heartbeat from the active PRE module before initiating a switchover and assuming
responsibility as the active PRE module. If set to 0, the standby PRE module initiates a switchover
immediately when the active PRE module misses a scheduled heartbeat.
Examples The following example shows how to set the timeout period to 60 milliseconds:
Router# config t
Router(config)# redundancy
Router(config-r)# main-cpu
Router(config-r-mc)# switchover timeout 60
Router(config-r-mc)# exit
Router(config-f)# exit
Router(config)#
Command Description
redundancy Configures the synchronization of system files between the active and
standby PRE1 modules.
redundancy Forces a manual switchover between the active and standby PRE1 modules.
force-failover
main-cpu
This chapter describes the cable-specific debugging commands for the Cisco Cable Modem Termination
System (CMTS) universal broadband routers. This chapter contains the following sections:
• Supported Platforms and Cisco IOS Releases, page 5-3—Describes the Cisco CMTS platforms and
Cisco IOS releases that support the commands listed in this section.
• Debug Commands, page 5-4—Describes the cable-specific commands that are used to troubleshoot
the Cisco CMTS configuration and operation, and to troubleshoot the operation of a connected cable
modem (CM).
Note This chapter documents only cable-specific debugging commands. For non-cable-specific debugging
commands, see the command reference documentation for Cisco IOS Release 12.2, available on
Cisco.com and the Documentation CD-ROM. For information about other cable-specific commands for
the Cisco CMTS routers, see Chapter 2, “Cisco CMTS Configuration Commands” and Chapter 3,
“Cisco CMTS Show Commands.”
Caution The debug commands are primarily intended for use in controlled test and troubleshooting situations
with a limited volume of traffic. You should use caution when enabling debug messages because sending
these messages to the console consumes system resources. Cisco recommends that when you use the
debug cable commands, you limit their output to a particular interface or CM, using the debug cable
interface command.
Tip When using the debug commands, you might occasionally see messages similar to the following:
These messages indicate that the processor has displayed the first part of one message and was waiting
for the information needed for the second half of the message when a new message was generated. The
debug routines thus print the new message without waiting for the information from the previous
message. These messages are informational only and can be ignored.
Note Not all Cisco IOS releases support all Cisco CMTS platforms. See the release notes for each Cisco IOS
release for details on which platforms are supported.
Debug Commands
This section documents the following CMTS cable-related debug commands.
• debug cable
• debug cable arp
• debug cable arp filter
• debug cable bpiatp
• debug cable bpiatp
• debug cable bundle
• debug cable config-file
• debug cable dcc
• debug cable dci
• debug cable dhcp
• debug cable dsg
• debug cable dynamic-secret
• debug cable dynsrv
• debug cable encap
• debug cable envm
• debug cable error
• debug cable flap
• debug cable freqhop
• debug cable hw-spectrum
• debug cable interface
• debug cable keyman
• debug cable l2-vpn
• debug cable load-balance
• debug cable mac-address
• debug cable mac-protocol
• debug cable mac-scheduler
• debug cable map
• debug cable phs
• debug cable phy
• debug cable privacy
• debug cable qos
• debug cable range
• debug cable receive
• debug cable registration
• debug cable remote-query
Note Most debug commands assume that the network administrator or cable operator is familiar with DOCSIS
networks and the DOCSIS specifications (see http://www.cablemodem.com/specifications.html for the
current copies of the DOCSIS 1.0 and 1.1 specifications.)
debug cable
To enable debugging of the cable interface, use the debug cable command in privileged EXEC mode.
To disable debugging output, use the no form of the command.
debug cable
no debug cable
Usage Guidelines This command enables debugging of the cable interfaces. To avoid excessive output that could interfere
with router performance, you should limit debugging to a particular cable interface, using the debug
cable interface command, before giving the debug cable command.
Examples The following shows sample output from the debug cable bpiatp command:
Router# debug cable
Router# debug cable interface c3/0
CMTS interface debugging is on
Router#
Jun 25 08:36:37.339: cmts_helper_forward 00e0.a3b6.f0af no match
Note The last message displayed above, “unable to find CM with SID 0,” is typically generated by the show
cable commands and can be ignored.
Usage Guidelines The debug commands are primarily intended for use in controlled test and troubleshooting situations
with a limited volume of traffic. In particular, avoid using the debug cable arp command on an interface
with a significant number of CMs, because the resulting volume of debug output could impact system
performance. Cisco recommends that when you use the debug cable arp command, you limit its output
to a particular interface or CM, using the debug cable interface or debug cable mac-address
commands.
Examples The following shows typical output for a particular cable modem using the debug cable arp command:
Router# debug cable arp
CMTS arp debugging is on
ARPGLEAN cmts glean idb Cable3/0 MAC 0020.4072.7418 SID 2 ipaddr 31.0.0.2
Usage Guidelines If you suspect a particular CM is generating a large volume of ARP traffic, you can enable debugging
for that particular CM using the debug cable arp command. If the ARP traffic is excessive, you can
enable ARP filtering on the associated cable interface using the cable arp filter command. To show the
results of that ARP filtering, use the debug cable arp filter command.
Tip Because this command can produce a large volume of debug information, it does not produce any output
until you first limit debugging output to a particular Service ID (SID) or one or more particular CM MAC
addresses, using the debug cable interface sid or debug cable mac-address commands, respectively.
Examples The following example shows how to enable debugging messages for ARP filtering for a particular MAC
address, and samples of the typical messages that can be displayed:
Router# debug cable mac-address 000C.0102.0304
Router# debug cable arp filter
Router#
ARP Req Filter = T shdw 000C.0102.0304 sip 10.11.13.1 dhdw 00C0.0809.0A0B dip
192.168.100.14 cnt 2
ARP Req Filter = T src_ip 10.11.13.1 dst_ip 192.168.100.14
The following example shows how to enable debugging messages for ARP filtering for a particular SID
on a cable interface:
Router# debug cable interface cable c5/0 sid 31
Router# debug cable arp filter
Router#
Usage Guidelines This command activates debugging of the BPI feature. When this command is activated, the
Cisco CMTS displays debugging information for any BPI-related messages that the CMTS sends or
receives.
Note This command is supported only on images that support BPI or BPI+ encryption.
Tip Debugging must be enabled for one or more cable interfaces, using the debug cable interface command,
before the debug cable bpiatp command displays any output.
Examples The following shows sample output from the debug cable bpiatp command:
Router# debug cable interface c3/0
Router# debug cable bpiatp
Syntax Description pkt (Optional) Displays detailed information about packets that are transmitted
over the cable bundle.
Usage Guidelines This command activates debugging for cable interfaces that are bundled together into a master/slave
relationship, using the cable bundle command.
Note The debug cable bundle pkt command does not display information about multicast packets on the
Cisco uBR10012 router. Use the show ip mroute count and show hardware pxf cpu mroute commands
to display this information on the Cisco uBR10012 router.
Tip This command can generate a significant amount of output. To limit the debug output to a specific cable
interface, use the debug cable interface command, before using the debug cable bundle command.
Examples The following shows typical output from the debug cable bundle command for a particular cable
interface:
Router# debug cable interface c3/0
Router# debug cable bundle
Router#
Usage Guidelines This command shows debugging messages about the internal configuration file editor on the Cisco
CMTS. For more information about the internal configuration file editor, see the cable config-file
command and its subcommands.
Caution The debug commands are primarily intended for use in controlled test and troubleshooting situations
with a limited volume of traffic.
Examples The following example shows how to enable debugging for the internal configuration file editor:
Router# debug cable config-file
When debugging is turned on, the Cisco CMTS displays the following message when it generates a
DOCSIS configuration file for transmission to a CM:
Note See the DOCSIS 1.1 specification (revision SP-RFIv1.1-I05-000714 and above) for a description of the
fields that can appear in a DOCSIS configuration file.
Related Commands cable config-file Creates a DOCSIS configuration file and enters configuration file
mode.
access-denied Disables access to the network.
channel-id Specifies upstream channel ID.
cpe max Specifies the maximum number of CPE devices allowed access.
download Specifies the filename and server IP address for downloading a new
software image.
frequency Specifies the downstream frequency.
option Specifies options for the configuration file that are not provided for
by the other commands.
privacy Specifies privacy options for baseline privacy images.
service-class Specifies service class definitions for the configuration file.
snmp manager Specifies Simple Network Management Protocol (SNMP) options.
timestamp Enables time-stamp generation.
show running-config Displays the current run-time configuration, which includes any
configuration files that have been defined.
show startup-config Displays the current saved configuration, which includes any
configuration files that have been defined and saved.
Usage Guidelines This command shows debugging messages about the DCC Request (DCC-REQ) message that the CMTS
sends to the CM, and about the DCC Response (DCC-RSP) message that the CM sends in reply.
Caution The debug commands are primarily intended for use in controlled test and troubleshooting situations
with a limited volume of traffic. In particular, avoid using the debug cable dcc command on an interface
with a significant number of CMs, because the resulting volume of debug output could impact system
performance. Cisco recommends that when you use the debug cable dcc command, you limit its output
to a particular interface or CM, using the debug cable interface command.
Tip To display the contents of the DCC messages, enable TLV debugging with the debug cable tlvs
command.
Note See the DOCSIS 1.1 specification (revision SP-RFIv1.1-I05-000714 and above) for information on the
content and format of the DCC-REQ and DCC-RSP messages.
Examples The following examples show typical output for the debug cable dcc command. The following example
shows the debug output from a DCC-REQ message that instructs the CM to change its upstream channel
to channel 1, using the default initialization technique (option 0, the CM is to reinitialize its MAC layer,
requiring a complete reregistration):
Router# debug cable int c3/0
Router# debug cable dcc
CMTS DCC encodings debugging is on
Router#
00:02:57: Found DCC TLV
00:02:57: US Channel ID 1
00:02:57: received a DCC_RSP. upstream = 1.
The following example shows the debug output from a DCC-REQ message that instructs the CM to
change its upstream channel to channel 1, using initialization technique 4 (the CM is to continue its
normal operations after synchronizing to the new channel).
0:04:29: Found DCC TLV
00:04:29: US Channel ID 1
00:04:29: Found DCC TLV
00:04:29: Init Tech 4
00:04:29: received a DCC_RSP. upstream = 1.
00:04:29: CM new state = 15
00:04:30: DCC-RSP-NEW-TIMEOUT: CmMac->00ac.0000.0070 OrgId->32770
00:04:30: DCC-RSP-ARRIVE is lost.
00:04:30: received a DCC_RSP. upstream = 0.
00:04:30: ERROR: Received DCC-RSP-ARRIVE w/o DCC-REQ.
00:04:30: DCC-ACK Message Contents:
00:04:30: 0x0000: C2 00 00 1A 00 00 00 30 EB 15 2E 97 00 AC 00 00
00:04:30: 0x0010: 00 70 00 08 00 00 03 02 19 00 80 02
00:04:30: DCC-ACK-SENT: CM->0030.eb15.2e97 TranscId->32770
The following example shows the debug output from a DCC-REQ message that instructs the CM to
change its upstream channel to channel 2, using initialization technique 4, and substituting a new service
flow ID (SFID) of 160 for the current SFID of 14.
00:05:19: Found DCC TLV
00:05:19: US Channel ID 2
00:05:19: Found DCC TLV
00:05:19: Init Tech 4
00:05:19: Found DCC TLV
00:05:19: SFID Substitute old 14 new 160
00:05:19: received a DCC_RSP. upstream = 0.
00:05:19: CM new state = 15
00:05:20: DCC-RSP-NEW-TIMEOUT: CmMac->00ac.0000.0070 OrgId->32771
00:05:20: DCC-RSP-ARRIVE is lost.
00:05:20: received a DCC_RSP. upstream = 1.
00:05:20: ERROR: Received DCC-RSP-ARRIVE w/o DCC-REQ.
00:05:20: DCC-ACK Message Contents:
00:05:20: 0x0000: C2 00 00 1A 00 00 00 30 EB 15 2E 97 00 AC 00 00
00:05:20: 0x0010: 00 70 00 08 00 00 03 02 19 00 80 03
00:05:20: DCC-ACK-SENT: CM->0030.eb15.2e97 TranscId->32771
The following example shows the debug output from a DCC-REQ message that specifies an upstream
channel with a frequency that is not a multiple of 62,500 Hz, which is required by the DOCSIS
specification:
00:07:28: Found DCC TLV
00:07:28: US Channel ID 2
00:07:28: Found DCC TLV
00:07:28: Init Tech 4
00:07:28: Found DCC TLV
00:07:28: ERROR: DS frequency not a multiple of 62500Hz.
Related Commands debug cable tlvs Displays debugging messages about the TLV values used for service
flow encodings, classifier encodings, and PHS rules.
Usage Guidelines This command shows debugging messages about the DCI-REQ messages that the Cisco CMTS receives
from CMs.
Note See the DOCSIS 1.1 specification (revision SP-RFIv1.1-I05-000714 and above) for additional
information on the DCI-REQ, DCI-RSP, and Upstream Transmitter Disable (UP-DIS) messages.
Examples The following example shows typical output displayed by the debug cable dci command:
Router# debug cable interface c3/0
Router# debug cable dci
CMTS dci debugging is on
Router#
DCI-REQ: CM->1234.5678.abcd SID->1
Device Class 1st half->0000000000000000 Device Class 2nd half->0000000000000001
Related Commands cable dci-response Configures how a cable interface responds to DCI-REQ messages
coming from CMs on that interface.
cable dci-upstream-disable Configures the cable interface so that it sends an Upstream
Transmitter Disable (UP-DIS) message in response to a DCI-REQ
message from a particular CM.
Usage Guidelines The debug commands are primarily intended for use in controlled test and troubleshooting situations
with a limited volume of traffic. In particular, avoid using the debug cable dhcp command on an
interface with a significant number of CMs, because the resulting volume of debug output could impact
system performance. Cisco recommends that when you use the debug cable dhcp command, you limit
its output to a particular interface or CM, using the debug cable interface or debug cable mac-address
commands.
Examples The following shows typical debugging messages for the debug cable dhcp command for a particular
cable modem that is acquiring a DHCP address:
Router# debug cable dhcp
CMTS dhcp debugging is on
Usage Guidelines Because this command can produce a large volume of debug information, use this command only when
you have also enabled debugging for a particular interface or MAC address, using the debug cable
interface and debug cable mac-address commands, respectively.
Examples The following example shows how to enable debugging output using the debug cable dsg command:
Router# debug cable dsg
Router#
The following sample messages show that a DSG tunnel has been created, along with its mappings:
Router(config-if)# cable dsg 6.6.6 237.2.2.2 exn
Router(config-if)#
DSG: a mapping entry created for 0006.0006.0006 237.2.2.2 on Cable3/0
DSG: got mac 0006.0006.0006 for group 237.2.2.2 on Cable3/0
DSG: mac 0006.0006.0006 is resolved for 237.2.2.2 on Cable3/0
DSG: interface Cable3/0 joined the igmp static group 237.2.2.2.
The following sample messages show that a particular DSG tunnel and its mappings have been deleted
and removed:
DSG: tunnel 0001.0002.0003 is removed
DSG: Vendor entry CCC is freed
DSG: mapping entry freed for 235.5.5.5 0001.0002.0003 Cable 3/0
DSG: The specified DSG entry has been removed.
DSG: interface Cable 3/0 left the igmp static group 235.5.5.5
DSG: all tunnels have been removed on interface Cable 3/0 and its subinterfaces
The following messages show that the Cisco CMTS is using its internal DSG tables to resolve a
particular MAC address:
DSG: mac 0001.0002.0003 is resolved for 225.2.2.2 on Cable5/0
The following sample messages show that the Cisco CMTS is using its internal DSG tables to find the
appropriate MAC address for an IP multicast group:
DSG: got mac 0001.0002.0003 for group 225.2.2.2 on Cable5/0
The following sample messages show that the Cisco CMTS is using its internal DSG tables to find the
appropriate IP multicast group for a particular MAC address:
DSG: got group 225.2.2.2 from mac 0001.0002.0003
The following sample messages show the debug message that shows an unexpected event occurred while
the DSG subsystem was waiting to send the next keepalive message:
DSG: Unexpected event for CMTS DSG process
Usage Guidelines
Tip Because this command can produce a large volume of debug information, use this command only when
you have also enabled debugging for a particular interface or MAC address, using the debug cable
interface and debug cable mac-address commands, respectively.
Examples The following example shows how to enable debugging output using the debug cable dynamic-secret
command:
Router# debug cable dynamic-secret
Router#
The following example shows typical output for a cable modem that is reset and reregisters while the
Dynamic Shared Secret feature is enabled:
02:15:59: Closing file for modem 00c0.2345.6789: New modem state from resetting to offline
02:16:10: Found file name in BOOT_FILE option
02:16:10: Parsing IP address from 10.10.35.200, len 10.. Got 10.10.35.200
Setting 10 bytes to PAD
Router#
The following example shows the typical messages that are shown when you use the clear cable modem
lock command to clear the lock on one or more cable modems that have failed the Dynamic Shared
Secret checks and were locked into restrictive quality of service (QoS) configurations:
Router# clear cable modem all lock
01:46:37: Closing file for modem 00c0.2854.73f5: New modem state from online to offline
01:46:37: Closing file for modem 00c0.734e.b4aa: New modem state from online(pt) to
offline
01:46:37: Closing file for modem 00c0.7366.17cb: New modem state from init(d) to offline
01:46:37: Closing file for modem 00c0.80bc.22b5: New modem state from online to offline
Router#
The following debug message is displayed when the CMTS has verified the CMTS MIC in a
Data-over-Cable Service Interface Specifications (DOCSIS) configuration file against the shared secret
that is configured on a cable interface:
Validated against Shared secret
The CMTS displays the following debug message when the CMTS has verified the CMTS MIC in a
DOCSIS configuration file against one of the 16 possible secondary shared secrets that are configured
on a cable interface:
Validated against secondary secret 11
The CMTS displays the following debug message when the CMTS obtains a new DOCSIS configuration
file from the TFTP server. The CMTS keeps this file in its internal cache for 30 seconds, so that it can
be used for other cable modems that might request it.
Creating new cache for config-file.cm @ 10.10.10.21
The CMTS displays the following debug messages when it receives a registration request or TFTP
request for a DOCSIS configuration file from a device that is not a cable modem. This can indicate that
a user is trying to manually download a DOCSIS configuration file so that it can be decoded and
modified.
MAC address 0102.0304.0506 not of a CM
MAC Address 0102.0304.0506, IP address 10.10.10.13 is not a modem
The CMTS displays the following debug message when it receives a TFTP request for an unknown TFTP
server. This can indicate that a user is trying to download a DOCSIS configuration file from a local TFTP
server.
TFTP server unknown for CM 0102.0304.0506
The CMTS displays the following debug message when it receives a TFTP request for a non-cable
interface. This can indicate that a user is trying to spoof an IP or Ethernet MAC address, and is trying to
access a TFTP server through the Internet or a local network.
TFTP request from a non-cable interface GE1/0/0 ignored
The CMTS displays the following debug messages when it receives a TFTP request for a DOCSIS
configuration file that is not available on the TFTP server:
16:11:33: Could not locate bootfile name for 0102.0304.0506
16:11:33: Cannot locate config-file.cm requested by CM 0102.0304.0506
16:11:33: Closing file for modem 0102.0304.0506: New modem state from init(rc) to offline
Usage Guidelines This command activates dynamic service flow debugging, which displays a debugging message
whenever one of the following DOCSIS 1.1 dynamic service messages is processed:
• Dynamic Service Add (DSA)—This message is used to create a new service flow.
• Dynamic Service Change (DSC)—This message is used to change the attributes of an existing
service flow.
• Dynamic Service Deletion (DSD)—This message is used to delete an existing service flow.
Each type of dynamic service message includes a request (DSA-REQ, DSC-REQ, DSD-REQ) and a
response (DSA-RSP, DSC-RSP, DSD-RSP).
Do not use this command when you have a large number of active CMs on your network, because it could
generate a huge amount of output to the console port.
Note Debugging must be enabled for one or more cable interfaces, using the debug cable interface command,
before the debug cable dynsrv command will display any output.
Tip If using the debug cable dynsrv command, also use the debug cable mac-address and the debug cable
tlvs command to enable full DOCSIS MAC-layer debugging.
Examples The following example shows typical output displayed by the debug cable dynsrv command:
Router# debug cable interface c3/0
Router# debug cable dynsrv
CMTS dynsrv debugging is on
Router#
*May 5 05:15:36.531: DSA-REQ-RECD: OrgMac->0050.734e.b5b1 OrgId->52
*May 5 05:15:36.531: DSx-STATE-CREATED: OrgMac->0050.734e.b5b1 OrgId->52
*May 5 05:15:36.531: DSA-REQ TLV Information:
*May 5 05:15:36.531: Type Subtype Subtype Length Value
*May 5 05:15:36.531: 24 10
*May 5 05:15:36.531: 19 2 89
*May 5 05:15:36.531: 20 4 20000
*May 5 05:15:36.531: 80 69
*May 5 05:15:36.531: DSA-REQ: Requested QoS Parameter Information:
*May 5 05:15:36.531: Srv Flow Ref: 0 Grant Size: 89 Grant Intvl: 20000
*May 5 05:15:36.531: Requested QoS parameters match QoS Profile:3 (G729)
*May 5 05:15:36.531: DSA-REQ-SID-ASSIGNED: CM 0050.734e.b5b1 SID 11
*May 5 05:15:36.531: DSA-RSP-SEND: OrgMac->0050.734e.b5b1 OrgId->52
*May 5 05:15:36.531: DSA-RSP msg TLVs
*May 5 05:15:36.531: Type:Length:Value
*May 5 05:15:36.531: US QoS Encodings 24:8
*May 5 05:15:36.531: SID 3:2:11
*May 5 05:15:36.531: Service Flow Reference 1:2:0
*May 5 05:15:36.531: DSA-RSP hex dump:
*May 5 05:15:36.531: 0x0000: C2 00 00 26 00 00 00 50 73 4E B5 B1 00 10 0B AF
*May 5 05:15:36.531: 0x0010: BC 54 00 14 00 00 03 01 10 00 00 34 00 18 08 03
*May 5 05:15:36.531: 0x0020: 02 00 0B 01 02 00 00 00
Usage Guidelines The debug cable encap command displays debugging messages about the following types of
encapsulated packets:
• Debug messages prefixed with ENCAPSTR display information about CEF adjacency operations.
• Debug messages prefixed with VENCAP display information about MAC-layer encapsulation for
switched packets (such as PPPoE and IP packets).
The debug commands are primarily intended for use in controlled test and troubleshooting situations
with a limited volume of traffic. In particular, avoid using the debug cable encap command on an
interface with a significant number of CMs, because the resulting volume of debug output could impact
system performance. Cisco recommends that when you use the debug cable encap command, you limit
its output to a particular interface or CM, using the debug cable interface or debug cable mac-address
commands.
Examples The following shows typical output for the debug cable encap command. Messages are shown for both
CEF adjacency and MAC-layer encapsulation events:
Router# debug cable encap
CMTS encap debugging is on
ENCAPSTR hwidb Cable3/1 idb Cable3/1.1 mac 0020.4072.7418 ipaddr 31.0.0.2 linktype 7
ENCAPSTR 0020.4072.7418 SID 2 STR 00000000800200204072741800D0582770540800
Router#
Usage Guidelines This command is used to debug the sensor circuitry used to measure internal temperature, midplane
voltages, fan performance, and power supply voltages on the Cisco CMTS console.
Examples The following example shows sample output displayed by the debug cable envm command
Router# debug cable envm
ENVM: ps id=0xFF0, v=0x2050, r=0xC0AB, pstype=1
ENVM: ps id=0x2FD0, v=0x2050, r=0x24201, pstype=27
NVM: Sensor 0: a2dref=131, a2dact=31, vref=12219, vact=1552 Alpha=8990, temp=27
Table 5-2 Sample Output for the debug cable envm Command
Field Description
ps id Power supply raw voltage reading.
pstype Power supply type determined from ps ID, v, and r. If the
Cisco CMTS contains dual power supplies, the ID information for
two types is usually printed.
Sensor Sensor number.
a2dref Analog-to-digital converter reference reading.
a2dact Analog-to-digital converter actual (measured reading).
vref Reference voltage.
vact Actual voltage.
Alpha Raw temperature reading.
temp Temperature corresponding to Alpha.
Usage Guidelines This command displays unexpected DOCSIS MAC protocol messages. When the Cisco CMTS does not
to expect to receive a specific MAC message, or if a packet contains errors in size or content, an error
message and a hex dump of the packet are printed. Other miscellaneous error conditions may also show
up in output.
Examples The following shows typical output displayed by the debug cable error command.
Router# debug cable error
Router#
00:19:22: Receive data error, status=0x0D04
00:19:22: Receive data error:
00:19:22: Prepended data:
5C 1E 00 02 00 5F 58 5F 01 12 36 FF F2 00 00 00
00:19:22: Packet data (size=36):
00:19:22: 0x000: C2 00 00 1E 8E 07 00 E0 1E D7 CC 94 00 50 73 18
00:19:22: 0x010: E9 F1 00 0C
00:19:22:
Usage Guidelines This command shows debugging messages about the internal configuration file editor on the Cisco
CMTS. For more information about the internal configuration file editor, see the cable config-file
command and its subcommands.
Caution The debug commands are primarily intended for use in controlled test and troubleshooting situations
with a limited volume of traffic.
Examples The following example shows how to enable debugging for the internal configuration file editor:
Router# debug cable flap
When debugging is turned on, the Cisco CMTS displays the following message when a CM is added to
the flap list:
Cable modem <<mac address>> added to flap-list
When debugging is turned on, the Cisco CMTS displays the following message when a CM is removed
from the flap list:
Cable modem <<mac address>> removed from flap-list (<<number>> seconds after last flap)
When debugging is turned on, the Cisco CMTS displays the following message when it checks the flap
list for whether any CMs have aged out and should be removed from the list:
CMTS flap list aging check (interval = 120 min)
Related Commands cable flap-list aging Specifies the number of days to keep a CM in the flap-list table before
aging it out of the table.
cable flap-list insertion-time Sets the insertion time interval that determines whether a CM is
placed in the flap list.
cable flap-list Specifies miss threshold for recording a flap-list event.
miss-threshold
cable flap-list power-adjust Specifies the power-adjust threshold for recording a CM flap-list
threshold event.
cable flap-list size Specifies the maximum number of CMs that can be listed in the
flap-list table.
clear cable flap-list Clears all the entries in the flap-list table.
ping docsis Sends a DOCSIS ping to a CM and increments the flap-list counters
as appropriate.
show cable flap-list Displays the current contents of the flap list.
Examples The following example shows how to display debug messages for frequency hopping:
router# debug cable interface c6/0
router# debug cable freqhop
CMTS freqhop debugging is on
router#
Sep 27 10:36:41.202: Cable5/0 U0: last hop delta: 1
Sep 27 10:36:42.202: Cable5/0 U0: last hop delta: 2
Examples The following shows how to enable debug cable hw-spectrum debugging.
Router# debug cable hw-spectrum
CMTS spectrum analyzer debugging is on
Router#
debug cable interface cable {slot/port | slot/subslot/port} [mac-address address [mask] | sid
number] [verbose]
no debug cable interface cable {slot/port | slot/subslot/port} [mac-address address [mask] | sid
number] [verbose]
Syntax Description slot/port Identifies the cable interface and downstream port on the Cisco uBR7100
series and Cisco uBR7200 series routers.
On the Cisco uBR7100 series router, the only valid value is 1/0. On the
Cisco uBR7200 series router, slot can range from 3 to 6, and port can be 0
or 1, depending on the cable interface.
slot/subslot/port Identifies the cable interface on the Cisco uBR10012 router. The following
are the valid values:
• slot = 5 to 8
• subslot = 0 or 1
• port = 0 to 4 (depending on the cable interface)
mac-address address (Optional) Specifies that debugging is to be done only on traffic related to
mask the specified MAC address. An optional mask can be specified to indicate a
range of MAC addresses. The mask is ANDed with the address to determine
which bits of the address must match to be included in the debugging display.
sid number (Optional) Specifies that debugging is to be done only on traffic related to
the specified SID. The valid range is 1 to 8191.
verbose (Optional) Displays detailed debug information.
Defaults Debugging for the cable interfaces is not enabled, which means most of the other debug cable
commands will not display any output, even when debugging is enabled.
Usage Guidelines The debug cable interface command must be used to enable debugging on a cable interface before other
debug commands can be used on that interface. The mac-address and sid options can be used to restrict
the debug output to only those messages that are related to a specific MAC address or SID, so that the
volume of debug messages does not affect system performance.
Examples The following example shows how to enable debugging on the cable interface in slot 6:
Router# debug cable interface c6/0
Router# show debug
CMTS specific:
Debugging is on for Cable6/0
Router#
The following shows how to enable verbose debugging on the cable interface in slot 6:
Router# debug cable interface c6/0 verbose
Router# show debug
CMTS specific:
Debugging is on for Cable6/0 (verbose)
Router#
The following example shows how to enable debugging on the cable interface in slot 6 for all traffic
coming from CMs and other devices with MAC addresses that match the address range 0010.0000.0000
through 0010.00FF.FFFF (0010.00xx.xxxx):
Router# debug cable interface c6/0 mac-address 0010.0000.0000 FFFF.FF00.0000
Router# show debug
CMTS specific:
Debugging is on for Cable6/0, Address 0010.0000.0000, Mask ffff.ff00.0000
Router#
Usage Guidelines This command activates debugging of the TEK and KEK baseline privacy key activity. When this
command is activated, all activity related to KEK and TEK keys is displayed on the Cisco CMTS
console. This command is used to display encryption key management debugging output.
Note This command is supported only on images that support BPI or BPI+ encryption.
Examples The following shows typical output from the debug cable keyman command.
Router# debug cable keyman
Router#
Dec 11 23:16:19.143: 0D 6F 45 76 1D 17 FD 26 6D 02 03 01 00 01
Dec 11 23:16:19.155: RSA encryption result = 0
Dec 11 23:16:19.155: Output :
Dec 11 23:16:19.155: 88 5F 67 22 86 68 2B 1D A6 F4 E9 62 43 58 1A C8
Dec 11 23:16:19.155: 49 97 7E 81 EE EF B0 DD C4 42 30 FD 24 B0 54 2E
Dec 11 23:16:19.155: 01 CC 84 53 BD 71 50 9D B3 82 4D 7B 49 42 E1 F0
Dec 11 23:16:19.155: 2D 67 3D 46 CB 27 4D 60 16 00 4D EE E1 F3 FD 1D
Dec 11 23:16:19.155: 9C E6 03 3C 77 C8 3A 44 B9 FA 34 2E 44 1B 69 F4
Dec 11 23:16:19.155: AA 68 BF BB A5 43 9B F7 85 82 ED 39 45 02 92 56
Dec 11 23:16:19.155: CMTS sent AUTH response.
Dec 11 23:16:24.267: CMTS Received TEK REQ.
Dec 11 23:16:24.267: Message Digest Verification Failed.
Dec 11 23:16:24.267: Sending KEK INVALID.
Dec 11 23:16:24.323: CMTS Received AUTH REQ.
Dec 11 23:16:24.323: Find a match CM key for abcd.0123.4455
Syntax Description conditional (Optional) Displays the packets that are sent or received for a particular
cable modem or cable interface.
Note The conditional option does not display any output until you have
also enabled debugging for a particular interface, using the debug
cable interface command, or for a particular MAC address, using
the debug cable mac-address command.
Usage Guidelines The debug cable l2-vpn command displays status information for the mapping of cable modems to
PVCs on an ATM interface (see the cable vc-map command) or to a VLAN on an Ethernet,
Fast Ethernet, or Gigabit Ethernet interface (see the cable dot1q-vc-map command). The debug
messages show when a cable modem is mapped to a PVC or VLAN, when the mapping is changed or
removed, and when packets are sent and received over the mapping.
The conditional option displays information for each packet that is sent and received over an ATM PVC
or VLAN mapping. Because this can produce a large volume of debug information, the conditional
option can be used only when you have also enabled debugging for a particular interface or MAC
address, using the debug cable interface and debug cable mac-address commands, respectively.
Examples The following example shows typical output for the debug cable l2-vpn command when a cable modem
is mapped to an ATM PVC:
Router# debug cable l2-vpn
Router(config)#
The following example shows typical output for the debug cable l2-vpn command when a cable modem
is mapped to an IEEE 802.1Q VLAN:
The following example shows typical output for the debug cable l2-vpn command when a mapping is
deleted:
Router# debug cable l2-vpn
Router(config)#
The following example shows typical output for the conditional option. This example shows output for
traffic to and from one particular cable modem. Each debug message shows the size of the packet, the
source and destination MAC addresses, the cable interface and SID being used, and the ATM interface
and PVC/PVI being used.
Router# debug cable mac-address 000C.0807.06.05
Router# debug cable l2-vpn conditional
6d00h: Send pkt size 1020 encsize 6 from 0002.4a1d.dc1d on ATM2/0:1/1 to 000C.0807.0605 on
Cable4/0:0x1
6d00h: Fwd pkt size 74 from 000C.0807.0605 on Cable4/0:0x1 to 0900.07ff.ffff on ATM2/0:1/1
Router#
Syntax Description error (Optional) Displays debugging messages about errors that might occur
during load-balancing operations about the actual number of CMs that are
active on a channel.
Usage Guidelines The debug cable load-balance command displays debugging output for when cable modems come
online those cable interfaces that are part of a load balance group. It also displays debugging messages
when cable modems are moved to achieve balanced loads on those cable interfaces.
Tip Because this command can produce a large volume of debug information, Cisco recommends that you
limit debugging output to a particular interface or MAC address, using the debug cable interface and
debug cable mac-address commands, respectively.
Examples The following example shows typical output for the debug cable load-balance command for a particular
cable interface:
Router# debug cable interface c3/0
Router# debug cable load-balance
*Feb 13 13:39:21.594 PDT: lb: Removing Modem entry 0050.7318.e615: at target (upstream)
Router#
The following example shows typical output for the debug cable load-balance command when the
error option is used to display messages about possible errors in the number of CMs that are active on
the interface.
Router# debug cable interface c5/1/0
Router# debug cable load-balance error
Router#
CMTS load balancing error debugging is on
Usage Guidelines You can repeat this command for other MAC addresses. Each time you specify a different MAC address,
debugging is turned on for that particular MAC address.
If you enter two commands with the same MAC address, but with different values for the mask or
verbose keywords, the router treats both commands as the same. In this case, the latest debugging
information supersedes the previous debugging information.
Note Do not use this command if you have a large number of CMs on your network. The Cisco CMTS will
become flooded with console printouts.
Examples The following example demonstrates how to enable debugging for all traffic coming from cable
interface 3/0 of CMs with the MAC address 00E0.1Exx.xxxx:
Tip To monitor a specific CM when it comes online, use the debug cable mac-address, debug cable
mac-protocol, and debug cable registration commands.
Field Description
SID value is.... Reports the service ID of the modem. The range is from 1 through
891. The information on this line should agree with the first line of
the return (that is, Ranging Modem with Sid...).
CM mac address.... The MAC address of the specified CM.
Timing offset is.... The time by which to offset the frame transmission upstream so that
the frame arrives at the expected minislot time at the CMTS.
Power value is FE0, or 0 dB The raw value derived from the 3137 Broadcom chip. Alternatively,
the dB value specifies the relative change in the transmission power
level that the CM needs to make sure that transmissions arrive at the
CMTS at the desired power level.
Freq Error = .... The raw value derived from the 3137 Broadcom chip.
Freq offset is .... Specifies the relative change in the transmission frequency that the
CM will make to match the CMTS.
Usage Guidelines Do not use this command if you have a large number of CMs on your network. The Cisco CMTS will
become flooded with console printouts.
Examples The following example shows the return for the MAC layer:
router# debug cable mac-protocol
Tip To monitor a specific CM when it comes online, use the debug cable mac-address, debug cable
mac-protocol, and debug cable registration commands.
Field Description
SID value is.... Reports the service ID of the modem. The range is from 1 through
8191. The information on this line should agree with the first line of
the return (that is, Ranging Modem with Sid...).
CM mac address.... The MAC address of the specified CM.
Timing offset is.... The time by which to offset the frame transmission upstream so that
the frame arrives at the expected minislot time at the CMTS.
Power value is FE0, or 0 dB The raw value derived from the Broadcom chip. Alternately, the dB
value specifies the relative change in the transmission power level
that the CM needs to make so that transmissions arrive at the CMTS
at the desired power level.
Freq Error = .... The raw value derived from the Broadcom chip.
Freq offset is .... Specifies the relative change in the transmission frequency that the
CM will make to match the CMTS.
Syntax Description admission-control (Optional) Displays debugging output for the MAC scheduler’s admission
control activities, which controls the percentage of overbooking allowed on
the upstream channel.
Usage Guidelines Do not use this command if you have a large number of CMs on your network. The Cisco CMTS will
become flooded with console printouts.
Caution The debug commands are primarily intended for use in controlled test and troubleshooting situations
with a limited volume of traffic. In particular, avoid using the debug cable mac-scheduler command on
an interface with a significant number of CMs, because the resulting volume of debug output could
impact system performance. Cisco recommends that when you use the debug cable mac-scheduler
command, you limit its output to a particular interface or CM, using the debug cable mac-address or
debug cable interface commands.
Examples The following example shows debugging being turned on for the MAC scheduler:
Router# debug cable mac-scheduler
CMTS scheduler debugging is on
Router#
The following examples shows admission-control debugging being turned on for a particular CM with
the MAC address of 000C.1234.5678, and the typical messages that appear if the CM cannot register
because the channel is oversubscribed.
Router# debug cable mac-address 000C.1234.5678 verbose
Router# debug cable mac-scheduler admission-control
Router#
Related Commands cable upstream Determines the percentage of overbooking allowed on the upstream
admission-control channel.
debug cable Displays debugging output for the CMs that match the specified address or
mac-address range of addresses.
debug cable Displays debug messages for the MAC-layer protocol.
mac-protocol
debug cable Displays debug messages for upstream admission control activity.
us-adm-ctrl
Syntax Description error Displays debugging messages about DOCSIS MAP messages that were
received with errors.
sid [sid-num] Specifies the specific service ID (SID) to be debugged in DOCSIS MAP
messages. The valid range for the optional sid-num value is 1 to 8191. If
sid-num is not specified, debugging messages are shown for all SIDs.
Examples The following example shows how to display all MAP messages, with and without data grants:
Router# debug cable map
19:41:53: On interface Cable6/0, sent 5000 MAPs, 1321 MAPs had grant(s)Long Grants
13256993, Total Short Grants 223
Table 5-5 describes the fields displayed by the debug cable map command.
Field Description
sent 5000 MAPs Total number of maps transmitted.
MAPs had grant(s) Long Grants Total number of grants considered long-sized by CMTS.
Total Short Grants Total number of grants considered short-sized by CMTS.
us_ch_id Identifies the upstream channel ID for this message.
ucd_count Number of upstream channel descriptors (UCDs).
num_elems Number of information elements in the map.
reserved Reserved for alignment.
Alloc Start Time Start time from CMTS initialization (in minislots) for assignments
in this map.
Ack Time Latest time from CMTS initialization (in minislots) processed in
upstream. The CMs use this time for collision detection.
Rng_bkoff_start Initial backoff window for initial ranging contention, expressed as
a power of 2. Valid values are from 0 to 15.
Rng_bkoff_end Final backoff window for initial ranging contention, expressed as a
power of 2. Valid values are from 0 to 15.
Data_bkoff_start Initial backoff window for contention data and requests, expressed
as a power of 2. Valid values are from 0 to 15.
Data_bkoff_end Final backoff window for contention data and requests, expressed
as a power of 2. Valid values are from 0 to 15.
sid Service ID.
iuc Interval usage code (IUC) value.
mslot_offset Minislot offset.
The following shows typical output for the debug cable map error command:
Router# debug cable int cable 4/0
Router# debug cable map error
CMTS map errors debugging is ON
Router#
Usage Guidelines Do not use this command when you have a large number of active CMs on your network, because it could
generate a huge amount of output to the console port.
This command displays the output for both the upstream and downstream drivers. The upstream receive
driver restores headers that have been suppressed by CMs, and the downstream driver suppresses specific
fields in packet header before forwarding a frame to the CM.
Examples The following example shows typical output from PHS debugging:
Router# debug cable phs
CMTS payload header suppression debugging is on
Usage Guidelines This command activates debugging of messages generated in the PHY system, which is the physical
layer where upstream and downstream activity between the Cisco CMTS and the HFC network is
controlled. When this command is activated, any messages generated in the PHY system are displayed
on the Cisco CMTS console.
Examples The following is typical output from the debug cable phy command.
cmts_phy_init: mac_version == BCM3210_FPGA
bcm3033_set_tx_sym_rate(5056941)
stintctl = 0x54484800
bcm3033_set_tx_if_freq(44000000)
stfreqctl = 0x5BAAAAAA
cmts_phy_init_us: U0 part_id = 0x3136, revid = 0x05, rev_id2 = 0x64
cmts_phy_init: mac_version == BCM3210_FPGA
Media access controller chip version.
bcm3033_set_tx_sym_rate(5056941)
stintctl = 0x54484800
Physical layer symbol rate register value.
00:51:49: bcm3033_set_tx_if_freq(44000000)
00:51:49: stfreqctl = 0x5BAAAAAA
Physical layer intermediate frequency (IF) register value.
00:51:49: cmts_phy_init_us: U0 part_id = 0x3136, revid = 0x05, rev_id2 = 0x64
Physical layer receiver chip part version.
Usage Guidelines This command activates debugging of the Baseline Privacy Interface (BPI) feature. When this command
is activated, the BPI handler generates a debugging message whenever the BPI state changes or a
BPI-related event occurs.
Tip Debugging must be enabled for one or more cable interfaces, using the debug cable interface command,
before the debug cable privacy command displays any output. BPI debugging can be done only on a
per-interface basis, not on the basis of a CM’s MAC address.
Note This command is supported only on images that support BPI or BPI+ encryption.
Examples The following is typical output from the debug cable privacy command:
02:32:08: CMTS Received AUTH REQ.
02:32:08: Created a new CM key for 0030.96f9.65d9.
02:32:08: CMTS generated AUTH_KEY.
02:32:08: Input : 70D158F106B0B75
02:32:08: Public Key:
02:32:08: 0x0000: 30 68 02 61 00 DA BA 93 3C E5 41 7C 20 2C D1 87
02:32:08: 0x0010: 3B 93 56 E1 35 7A FC 5E B7 E1 72 BA E6 A7 71 91
02:32:08: 0x0020: F4 68 CB 86 A8 18 FB A9 B4 DD 5F 21 B3 6A BE CE
02:32:08: 0x0030: 6A BE E1 32 A8 67 9A 34 E2 33 4A A4 0F 8C DB BD
02:32:08: 0x0040: D0 BB DE 54 39 05 B0 E0 F7 19 29 20 8C F9 3A 69
02:32:08: 0x0050: E4 51 C6 89 FB 8A 8E C6 01 22 02 34 C5 1F 87 F6
02:32:08: 0x0060: A3 1C 7E 67 9B 02 03 01 00 01
02:32:08: RSA public Key subject:
02:32:08: 0x0000: 30 7C 30 0D 06 09 2A 86 48 86 F7 0D 01 01 01 05
02:32:08: 0x0010: 00 03 6B 00 30 68 02 61 00 DA BA 93 3C E5 41 7C
02:32:08: 0x0020: 20 2C D1 87 3B 93 56 E1 35 7A FC 5E B7 E1 72 BA
02:32:08: 0x0030: E6 A7 71 91 F4 68 CB 86 A8 18 FB A9 B4 DD 5F 21
02:32:08: 0x0040: B3 6A BE CE 6A BE E1 32 A8 67 9A 34 E2 33 4A A4
02:32:08: 0x0050: 0F 8C DB BD D0 BB DE 54 39 05 B0 E0 F7 19 29 20
02:32:08: 0x0060: 8C F9 3A 69 E4 51 C6 89 FB 8A 8E C6 01 22 02 34
02:32:08: 0x0070: C5 1F 87 F6 A3 1C 7E 67 9B 02 03 01 00 01
02:32:08: RSA encryption result = 0
02:32:08: RSA encrypted output:
02:32:08: 0x0000: B6 CA 09 93 BF 2C 05 66 9D C5 AF 67 0F 64 2E 31
02:32:08: 0x0010: 67 E4 2A EA 82 3E F7 63 8F 01 73 10 14 4A 24 ED
02:32:08: 0x0020: 65 8F 59 D8 23 BC F3 A8 48 7D 1A 08 09 BF A3 A8
02:32:08: 0x0030: D6 D2 5B C4 A7 36 C4 A9 28 F0 6C 5D A1 3B 92 A2
02:32:08: 0x0040: BC 99 CC 1F C9 74 F9 FA 76 83 ED D5 26 B4 92 EE
02:32:08: 0x0050: DD EA 50 81 C6 29 43 4F 73 DA 56 C2 29 AF 05 53
02:32:08: CMTS sent AUTH response.
02:32:08: CMTS Received TEK REQ.
02:32:08: Created a new key for SID 2.
02:32:08: CMTS sent KEY response.
Usage Guidelines This command activates debugging of QoS. When this command is activated, any messages related to
QoS parameters are displayed on the Cisco CMTS console.
Examples The following is typical output from the debug cable qos command:
CMTS_QOS_LOG_NO_MORE_QOS_INDEX
Modems cannot add more entries to the class of service table.
CMTS_QOS_LOG_NOMORE_QOSPRF_MEM
Memory allocation error when creating class of service table entry.
CMTS_QOS_LOG_NO_CREATION_ALLOWED
Class of service entry cannot be created by modem. Use CLI or SNMP
interface instead of the modem's TFTP configuration file.
CMTS_QOS_LOG_CANNOT_REGISTER_COS_SID
A service identifier (SID) could not be assigned to the registering modem.
CMTS_QOS_LOG_CANNOT_DEREGISTER_COS_SID
The modem's service identifier (SID) was already removed.
CMTS_QOS_LOG_MSLOT_TIMEBASE_WRAPPED
The 160 KHz timebase clock drives a 26-bit counter which wraps around
approximately every 7 minutes. This message is generated every time it
wraps around.
Usage Guidelines This command activates debugging of ranging messages from CMs on the HFC network. When this
command is activated, any ranging messages generated when CMs request or change their upstream
frequencies are displayed on the Cisco CMTS console. Use this command to display the details of the
initial and station maintenance procedures. The initial maintenance procedure is used for link
establishment. The station maintenance procedure is used for link keepalive monitoring.
Examples The following shows typical output from the debug cable range command.
Got a ranging request
SID value is 0 on Interface Cable3/0/U0
CM mac address 00:10:7B:43:AA:21 Timing offset is 3312
3E 1E 3F FF 00 00 59 BF 01 15 F8 01 A7 00 0C F0
The following output shows typical output when a CM first seeks to establish a link to the Cisco CMTS.
The service identifier (SID) value of 0 indicates that the modem has no assigned SID. The CM mac
address is the MAC address of the modem's radio frequency (RF) interface, not its Ethernet interface.
The Timing offset is a measure of the distance between the modem and the Cisco CMTS, expressed in
10.24 MHz clocks. This value is adjusted down to zero by the maintenance procedures. The first 16 bytes
of the prepended header of the message are dumped in hexadecimal.
CM mac address 0010.7b43.aa21
found..Assigned SID #2 on Interface Cable3/0/U0
Timing offset is CF0
Power value is 15F8, or -1 dB
Freq Error = 423, Freq offset is 1692
Ranging Modem with Sid 2 on i/f : Cable3/0/U0
The following is typical output when the CM is first assigned a SID during initial maintenance:
Initial Range Message Received on Interface Cable3/0/U0
CMTS reusing old sid : 2 for modem : 0010.7b43.aa21
Timing offset is CF0
Power value is 15F8, or -1 dB
The following is typical output when the modem is reassigned the same SID during initial maintenance.
Ranging Modem with Sid 2 on i/f : Cable3/0/U0
Output occurs when the modem is polled by the CMTS during station maintenance. Polling happens at
a minimum rate of once every 10 seconds.
The debug cable receive command was disabled in Cisco IOS Release 12.1 T, 12.1 EC, and later
releases, although it still appears in the CLI until Cisco IOS Release 12.1(11b)EC. To monitor the
packets received from the CMs, use the debug ip packet command instead.
Because the debug ip packet command produces a large volume of messages, you must use it together
with an access list to restrict the messages to a particular CM or CPE device to avoid affecting system
performance. For example, the following commands would set up an access list that monitors all traffic
being sent between the hosts with the two specified IP addresses:
router# configure terminal
router(config)# access-list 150 permit ip host ip-address-1 host ip-address-2
router(config)# access-list 150 permit ip host ip-address-2 host ip-address-1
router(config)# exit
router# debug ip packet 150 detail
Usage Guidelines The debug cable registration command displays messages about the registration request and response
messages sent and received by the CMTS when a CM initiates the DOCSIS registration process. To see
the relevant messages, you must also enable debugging for a particular interface or CM using the debug
cable interface or debug cable mac-address commands.
Examples The following shows typical debugging output from a registration process:
router# debug cable interface c3/0 verbose
router# debug cable registration
CMTS registration debugging is on
The following example shows what can occasionally occur when a shared secret has been implemented.
Some CMs calculate the MD5 Message Integrity Check (MIC) over the length of the registration TLV
parameters as well as the length of the shared secret itself, while other CMS calculate the MIC value
only over the length of the registration TLV parameters. The Cisco CMTS attempts to verify the MIC
and shared secret values using the first technique, and if that fails, the CMTS then uses the second
technique to verify the CM.
Jun 28 12:17:36.171: Registration request from 00c0.abcd.ef01, SID 58 on Cable5/0/U0
Jun 28 12:17:36.171: Found Network Access TLV
Jun 28 12:17:36.171: Found Class Of Service TLV Block
Jun 28 12:17:36.171: Found Max CPEs TLV
Jun 28 12:17:36.171: Found TFTP Server Provisioned CM Address TLV
Jun 28 12:17:36.171: Found CM-MIC TLV
Jun 28 12:17:36.171: Found CMTS-MIC TLV
Jun 28 12:17:36.171: Found Modem Capabilities TLV
Jun 28 12:17:36.171: Found CM IP Address TLV
Jun 28 12:17:36.171: Computing CMTS-MIC to validate REG-REQ data.
Jun 28 12:17:36.171: CMTS_MIC(rfc2104) failed text + key
Jun 28 12:17:36.171: CMTS_MIC(rfc2104) passed
Jun 28 12:17:36.171: REG-RSP Status : ok (0)
Jun 28 12:17:36.171: Registration Response Transmitted
The following example shows typical output when a CM attempts to come online without downloading
a DOCSIS configuration file from a TFTP server through the Cisco CMTS cable interface, when the
cable tftp-enforce command has been used.
Router# debug cable interface c3/0 verbose
Router# debug cable registration
CMTS registration debugging is on
Tip To monitor a specific CM when it comes online, use the debug cable mac-address, debug cable
mac-protocol, and debug cable registration commands.
Examples The following example shows typical debugging output for a successful poll of the CMs:
router# debug cable remote-query
remote-query debugging is on
.
For IP address 209.165.200.223
Nov 10 15:56:50.241: docsIfSignalQualityEntry.5.4 = 380
Nov 10 15:56:50.241: docsIfMibObjects.2.2.1.3.2 = 360
Nov 10 15:56:50.245: docsIfDownstreamChannelEntry.6.4 = -30
Nov 10 15:56:50.245: docsIfUpstreamChannelEntry.6.3 = 12422
Nov 10 15:56:50.249: docsIfSignalQualityEntry.6.4 = 0
Nov 10 15:56:50.477:
The following example shows typical debugging output when the waiting queue at the CMTS is empty:
SNMP proxy exec got event, but queue is empty
The following example shows typical debugging output when you try to modify the polling interval or
community string while the polling in is progress:
Community string if modified will not be reflected
Note The polling interval will be changed but to change the community string, you must unconfigure
the snmp-server community command and reconfigure it with the new community string.
Usage Guidelines This command activates display of reset messages from cable interfaces.
Examples The following shows typical output from the debug cable reset command:
Router# debug cable reset
CMTS reset debugging is on
Router#
Usage Guidelines This command displays debugging messages when the counters in the DOCSIS-IF-MIB are updated.
Note For more information about the information displayed by this command, see RFC 2670 and the
DOCS-IF-MIB MIB at the following URL:
http://www.cisco.com/go/mibs
Examples The following shows typical output from the debug cable rfmib command:
Router# debug cable rfmib
CMTS RFMIB debugging is on
Router#
Cable7/0/0 DS
cur_snmp_ifOutOctets 29282580
cur_snmp_total_bytes 3348841605
last_snmp_ifOutOctets 27327636
last_snmp_total_bytes 3126121018
Cable7/0/0 DS, delta_outoctets 1954944, delta_total_bytes 222720587, chan_utilization 1
Cable7/0/0 US 2
cur_snmp_total_ms 36065552
cur_snmp_ucast_grnt_ms 11287
cur_snmp_used_cntn_ms 1238
last_snmp_total_ms 33665428
last_snmp_ucast_grnt_ms 10807
last_snmp_used_cntn_ms 1238
Cable7/0/0 US 2 delta_total_ms 2400124, delta_ucast_grnt_ms 480, delta_used_cntn_ms 0,
chan_utilization 0
Usage Guidelines This command activates debugging of spectrum management (frequency agility) on the HFC network.
When this command is activated, any messages generated due to spectrum group activity will be
displayed on the Cisco CMTS console. Spectrum group activity can be additions or changes to spectrum
groups, or frequency and power lever changes controlled by spectrum groups.
Examples The following shows sample output from the debug cable specmgmt command:
Router# debug cable specmgmt
CMTS specmgmt debugging is on
Router#
reassign-blind: U0 not present or shutdown
Usage Guidelines This command activates debugging of the channel allocations on the HFC network. When this command
is activated, any messages generated when channels are allocated to CMs on the HFC network are
displayed on the Cisco CMTS console.
Caution This command should be used for development testing only, not in production setting.
Examples The following shows sample output from the debug cable startalloc command:
Router# debug cable startalloc
Router#
00:53:27: Cable3/U0 MAP startalloc adjusted by 1 mslots
00:53:27: Cable4/U0 MAP startalloc adjusted by 3 mslots
00:53:27: Cable3/U0 MAP startalloc adjusted by 5 mslots
00:53:27: Cable4/U0 MAP startalloc adjusted by 4 mslots
00:53:28: Cable3/U0 MAP startalloc adjusted by 4 mslots
00:53:28: Cable4/U0 MAP startalloc adjusted by 5 mslots
Usage Guidelines
Tip Because this command can produce a large volume of debug information, use this command only when
you have also enabled debugging for a particular interface or MAC address, using the debug cable
interface and debug cable mac-address commands, respectively.
Examples The following example shows how to enable debugging output using the debug cable
subscriber-monitoring command:
Router# debug cable subscriber-monitoring
Command Description
debug cable Enables debugging output for the cable modems that match the specified
mac-address hardware (MAC) address or range of addresses.
show cable qos Displays the quality of service (QoS) enforce-rules that are currently
enforce-rule defined.
Usage Guidelines This command is supported only in images that support telco-return operation (-t-).
Examples The following is sample output from the debug cable telco-return and debug cable telco-return msg
commands:
Router# debug cable telco-return
Router# debug cable telco-return msg
01:17:31:Sending TCD message:
TLV type = 1
TLV len = 56
Factory default flag: 1
Phone number 1: 5551212
Service provider name:uBR7246
Connection threshold: 10
Username: guest
Password: password
DHCP authenticate: 1
DHCP server: 10.10.255.255
PPP authentication: 2
Manual dial: 1
Sending TSI message:
DS channel IP address: 10.10.10.10
Registration IP address:10.10.10.10
CMTS boot time: 3080626752
DS channel ID: 0
Epoch: 1
Usage Guidelines This command is supported only in images that support telco-return operation (-t-).
Examples The following is sample output from the debug cable telco-return msg command:
Router# debug cable telco-return
Router# debug cable telco-return msg
01:17:31:Sending TCD message:
TLV type = 1
TLV len = 56
Factory default flag: 1
Phone number 1: 5551212
Service provider name:uBR7246
Connection threshold: 10
Username: guest
Password: password
DHCP authenticate: 1
DHCP server: 10.10.255.255
PPP authentication: 2
Manual dial: 1
Sending TSI message:
DS channel IP address: 10.10.10.10
Registration IP address:10.10.10.10
CMTS boot time: 3080626752
DS channel ID: 0
Epoch: 1
Usage Guidelines This command displays the TLVs for service flow encodings, classifier encodings, and PHS rules. Do
not use this command when you have a large number of active CMs on your network because it could
generate a huge amount of output to the console port.
Examples The following example shows typical output for the debug cable tlvs command:
Router# debug cable tlvs
CMTS TLV encodings debugging is on
Related Commands debug cable dynsrv Displays debugging information about DOCSIS 1.1 dynamic service
flow messages.
debug cable interface Enables debugging on a specific cable interface.
debug cable mac-address Enables debugging for MAC-layer information for a specific CM.
Usage Guidelines This command displays information about the operation of the ToD server that is onboard the
Cisco CMTS. Before this command will display any output, you must also use the debug cable
interface command to enable debugging operations on each interface that has CMs you wish to monitor.
Examples The following example shows typical output for the debug cable tod command:
Router# debug cable interface c3/0
Router# debug cable tod
TOD server debugging is on
Router#
For telco-return CMs, the ToD server verifies that the IP address for the CM making the ToD request is
on the correct cable interface, so as to prevent IP spoofing. If the IP address and interface do not match,
the following message is printed:
000104: Jun 8 05:48:08.783: tod: Cant match output i/f for telco return
Related Commands debug cable interface Enables debugging on a specific cable interface.
debug cable mac-address Enables debugging for MAC-layer information for a specific CM.
Examples The following command enables debugging of messages that the CMTS transmits on the cable interface:
Router# debug cable transmit
CMTS debug transmit debugging is on
Router#
The debug cable transmit command was disabled in Cisco IOS Release 12.1 T, 12.1 EC, and later
releases, although it still appears in the CLI until Cisco IOS Release 12.1(11b)EC. To monitor the
packets transmitted by the CMs, use the debug ip packet command instead.
Because the debug ip packet command produces a large volume of messages, you must use it together
with an access list to restrict the messages to a particular CM or CPE device to avoid affecting system
performance. For example, the following commands would set up an access list that monitors all traffic
being sent between the hosts with the two specified IP addresses:
router# configure terminal
router(config)# access-list 150 permit ip host ip-address-1 host ip-address-2
router(config)# access-list 150 permit ip host ip-address-2 host ip-address-1
router(config)# exit
router# debug ip packet 150 detail
Usage Guidelines This command activates debugging of any upstream channel change (UCC) messages generated when
CMs request or are assigned a new channel. When this command is activated, any messages related to
upstream channel changes are displayed on the Cisco CMTS console.
Examples The following is typical output from the debug cable ucc command:
Router# debug cable ucc
Router#
SID 2 has been registered
Mac Address of CM for UCC
00:0E:1D:D8:52:16
UCC Message Sent to CM
Changing SID 2 from upstream channel 1 to upstream channel 2
Usage Guidelines This command activates debugging of any upstream channel descriptor (UCD) messages. UCD messages
contain information about upstream channel characteristics and are sent to the CMs on the HFC network.
Cable modems that are configured to use enhanced upstream channels use these UCD messages to
identify and select an enhanced upstream channel to use. When this command is activated, any messages
related to upstream channel descriptors are displayed on the Cisco CMTS console.
Examples The following is typical output from the debug cable ucd command:
UCD MESSAGE
-----------
FRAME HEADER
FC - 0xC2 ==
MAC_PARM - 0x00
LEN - 0xD3
MAC MANAGEMENT MESSAGE HEADER
DA - 01E0.2F00.0001
SA - 0009.0CEF.3730
msg LEN - C1
DSAP - 0
SSAP t - 0
control - 03
version - 01
type - 02 ==
US Channel ID - 1
Configuration Change Count - 5
Mini-Slot Size - 4
DS Channel ID - 1
Symbol Rate - 8
Frequency - 10000000
Preamble Pattern - CC CC CC CC CC CC CC CC CC CC CC CC CC
CC 0D 0D
Burst Descriptor 0
Interval Usage Code - 1
Modulation Type - 1 == QPSK
Usage Guidelines This command activates hardware debugging of the internal upconverter that is onboard the
Cisco uBR7100 series or the Cisco uBR10-MC5X20S cable interface line card on the Cisco uBR10012
router.
Examples The following command shows how to enable the debug cable upconverter output:
Router# debug cable upconverter
Upconverter programming debugging is on
Router# config t
Router(config)# int c1/0
Router(config-if)# no cable downstream rf-shutdown
Ack failed from upconverter
Card does not have upconverter?
Error in upconverter!
Router(config-if)#
Examples The following command shows how to enable debugging output for upstream admission control:
Router# debug cable us-adm-ctrl
CMTS upstream admission control debugging is on
The following are the debug messages that are displayed when the CMTS does not have an admission
policy, scheduling instance, or service class for a registering CM:
Null service class
Null admission policy
Null scheduler instance
The CMTS displays the following debug message when a CM requests a scheduling type that is either
not defined, not recognized, or not supported:
Undefined scheduling Type
debug checkpoint
To enable debugging of the Checkpointing Facility (CF) subsystem on the Cisco uBR10012 router, use
the debug checkpoint command in privileged EXEC mode. To disable debugging output, use the no
form of the command.
Usage Guidelines The debug checkpoint command enables debugging of the Checkpoint Facility (CF) subsystem, which
passes messages from the Active processor to the Standby processor. It also handles sequencing and
throttling, as needed, during redundancy operations.
Examples The following example shows how to enable debugging messages for the CF subsystem:
Router# debug checkpoint
Router#
debug cr10k-rp
To enable debugging of the subsystems on the active Performance Routing Engine (PRE1) module on
the Cisco uBR10012 router, use the debug cr10k-rp pkt command in privileged EXEC mode. To disable
debugging output, use the no form of the command.
debug cr10k-rp [cli | drv | ha-all | ha-error | ha-msg | ha-recovery | ha-timing | ipc | oir | pkt
[conditional [peek byte] ] | sid | spec]
no debug cr10k-rp [cli | drv | ha-all | ha-error | ha-msg | ha-recovery | ha-timing | ipc | oir | pkt
[conditional [peek byte] ] | sid | spec]
Syntax Description cli (Optional) Displays debugging messages for the command-line interface
(CLI) commands run on the processor.
drv (Optional) Displays debugging messages for the processor’s driver software.
ha-all (Optional) Displays debugging messages related to High Availability (HA)
redundancy events.
ha-error (Optional) Displays debugging messages about errors related to the recovery
of cable modems during HA switchovers.
ha-msg (Optional) Displays debugging messages for HA bulk synchronization
operations.
ha-recovery (Optional) Displays debugging messages related to the recovery operations
for cable modems after HA switchovers. In particular, these messages
concern the recovery of high-priority cable modems that have voice calls.
ha-timing (Optional) Displays debugging messages related to HA timing events.
ipc (Optional) Displays debugging messages for the processor’s interprocess
communications (IPC) system.
oir (Optional) Displays debugging messages for online insertion and removal
(OIR) operations.
pkt (Optional) Displays debugging messages for the packets that the PRE1
module processes.
conditional (Optional) Enables conditional debugging for the packets processed by the
PRE1 module.
peek byte (Optional) Specifies that debugging should show the value for a specific byte
in each packet processed by the PRE. The valid range for byte is 1 to 120.
sid (Optional) Displays debugging messages for the service IDs (SIDs)
processed by the PRE1 module.
spec (Optional) Displays debugging messages for spectrum management
operations.
Usage Guidelines The debug cr10k-rp pkt command enables debugging of the different subsystems that are active on the
PRE1 modules in the Cisco uBR10012 router. You can perform general debugging by giving the
command without any options, or you can limit the debugging output to a specific subsystem by
specifying one of the optional keywords.
In Cisco IOS Release 12.2(11)BC2 and later releases, you can use the conditional option, together with
the debug cable mac-address and debug cable interface commands, to display information about
selected packets. The command will display only those packets that match the specified cable interface
or MAC address options.
Together with the conditional option, you can also optionally specify the peek keyword to create
specifically match only those packets that contain a matching MAC address at the specified location in
the datagram. This can be useful for examining certain types of packets, such as DHCP or ARP packets.
Examples The following example shows typical output for CLI debugging messages:
Router# debug cr10k-rp cli
The following example shows typical output for IPC debugging messages:
Router# debug cr10k-rp ipc
00:03:15: RP 0 0 0
00:03:15: SIC 0 0 0
00:03:15: LC 0 0 0
The following example shows typical output for IPC debugging messages when you are shutting down
and reenabling a cable interface:
Router# debug cr10k-rp ipc
Router(config-if)# no shutdown
The following example shows a typical display for the debug cr10k-rp pkt conditional command,
which displays packets for SID 2 on cable interface 6/1/0:
Router# debug cable interface c6/1/0 sid 2
Router# debug cr10k-rp pkt conditional
Router# show debug
CR10K PACKET:
Dump cr10k packets to/from RP conditionally
The following example shows how to enable conditional debugging of packets, displaying only those
packets that contain the desired mac address at byte 92 in the datagram:
Router# debug cr10k-rp pkt conditional peek 92
Router# debug cable interface c6/1/0 mac-address 00C0.abcd.ef00
Router# show debug
CR10K PACKET:
Dump cr10k packets to/from RP conditionally
Additionally, peeking inside transmitted pkts at offset 92
Both types of packet debugging generate output similar to the following example:
Jun 19 13:07:32.316: RPTX: Using Downstream Service Flow ID : 16939, SID : 2 V5
Table 5-6 explains the information contained in the display for each packet:
Field Description
RPIX: Using Downstream Displays the service flow ID (SFID) for this packet.
Service Flow ID
SID Displays the service ID (SID) for this packet.
RPTX or RPRX Displays whether this packet is transmitted (RPTX) or received
(RPRX) by the processor.
Size Displays the size of the packet’s datagram in decimal.
Packet Dump Displays the first 96 bytes of the packet’s datagram in hexadecimal.
The command then displays an ellipses (. . .) if the datagram is larger
than 96 bytes.
The following example shows typical output for SID debugging messages:
Router# debug cr10k-rp sid
The following example shows typical output for spectrum management debugging messages for a
particular interface:
Router# debug cable interface c6/1/0 sid 2
Router# debug cr10k-rp pkt spec
The following lists the typical messages that are displayed by the ha-all option.
PRE Redundancy: failed to get RF buf to send msg to peer
PRE Redundancy: failed to send RF buf to peer
PRE REDUNDANCY: bulk sync in progress
PRE REDUNDANCY: Got RF message when not in Active state.
RP DS SRV FLOW packet sanity check... ok.
Failed to find DS SF with sfid 321
Deleting an old inter_rp_ds_srv_flow
Adding a new inter_rp_ds_srv_flow
Updating an inter_rp_ds_srv_flow
Processing inter_rp_ds_srv_flow
cr10k_rp_ha_parse_sync: Received Packet of 122 len
cr10k_rp_ha_parse_sync:Received
Synching cm instance
CR10K HA: Standby recv chkpt msg
PRE REDUNDANCY: NO Resources
PRE REDUNDANCY: RF_PROG_STANDBY_BULK received
PRE REDUNDANCY:This is standby from boot
PRE REDUNDANCY: RF_PROG_ACTIVE_FAST received
The following example shows the typical messages for the ha-timing option. These messages show the
total time it takes to synchronize all of the cable modems on a cable interface after a switchover, as well
as the total time it takes for all cable modems to recover and come online. These messages also show the
total time it took the HCCP and DOCSIS protocol subsystems to synchronize after a switchover.
Router# debug cable interface c6/1/0
Router# debug cr10k-rp ha-timing
The following example shows the typical messages for the ha-msg option. These messages show the
total time it takes to synchronize all of the cable modems on a cable interface after a switchover, as well
as the total time it takes for all cable modems to recover and come online. These messages also show the
total time it took the HCCP and DOCSIS protocol subsystems to synchronize after a switchover.
Router# debug cable interface c6/1/0
Router# debug cr10k-rp ha-msg
PRE_HA_BUGMSG
PRE REDUNDANCY: Bulk sync completed
PRE REDUNDANCY: Recv bulk sync complete - sending ack
The following example shows the typical messages for the ha-recovery option. The following messages
show the typical recovery process, in which cable modems with active voice calls are recovered first.
After these cable modems are online, the remaining, data-only cable modems are recovered.
PRE_RECOVERY: <Cable I/F> Received message to recover voice
PRE_RECOVERY: Suspending recovery until higher priority modems are recovered
PRE_RECOVERY: All interfaces recovered. Killing the voice process
PRE_RECOVERY: No events in voice queue. Allow data modems to recover
PRE_RECOVERY: <Cable I/F> Resume data recovery after suspend (modems recovered <# of CMs>)
PRE_RECOVERY:<Cable I/F> Received message to recover data
PRE_RECOVERY: All interfaces recovered. Killing the data process
The following are possible messages that can be displayed because of potential error conditions:
PRE_RECOVERY:<Cable I/F> No modems to be recovered
PRE_HA:<Cable I/F> Unable to start the voice recovery process
PRE_HA: <Cable I/F> Unable to start the data recovery process
Usage Guidelines You must use the debug hccp events command before the debug hccp authentication command will
generate any debug message output.
Examples The following example shows the additional 1+1 redundancy authentication debug message output
produced when the debug hccp authentication command has been activated:
Router# debug hccp events
Router# debug hccp authentication
Command Description
debug hccp sync Displays debug messages for HCCP synchronization messages.
debug hccp timing Displays debug messages for the timing of HCCP events.
Usage Guidelines The debug hccp channel-switch command displays debugging messages related to the SNMP messages
and other communication between the CMTS and an RF-switch or channel-switch during N+1 (1:n)
HCCP operations.
Note You must use the debug hccp events command to activate HCCP event debugging before the debug
hccp channel-switch command will generate any debug output.
Examples The following example shows typical output for the debug hccp channel-switch command:
Router# debug hccp events
Router# debug hccp channel-switch
Usage Guidelines The debug hccp docsis-recovery command displays debugging messages about the recovery of CMs
during N+1 (1:n) HCCP operations.
Note You must use the debug hccp events command to activate HCCP event debugging before the debug
hccp docsis-recovery command will generate any debug output.
Examples The following example shows typical output for the debug hccp docsis-recovery command:
Router# debug hccp events
Router# debug hccp docsis-recovery
Usage Guidelines You must use the debug hccp events command to activate HCCP debugging before the other debug
hccp commands will display debugging output.
Examples The following example shows HCCP group interaction debug message output produced when the debug
hccp events command has been activated:
Router# debug hccp events
Usage Guidelines The debug hccp fast-failure-detection command displays debugging messages about the operation of
sync pulse messages for FFD support during N+1 (1:n) HCCP operations. A Working interface sends
these sync pulse messages upon a failure to proactively inform the Protect interface that a switchover is
occurring.
Note You must use the debug hccp events command to activate HCCP event debugging before the debug
hccp fast-failure-detection command will generate any debug output.
Examples The following example shows typical FFD debugging messages that are displayed by the debug hccp
fast-failure-detection command:
Router# debug hccp events
Router# debug hccp fast-failure-detection
HCCP: FFD cutover packet address updated: src = 10.10.10.3, dst = 10.10.10.4
HCCP: FFD cutover packet allocated!
Command Description
debug hccp plane Displays debug messages for HCCP-related messages sent between the
router’s control plane and data backplane.
debug hccp sync Displays debug messages for HCCP synchronization messages.
debug hccp timing Displays debug messages for the timing of HCCP events.
Syntax Description error Display debugging messages related to database errors that occur.
events Display debugging messages related to all events that occur during database
operations.
Usage Guidelines You must use the debug hccp events command before the debug hccp inter-db command will generate
any debug message output.
Examples The following example shows typical debug output for the debug hccp inter-db error command:
Router# debug hccp events
Router# debug hccp inter-db error
The following example shows typical debug output for the debug hccp inter-db events command:
Router# debug hccp events
Router# debug hccp inter-db events
Syntax Description message Display debugging messages for the inter-plane messages that occur.
packet Display a partial dump of packets that are sent between the control plane and
data backplane.
syncpulse Display debugging messages related to the “heartbeat” packets that are sent
between the control plane and data backplane to synchronize events.
Usage Guidelines The processor card and line cards on the Cisco uBR10012 router chassis communicate with each other
using the control plane (which is on the processor card) and the data backplane (the backplane into which
the line cards are installed). The debug hccp plane command displays debugging messages related to
the messages and packets that are transmitted between the control plane and data backplane.
Note You must use the debug hccp events command to activate HCCP event debugging before the debug
hccp plane command will generate any debug output.
Examples The following example shows typical output that is produced by the debug hccp plane message
command:
Router# debug hccp events
Router# debug hccp plane message
Mar 7 08:47:26.513: HCCP 4 Protect 81: Data plane sending message FAILURE_SYNCPULSE
Mar 7 08:47:26.513: HCCP 1 Protect 80: Data plane received message BECOME_ACTIVE_STRUCT
Mar 7 08:47:26.513: HCCP 2 Working 1: Control plane sending message STOP_SYNC
Mar 7 08:47:26.513: HCCP 1 Protect Cable8/1/0: Data plane received message FORWARDING
Mar 7 08:47:26.513: HCCP 1 Protect 1: Control plane sending message INIT_DS
Mar 7 08:47:26.513: HCCP 1 Protect 3: Control plane sending message INIT_DS
Mar 7 08:47:26.513: HCCP 2 Protect 5: Control plane sending message INIT_DS
Mar 7 08:47:26.513: HCCP 1 Protect Cable5/1/0: Control plane sending message READY
Mar 7 08:47:26.513: HCCP 1 Protect 1: Data plane received message START_SYNC
Mar 7 08:47:26.513: HCCP 1 Protect 1: Data plane received message DO_STATICSYNC
Mar 7 08:47:26.513: HCCP 1 Protect 1: Data plane sending message STATICDONE
Mar 7 08:47:26.513: HCCP 2 Protect 1: Data plane received message START_SYNC
Mar 7 08:47:26.513: HCCP 2 Protect 1: Data plane received message DO_STATICSYNC
Mar 7 08:47:26.513: HCCP 2 Protect 1: Data plane sending message STATICDONE
Mar 7 08:47:26.513: HCCP 2 Working 1: Control plane sending message BECOME_ACTIVE_STRUCT
Mar 7 08:47:26.513: HCCP 2 Working Cable5/0/1: Control plane sending message FORWARDING
Mar 7 08:47:26.513: HCCP 2 Protect 1: Control plane sending message STOP_SYNC
Mar 7 08:47:26.513: HCCP 2 Protect 1: Control plane sending message BECOME_STANDBY_STRUCT
Mar 7 08:47:26.513: HCCP 2 Protect Cable5/1/1: Control plane sending message BLOCKING
Mar 7 08:47:26.513: HCCP 2 Protect Cable5/1/1: Control plane sending message READY_NOT
Mar 7 08:47:26.513: HCCP 2 Protect 1: Control plane sending message DEACTIVATE_MEMBER
The following example shows a typical example of the message that is produced by the debug hccp
plane packet command:
Router# debug hccp events
Router# debug hccp plane packet
Aug 2 00:37:24.203: HCCP 1 70 Protect: Data plane receives DOCSIS sync packet
The following example shows a typical example of the message that is produced by the debug hccp
plane syncpulse command:
Router# debug hccp events
Router# debug hccp plane syncpulse
Aug 2 00:37:24.203: HCCP 1 70 Protect: Data plane receives DOCSIS sync packet
Aug 2 00:37:24.203: CMTS HCCP docsis_ver 1, sw_ver 1
Tip Use both the message and syncpulse options to debug heartbeat synchronization problems.
debug hccp sync cable [bpi | classifier | cm | cpe-management | host | phs | qosparam |
ranged-list | service-flow | sid | tlvs | ucd]
no debug hccp sync cable [bpi | classifier | cm | cpe-management | host | phs | qosparam |
ranged-list | service-flow | sid | tlvs | ucd]
Syntax Description cable (Optional) Displays debugging for SYNC messages on the cable interface.
bpi (Optional) Displays debugging for SYNC messages about BPI configuration
and operation.
classifier (Optional) Displays debugging for SYNC messages about classifier
coordination.
cm (Optional) Displays debugging for CM-related SYNC messages.
cpe-management (Optional) Displays debugging for SYNC messages that concern
CPE-related parameters, such as MAX CPE, MAX CPE IP, and max
learnable addresses.
host (Optional) Displays debugging for host-related SYNC messages.
offered-band (Optional) Displays debugging messages for CMTS-generated offered band
messages.
phs (Optional) Displays debugging for SYNC messages about PHS values.
qosparam (Optional) Displays debugging for SYNC messages about QoS and service
templates.
ranged-list (Optional) Displays debugging for SYNC messages about ranged list
messages.
service-flow (Optional) Displays debugging for SYNC messages about service flows.
sid (Optional) Displays debugging for SYNC messages that concern service IDs
(SIDs).
tlvs (Optional) Displays any type, length, or value errors in SYNC messages.
ucd (Optional) Displays debugging for SYNC messages that concern DOCSIS
upstream channel descriptor (UCD) messages.
Release Modification
12.2(11)BC1 Support was added for the N+1 (1:n) RF Switch with the
Cisco uBR7246VXR router.
12.2(15)BC2 The cpe-management option was added.
Usage Guidelines You must activate the debug hccp events command before the debug hccp sync command will generate
any debug message output.
Examples The following example shows typical output for the debug hccp sync command:
Router# debug hccp events
Router# debug hccp sync
The following example shows typical debugging messages for the debug hccp offered-band command:
Router# debug hccp events
Router# debug hccp sync cable offered-band
Syntax Description if-config (Optional) Displays debugging messages showing the timing of the
reconfiguration of cable interfaces during HCCP redundancy operations.
Usage Guidelines You must activate the debug hccp events command before the debug hccp timing command will
generate any debug message output.
Examples The following example shows typical output for the debug hccp timing command:
Router# debug hccp events
Router# debug hccp timing
The following example shows typical output for the debug hccp timing if-config command:
Router# debug hccp events
Router# debug hccp timing if-config
Command Description
debug hccp plane Displays debug messages for HCCP-related messages sent between the
router’s control plane and data backplane.
debug hccp sync Displays debug messages for HCCP synchronization messages.
Syntax Description detail Displays additional debug messages for specific events, such as the content
of PacketCable headers and messages.
Note Release 12.2(15)BC1 removed this option and replaced it with the
verbose option of the debug packetcable subscriber command.
Usage Guidelines This command enables the display of all PacketCable debugging messages, and is equivalent to giving
the other debug packetcable gate commands individually. Use this command to get complete debugging
about a particular event, such as the creation or termination of a call.
In Cisco IOS Release 12.2(15)BC1 and later releases, you must first use the debug packetcable
subscriber command to enable PacketCable debugging for one or more IP addresses before the debug
packetcable all command displays any output.
Note To display detailed debugging output in Cisco IOS Release 12.2(15)BC1 and later releases, use the
verbose option when you enable PacketCable debugging output using the debug packetcable
subscriber command.
Caution This command can generate a significant amount of debugging information, and the volume of this
information could impact system performance on active PacketCable networks. Do not use this
command except in lab or test networks, or where the need to troubleshoot problems makes the impact
on system performance acceptable.
Examples The following example shows typical output for the debug packetcable all command for the events
starting with a call is placed up until the gates go into the committed state:
Router# debug packetcable all
PacketCable Client:
Pktcbl gate control msgs debugging is on
Pktcbl gate coord msgs debugging is on
Pktcbl commit msgs debugging is on
Pktcbl event msgs debugging is on
Pktcbl rsvp-to-docsis msgs debugging is on
Pktcbl gate database changes debugging is on
Router#
Jul 25 14:28:13.442 UTC: PktCbl(cops): Received a COPS DEC message, flags is 0x1
Jul 25 14:28:13.442 UTC: Pktcbl(gcp): Received GATE ALLOC message, tid=0x4
Jul 25 14:28:13.442 UTC: Pktcbl(gdb): Created new Subscriber IE for 3.3.1.3
Jul 25 14:28:13.442 UTC: Pktcbl(gdb): Updated subscriber IE [subs addr: 3.3.1.3, gate: 38]
Jul 25 14:28:13.442 UTC: Pktcbl(gdb): Created gate IE, gateid = 38, total gates: 1
Jul 25 14:28:13.442 UTC: Pktcbl(gdb): Started gate [id 38] timer t0 [30 sec]
Jul 25 14:28:13.442 UTC: Pktcbl(gcp): Building GCP message, added obj TRANSACTION ID ; len:8 padding:0
Jul 25 14:28:13.442 UTC: Pktcbl(gcp): Building GCP message, added obj SUBSCRIBER ID (IPV4); len:8 padding:0
Jul 25 14:28:13.442 UTC: Pktcbl(gcp): Building GCP message, added obj GATE ID ; len:8 padding:0
Jul 25 14:28:13.442 UTC: Pktcbl(gcp): Building GCP message, added obj ACTIVITY COUNT ; len:8 padding:0
Jul 25 14:28:13.442 UTC: Pktcbl(gcp): Building GCP message, added obj GCOORD PORT ; len:8 padding:0
Jul 25 14:28:13.442 UTC: Pktcbl(gcp): Built GCP message, GATE ALLOC ACK , length: 40, copsLen 68
Jul 25 14:28:13.658 UTC: PktCbl(cops): Received a COPS DEC message, flags is 0x1
Jul 25 14:28:13.658 UTC: Pktcbl(gcp): Received GATE SET message, tid=0x6
Jul 25 14:28:13.658 UTC: Pktcbl(gdb): request to transition gate ID 38 to state 2
Jul 25 14:28:13.658 UTC: Pktcbl(gdb): GateID: 38, changed state to: 2
Jul 25 14:28:13.658 UTC: Pktcbl(gdb): request to transition gate ID 38 to state 2
Jul 25 14:28:13.658 UTC: Pktcbl(gdb): Stopped gate [id 38] timer [type 1]
Jul 25 14:28:13.658 UTC: Pktcbl(gdb): Started gate [id 38] timer t1 [180000 msec]
Jul 25 14:28:13.658 UTC: Pktcbl(gcp): Building GCP message, added obj TRANSACTION ID ; len:8 padding:0
Jul 25 14:28:13.658 UTC: Pktcbl(gcp): Building GCP message, added obj SUBSCRIBER ID (IPV4); len:8 padding:0
Jul 25 14:28:13.658 UTC: Pktcbl(gcp): Building GCP message, added obj GATE ID ; len:8 padding:0
Jul 25 14:28:13.658 UTC: Pktcbl(gcp): Building GCP message, added obj ACTIVITY COUNT ; len:8 padding:0
Jul 25 14:28:13.658 UTC: Pktcbl(gcp): Built GCP message, GATE SET ACK , length: 32, copsLen 60
Jul 25 14:28:13.822 UTC: PktCbl(d2r): DSA-REQ received, gateid: 38
Jul 25 14:28:13.822 UTC: Pktcbl(gdb): handle=38 dir=0 type=3 (get gate flowspec)
Jul 25 14:28:13.822 UTC: Pktcbl(gdb): handle=38 dir=1 type=2 (get gate flowspec)
Jul 25 14:28:13.822 UTC: Pktcbl(gdb): handle=38 dir=0 type=2 (get gate flowspec)
Jul 25 14:28:13.822 UTC: Pktcbl(gdb): handle=38 dir=1 type=3 spec=61DA13A8 (set gate flowspec)
Jul 25 14:28:13.822 UTC: Pktcbl(gdb): handle=38 dir=0 type=3 spec=61DA13C4 (set gate flowspec)
Jul 25 14:28:13.822 UTC: Pktcbl(gdb): request to transition gate ID 38 to state 3
Jul 25 14:28:13.822 UTC: Pktcbl(gdb): GateID: 38, changed state to: 3
Jul 25 14:28:13.826 UTC: Pktcbl(em): Send msg: type=QOS_RESERVE dqos=0x628DE278
Jul 25 14:28:13.834 UTC: Pktcbl(gdb): Get gate spec info, handle=38 dir=0 spec=61DA1420
Jul 25 14:28:23.950 UTC: Pktcbl(g2g): received GATE_OPEN message, tid 2
Jul 25 14:28:23.950 UTC: Pktcbl(g2g): sending g2g GATE_OPEN_ACK message to 192.168.80.15:1812 from
192.168.80.1:50048
Jul 25 14:28:23.950 UTC: Pktcbl(gdb): request to transition gate ID 38 to state 5
Jul 25 14:28:23.950 UTC: Pktcbl(gdb): GateID: 38, changed state to: 5
Jul 25 14:28:23.950 UTC: Pktcbl(gdb): Started gate [id 38] timert2 [2000 ms]
Jul 25 14:28:24.030 UTC: Pktcbl(gdb): Get gate spec info, handle=38 dir=1 spec=61DA1268
Jul 25 14:28:24.034 UTC: PktCbl(d2r): DSC-REQ received, gateid: 38
Jul 25 14:28:24.034 UTC: Pktcbl(gdb): Get gate spec info, handle=38 dir=0 spec=61DA1308
Jul 25 14:28:24.034 UTC: Pktcbl(gdb): handle=38 dir=0 type=6 (get gate flowspec)
Jul 25 14:28:24.034 UTC: Pktcbl(gdb): handle=38 dir=1 type=3 (get gate flowspec)
Jul 25 14:28:24.034 UTC: Pktcbl(gdb): handle=38 dir=0 type=3 (get gate flowspec)
Jul 25 14:28:24.034 UTC: Pktcbl(gdb): handle=38 dir=1 type=6 spec=61DA13A8 (set gate flowspec)
Jul 25 14:28:24.034 UTC: Pktcbl(gdb): handle=38 dir=0 type=6 spec=61DA13C4 (set gate flowspec)
Jul 25 14:28:24.034 UTC: Pktcbl(gdb): request to transition gate ID 38 to state 4
Router#
Command Description
debug packetcable ipc Enables interprocess communications (IPC) messages related to
PacketCable operations on the Cisco uBR10012 router.
debug packetcable Enables PacketCable debugging for a specific subscriber IP address.
subscriber
Usage Guidelines This command enables debugging for the COPS messages and errors that are related to PacketCable
operations. It produces output that is similar to the debug cops command, except that the output for this
command is limited to the use of the COPS protocol to support PacketCable connections.
Examples The following example shows typical debugging output for the debug packetcable cops command:
Router# debug packetcable cops
Pktcbl COPS msgs debugging is on
Router#
Aug 21 12:43:41 UTC: PktCbl(cops): Received callback [code 7, handle: 0x64911528] from
COPS engine
Aug 21 12:43:41 UTC: PktCbl(cops): Remove GC (64911528)
Aug 21 12:43:42 UTC: PktCbl(cops): Received callback [code 8, handle: 0x64463AA4] from
COPS engine
Aug 21 12:43:42 UTC: PktCbl(cops): Incoming TCP connect from GC (1.10.90.1)
Aug 21 12:43:42 UTC: PktCbl(cops): Received callback [code 4, handle: 0x64463AA4] from
COPS engine
Aug 21 12:43:42 UTC: PktCbl(cops): Received COPS CLIENT_ACCEPT [tcp handle: 0x64463AA4]
Syntax Description commit Displays debugging messages for the commit events on each gate.
control Displays debugging messages for gate control events (allocation, set, and
delete).
coordination Displays debugging messages for gate coordination events (gate close and
open) (not supported in Release 12.2(15)BC1 and later releases).
database Displays debugging messages for all updates to the gate database, including
gate creation and deletion, state transitions, and structure updates.
docsis-mapping Displays debugging messages for the mapping between PacketCable and
Data-over-Cable System Interface Specification (DOCSIS) parameters.
events Displays debugging messages for the event messages that are sent during a
voice call.
process (Optional) Displays non-subscriber-related process event messages
(available only when using the events option).
detail Displays additional debug messages for specific events, such as the contents
of a PacketCable headers and messages.
Note Release 12.2(15)BC1 removed this option and replaced it with the
verbose option of the debug packetcable subscriber command.
Usage Guidelines Use this command to enable debugging for the individual PacketCable functional systems on the
Cisco CMTS. As a general rule, selectively use these commands to debug or troubleshoot problems
instead of turning on all debugging with the debug packetcable all command.
In Cisco IOS Release 12.2(15)BC1 and later, you must also enable debugging for one or more IP
addresses, using the debug packetcable subscriber command, before the debug packetcable gate
command displays any output. The debug packetcable gate events process command is an exception
to this, however, because it does not display subscriber-related information.
Note The debug packetcable all command is equivalent to repeatedly giving the debug packetcable gate
command with each of its possible options.
Tip To display detailed debugging output in Cisco IOS Release 12.2(15)BC1 and later releases, use the
verbose option when you enable PacketCable debugging output using the debug packetcable
subscriber command.
Examples This section shows typical examples for each type of debugging message.
Note The coordination option was removed in Cisco IOS Release 12.2(15)BC1.
Note The GATE_OPEN and GATE_CLOSE messages show the gate ID of the remote gate, not the local gate.
Jul 25 16:17:29 UTC: Pktcbl(gdb): Allocated gateid 2359392 0x240060 (bucket 0x24, 0x60)
Jul 25 16:17:29 UTC: Pktcbl(gdb): Created new Subscriber IE for 192.168.78.19
Jul 25 16:17:29 UTC: Pktcbl(gdb): Updated subscriber IE [subs addr: 192.168.78.19, gate:
2359392]
Jul 25 16:17:29 UTC: Pktcbl(gdb): Created gate IE, gateid = 2359392, total gates: 1
Jul 25 16:17:29 UTC: Pktcbl(gdb): Started gate [id 2359392] timer t0 [30 sec]
Jul 25 16:17:29 UTC: Pktcbl(gdb): Allocated gateid 2430632 0x2516A8 (bucket 0x25, 0x16A8)
Jul 25 16:17:29 UTC: Pktcbl(gdb): Created new Subscriber IE for 192.168.78.21
Jul 25 16:17:29 UTC: Pktcbl(gdb): Updated subscriber IE [subs addr: 192.168.78.21, gate:
2430632]
Jul 25 16:17:29 UTC: Pktcbl(gdb): Created gate IE, gateid = 2430632, total gates: 2
Jul 25 16:17:29 UTC: Pktcbl(gdb): Started gate [id 2430632] timer t0 [30 sec]
Jul 25 16:17:29 UTC: Pktcbl(gdb): request to transition gate ID 2430632 direction
downstream to state 2
Jul 25 16:17:29 UTC: Pktcbl(gdb): request to transition gate ID 2430632 direction
downstream to state 2
Jul 25 16:17:29 UTC: Pktcbl(gdb): request to transition gate ID 2430632 direction
downstream to state 2
Jul 25 16:17:29 UTC: Pktcbl(gdb): Stopped gate [id 2430632] timer [type 1]
Jul 25 16:17:29 UTC: Pktcbl(gdb): Started gate [id 2430632] timer t1 [300 sec]
Jul 25 16:17:29 UTC: Pktcbl(gdb): request to transition gate ID 2359392 direction
downstream to state 2
Jul 25 16:17:29 UTC: Pktcbl(gdb): request to transition gate ID 2359392 direction
downstream to state 2
Jul 25 16:17:29 UTC: Pktcbl(gdb): request to transition gate ID 2359392 direction
downstream to state 2
Jul 25 16:17:29 UTC: Pktcbl(gdb): Stopped gate [id 2359392] timer [type 1]
Jul 25 16:17:29 UTC: Pktcbl(gdb): Started gate [id 2359392] timer t1 [300 sec]
Jul 25 16:17:29 UTC: Pktcbl(gdb): request to set gate state to 3 in upstream direction for
gate handle 622D3650
Jul 25 16:17:29 UTC: Pktcbl(gdb): request to transition gate ID 2430632 direction upstream
to state 3
Jul 25 16:17:29 UTC: Pktcbl(gdb): request to set gate state to 3 in downstream direction
for gate handle 622D3650
Jul 25 16:17:29 UTC: Pktcbl(gdb): request to transition gate ID 2430632 direction
downstream to state 3
Jul 25 16:17:29 UTC: Pktcbl(gdb): request to set gate state to 3 in upstream direction for
gate handle 622C3EF8
Jul 25 16:17:29 UTC: Pktcbl(gdb): request to transition gate ID 2359392 direction upstream
to state 3
Jul 25 16:17:29 UTC: Pktcbl(gdb): request to set gate state to 3 in downstream direction
for gate handle 622C3EF8
Jul 25 16:17:29 UTC: Pktcbl(gdb): request to transition gate ID 2359392 direction
downstream to state 3
Jul 25 16:17:29 UTC: Pktcbl(gdb): request to transition gate ID 2430632 direction upstream
to state 4
Jul 25 16:17:29 UTC: Pktcbl(gdb): Started gate [id 2430632] timert2 [2000000 ms]
Jul 25 16:17:29 UTC: Pktcbl(gdb): Started gate [id 2430632] timer t5 [500 msec]
Jul 25 16:17:29 UTC: Pktcbl(gdb): Cancelled gate [id 2430632] timer t1
Jul 25 16:17:29 UTC: Pktcbl(gdb): Cancelled gate [id 2430632] timer t2
Jul 25 16:17:29 UTC: Pktcbl(gdb): Cancelled gate [id 2430632] timer t5
Note Use the debug packetcable events process command to display timing-related information for
PacketCable events.
Usage Guidelines Use this command to enable debugging for events that are related to HCCP redundancy operations that
are related to PacketCable operations on the Cisco CMTS. These debugging messages show errors that
occurred when the Cisco CMTS was synchronizing the PacketCable databases and state information
between the Working and Protect interfaces.
Examples The following example shows a typical debugging message for the debug packetcable hccp command.
Router# debug packetcable hccp
Tip The above debug message indicates that the Cisco CMTS was synchronizing the PacketCable gate
database on the Protect interface at the same time a PacketCable gate was in the process of being created.
Because the gate had not yet been fully initializated, the synchronization of the gate database had
incomplete information about the gate. This is typically a temporary condition that is resolved at the next
synchronization of the interfaces.
Command Description
debug packetcable Enables debugging of Common Open Policy Service (COPS) messages and
cops errors that are related to PacketCable operations on the Cisco CMTS router.
debug packetcable Displays general debugging messages related to specific PacketCable gate
gate events and messages.
debug packetcable ipc Enables interprocess communications (IPC) messages related to
PacketCable operations on the Cisco uBR10012 router.
Usage Guidelines This command enables debugging for the IPC messages that are sent between the PRE1 module and
cable interface line cards on the Cisco uBR10012 router during PacketCable operations. This command
is not supported on the Cisco uBR7200 series router because this router does not use IPC messaging for
PacketCable operations.
Tip On the Cisco uBR10012 router, the debug packetcable ipc command displays some of the debugging
messages that are displayed on other Cisco CMTS platforms by the control option for the debug
packetcable gate command.
Note The debug packetcable ipc command does not display any output until you have also enabled
PacketCable debugging for one or more IP addresses using the debug packetcable subscriber
command.
Examples The following example shows typical debugging output for the debug packetcable ipc command:
Router# debug packetcable subscriber 10.10.10.131
Router# debug packetcable ipc
Debug pktcbl IPC messages debugging is on
Router#
Jul 26 08:51:34 UTC: Pktcbl(ipc): Delete gate [5123] notification sent from Cable 6/1/1 to
RP
Jul 26 08:51:34 UTC: Pktcbl(ipc): Delete gate [5123] IPC received on LC
Jul 26 08:51:34 UTC: Pktcbl(ipc): Gate-set [5123] notification sent from Cable 6/1/1 to RP
Jul 26 08:51:34 UTC: Pktcbl(ipc): Create gate [5126] IPC sent to Cable 6/1/1
Jul 26 08:51:34 UTC: Pktcbl(ipc): Create gate [5126] IPC received on LC
Jul 26 08:51:34 UTC: Pktcbl(ipc): Gate-set response [5126] IPC message received on RP
Jul 26 08:54:17 UTC: Pktcbl(ipc): Create gate [7173] IPC sent to Cable6/1/1
Jul 26 08:54:17 UTC: Pktcbl(ipc): Gate-set [7173] ipc sent to Cable6/1/1
Jul 26 08:54:17 UTC: Pktcbl(ipc): Gate-set response [7173] IPC message received on RP
Syntax Description ip-address IP address for which PacketCable debugging should be enabled.
mask Subnet mask to use for this IP address. The router uses this mask to
determine the scope of the IP addresses to be debugged. The default is
255.255.255.255 to indicate the IP address is a specific, single IP address.
verbose Displays detailed information as part of the debug messages, such as the
contents of a PacketCable headers and messages.
Note The verbose option replaces the detail option that appeared in
previous versions of the other debug packetcable command.
Usage Guidelines This command enables debugging for one or more specific PacketCable subscribers. This command by
itself does not generate any debugging output, but enables debugging output for the other debug
packetcable commands.
In Cisco IOS Release 12.2(15)BC1 and later releases, you must use the debug packet subscriber
command to enable debugging for at least one IP address before the following debug packetcable
commands will generate output:
• debug packetcable gate commit
• debug packetcable gate control
• debug packetcable gate database
• debug packetcable gate docsis-mapping
• debug packetcable gate events
• debug packetcable ipc
Note You do not need to use the debug packetcable subscribe command before using the debug packetcable
cops and debug packetcable gate events process commands because these display information that is
not subscriber-specific.
Examples The following example shows how to enable PacketCable gate control debugging for one specific
PacketCable subscriber at the IP address of 10.10.10.131:
Router# debug packetcable subscriber 10.10.10.131
Router# debug packetcable gate control
Router#
The following example shows how to enable PacketCable events debugging for all PacketCable
subscribers within the 6.6.1.0 subnet:
Router# debug packetcable subscriber 6.6.1.0 255.255.255.0
Router# debug packetcable gate events
Router#
debug pxf
To enable debugging of the Parallel eXpress Forwarding (PXF) subsystems on the active Performance
Routing Engine (PRE1) module on the Cisco uBR10012 router, use the debug pxf command in
privileged EXEC mode. To disable debugging output, use the no form of the command.
Syntax Description dma Displays debugging information for direct memory access (DMA) buffers,
error counters, and registers on the PXF processor.
microcode Disables the automatic reloading of the microcode on the PXF processors
upon a crash or fault condition. (If a fault or crash occurs, you must manually
load the microcode on the PXF processors using the microcode reload
command.)
stats Displays debugging information for the statistics collector events on the PXF
processor.
subblocks Displays debugging information for changes in the subblocks onboard the
PXF processor.
Usage Guidelines The debug pxf command enables debugging of the different subsystems that are active on the PXF
processors that are on the PRE1 modules in the Cisco uBR10012 router.
Also, by default the PRE1 modules automatically reload the microcode on the PXF processors in case
of a crash or fault. The debug pxf microcode command disables this automatic reloading of the
microcode, to allow further debugging. When you have finished debugging the PXF processor, you then
must manually reload the microcode on the PXF processor using the microcode reload command.
Router#
Router#
If a fault or crash then occurs on the PXF processors, the following messages are displayed on the
console to indicate that the automatic reload of the microcode has been disabled and that the microcode
must be manually reloaded using the microcode reload command.
Mar 1 16:29:58.796: %SLICE_TOASTER-4-PXF_CRASHINFO: Writing Slice (PXF) debug information
to slot0:pxf_crashinfo_20020301-212958.
Mar 1 16:30:00.252: NOTE: 'debug pxf microcode' is set. Use 'micro reload pxf' to restart
the PXF
Router#
Router#
debug redundancy
To enable debugging of the Route Processor Redundancy (RPR) feature and its background procedures,
use the debug redundancy command in Privileged EXEC mode.
Syntax Description alarms Enables debugging messages for alarms sent because of redundancy
procedures.
all Enables all redundancy debugging messages.
configsync Enables debugging messages for the synchronization of the configuration
files.
fsm Enables debugging for changes in the redundancy finite state machine
(FSM).
keepalive Enables debugging messages for the keepalive messages sent between
Performance Routing Engine (PRE1) modules.
peer-monitor Enables debugging messages for the standby PRE1 module’s monitoring of
the active PRE1 module.
rf-fsm Enables debugging for changes in the redundancy finite state machine
(FSM).
services Enables debugging for the services requested during redundancy
processing.
timesync Enables debugging messages for time synchronization procedures.
Examples The following example shows all redundancy debugging messages being enabled:
Router# debug redundancy all
Router#
The following example shows typical messages that the debug redundancy alarms command displays:
Router# debug redundancy alarms
The following example shows the typical state changes that the debug redundancy fsm command
displays when the standby PRE1 module is reset:
Router# debug redundancy fsm
The following example shows the messages that are displayed by the debug redundancy keepalive
command:
Router# debug red keepalive
Sent keepalive
Received keepalive
Sent keepalive
Received keepalive
Sent keepalive
Received keepalive
Sent keepalive
Command Description
redundancy Enters redundancy configuration mode.
redundancy Forces a switchover so that the standby PRE1 module becomes the active
force-failover PRE1 module.
main-cpu
This section describes the cable-specific commands available to the family of Cisco cable customer
premises equipment (CPE) devices. See the following sections for more information:
• Supported Platforms and Cisco IOS Releases—Describes the cable CPE platforms and Cisco IOS
releases that support the commands listed in this section.
• Cable CPE Commands—Describes each cable-specific command to change or display the
configuration of a cable CPE device.
• Debug Commands—Describes the cable-specific commands that are needed only when
troubleshooting a cable CPE device and its configuration.
Note Not all platforms support all commands, and support for some commands depends on the specific
Cisco IOS release. See the “Command History” section for each command for a list of the supported
platforms and required Cisco IOS releases.
Many of the related commands mentioned in this chapter are not cable-specific commands and thus are
not described in this section. Also, other platforms support some of these commands with additional
options. For a description of these and other noncable specific-commands, see the command reference
documentation for Cisco IOS Release 12.1, available on Cisco.com and the Documentation CD-ROM.
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Usage Guidelines It is normally not necessary to enter this command in data-over-cable bridging applications because
DOCSIS-compliant bridging is enabled by default. However, to configure the router for full transparent
bridging or for routing mode, use the no form of the command and then configure the router as desired
using the appropriate CLI commands.
Examples The following example shows how to disable DOCSIS-compliant bridging on the cable interface:
Router# configure terminal
Router(config)# interface cable-modem 0
Router(config-if)# no cable-modem compliant bridge
Router(config-if)#
cable-modem dhcp-proxy
To specify that a Dynamic Host Configuration Protocol (DHCP) server should provide an IP address for
the router’s Ethernet interface, for the loopback interface, or for the router’s Network Address
Translation (NAT) address pool, use the cable-modem dhcp-proxy command in cable interface
configuration mode. To disable this feature so that you can then manually assign an IP address to the
Ethernet interface or NAT address pool, use the no form of this command.
Cisco uBR905, Cisco uBR924, Cisco uBR925 Cable Access Routers, and Cisco CVA122 Cable Voice Adapter
Note This command is available only when the router is configured for routing mode and cannot be used when
the router is configured for DOCSIS-compliant bridging.
Syntax Description interface ethernet Identifies the Ethernet interface to be assigned the static IP address from the
number DHCP server (always 0).
interface loopback Identifies the loopback interface to be assigned the static IP address from
number the DHCP server (always 0).
nat pool-name Specifies the name of the NAT pool to be created using the IP address and
subnet mask supplied by the DHCP server. (This option is equivalent to
giving the ip nat pool pool-name start-ip end-ip netmask subnet
command, using the IP address and subnet mask supplied by the DHCP
server.)
Note When replying to the proxy request for the Ethernet interface, the DHCP server should assign an IP
address that is on the same network as the customer premises equipment (CPE) devices that are attached
to the router’s Ethernet interface.
Tip If you have configured a Cisco CM for routing mode and are also using the cable-modem dhcp-proxy
nat command on the CM, you must configure the corresponding cable interface on the Cisco CMTS with
the cable dhcp-giaddr policy command.
The reason is that the default router configuration is for DOCSIS-compliant bridging, which includes
two bridge-group 59 commands for each interface. To use the cable-modem dhcp-proxy command,
you must put the router into routing mode, which means removing the bridge-group commands with the
equivalent no bridge-group commands.
However, because no bridge-group is the default for these CLI commands, they are not saved in the
running configuration. So when you save the Cisco IOS configuration file and copy it to other routers,
the router is only partially configured for routing mode and continually resets its interfaces.
In addition, whenever you use the cable-modem dhcp-proxy command to create a NAT pool, the router
automatically adds the appropriate ip nat pool commands to the configuration when it receives the actual
IP addresses from the DHCP server. The IP addresses specified in this command are particular to each
user and should not be copied to other routers.
To avoid this problem, use the following procedure to create a Cisco IOS configuration file that uses the
cable-modem dhcp-proxy command to create a NAT address pool for NAT/PAT address translation:
For example, the following are the relevant lines in a typical DHCP proxy NAT configuration for a cable
access router:
interface Ethernet0
ip address 192.168.1.1 255.255.255.0
ip nat inside
load-interval 30
!
interface cable-modem0
ip nat outside
load-interval 30
no cable-modem compliant bridge
cable-modem dhcp-proxy nat nat-pool
!
ip nat pool nat-pool 10.15.0.10 10.15.0.10 netmask 255.255.0.0
When you copy this configuration file to the TFTP server, modify this portion of the configuration file
to add the no bridge-group commands under each interface and to remove the ip nat pool command:
interface Ethernet0
ip address 192.168.1.1 255.255.255.0
ip nat inside
load-interval 30
no bridge-group 59
no bridge-group 59 spanning-disabled
!
interface cable-modem0
ip nat outside
load-interval 30
no cable-modem compliant bridge
Examples The following example shows how to configure the router so that it makes a proxy DHCP request to
obtain an IP address for its Ethernet interface:
Router(config)# interface c0
Router(config-if)# cable-modem dhcp-proxy interface ethernet 0
The following example creates a NAT address pool with the IP address assigned by the DHCP server;
this IP address must be in the network attached to the Ethernet address (which in this case is
192.168.100.0).
Router(config)# ip nat inside source list 1 pool net-208 overload
Router(config)# interface cable0
Router(config-if)# ip nat outside
Router(config-if)# no cable compliant bridge
Router(config-if)# cable-modem dhcp-proxy nat net-208
Router(config-if)# exit
Router(config)# interface ethernet0
Router(config-if)# ip address 192.168.100.94 255.255.255.0
Router(config-if)# ip nat inside
Router(config-if)# exit
Router(config)# access-list 1 permit 192.168.100.0 0.0.0.255
Router(config)#
Note Cisco IOS Release 12.1(2)T removed this command from the CLI for all platforms and reserved it for
exclusive use by the DOCSIS provisioning process.
Syntax Description ds-frequency Downstream channel frequency in Hz, which can be from 91,000,000 to
860,000,000.
us-power Upstream power level in decibels per millivolt (dBmV), which can be from 8 to
61.
Defaults Enabled
Usage Guidelines This command is auto-generated by the operation of the cable MAC layer process. The DOCSIS RFI
specification requires that CMs remember the downstream frequency and upstream power of the last
successfully ranged session. These arguments are called up as the first downstream frequency and
upstream power to use the next time the CM is booted. This operation dramatically speeds up the channel
search.
Use the no cable-modem downstream saved channel ds-frequency us-power command to remove the
saved frequency and power setting from the running configuration, which will be saved at the next
initialization cycle.
To comply with DOCSIS requirements, Cisco IOS Release 12.1(2)T removed this command from the
CLI for all platforms and reserved it for exclusive use by the DOCSIS provisioning process. This
command exists in earlier Cisco IOS versions, but Cisco recommends that this command NOT be used
by end users of Cisco cable CPE devices.
Examples The following example shows how to remove the downstream frequency of 91,000,000 Hz and the
upstream power level of 33 dBmV from the running configuration of a cable-modem interface:
Router(config)# interface cable-modem 0
Router(config-if)# no cable-modem downstream saved channel 91000000 33
Router(config-if)#
cable-modem fast-search
To enable a faster downstream search algorithm on the cable interface, use the cable-modem fast-search
command in cable interface configuration mode. To disable the downstream fast-search feature, use the
no form of this command.
cable-modem fast-search
no cable-modem fast-search
Note Cisco IOS Release 12.1(2)T removed this command from the CLI for all platforms and reserved it for
exclusive use by the DOCSIS provisioning process.
Defaults Disabled
Usage Guidelines This feature speeds up the frequency search performed by the cable access router. Normally it takes the
cable access router about 30 to 50 seconds to sample 30 to 50 frequencies. The cable-modem
fast-search command can reduce this search time. However, there might be some cases where this
fast-search algorithm might not perform as well as the default algorithm. Trial and error is the only way
to discover how well this feature works for your environment.
Examples The following example shows how to enable the faster downstream search algorithm on the router’s
cable interface:
Router(config)# interface cable-modem 0
Router(config-if)# cable-modem fast-search
Router(config-if)#
Cisco uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Defaults Enabled
Command Modes Interface configuration and subinterface configuration (cable interface only)
Usage Guidelines TCP traffic uses a packet-acknowledge algorithm, where a group of packets must be acknowledged
before additional traffic can be sent. When a large number of packets is transmitted on the downstream,
it can result in a large number of acknowledgements on the upstream. Because the downstream
bandwidth is typically many times greater than the upstream bandwidth, certain applications can
temporarily overrun the upstream with a large volume of acknowledgement packets.
If any of those acknowledgements are dropped or lost, traffic can be backed up, and data packets might
have to be resent, even if those packets had in fact been successfully received. This can significantly
impact real-time traffic, such as voice calls.
To optimize the TCP traffic on the upstream in these circumstances, the Cisco uBR905, Cisco uBR924,
and Cisco uBR925 cable access routers and the Cisco CVA122 Cable Voice Adapters automatically
analyze the upstream traffic and drop unnecessary packet acknowledgements when traffic begins
backing up. This feature has been automatically enabled by default on the routers, starting with
Cisco IOS Release 12.0(5)T.
In some situations, however, this feature can result in packets being dropped on the upstream, which
could impact the performance of certain applications such as FTP transfers. If packet drops do occur on
the upstream, this feature can be turned off with the no cable-modem qos drop-ack command.
Examples The following example shows how to disable the TCP packet optimization feature on the cable interface,
so that all TCP packet acknowledgements are sent:
Router(config)# interface cable-modem 0
Router(config-if)# no cable-modem qos drop-ack
Router(config-if)#
The following example shows how to enable the TCP packet optimization feature on the cable interface.
This is the default configuration, so it does not need to be done unless it has been previously disabled.
Router(config)# interface cable-modem 0
Router(config-if)# cable-modem qos drop-ack
Router(config-if)#
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Defaults Enabled
Examples The following example shows how to configure the cable interface for QPSK modulation on the
upstream:
Router(config)# interface cable-modem 0
Router(config-if)# cable-modem upstream preamble qpsk
Router(config-if)#
Note Cisco IOS Release 12.1(2)T removed this command from the CLI for all platforms and reserved it for
exclusive use by the DOCSIS provisioning process.
Defaults Enabled
Usage Guidelines This command allows you to configure the voice traffic on a router to allow only calls having a
high-priority service identifier (SID) to be connected.
If the dynamic configuration of high-priority queues for voice traffic fails, or if the far end cannot
support the multiple SIDs and multiple classes of service required by high-priority traffic, the flag set
by this command will be checked. If enabled (the default setting), the call will be allowed to go through.
If disabled, the call will fail.
Examples The following example shows how to disable best-effort voice calls:
Router(config)# interface cable-modem 0
Router(config-if)# no cable-modem voip best-effort
Router(config-if)#
Cisco uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Defaults The default is to use the clock from the cable interface for VoIP calls.
Usage Guidelines This command enables the internal clock, allowing it to make VoIP calls over the Ethernet and USB
interfaces even when the cable interface is down or disconnected. If the CMTS is a Cisco uBR7200 series
with a Cable Clock Card, this command disables the use of that clock.
This command can be used in both DOCSIS IP bridging and routing mode. However, when operating in
DOCSIS IP bridging mode, VoIP packets are transmitted out only on the cable interface, so the router
must be operating in routing mode to transmit voice packets out the Ethernet and USB interfaces.
Examples The following example shows how to enable the internal clock for VoIP calls:
Router(config)# interface cable0
Router(config-if)# cable-modem voip clock-internal
Router(config-if)#
Command Description
cable-modem fast-search Enables a faster downstream search algorithm on the cable
interface.
cable-modem upstream Enables the QPSK modulation scheme in the upstream direction
preamble qpsk from the cable interface to the CMTS.
Examples The following example clears the router’s statistical and error counters to zero:
Router# clear crypto engine accelerator counter
Router#
Command Description
show crypto engine accelerator Displays the contents of command and transmit rings for the crypto
ring engine.
show crypto engine accelerator Displays the active (in-use) entries in the crypto engine security
sa-database association (SA) database.
show crypto engine accelerator Displays the current run-time statistics and error counters for the
statistic crypto engine.
show crypto engine brief Displays a summary of the configuration information for the crypto
engine.
show crypto engine Displays the version and configuration information for the crypto
configuration engine.
show crypto engine Displays a list of the current connections maintained by the crypto
connections engine.
Syntax Description name (Optional) Identifies the IPSec VPN tunnel that is to be disconnected or
cleared with a unique, arbitrary name. If no name is specified, then all
existing tunnels are disconnected or cleared.
Defaults If no tunnel name is specified, all active tunnels on the machine are cleared.
Usage Guidelines The clear crypto ipsec client ezvpn command resets the Cisco Easy VPN Remote state machine,
bringing down the current Cisco Easy VPN Remote connection and bringing it back up on the interface.
If you specify a tunnel name, then only that tunnel is cleared. If no tunnel name is specified, all active
tunnels on the machine are cleared.
If the Cisco Easy VPN Remote connection for a particular interface is configured for autoconnect, this
command also initiates a new Cisco Easy VPN Remote connection.
Examples The following example shows the Cisco Easy VPN Remote state machine being reset:
Router# clear crypto ipsec client ezvpn
Router#
Usage Guidelines This command is not normally needed for typical operations because the router’s onboard hardware
accelerator for IPSec encryption is enabled by default. The hardware accelerator should not be disabled
except on instruction from Cisco TAC personnel.
Examples The following example shows how to enable the router’s onboard hardware accelerator for IPSec
encryption. This is normally needed only after the accelerator has been disabled for testing or debugging
purposes.
Router# crypto engine accelerator
Router#
The following example shows how to disable the router’s onboard hardware accelerator. If IPSec
encryption is configured, all current connections are brought down. Future encryption is performed by
the Cisco IOS software, which has the same functionality as the hardware accelerator, but performance
is significantly slower.
Router# no crypto engine accelerator
Warning! all current connections will be torn down.
Do you want to continue? [yes/no]: y
...Crypto accelerator in slot 0 disabled
Syntax Description name Identifies the IPSec VPN tunnel with a unique, arbitrary name.
Usage Guidelines If the tunnel name is not specified, the authorization request is made on the active tunnel. If there is more
than one active tunnel, the command fails with an error requesting that you specify the tunnel name.
When making a VPN connection, individual users might also be required to provide authorization
information, such as a username or password. When the remote end requires this information, the router
displays a message on the router’s console instructing the user to enter the crypto ipsec client ezvpn
xauth command. The user then uses the CLI to give this command and reply to the following prompts
to provide the required information.
Note If the user does not respond to the Authentication notification, the message is repeated every ten seconds.
Examples The following example shows the user being prompted to enter the crypto ipsec client ezvpn xauth
command. The user then enters the requested information and continues.
Router#
20:27:39: EZVPN: Pending XAuth Request, Please enter the following command:
20:27:39: EZVPN: crypto ipsec client ezvpn xauth
Router#
Note A separate crypto ipsec client ezvpn command exists in interface configuration mode that assigns a
Cisco Easy VPN Remote configuration to the interface.
Syntax Description name Identifies the Cisco Easy VPN Remote configuration with a unique,
arbitrary name.
Defaults Newly created Cisco Easy VPN Remote configurations default to client mode.
Usage Guidelines The crypto ipsec client ezvpn command creates a Cisco Easy VPN Remote configuration and then
enters the Cisco Easy VPN Remote configuration mode, at which point you can enter the following
subcommands:
• connect [auto | manual]—To manually establish and terminate an IPSec VPN tunnel on demand.
– The auto option is the default setting, because it was the initial Phase I functionality. The IPSec
Virtual Private Network (VPN) tunnel is automatically connected when the Cisco Easy VPN
Remote feature is configured on an interface.
– The manual option specifies the manual setting to direct the Cisco Easy VPN Remote to wait
for a command or API call before attempting to establish the Cisco Easy VPN Remote
connection. When the tunnel times out or fails, subsequent connections have to wait for the
command to reset to manual or an application program interface (API) call.
• default—Sets the following command to its default values.
• exit—Exits the Cisco Easy VPN configuration mode and returns to global configuration mode.
• group group-name key group-key—Specifies the group name and key value for the VPN
connection.
• local-address interface-name—To inform the Cisco Easy VPN router which interface is used to
determine the public IP address, which is used to source the tunnel. This applies only to the
Cisco uBR905 and Cisco uBR925 cable access routers.
– The value of interface-name specifies the interface used for tunnel traffic.
After specifying the local address used to source tunnel traffic, the IP address can be obtained in two
ways:
– The local-address subcommand can be used with the cable-modem dhcp-proxy {interface
loopback number} command to obtain a public IP address and automatically assign it to the
loopback interface.
– The IP address can be manually assigned to the loopback interface.
• mode {client | network-extension}—Specifies the router’s VPN mode of operation:
– The client option (default) automatically configures the router for Cisco Easy VPN client mode
operation, which uses NAT/PAT address translations. When the Cisco Easy VPN client
configuration is assigned to an interface, the router automatically creates the NAT/PAT and
access-list configuration needed for the VPN connection.
– The network-extension option specifies that the router should become a remote extension of
the enterprise network at the other end of the VPN connection. The PCs that are connected to
the router typically are assigned an IP address in the enterprise network’s address space.
• no—Removes the command or sets it to its default values.
• peer {ipaddress | hostname}—Sets the peer IP address or hostname for the VPN connection. A
hostname can be specified only when the router has a DNS server available for hostname resolution.
Note The Cisco Easy VPN Remote feature attempts to resolve the hostname when the peer
command is given, not when the VPN tunnel is created. If the hostname cannot be resolved
at that time, the peer command is not accepted.
After configuring the Cisco Easy VPN Remote configuration, use the exit command to exit the
Cisco Easy VPN Remote configuration mode and return to global configuration mode.
Note You cannot use the no crypto ipsec client ezvpn command to delete a Cisco Easy VPN Remote
configuration that is assigned to an interface. You must remove that Cisco Easy VPN Remote
configuration from the interface before you can delete the configuration.
Examples The following example shows a Cisco Easy VPN Remote configuration named telecommuter-client
being created on a Cisco uBR905 or Cisco uBR925 cable access router and being assigned to cable
interface 0:
Router# config t
Router(config)# crypto ipsec client ezvpn telecommuter-client
Router(config-crypto-ezvpn)# group telecommute-group key secret-telecommute-key
Router(config-crypto-ezvpn)# peer telecommuter-server
Router(config-crypto-ezvpn)# mode client
Router(config-crypto-ezvpn)# exit
Router(config)# interface c0
Router(config-if)# crypto ezvpn telecommuter-client
Router(config-if)# exit
Router(config)#
Note Specifying the mode client option as shown above is optional, because this is default configuration for
these options.
The following example shows the Cisco Easy VPN Remote configuration named telecommuter-client
being removed from the interface and then deleted:
Router# config t
Router(config)# int e1
Router(config-if)# no crypto ipsec client ezvpn telecommuter-client
Router(config-if)# exit
Router(config)# no crypto ipsec client ezvpn telecommuter-client
Router(config)#
Note A separate crypto ipsec client ezvpn command exists in global configuration mode that creates a
Cisco Easy VPN Remote configuration.
Syntax Description name Specifies the Cisco Easy VPN Remote configuration to be assigned to the
interface.
outside (Optional) Specifies the outside interface of the IPSec client router. This is
optional for outside interfaces. You can add up to four outside tunnels, one
tunnel per outside interface, for all platforms.
inside (Optional) Specifies the inside interface of the IPSec client router. The
Cisco 1700 series has no default inside interface and any inside interface
must be configured. The Cisco 800 series routers, and Cisco uBR905 and
Cisco uBR925 cable access routers have default inside interfaces. However,
you can configure any inside interface. You can add up to three inside
interfaces for all platforms.
Defaults The default inside interface is the Ethernet interface on Cisco 800 series routers and Cisco uBR905 and
Cisco uBR925 cable access routers.
Usage Guidelines The crypto ipsec client ezvpn command assigns a Cisco Easy VPN Remote configuration to an
interface, enabling the creation of a virtual private network (VPN) connection over that interface to the
specified VPN peer. If the Cisco Easy VPN Remote configuration is configured for the client mode of
operation, this also automatically configures the router for network address translation (NAT)/port
address translation (PAT) and an associated access list.
Cisco IOS Release 12.2(8)YJ and Cisco IOS Release 12.2(15)T enhanced the command to allow you to
configure multiple outside and inside interfaces. To configure multiple outside and inside interfaces, you
must use the interface interface-name command to first define type of interface on the IPSec client
router.
• In client mode for the Cisco Easy VPN Remote feature, a single security association (SA)
connection is used for encrypting and decrypting the traffic coming from all the inside interfaces. In
network extension mode, one SA connection is established for each inside interface.
• When a new inside interface is added or an existing one is removed, all established security
association (SA) connections are deleted and new ones are initiated.
• Configuration information for the default inside interface is shown with the crypto ipsec client
ezvpn name inside command. All inside interfaces, whether they belong to a tunnel, are listed in
interface configuration mode, as an inside interface, along with the tunnel name.
The following Cisco IOS Release 12.2(4)YA restrictions apply to the crypto ipsec client ezvpn
command:
• In Cisco IOS Release 12.2(4)YA, the Cisco Easy VPN Remote feature supports only one tunnel, so
the crypto ipsec client ezvpn command can be assigned to only one interface. If you attempt to
assign it to more than one interface, an error message is displayed. You must use the no form of this
command to remove the configuration from the first interface before assigning it to the second
interface.
• The crypto ipsec client ezvpn command should be assigned to the outside interface of the NAT/PAT
translation. This command cannot be used on the inside NAT/PAT interface. On some platforms, the
inside and outside interfaces are fixed.
For example, on Cisco uBR905 and Cisco uBR925 cable access routers, the outside interface is
always the cable interface. On Cisco 1700 series routers, the Fast Ethernet interface defaults to being
the inside interface, so attempting to use the crypto ipsec client ezvpn command on the Fast
Ethernet interface displays an error message.
Note You must first use the global configuration version of the crypto ipsec client ezvpn command to create
a Cisco Easy VPN Remote configuration before assigning it to an interface.
Examples The following example shows a Cisco Easy VPN Remote configuration named telecommuter-client
being assigned to the cable interface on a Cisco uBR905/uBR925 cable access router:
Router# config t
Router(config)# interface c0
Router(config-if)# crypto ipsec client ezvpn telecommuter-client
Router(config-if)# exit
Router(config)#
The following example first shows an attempt to delete the Cisco Easy VPN Remote configuration
named telecommuter-client, but the configuration cannot be deleted because it is still assigned to an
interface. The configuration is then removed from the interface and then deleted:
Router# config t
Syntax Description name Identifies the IPSec VPN tunnel with a unique, arbitrary name.
Usage Guidelines This command is used with the connect [auto | manual] subcommand. After the manual setting is
designated, the Cisco Easy VPN Remote feature waits for a command or API call before attempting to
establish the Cisco Easy VPN Remote connection.
If the configuration is manual, then the tunnel is connected only after the crypto ipsec client ezvpn
connect name command is entered in privileged EXEC mode, and after the connect [auto] | manual
subcommand is entered.
Examples The following example shows how to connect an IPSec VPN tunnel named ISP-tunnel on a
Cisco uBR905/uBR925 cable access router:
Router# crypto ipsec client ezvpn connect ISP-tunnel
Command Description
crypto ipsec client (Interface configuration mode) Assigns a Cisco Easy VPN Remote
ezvpn (interface configuration to an interface.
configuration)
ip http ezvpn Enables the Cisco Easy VPN Remote web server interface.
Cisco uBR905 and Cisco uBR925 cable access routers, and Cisco CVA122 Cable Voice Adapter
Syntax Description codeAccessStart Specifies the code Access Start Time as a UTC time value
start-time (YYMMDDhhmmssZ) in Greenwich Mean Time.
cvcAccessStart Specifies the CVC Access Start Time as a UTC time value
start-time (YYMMDDhhmmssZ) in Greenwich Mean Time.
organization name Specifies the name of the manufacturer of the code file. Use quotes if the
name value contains more than one word.
Defaults The codeAccessStart and cvcAccessStart times default to 011219000000Z (midnight on December 19,
2001 Greenwich Mean Time). The organization defaults to Cisco Systems.
Note Typically, the default values should not be changed unless you are instructed to do so by Cisco TAC or
field service engineers.
Usage Guidelines This command configures the access start times and organization name that are required by Appendix D
in the DOCSIS BPI+ specification. The time values are specified as UTC time values in Greenwich Mean
Time, with a two-digit year. If the year is between 50 and 99, it is interpreted as 1950 to 1999. If the year
is between 00 and 49, it is interpreted as 2000 to 2049.
The router uses the codeAccessStart value to verify the Code Verification Signature (CVS) that is
affixed to the code file downloaded using the secure software download feature. The router uses the
ccvAccessStart value to verify the CVC for the code file. The router also uses the organization value
to verify that the code file has been created by the proper manufacturer.
Tip These values are the same that are set using the docsBpi2CodeMfgCodeAccessStart,
docsBpi2CodeMfgCvcAccessStart, and docsBpi2CodeMfgOrgName attributes in the BPI+ MIB
(DOCS-BPI2-MIB).
Examples The following example shows the default configuration for the docsis cvc mfg commands:
Router(config)# docsis cvc mfg organization "Cisco Systems"
Router(config)# docsis cvc mfg codeAccessStart 011219000000Z
Router(config)# docsis cvc mfg cvcAccessStart 011219000000Z
Router(config)#
Note You must set the organization name using the docsis cvc mfg organization command before you can set
either access start time.
Cisco uBR905 and Cisco uBR925 cable access routers, and Cisco CVA122 Cable Voice Adapter
Syntax Description codeAccessStart Specifies the code Access Start Time as a UTC time value
start-time (YYMMDDhhmmssZ) in Greenwich Mean Time.
cvcAccessStart Specifies the CVC Access Start Time as a UTC time value
start-time (YYMMDDhhmmssZ) in Greenwich Mean Time.
organization name Specifies the name of the manufacturer of the code file. Use quotes if the
name value contains more than one word.
Usage Guidelines This command configures the optional cosigner access start times and organization name that are
specified by Appendix D in the DOCSIS BPI+ specification. The time values are specified as UTC time
values in Greenwich Mean Time, with a two-digit year. If the year is between 50 and 99, it is interpreted
as 1950 to 1999. If the year is between 00 and 49, it is interpreted as 2000 to 2049.
You do not need to use this command unless the MSO or service provider is digitally signing the
Cisco IOS software images that it plans to download to the Cisco cable modems. If so, then this
command must be used to set the appropriate access times and organization name, so that the cable
modem can properly authenticate the software images during a secure software download.
The router uses the codeAccessStart value to verify the cosigner’s Code Verification Signature (CVS)
that is affixed to the code file downloaded using the secure software download feature. The router uses
the ccvAccessStart value to verify the cosigner’s CVC that is affixed to the code file. The router also
uses the organization value to verify that the code file has been signed by the proper MSO or cable
operator.
Tip These values are the same that are set using the docsdocsBpi2CodeCoSignerCodeAccessStart,
Bpi2CodeCoSignerCvcAccessStart, and docsBpi2CodeCoSignerOrgName attributes in the BPI+ MIB
(DOCS-BPI2-MIB).
Examples The following example shows the docsis cvc mso commands being used to configure the router for a
cosigned CVC from an organization named “MSO Organization” and with certificate access times of
midnight on March 1, 2002 Greenwich Mean Time:
Router(config)# docsis cvc mfg organization "MSO Organization"
Router(config)# docsis cvc mfg codeAccessStart 020301000000Z
Router(config)# docsis cvc mfg cvcAccessStart 020301000000Z
Router(config)#
Note You must set the organization name using the docsis cvc mso organization command before you can set
either access start time.
Cisco uBR905 and Cisco uBR925 cable access routers, and Cisco CVA122 Cable Voice Adapter
Usage Guidelines This command verifies that the root CA public key and the private key that are installed in the router at
the factory are valid. The command uses the root CA public key to encrypt a string, and then it uses the
router’s private key to decrypt the key.
Typically, the root CA public key and private key are installed at the factory and never need to be
updated. However, DOCSIS allows the keys to be updated as part of the secure software download
procedure. If this occurs, you can use the docsis cvc test command to verify that the keys are valid and
are properly installed.
Examples The following example shows a typical successful result of the docsis cvc test command:
Router# config terminal
Router(config)# docsis cvc test
Encrypted sting: This is a test
Encrypt result: xxxxxxxxxxxxxxxxxxxxxxxxxxx
Note If the decrypt result is not “This is a test,” then the test failed, which indicates that either the public key
or the private key is not valid.
dtmf-relay
To configure the router so it transmits Dual-Tone Multifrequency (DTMF) tones as out-of-band signals
during H.323 voice calls, use the dtmf-relay command in dial-peer voice configuration mode. To return
to the default configuration of transmitting DTMF tones as part of the voice traffic, use the no form of
this command.
Cisco uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
no dtmf-relay
Syntax Description cisco-rtp (Optional) Forwards DTMF tones using the Real-Time Transport Protocol
(RTP) with a Cisco proprietary payload type.
Note RTP is a proprietary Cisco protocol that interoperates only between
two Cisco access servers or routers running Cisco IOS images that
support the RTP protocol. The RTP protocol typically requires
Cisco IOS 12.0(5)T or later releases; see the router’s release notes
for complete information.
h245-alphanumeric (Optional) Forwards DTMF tones using the H.245 Alphanumeric User
Input Indication method. This option transmits each tone using a fixed
duration of 500 milliseconds. Supports tones 0-9, *, #, and A-D.
h245-signal (Optional) Forwards DTMF tones using the H.245 Signal User Input
Indication method. This option transmits each tone using the original
duration and supports tones 0-9, *, #, and A-D.
Defaults By default, DTMF tones are transmitted inband, as part of the voice traffic.
Usage Guidelines DTMF tones are generated when you press the keypad digits on a touch-tone phone. DTMF tones are
most commonly used to dial calls, but they can also be used during a call to interact with an Interactive
Voice Response (IVR) system, such as voicemail, automated banking services and so on. By default,
DTMF tones are transmitted along with the regular voice traffic, but this can cause problems with some
IVR systems.
In particular, IVR systems might not recognize DTMF tones when using highly compressed CODECs
such as G.729a. These CODECs are highly optimized for voice frequencies, but they can distort DTMF
tones, preventing IVR systems from recognizing the tones. To avoid this problem, use one or more of
the following methods of transmitting DTMF tones in an out-of-band channel, separately from the voice
traffic:
• Cisco RTP—This option transmits the DTMF tones using a proprietary encoding that allows them
to use the same RTP channel as the voice traffic. This method accurately transports DTMF tones but
requires the use of Cisco gateways at both the originating and terminating endpoints of the H.323
call.
• H.245 Alphanumeric—This option transmits DTMF tones through a separate H.245 signaling
channel using H.245 User Input Indication messages. Tones are transmitted as alphanumeric digits
with a fixed duration of 500 milliseconds. This method is required for all H.323v2 compliant
systems.
• H.245 Signal—This option transmits DTMF tones through a separate H.245 signaling channel using
H.245 User Input Indication messages. This method preserves both the tone information and the
original duration of the tone, which allows the caller to use services that require you to press a key
for a particular length of time. For example, a popular calling card feature allows you to break out
of an existing call by pressing the pound (#) key for more than two seconds and then make a second
call without having to hang up in between.
You can enable more than one DTMF relay option for a particular dial peer to support multiple
destinations that might use different methods. If you enable more than one option, and if the peer is
capable of receiving DTMF in more than one of these formats, the router selects the DTMF format with
the highest priority:
1. Cisco RTP (highest priority)
2. H.245 Signal
3. H.245 Alphanumeric
4. None—DTMF is sent inband
Examples The following example shows how to configure an outgoing dial peer so that DTMF tones to that
destination are transmitted using the Cisco RTP protocol, if it is supported by the remote end; otherwise,
the DTMF tones are transmitted using the H.245 signaling protocol.
Router(config)# dial-peer voice 100 voip
Router(config-dial-peer)# destination-pattern 555-1212
Router(config-dial-peer)# session target ipv4:192.168.100.110
Router(config-dial-peer)# dtmf-relay cisco-rtp h245-signal
Router(config-dial-peer)# exit
The following example shows how to reconfigure the above dial peer and disables out-of-band DTMF
signaling, so that the DTMF tones are sent inband, as part of the voice traffic:
Router(config)# dial-peer voice 100 voip
Router(config-dial-peer)# no dtmf-relay
Router(config-dial-peer)# exit
Cisco uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Syntax Description ip-address Specifies the IP address to be used for outgoing H.323 traffic, which
includes H.225, H.245, and RAS messages. This IP address typically is the
IP address assigned to the Ethernet interface.
Defaults No defaults assigned. By default, H.323 traffic is transmitted with the IP address assigned to the cable
interface.
Usage Guidelines The h323-gateway voip bind srcaddr command can be used with any interface, but it is primarily used
with the cable access router’s Ethernet interface when configuring a virtual private network (VPN). In
this configuration, the h323-gateway voip bind srcaddr command configures the router so that VoIP
traffic is sent using the IP address of the Ethernet interface (as opposed to the default behavior, which is
to use the IP address of the default outgoing interface, which is the cable interface).
The h323-gateway voip bind srcaddr command allows the enterprise network to maintain the H.323
gatekeeper and gateway in the enterprise network’s address space. Without the h323-gateway voip bind
srcaddr command, outgoing voice traffic uses the IP address of the cable interface. This method requires
that the H.323 gatekeeper and gateway be maintained in the cable service provider’s address space,
which is not desirable if the enterprise needs to control the voice network and VPN configuration.
Note The h323-gateway voip bind srcaddr command can be used only when the cable access router is
operating in routing mode. This command has no effect when the router is operating in DOCSIS bridging
mode.
Examples The following example shows how to configure the Ethernet interface with the IP address of
192.168.100.94, and then how to configure the interface so that H.323 traffic will be transmitted using
that IP address:
Router(config)# interface ethernet0
Router(config-if)# ip address 192.168.100.94 255.255.255.0
Router(config-if)# h323-gateway voip bind srcaddr 192.168.100.94
Router(config-if)#
The following example shows how to remove the H.323 binding, so that H.323 voice traffic is
transmitted using the cable interface’s IP address:
Router(config-if)# no h323-gateway voip bind srcaddr
Router(config-if)#
interface cable-modem
To enter interface configuration mode for the cable interface on a router, use the interface cable-modem
command in global configuration mode.
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Defaults Disabled
Usage Guidelines When this command is entered, the router switches from global configuration mode to interface
configuration mode.
Examples The following example shows how to enter interface configuration mode for the router’s cable interface
and then to enter the available interface configuration commands:
Router(config)# interface cable-modem 0
Router(config-if)# cable-modem ?
compliant Enter compliant modes for interface
downstream Downstream channel characteristics
fast-search Enable/disable the DS fast search
upstream upstream channel characteristics
voip Options for Voice over IP traffic over the cable interface
Router(config-if)#
cable-modem upstream Enables the QPSK modulation scheme in the upstream direction
preamble qpsk from the cable interface to the CMTS.
cable-modem voip best-effort Allows voice traffic to be transmitted on the upstream using a
best-effort QoS.
interface usb
To enter the interface configuration mode for the Universal Serial Bus (USB) interface, use the interface
usb command in global configuration mode.
Cisco uBR925 cable access router, Cisco CVA122 Cable Voice Adapter
Defaults Disabled
Usage Guidelines When this command is entered, the router switches from global configuration mode to interface
configuration mode for the USB interface.
Examples The following example shows how to enter interface configuration mode for the USB interface and then
to display the available commands:
Router(config)# interface usb 0
Router(config-if)#?
Interface configuration commands:
access-expression Build a bridge boolean access expression
arp Set arp type (arpa, probe, snap) or timeout
bandwidth Set bandwidth informational parameter
bridge-group Transparent bridging interface parameters
carrier-delay Specify delay for interface transitions
cdp CDP interface subcommands
crypto Encryption/Decryption commands
custom-queue-list Assign a custom queue list to an interface
default Set a command to its defaults
delay Specify interface throughput delay
description Interface specific description
exit Exit from interface configuration mode
fair-queue Enable Fair Queuing on an Interface
h323-gateway Configure H323 Gateway
help Description of the interactive help system
hold-queue Set hold queue depth
ip Interface Internet Protocol config commands
keepalive Enable keepalive
Router(config-if)#
ip address docsis
To specify that the cable access router should use the DHCP protocol, as required by the DOCSIS
specification, to assign an IP address for its cable interface, use the ip address docsis command in cable
interface configuration mode. To disable the use of DHCP, use the no form of this command.
Cisco uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
ip address docsis
no ip address docsis
Syntax Description There are no key words or arguments for this command.
Defaults The cable access router uses the DHCP protocol, as required by the DOCSIS specification, to assign an
IP address to its cable interface during system power-on.
Usage Guidelines The ip address docsis command configures the cable access router so that it obtains its IP address from
a DHCP server at system power-on, which is a requirement for DOCSIS operation. This is the default
mode of operation. If the configuration for the cable interface does not include any form of ip address
command, the cable access router defaults to configuring the cable interface with the ip address docsis
command.
Configuring the cable interface with any other form of the ip address command or with the no ip
address docsis command prevents the cable access router from operating in DOCSIS networks. This
mode of operation should be used only in lab or test networks.
Note Earlier Cisco IOS software releases for the cable access routers used either the ip address negotiated
or the ip address dhcp command to specify that the cable interface should obtain its IP address from a
DHCP server. These commands should no longer be used to configure the router’s cable interface.
Examples The following example shows how to configure the cable access router so that it obtains the IP address
for its cable interface from a DHCP server:
Router(config)# interface cable-modem 0
Router(config-if)# ip address docsis
Router(config-if)# exit
Router(config)#
ip dhcp smart-relay
To enable the DHCP smart-relay feature, use the ip dhcp smart-relay command in global configuration
mode. To disable this feature, use the no form of this command.
Cisco uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
ip dhcp smart-relay
no ip dhcp smart-relay
Usage Guidelines The DHCP smart-relay feature enables a CM to automatically switch to a secondary DHCP server if the
primary DHCP server cannot provide the requested IP address. If a DHCP Relay Agent is specified in
the DOCSIS configuration file that the router downloads during its initial provisioning, the secondary
server can reside on a separate subnet.
The DHCP smart-relay feature is enabled by default, so this command is not normally needed. However,
if DHCP clients send multiple DHCP request messages at the same time, use the no ip dhcp smart-relay
command to disable this feature, so that the primary DHCP server has sufficient time to respond to the
initial client requests.
Examples The following example shows how to enable the DHCP smart-relay feature:
Router(config)# ip dhcp smart-relay
The following example shows how to disable the DHCP smart-relay feature, which would be done when
the DHCP clients send multiple DHCP request messages at the same time:
Router(config)# ip dhcp smart-relay
ip http cable-monitor
To enable the cable access router’s onboard Cable Monitor web server, use the ip http cable-monitor
command in global configuration mode. To disable the Cable Monitor and turn off all access to the
onboard Cisco web server, use the no form of this command.
Cisco uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
no ip http cable-monitor
Syntax Description basic Displays only the basic status and performance pages.
advance Displays all status and diagnostic pages.
Note The Cable Monitor should not be used in advanced mode without
first implementing a secure password strategy on the cable access
router. Enabling the Cable Monitor in advanced mode without
setting an encrypted enabled password could provide information
that would allow remote users to change the router’s configuration.
url-ip-address (Optional) Specifies the IP address for the Cable Monitor. This argument,
along with the url-mask argument, also defines the network that provides
the IP address pool used by the temporary DHCP server when the cable
interface goes down.
url-mask (Optional) Specifies the subnet mask for the Cable Monitor. This argument,
along with the url-ip-address argument, also defines the network that
provides the IP address pool used by the temporary DHCP server when the
cable interface goes down.
Usage Guidelines This command enables the Cable Monitor, an onboard web server that displays current status,
troubleshooting, and performance information. The Cable Monitor can be accessed in two ways:
• When the cable access router has established connectivity with the CMTS over the cable interface,
a service technician can use a web browser to remotely access the router and display the desired
information.
• When the cable network is not operational and the cable access router is not online, the subscriber
can access the tool with a PC connected to the router’s Ethernet ports. Technicians can then prompt
the user for the information they need to determine the source of the problem.
Enabling the Cable Monitor also enables the Cisco web server that is onboard the cable access router,
which is the equivalent to entering the ip http server command. However, when the Cable Monitor is
enabled, all other access, including CLI access, to the onboard web server is automatically disabled.
Note When the Cable Monitor is enabled in the startup configuration file, the messages “Starting DNS
process” and “Terminating DNS process” can appear in the messages displayed during boot-up on the
console. These messages are normal and can be ignored.
Disabling the Cable Monitor using the no ip http cable-monitor command also automatically disables
the Cisco web server, which is the equivalent of giving the no ip http server command. When disabling
the Cable Monitor, the console might display warning messages similar to the following:
% monitor-209.165.202.131 is not in the database.
% monitor-192.168.100.1 is not in the database.
% Range [209.165.202.131, 209.165.202.131] is not in the database.
% Range [192.168.100.1, 192.168.100.1] is not in the database.
These messages can be ignored because they are simply confirming that the IP addresses used for the
Cable Monitor are no longer being used for that purpose.
The URL-IP-address and URL-mask arguments also specify that the class C private network
192.168.100.0 is the default address pool for the temporary DHCP server that activates when the cable
interface goes down.
Note The Cable Monitor web interface does not work with the Cisco Easy VPN Remote web interface. To
access the Cable Monitor web interface, you must first disable the Cisco Easy VPN Remote web
interface with the no ip http ezvpn command, and then enable the Cable Monitor with the ip http
cable-monitor command.
Examples The following example shows how to enable the Cable Monitor for advanced mode, in which all status
and diagnostic pages are displayed:
Router(config)# ip http cable-monitor advance
Router(config)#
The following example shows how to disable both the Cable Monitor and the Cisco web server,
preventing all web server access to the Cisco uBR924 cable access router:
Router(config)# no ip http cable-monitor
Router(config)#
Note The ip http command also supports two options, access-class and authentication, that should not be
used when the Cable Monitor is enabled.
ip http ezvpn
To enable the Cisco Easy VPN Remote web server interface, use the ip http ezvpn command in global
configuration mode. To disable the Cisco Easy VPN Remote web interface, use the no form of this
command.
ip http ezvpn
no ip http ezvpn
Defaults The Cisco Easy VPN Remote web interface is disabled by default.
Usage Guidelines This command enables the Cisco Easy VPN Remote web server, an onboard web server that allows users
to connect an IPSec Easy VPN tunnel and to provide the required authentication information. This
allows the user to perform these functions without having to use the Cisco command-line interface.
Before using this command, you must first enable the Cisco web server that is onboard the cable access
router by entering the ip http server command. Then use the ip http ezvpn command to enable the Cisco
Easy VPN Remote web server. You can then access the web server by entering the IP address for the
router’s Ethernet interface in your web browser.
Note The Cisco Easy VPN Remote web interface does not work with the Cable Monitor web interface in
Cisco IOS Release 12.2(8)YJ. To access the Cable Monitor web interface, you must first disable the
Cisco Easy VPN Remote web interface with the no ip http ezvpn command, and then enable the Cable
Monitor with the ip http cable-monitor command.
Examples The following example shows how to enable the Cisco Easy VPN Remote web server interface:
Router# configure terminal
Router(config)# ip http server
Router(config)# ip http ezvpn
Router(config)# exit
Router# copy running-config startup-config
ping docsis
To determine whether a specific CM is reachable from the CMTS at the DOCSIS MAC layer, use the
ping docsis command in privileged EXEC mode.
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Syntax Description mac-addr Specifies the 48-bit hardware (MAC) address of the CM.
ip-addr Specifies the IP address of the CM.
count Specifies the number of ping packets to be sent.
verbose Specifies verbose mode for the output, giving additional details about the packets
transmitted and received.
Usage Guidelines The DOCSIS ping is a unique Cisco technology that allows a cable operator to quickly diagnose the
health of a channel between the CMTS and any particular DOCSIS cable CPE device. The DOCSIS ping
is similar in concept to the IP ping but uses the lower MAC layer instead of the datalink or transport
layers. Using the MAC layer has two major advantages:
• A DOCSIS ping uses only 1/64 of the bandwidth of an IP ping.
• A DOCSIS ping can be used with CMs that have not yet acquired an IP address. This allows cable
operators to “ping” CMs that weren't able to complete registration or that were improperly
configured at the IP layer.
In addition to providing connectivity information, the ping docsis command provides a real-time view
and plot of requested power adjustments, frequency, timing offset adjustments, and a measure of optimal
CMTS reception power.
If a CM responds to the ping docsis command, but does not respond to an IP ping, the problem could be
one of the following:
• The CM is still in the registration process and has not yet come completely online. In particular, the
CM could be waiting for the DHCP server to assign it an IP address.
• Severe interference or other faults on the physical layer (either the upstream or downstream).
• Significant upstream signal error, distortion, or amplitude errors, often resulting in frequent power
adjustments (which are shown in the cable flap list).
• A non-DOCSIS compliant upstream carrier-to-noise power ratio (C/N) that is between 14 and
21 dB, along with a mixed modulation profile, such as ranging request/response messages being sent
in QPSK mode and short and long data grants in 16-QAM mode.
Note The ping docsis command is a DOCSIS-compliant process that can be used with any two-way
DOCSIS-compliant CM; the CM does not require any special features or code. The ping docsis
command cannot be used with telco-return CMs.
Table 6-2 explains the different characters that can appear in the output for the ping docsis command:
Note If a CM is already in the flap list, the ping docsis command increments the hit, miss, and
power-adjustment fields for it in the cable flap list.
Examples The following example shows a default ping docsis command that sends five packets to the CM with the
MAC address of 0010.7bb3.fd19, with a response being received for each:
Router# ping docsis 0010.7bb3.fd19
The following example shows that the CM at 192.168.100.10 is connected to the network and is
operational, but that one ping packet was lost and that several power adjustments were made during the
ping process:
Router# ping docsis 192.168.100.10
A CM that displays output such as that above (a higher percentage of successful pings but with a number
of power adjustment readings) is most likely experiencing a problem that is not bad enough to force the
modem offline, but that does indicate a problem that should be addressed.
If this problem is consistent for just a small number of modems on an upstream receiver (such as a fiber
node within a combining group), then the problem is likely related to in-home wiring at those modem
locations. It could also be due to a cable TV network element that is on the same HFC segment.
If the problem occurs for all CMs on a single fiber node, then changing the upstream frequency or
reducing the number of homes passed per combining group might improve conditions. If this does not
help the situation, the problem could be due to a faulty cable drop, dirty optical connector on the node,
or other physical plant problem.
port (dial-peer)
To associate a dial peer with a specific voice port, use the port dial-peer configuration command. To
cancel this association, use the no form of this command.
Cisco uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
port number
no port number
Note For complete details on this command for all supported platforms, see the Cisco IOS Voice, Video, and
Fax Command Reference, Release 12.2, available on Cisco.com.
Syntax Description: number Specifies one of the RJ-11 voice port connectors installed in the router. Valid
entries are 0 (which corresponds to the RJ-11 connector labeled V1) and 1
(which corresponds to the RJ-11 connector labeled V2).
Usage Guidelines This command is used for calls incoming from a telephony interface to select an incoming dial peer and
for calls coming from the VoIP network to match a port with the selected outgoing dial peer.
Examples The following example shows how to associate a POTS dial peer 10 with voice port 1 (connector V2) on
the Cisco uBR924 or Cisco uBR925 cable access router or on the CVA122 Cable Voice Adapter:
dial-peer voice 10 pots
port 1
The following example shows how to associate a POTS dial peer 30 with voice port 0 (connector V1) on
the Cisco uBR924 or Cisco uBR925 cable access router or on the CVA122 Cable Voice Adapter:
dial-peer voice 30 pots
port 0
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Examples The following example shows sample output for this show bridge cable-modem command:
Router# show bridge cable-modem 0
Field Description
Total of 300 station blocks Total number of forwarding database elements in the system. The
memory to hold bridge entries is allocated in blocks of memory
sufficient to hold 300 individual entries. When the number of free
entries falls below 25, another block of memory sufficient to hold
another 300 entries is allocated. Thus, the total number of forwarding
elements in the system is expanded dynamically, as needed, limited by
the amount of free memory in the router.
Bridge Group The number of the bridge group to which this interface is assigned.
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Usage Guidelines The show controllers cable-modem display begins with information from the first few registers of the
Broadcom BCM3300 chip. Next is buffer information for the receive, receive MAC message, buffer
descriptor, and packet descriptor rings. Then comes MIB statistics from the BCM3300 chip, DMA base
registers to indicate where the rings start, global control and status information, and finally interrupts for
the interrupt code.
When using this command, be sure to check the tx_count and the tx_head and tx_tail values for the buffer
descriptor (TX BD) and packet descriptor (TX PD) rings. The tx_count should be greater than 0, and the
tx_head and tx_tail values should not be equal. If these values do not change for several minutes, it could
indicate that there are packets stuck on the ring. This condition is often caused by the CMTS not giving
grants.
Examples The following shows typical output for the show controllers cable-modem command:
Router# show controllers cable-modem 0
BCM Cable interface 0:
BCM3300 unit 0, idb 0x200EB4, ds 0x82D4748, regaddr = 0x800000, reset_mask 0x80
station address 0010.7b43.aa01 default station address 0010.7b43.aa01
PLD VERSION: 32
Tuner: status=0x00
Rx: tuner_freq 699000000, symbol_rate 5055849, local_freq 11520000
snr_estimate 33406, ber_estimate 0, lock_threshold 26000
QAM in lock, FEC in lock, qam_mode QAM_64
Tx: tx_freq 20000000, power_level 0x3E, symbol_rate 1280000
ehdr: 01 06 02 74 34 11
07 status=0x20 bd_index=0x0007 len=0x0000 hdr_len=0x0000
ehdr: 01 06 02 74 34 11
MIB Statistics
DS fifo full = 0, Rerequests = 0
DS mac msg overruns = 0, DS data overruns = 0
Qualified maps = 348, Qualified syncs = 73
CRC fails = 0, HDR chk fails = 0
Data pdus = 0, Mac msgs = 423
Valid hdrs = 423
BCM3300 Registers:
downstream dma:
ds_data_bd_base=0x001D40, ds_mac_bd_base=0x001E80
ds_data_dma_ctrl=0x98, ds_mac_dma_ctrl=0xD8
ds_dma_data_index=0x0007, ds_dma_msg_index=0x0000
upstream dma:
us_bd_base=0x001FB8, us_pd_base=0x002038
us_dma_ctrl=0x80, us_dma_tx_start=0x00
Global control and status:
global_ctrl_status=0x00
interrupts:
irq_pend=0x0008, irq_mask=0x00F7
Router#
The following shows an excerpt from the display for the all option:
Router# show controllers cable-modem 0 all
BCM MAC/PHY: Chip id = BCM3300 Revision A (1)
...
Tuner: status=0x00
Rx: tuner_freq 645000000, symbol_rate 5056000, local_freq 11520000
snr_estimate 345(TenthdB), ber_estimate 0, lock_threshold 23000
QAM in lock, FEC in lock, qam_mode QAM_64 (Annex B)
Tx: tx_freq 27984000, symbol rate 16 (2560000 sym/sec)
power_level: 29.75 dBmV (current)
30 (gain in US AMP units)
5 (BCM3300 attenuation in .4 dB units)
IF AGC=0x2010 (8208) RF AGC=0x3753 (14163)
Combined AGC = 22371 (band = 1)
Router#
Note The show controllers cable-modem 0 all command displays extensive information about the current
state of the modem and its MAC-layer and PHY-layer registers and buffers. You need to open a capture
buffer on your terminal or Telnet software to log this information before you give this command.
Table 6-4 describes the significant fields shown by the show controllers cable-modem command. For
more information, see the Broadcom documentation for the BCM3300 chip.
Field Description
BCM3300 unit Unit number of this BCM3300 chip.
idb Interface description block number.
ds Downstream channel.
regaddr Indicates the start of the BCM3300 registers.
reset_mask Indicates the bit to hit when resetting the chip.
station address MAC address of this router’s cable interface.
default station address Default MAC address assigned by the factory for this router.
PLD VERSION PLD version of the BCM3300 chip.
MAC State Current MAC state of the router.
Prev States Number of states that have previously existed since initialization.
MAC mcfilter MAC control filter for MAC messages.
data mcfilter MAC control filter for data.
DS Downstream Broadcom receiver chip number and ID.
US Upstream Broadcom transmitter chip number and ID.
Tuner: status Current status of the tuner.
Rx: tuner_freq Downstream frequency (in Hz) that the router searched for and found.
symbol_rate Downstream frequency in symbols per second.
local_freq Frequency on which the transmitter and the tuner communicate.
snr_estimate Estimate of signal-to-noise ratio (SNR) in dB multiplied by 1000.
ber_estimate Estimate of bit error rate (always 0).
lock_threshold Minimum signal-to-noise ratio (SNR) that the router will accept as a valid
lock.
qam_mode The modulation scheme used in the downstream direction.
Tx: tx_freq Upstream frequency sent to the router by the CMTS in the UCD message.
power_level Transmit power level as set in the hardware, expressed as a hexadecimal
value. The units are unique to the hardware used. Use the show controllers
cable-modem mac state command to see the power level in dBmV.
symbol_rate Upstream frequency in symbols per second.
TFTP server IP address of the TFTP server at the CMTS.
TOD server IP address of the time-of-day server at the CMTS.
Security server IP address of the security server at the CMTS.
Field Description
Timezone Offset Correction received from the DHCP server to synchronize the router time
clock with the CMTS.
Config filename Name of the file stored on the cable company’s TFTP server that contains
operational parameters for the router.
buffer size Size in bytes of the BCM3300 message buffers.
RX data PDU ring: Indicates the memory location of the beginning of buffer information for the
receive data ring.
rx_head Indicates current head buffer descriptor.
rx_p Indicates current head packet descriptor.
RX MAC message ring: Indicates the memory location of the beginning of buffer information for the
receive MAC message ring.
rx_head_mac Indicates current head buffer descriptor.
rx_p_mac Indicates current head packet descriptor.
TX BD ring: Indicates the memory location of the beginning of buffer information for the
transmit buffer descriptor ring.
tx_count If tx_count is 0, or if tx_head and tx_tail are equal and there is no change for
a period of time, it means there are packets stuck on the ring. This condition
may be caused by the CMTS not giving grants.
tx_head Indicates current head transmit packet descriptor.
head_txp The next packet descriptor to get used, along with its index.When head_txp
and tail_txp are the same, the transmit queue is empty.
tx_tail Indicates current tail transmit packet descriptor.
tail_txp The next packet descriptor to get sent, along with its index. When head_txp
and tail_txp are the same, the transmit queue is empty.
TX PD ring: Indicates the memory location of the beginning of buffer information for the
transmit packet descriptor ring.
tx_head_pd Indicates current head packet descriptor.
tx_tail_pd Indicates current tail packet descriptor.
ehdr Extended MCNS header.
MIB Statistics
DS fifo full Number of times the downstream input first-in first-out (FIFO) buffer
became full on the router.
rerequests Number of times a bandwidth request generated by the router was not
responded to by the CMTS.
DS mac msg overruns Number of times the router’s DMA controller had a downstream MAC
message and there were no free MAC message buffer descriptors to accept
the message.
DS data overruns Number of times the router’s DMA controller had downstream data and there
were no free data PDU buffer descriptors to accept the data.
Qualified maps Number of times a MAP message passed all filtering requirements and was
received by the router.
Field Description
Qualified syncs Number of times a timestamp message was received by the router.
CRC fails Number of times a MAC message failed a cyclic redundancy check (CRC).
HDR chk fails Number of times a MAC header failed its 16-bit CRC check. The MAC
header CRC is a 16-bit Header Check Sequence (HCS) field that ensures the
integrity of the MAC header even in a collision environment.
Data pdus Total number of data protocol data units (PDUs) of all types received by the
router.
Mac msgs Number of MAC messages received by the router.
Valid hdrs Number of valid headers received by the router, including PDU headers,
MAC headers, and headers only.
Global control and Used to reset the BCM3300 chip.
status:
interrupts: Hexadecimal values of the pending IRQ interrupt and IRQ mask.
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Cisco uBR904, Cisco uBR905, Cisco uBR924, and Cisco uBR925 cable access routers, and Cisco CVA122 Cable
Voice Adapter
Usage Guidelines Baseline privacy key management exchanges take place only when both the router and the CMTS are
running code images that support Baseline Privacy Interface (BPI) or BPI Plus (BPI+) encryption, and
the privacy class of service is enabled via the configuration file that is downloaded to the router. Baseline
privacy code images for the router contain k1, k8, or k9 in the code image name.
Examples The following shows typical output for the show controllers cable-modem bpkm command for
DOCSIS 1.0 BPI operation when the CMTS does not have baseline privacy enabled:
Router# show controllers cable-modem 0 bpkm
Field Description
authorization wait time The number of seconds the router waits for a reply after sending the
Authorization Request message to the CMTS.
reauthorization wait The number of seconds the router waits for a reply after it has sent an
time Authorization Request message to the CMTS in response to a
reauthorization request or an Authorization Invalid message from the CMTS.
authorization grace time The number of seconds before the current authorization is set to expire that
the grace timer begins, signaling the router to begin the reauthorization
process.
operational wait time The number of seconds the Traffic Exchange Key (TEK) state machine waits
for a reply from the CMTS after sending its initial Key Request for its SID’s
keying material.
rekey wait time The number of seconds the TEK state machine waits for a replacement key
for this Service ID (SID) after the TEK grace timer has expired and the
request for a replacement key has been made.
tek grace time The number of seconds before the current TEK is set to expire that the TEK
grace timer begins, signaling the TEK state machine to request a replacement
key.
authorization rej wait Number of seconds the router waits before sending another Authorization
time Request message to the CMTS after it has received an Authorization Reject
message.
kek state The current state of the key encryption key that the CMTS uses to encrypt
the traffic encryption keys it sends to the router. See Table 6-7 on page 6-78
for the possible values.
tek state The current state of the traffic encryption key state machine for the specified
SID. See Table 6-7 on page 6-78 for the possible values.
The following shows typical output for the show controllers cable-modem bpkm command for
DOCSIS 1.1 BPI+ operation when baseline privacy is enabled:
Router# show controllers cable-modem 0 bpkm
Router#
Table 6-6 describes the fields shown in the display for BPI+ operation.
Field Description
Privacy Version Whether BPI or BPI+ is being run.
public key The Diffie-Hellman public key that the router uses to establish a BPI+
session with the CMTS.
keks The odd and even values for the key encryption key (KEK).
hmac upstream keys The odd and even values for the hash message authentication code (HMAC)
key used in upstream key requests.
hmac downstream keys The odd and even values for the HMAC message authentication key used in
downstream key replies, key rejects, and invalid TEK messages.
authorization wait time The number of seconds the router waits for a reply after sending the
Authorization Request message to the CMTS.
reauthorization wait The number of seconds the router waits for a reply after it has sent an
time Authorization Request message to the CMTS in response to a
reauthorization request or an Authorization Invalid message from the CMTS.
authorization grace time The number of seconds before the current authorization is set to expire that
the grace timer begins, signaling the router to begin the reauthorization
process.
operational wait time The number of seconds the TEK state machine waits for a reply from the
CMTS after sending its initial Key Request for its SID’s keying material.
rekey wait time The number of seconds the TEK state machine waits for a replacement key
for this SID after the TEK grace timer has expired and the request for a
replacement key has been made.
Table 6-6 show controllers cable-modem bpkm Field Descriptions (BPI+) (continued)
Field Description
tek grace time The number of seconds before the current TEK is set to expire that the TEK
grace timer begins, signaling the TEK state machine to request a replacement
key.
authorization rej wait Number of seconds the router waits before sending another Authorization
time Request message to the CMTS after it has received an Authorization Reject
message.
sa map wait time Number of seconds the router waits for a response after sending a Security
Association (SA) map request before timing out and resending the request.
sa map retries Number of times the router attempts an SA map request before it rejects the
attempt to create a new downstream service flow.
kek state The current state of the key encryption key that the CMTS uses to encrypt
the traffic encryption keys it sends to the router. See Table 6-7 for the
possible values.
tek state The current state of the traffic encryption key state machine for the specified
SID. See Table 6-7 for the possible values.
Table 6-7 describes the valid values for the kek state and tek state fields:
Table 6-7 State Values for KEK and TEK State Fields
State Description
Key Encryption Key (KEK) States
STATE_A_START The router is still completing the DOCSIS provisioning
process. If this state persists, it indicates that BPI/BPI+
encryption was not enabled for the router in its DOCSIS
configuration file.
STATE_B_AUTH_WAIT DOCSIS provisioning has been completed, and the router has
sent an authorization request to the CMTS and is waiting for a
reply. If this state persists, it indicates that the CMTS has not
enabled BPI/BPI+ operations.
STATE_C_AUTHORIZED The router has received a valid authorized reply from the
CMTS, completing the KEK exchange, and allowing the TEK
exchange to begin.
STATE_D_REAUTH_WAIT The router sent a reauthorization request and is waiting for the
reply from the CMTS. A reauthorization request can be sent if
the initial request is rejected, or when existing keys have
expired and must be reacquired.
STATE_E_AUTH_REJ_WAIT The router has received a nonpermanent authorization reject
response from the CMTS and is waiting for the timeout period
before sending another request.
STATE_F_SILENT The router has received a permanent authorization reject
response from the CMTS and has been placed in silent mode,
in which it does not pass traffic but does accept SNMP
management requests. (Valid only for BPI+ operations.)
Table 6-7 State Values for KEK and TEK State Fields (continued)
State Description
Traffic Encryption Key (TEK) States
STATE_A_START The router is still completing the DOCSIS provisioning
process, or is still performing the KEK key exchange. If this
state persists, it indicates that KEK authorization failed, or that
BPI/BPI+ encryption was not enabled for the router in its
DOCSIS configuration file.
STATE_B_OP_WAIT The router has successfully completed the KEK key exchange,
has sent a key request to the CMTS, and is waiting for a reply.
STATE_C_OP_REAUTH_WAIT The router has sent a reauthorization request and is waiting for
a reply, or the TEK key has been declared invalid. BPI/BPI+
encryption has not yet begun. If this state persists, it indicates
that the TEK key exchange has failed.
STATE_D_OPERATIONAL The router has completed the TEK key exchange, and BPI or
BPI+ encryption is operational between the router and the
CMTS.
STATE_E_REKEY_WAIT The existing TEK keys have expired, and the router has
requested a key update from the CMTS.
STATE_F_REKEY_REAUTH_WAIT The router has requested a key update from the CMTS and is
waiting for a reply. BPI/BPI+ encryption can continue using
the existing keys until they expire.
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Cisco uBR905 and uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Usage Guidelines This command displays the classifiers that are currently defined for both the upstream and downstream.
The information shown corresponds to the Quality of Service classifier parameters that are listed in
Appendix C of the DOCSIS 1.1 specification.
Examples The following example shows typical output for both upstream and downstream classifiers on the show
controllers cable-modem classifiers command:
Router# show controllers cable-modem 0 classifiers
IP classifiers
Tos: 0x1 0x3 0xFF
Protocol: 258
Source Address: 0.0.0.0
Source Mask: 255.255.255.255
Destination Address: 0.0.0.0
Destination Mask: 255.255.255.255
Source Port Start: 0
Source Port End: 65535
Destination Port Start: 0
Destination Port End: 65535
LLC Classifiers
Source MAC address: 0:0:0:0:0:0
Ether Type: 0x0 0x0 0x0
IP classifiers
Tos: 0x5 0x5 0xD
Protocol: 258
Source Address: 0.0.0.0
Source Mask: 255.255.255.255
Destination Address: 0.0.0.0
Destination Mask: 255.255.255.255
Source Port Start: 0
Source Port End: 65535
LLC Classifiers
Destination MAC address: 0:0:0:0:0:0:0:0:0:0:0:0
Source MAC address: 0:0:0:0:0:0
Ether Type: 0x0 0x0 0x0
IP classifiers
Tos: 0x8 0xFF 0xF8
Protocol: 258
Source Address: 0.0.0.0
Source Mask: 255.255.255.255
Destination Address: 0.0.0.0
Destination Mask: 255.255.255.255
Source Port Start: 0
Source Port End: 65535
Destination Port Start: 0
Destination Port End: 65535
LLC Classifiers
Destination MAC address: 0:0:0:0:0:0:0:0:0:0:0:0
Source MAC address: 0:0:0:0:0:0
Ether Type: 0x0 0x0 0x0
Router#
The following shows the typical display for the summary option:
Router# show controllers cable-modem 0 classifiers summary
Router#
The following shows the detailed information that is displayed for a specific classifier:
Router# show controllers cable-modem 0 classifiers 4
Field Description
Classifier Reference, The reference ID to uniquely identify the classifier in the DOCSIS
Classifier Ref configuration file and MAC management messages.
Classfier ID The ID used to uniquely identify the classifier in each service flow.
Service Flow Reference, The reference ID that uniquely identifies the service flow.
SF Ref
Service Flow ID, SFID The ID that uniquely identifies the service flow.
Rule Priority The priority assigned to the classifier, 0 to 255, with a higher value
indicating a higher priority.
Activation State, State Whether the classifier is activate (1) or inactive (0).
Dynsrv Change Action The action taken for this classifier in dynamic service change messages:
• 0 = Add the classifier.
• 1 = Replace the classifier.
• 2 = Delete the classifier.
SID The service ID (SID) associated with this classifier.
IP Classifiers
ToS The matching Type of Service (Tos) low byte, high byte, and masking
value.
Protocol The matching IP protocol type, as given in RFC 1700. A value of 256
matches any IP protocol, and a value of 257 matches TCP and UDP traffic.
Source Address and The matching IP source address, where the source address is ANDed with
Source Mask the source mask to specify the valid range of source addresses.
Destination Address and The matching IP destination address, where the destination address is
Destination Mask ANDed with the destination mask to specify the valid range of destination
addresses.
Source Port Start and The low end and high end matching source TCP/UDP port values.
Source Port End
Destination Port Start The low end and high end matching destination TCP/UDP port values.
and Destination Port End
LLC Classifiers
Destination MAC The six-byte matching MAC destination address and six-byte mask. The
address first six bytes (address) are ANDed with the last six bytes (mask) to
specify the valid range of MAC destination addresses.
Field Description
Source MAC address The six-byte matching MAC source address.
Ether Type The one-byte Ethernet protocol type and two-byte matching layer 3
protocol ID in the Ether frame. The first byte can have the following
values, which control the meaning of the following two bytes:
• 0x00 = no matching Ethernet protocol is required.
• 0x01 = Ethertype DIX or SNAP frames that match the two-byte packet
type.
• 0x02 = non-SNAP IEEE 802.2 encapsulation frames that match the
eight-bit packet type.
• 0x03 = MAC Management Messages with a type field between the two
bytes, except that RNG_RSP, REG_REQ, REG_RSP, and REG_ACK
frames are always matched.
• 0x04 = matches all data PDU packets, regardless of the two-byte
protocol ID.
Cisco uBR905 and Cisco uBR925 cable access routers, and Cisco CVA122 Cable Voice Adapter
Usage Guidelines This command displays the router’s X.509 DOCSIS cable-modem certificate, which uniquely identifies
the router during the BPI+ negotiation process. This command shows the individual X.509 components
of the certificate, starting with the DOCSIS restricted X.501 Distinguished Name and ending with the
1024-bit public key.
Tip This command displays the certificate that is burned into the router at the factory and is not normally
changed. The show controllers cable-modem manuf-cert command displays the manufacturer’s
certificate that is incorporated into the Cisco IOS image that the router is currently running. Upgrading
the Cisco IOS image could also update the manufacturer’s certificate.
Examples The following example shows the starting lines and ending lines of typical output for the show
controllers cable-modem cmcert command:
Router# show controllers cable-modem 0 cmcert
OID(3):Country 2.5.4.6
1w3d: PRT(2):US
END
END
SET(22)
SEQ(20)
OID(3):Organization 2.5.4.10
1w3d: PRT(13):Cisco Systems
END
END
SET(15)
SEQ(13)
OID(3):Organization Unit 2.5.4.11
1w3d: PRT(6):DOCSIS
END
END
SET(58)
SEQ(56)
OID(3):Common Name 2.5.4.3
1w3d: PRT(49):Cisco Cable Modem Root Certificate Authority R
END
END
...
1w3d: C7 9A A8 5C BD F3 30 5A E5 B6 66 1F 1E 3A C9 2E
1w3d: 04 5D B5 57 3E 75 ED A3 0A AB B6 5D 73 87 E9 BE
1w3d: ED 1A 68 7B B3 08 DA 0F E9 AA 05 28 E2 61 1B 3D
1w3d: END
Router#
Note You must manually enter a return to redisplay the router prompt after the certificate has been displayed.
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Examples The following shows typical output for the show controllers cable-modem crypto des command.
Router# show controllers cable-modem 0 crypto des
downstream des:
ds_des_key_table:
key 0: even 0, odd 0
key 1: even 0, odd 0
key 2: even 0, odd 0
key 3: even 0, odd 0
ds_des_cbc_iv_table:
iv 0: even 0, odd 0
iv 1: even 0, odd 0
iv 2: even 0, odd 0
iv 3: even 0, odd 0
ds_des_sid_table:
sid_1=0x0000, sid_2=0x0000, sid_3=0x0000, sid_4=0x0000
ds_des_sid_enable=0x80, ds_des_ctrl=0x2E
ds_des_sv=0x0F00
ds_unencrypted_length=0x0C
upstream des:
us_des_key_table:
key 0: even 0, odd 0
key 1: even 0, odd 0
key 2: even 0, odd 0
key 3: even 0, odd 0
us_des_cbc_iv_table:
iv 0: even 0, odd 0
iv 1: even 0, odd 0
iv 2: even 0, odd 0
iv 3: even 0, odd 0
pb_req_bytes_to_minislots=0x10
us_des_ctrl=0x00, us_des_sid_1= 0x1234
ds_unencrypted_length=0x0C
Router#
Table 6-9 describes the significant fields shown in the display. For more information, see the Broadcom
documentation for the BCM3300 chip.
Field Description
ds_des_key_table Displays a table showing the downstream DES keys.
ds_des_cbc_iv_table Displays a table showing the downstream DES Cipher Block Chaining
(CBC) mode information.
ds_des_sid_table Displays a table showing the SID values to be enabled for DES encryption.
ds_des_sid_enable Identifies which SID entries in the SID table are enabled for encryption. In
the above example, none of the entries are enabled for encryption.
ds_des_ctrl Control register that identifies the operating mode of the downstream DES
engine.
ds_des_sv Displays the DES security version register; the range of the version field in
the Baseline Privacy Interface (BPI) extended headers that will be accepted
by the hardware. High byte is upper limit, low byte is lower limit. The router
will accept versions 0 to 15.
ds_unencrypted_length Specifies the number of bytes that will be unencrypted at the beginning of
the MAC frame. 0x0C means the first 12 bytes are not encrypted, which is
what the DOCSIS Baseline Privacy specification calls for.
us_des_key_table Displays a table showing upstream DES keys.
us_des_cbc_iv_table Displays a table of upstream DES CBC mode information.
us_des_ctrl Control register that controls the operating mode of the upstream DES
engine. The value 0x24 means that the upstream is configured to enable
decryption and to use CBC mode.
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
show controllers cable-modem Displays the mini-slot lookup table for the cable interface.
lookup-table
show controllers cable-modem Displays detailed MAC-layer information for the cable interface.
mac
show controllers cable-modem Displays the contents of the registers used in the downstream
phy physical hardware for the cable interface.
show controllers cable-modem Displays the settings for the upstream and downstream tuners used
tuner by the cable interface.
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Usage Guidelines Some of the filtering parameters are MAC hardware addresses, Service IDs (SIDs), and upstream
channel IDs.
Examples The following shows typical MAC and SID filter information displayed by the show controllers
cable-modem filters command:
Router# show controllers cable-modem 0 filters
burst_maps:
map[0]=0 map[1]=0 map[2]=0 map[3]=0
bytes_per_minislot_exp=0x04
us_map_parser_minislot_adv=0x03, ticks_per_minislot=0x08, maint_xmit=0x0001
us_sid_table:
sid_1=0x0000, sid_2=0x0000, sid_3=0x0000, sid_4=0x0000
max_re_req=0x0010, rang_fifo=0x00
Router#
Table 6-10 describes the fields shown in the display. For more information, see the Broadcom
documentation for the BCM3300 chip.
Field Description
ds_mac_da_filters MAC address of the cable interface and the MAC address of any Ethernet
MAC it is bridging.
ds_mac_da_filter_ctrl Downstream MAC filter control for data.
ds_mac_msg_sof Downstream MAC message start of frame.
ds_mac_da_mc Downstream MAC control filter for data.
map_parser_sids Service IDs used for upstream bandwidth allocation.
ds_mac_filter_ctrl Downstream MAC filter control for MAC messages.
us_channel_id Upstream channel ID.
ds_pid Downstream packet ID.
mac_msg_proto_ver Version of the MAC management protocol in use.
reg_rang_req_sid Service ID (SID) field of the ranging request message.
ds_data_da_filter_table Downstream data processing filter table.
ds_data_da_filter_ctrl Downstream data processing filter control.
ds_pdu_sof Downstream PDU start of frame.
ds_data_da_mc Downstream data processing MAC control.
us_ctrl_status Upstream control status.
Minislots per request Length of each registration request in mini-slots.
burst_maps Maps the burst profiles saved in the BCM3037 registers to interval usage
codes (IUCs).
bytes_per_minislot_exp Number of bytes per expansion mini-slot.
ticks_per_minislot Number of time ticks (6.25-microsecond intervals) in each upstream
mini-slot.
maint_xmit Number of initial maintenance transmit opportunities.
us_sid_table Upstream service ID table.
max_re_req Maximum number of registration re-requests allowed.
rang_fifo Number of ranging requests that can be held in the first-in-first-out (FIFO)
buffer.
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Usage Guidelines This command displays the details of the lookup table. The driver uses this table to convert the size of
the packets that the router wants to transmit into a bandwidth request to the CMTS in mini-slots. The
contents of this table are affected by the upstream symbol rate that is negotiated between the CMTS and
the cable access router.
Use this table to look up the packet size and determine how many mini-slots will be needed.
Examples The following shows a typical mini-slot lookup table as displayed by the show controllers
cable-modem lookup-table command:
Router# show controllers cable-modem 0 lookup-table
000: 01 06 06 06 06 06 06 06 06 06 06 06 06 06 06 06
010: 06 06 06 06 06 06 06 06 06 06 06 06 06 06 06 06
020: 06 06 06 06 06 06 06 06 06 06 06 06 06 06 06 06
030: 06 06 06 06 06 06 06 06 06 06 06 06 06 06 06 06
040: 06 06 06 06 06 06 06 06 06 06 06 06 10 10 10 10
050: 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10
060: 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10
070: 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10
080: 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10
090: 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10
0A0: 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10
0B0: 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10
0C0: 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10 10
0D0: 10 10 10 10 10 10 10 10 10 10 10 10 10 1F 1F 1F
0E0: 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F
0F0: 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F
100: 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F
110: 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F
120: 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F
130: 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F
140: 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F
150: 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F
160: 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F
170: 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F
180: 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F
190: 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F
1A0: 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F 1F
1B0: 1F 1F 1F 1F 1F 1F 1F 1F 1F 2D 2D 2D 2D 2D 2D 2D
1C0: 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D
1D0: 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D
1E0: 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D
1F0: 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D
200: 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D
210: 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D
220: 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D
230: 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D
240: 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D
250: 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D
260: 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D
270: 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D
280: 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D 2D
290: 2D 2D 2D 2D 2D 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C
2A0: 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C
2B0: 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C
2C0: 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C
2D0: 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C
2E0: 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C
2F0: 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C
300: 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C
310: 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C
320: 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C
330: 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C
340: 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C
350: 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C
360: 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C 3C
370: 3C 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B
380: 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B
390: 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B
3A0: 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B
3B0: 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B
3C0: 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B
3D0: 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B
3E0: 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B
3F0: 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B
400: 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B
410: 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B
420: 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B
430: 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B
440: 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 4B 5A 5A 5A
450: 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A
460: 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A
470: 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A
480: 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A
490: 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A
4A0: 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A
4B0: 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A
4C0: 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A
4D0: 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A
4E0: 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A
4F0: 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A
500: 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A
510: 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A 5A
520: 5A 5A 5A 5A 5A 5A 5A 5A 5A 68 68 68 68 68 68 68
530: 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68
540: 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68
550: 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68
560: 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68
570: 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68
580: 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68
590: 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68
5A0: 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68
5B0: 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68
5C0: 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68
5D0: 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68
5E0: 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68
5F0: 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68 68
600: 68 68 68 68 68 77 77 77 77 77 77 77 77 77 77 77
610: 77 77 77 77 77 77 77 77 77 77 77 77 77 77 77 77
620: 77 77 77 77 77 77 77 77 77 77 77 77 77 77 77 77
630: 77 77 77 77 77 77 77 77 77 77 77 77 77 77 77 77
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
show controllers cable-modem number mac {errors | hardware | log | resets | state}
Usage Guidelines MAC log messages are written to a circular log file even when debugging is not turned on. These
messages include timestamps, events, and information pertinent to these events. Use the show
controllers cable-modem mac log command to view MAC log messages.
If the router interface fails to come up or resets periodically, the MAC log will capture what happened.
For example, if an address is not obtained from the DHCP server, an error is logged, initialization starts
over, and the router scans for a downstream frequency.
The most useful keywords for troubleshooting a router are log, errors, and resets. See the following
examples for typical outputs for these options.
Examples The following shows a typical display of the MAC log file for a cable interface that has successfully
registered with the CMTS:
Router# show controllers cable-modem 0 mac log
The following example gives the typical error messages that appear in the MAC log when the DHCP
server cannot not be reached:
Router# show controllers cable-modem 0 mac log
Router#
In this situation, use the MAC error display also contains information indicating that the DHCP server
could not be reached:
Router# show controllers cable-modem 0 mac errors
The following is a typical display of the MAC error log information, which is the same information that
is also available using SNMP:
Router# show controllers cable-modem 0 mac errors
This output indicates that the router acquired a downstream lock, successfully read a UCD, and
successfully read a MAP. However, it was unable to communicate with the CMTS after ranging through
all upstream transmit power levels. The router will try to communicate with the CMTS 16 times, and if
cannot receive a response from the CMTS, it will reset the cable interface to try to find a better
downstream frequency.
The show controllers cable-modem 0 mac resets command shows only the entries in the MAC log that
begin with the field CMAC_LOG_RESET. These fields provide you with a summary of the most recent reasons
why the cable interface was reset.
Reset messages and brief explanations are included in the following examples. However, the reset
messages do not commonly occur.
The following example shows the errors that are logged when the configuration file downloaded from
the TFTP server could not be read, typically because the file might not exist, or because the file might
have incorrect permissions.
Router# show controllers cable-modem 0 mac resets
62526.114 CMAC_LOG_RESET_CONFIG_FILE_READ_FAILED
62564.368 CMAC_LOG_RESET_T4_EXPIRED
62677.178 CMAC_LOG_RESET_CONFIG_FILE_READ_FAILED
62717.462 CMAC_LOG_RESET_CONFIG_FILE_READ_FAILED
62757.746 CMAC_LOG_RESET_CONFIG_FILE_READ_FAILED
62796.000 CMAC_LOG_RESET_T4_EXPIRED
62908.808 CMAC_LOG_RESET_CONFIG_FILE_READ_FAILED
62949.092 CMAC_LOG_RESET_CONFIG_FILE_READ_FAILED
62989.380 CMAC_LOG_RESET_CONFIG_FILE_READ_FAILED
63029.662 CMAC_LOG_RESET_CONFIG_FILE_READ_FAILED
63069.944 CMAC_LOG_RESET_CONFIG_FILE_READ_FAILED
63110.228 CMAC_LOG_RESET_CONFIG_FILE_READ_FAILED
63148.484 CMAC_LOG_RESET_T4_EXPIRED
63261.296 CMAC_LOG_RESET_CONFIG_FILE_READ_FAILED
Router#
The following example shows that the DHCP server could not be reached, or that it took too long to
respond.
Router# show controllers cable-modem 0 mac resets
497989.804 CMAC_LOG_RESET_DHCP_WATCHDOG_EXPIRED
498024.046 CMAC_LOG_RESET_DHCP_WATCHDOG_EXPIRED
498058.284 CMAC_LOG_RESET_DHCP_WATCHDOG_EXPIRED
Router#
The following example indicates that an event in the cable interface driver caused the interface to reset.
This often occurs because a shutdown command was just issued on the interface.
Router# show controllers cable-modem 0 mac resets
527986.444 CMAC_LOG_RESET_FROM_DRIVER
528302.042 CMAC_LOG_RESET_FROM_DRIVER
528346.600 CMAC_LOG_RESET_FROM_DRIVER
528444.494 CMAC_LOG_RESET_FROM_DRIVER
Router#
Table 6-11 describes the status messages that can appear in the show controllers cable-modem mac
resets command.
Message Description
CMAC_LOG_RESET_CONFIG_FILE_PARSE_FAILED The format of the DOCSIS configuration file acquired from the
TFTP server is not acceptable.
CMAC_LOG_RESET_LOSS_OF_SYNC Synchronization with the CMTS has been lost (SYNC messages are
not being received).
CMAC_LOG_RESET_T4_EXPIRED The maintenance ranging opportunities for this router are not being
received from the CMTS.
CMAC_LOG_RESET_DHCP_WATCHDOG_EXPIRED The DHCP server took too long to respond.
CMAC_LOG_RESET_TOD_WATCHDOG_EXPIRED The Time-of-Day (ToD) server took too long to respond.
CMAC_LOG_RESET_PRIVACY_WATCHDOG_EXPIRED The baseline privacy exchange with the CMTS took too long.
CMAC_LOG_RESET_CHANGE_US_WATCHDOG_EXPIRED The router was unable to transmit a response to a UCC-REQ
message.
CMAC_LOG_RESET_SECURITY_WATCHDOG_EXPIRED A “full security” exchange with the CMTS took too long.
CMAC_LOG_RESET_CONFIG_FILE_WATCHDOG_EXPIRED The TFTP server took too long to respond.
CMAC_LOG_RESET_ALL_FREQUENCIES_SEARCHED All downstream frequencies to be searched have been searched.
Note This message indicates that downstream frequencies were
found, but the router failed to acquire a downstream lock.
CMAC_LOG_RESET_T2_EXPIRED Initial ranging opportunities are not being received.
Table 6-11 show controllers cable-modem mac resets Field Descriptions (continued)
Message Description
CMAC_LOG_RESET_T3_RETRIES_EXHAUSTED The CMTS failed too many times to respond to a RNG-REQ
message.
Note After 16 T3 timeouts, the router will reset the cable
interface.
CMAC_LOG_RESET_RANGING_ABORTED The CMTS commanded the router to abort the ranging process.
CMAC_LOG_RESET_NO_MEMORY The router has run out of memory.
CMAC_LOG_RESET_CANT_START_PROCESS The router was unable to start an internal process necessary to
complete ranging and registration.
CMAC_LOG_RESET_CONFIG_FILE_READ_FAILED The reading of the configuration file from the TFTP server failed.
Note The file might not exist, or it might have incorrect
permissions.
CMAC_LOG_RESET_AUTHENTICATION_FAILURE The router failed authentication as indicated in a REG-RSP message
from the CMTS.
CMAC_LOG_RESET_SERVICE_NOT_AVAILABLE The CMTS has failed the router’s registration because a required or
requested class of service is not available.
CMAC_LOG_RESET_T6_RETRIES_EXHAUSTED The CMTS failed too many times to respond to a REG-REQ
message.
CMAC_LOG_RESET_MAINTENANCE_WATCHDOG_DRIVER The router MAC layer failed to detect a change in the interface
driver.
CMAC_LOG_RESET_NET_ACCESS_MISSING The Network Access parameter is missing from the DOCSIS
configuration file.
CMAC_LOG_RESET_FAILED_WRITE_ACCESS_CONTROL The router was unable to set the Write Access Control for an SNMP
parameter as specified by the DOCSIS configuration file.
CMAC_LOG_RESET_DHCP_FAILED The DHCP server did not respond with all the required values. The
required values are: IP address, network mask, TFTP server IP
address, TOD server IP address, DOCSIS configuration file name,
and time zone offset.
CMAC_LOG_RESET_CANT_START_DS_TUNER_PRCESS The router was unable to start the internal process used to manage
the downstream tuner.
CMAC_LOG_RESET_TOO_MANY_DS_LOCKS_LOST Downstream QAM/FEC lock has been lost too many times.
CMAC_LOG_RESET_NO_SEND_TO_DS_TUNER_PROCESS The router MAC-layer process was unable to communicate with the
downstream tuner management process.
CMAC_LOG_RESET_DS_TUNER_WATCHDOG The downstream tuner process failed to report its continuing
operation for a long period of time.
CMAC_LOG_RESET_UNABLE_TO_SET_MIB_OBJECT The router was unable to set an SNMP parameter as specified by the
DOCSIS configuration file.
CMAC_LOG_RESET_MIB_OBJECT_PROCESS_WATCHDOG The internal MIB object took too long to process the entries in the
DOCSIS configuration file.
The following example is a typical display for the show controllers cable-modem 0 mac hardware
command. The most interesting bit is the station address (hardware address). The MIB statistics reflect
the MAC hardware counters for various events, but these counters are typically reset every few seconds,
so their contents are not accurate in this display.
Router# show controllers cable-modem 0 mac hardware
PLD VERSION: 32
MIB Statistics
DS fifo full = 0, Rerequests = 0
DS mac msg overruns = 0, DS data overruns = 0
Qualified maps = 0, Qualified syncs = 0
CRC fails = 0, HDR chk fails = 0
Data pdus = 0, Mac msgs = 0
Valid hdrs = 0
BCM3300 Registers:
downstream dma:
ds_data_bd_base=0x001D40, ds_mac_bd_base=0x001E80
ds_data_dma_ctrl=0x98, ds_mac_dma_ctrl=0x98
ds_dma_data_index=0x0000, ds_dma_msg_index=0x0000
upstream dma:
us_bd_base=0x001FB8, us_pd_base=0x002038
us_dma_ctrl=0x00, us_dma_tx_start=0x00
global control and status:
global_ctrl_status=0x00
interrupts:
irq_pend=0x0018, irq_mask=0x00E7
timing recovery circuit:
loop_enable=0x00, minislot_divisor=0x00
K0_ctrl=0x06, K1_ctrl=0x07, acq_threshhold=0x01
err_threshhold=0x04, timeout_threshold=0xFF
nco_bias=0x4F7004F7, ranging_offset=0x00000000
ts_err=0x00, sync_valid=0x00, delta_F=0x00
timeout_err=0x00
spi:
dynamic_ctrl=0x09, static_ctr=0x9F, autonomous=0x01
irq_ack=0x00, spi_cmd=0x51, spi_addr=0x11
spi_data= FF/00/00/00/00/00/00
burst profiles:
profile 0:
01 19 1D 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
profile 1:
01 19 1D 03 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
profile 2:
01 19 1D 04 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
profile 3:
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Router#
Table 6-12 describes the MIB statistics shown in the display for this command.
Field Description
DS fifo full Number of times the downstream receive buffer on the router has become
full.
Rerequests Number of registration requests sent by the router to the CMTS.
DS mac msg overruns Number of times the DMA controller has had a downstream MAC message
and there were no free MAC message buffer descriptors to accept the
message.
DS data overruns Number of times the DMA controller has had downstream data and there
were no free data PDU buffer descriptors to accept the data.
Qualified maps Number of valid MAP messages received by the router.
Qualified syncs Number of times the router has received synchronization with the
downstream channel.
CRC fails Number of cyclic redundancy checks (CRCs) generated by the far-end
device that did not match the checksums calculated from the message
portions of the packets received.
HDR check fails Number of cyclic redundancy checks (CRCs) generated by the far-end
device that did not match the checksums calculated from the MAC headers
of the packets received. The MAC header CRC is a 16-bit Header Check
Sequence (HCS) field that ensures the integrity of the MAC header even in
a collision environment.
Data pdus Total number of data PDUs (protocol data units) of all types received by the
cable interface.
Mac msgs Number of MAC messages received by the cable interface.
Valid hdrs Number of valid MAC headers received by the cable interface.
Below the MIB statistics in the show controllers cable-modem 0 mac hardware display, the BCM3300
registers section shows the DMA locations of the indicated processing routines of the Broadcom 3220
MAC chip within the router.
The following is typical output from the show controllers cable-modem mac state command that
summarizes the state of the cable MAC layer and provides a list of downstream search frequency bands
and the order in which they are searched. The normal operational state of the interface is the
maintenance_state. If the cable MAC layer is in the wait_for_link_up_state, the information shown
in the display corresponds to the last time the interface was up.
Router# show controller cable-modem 0 mac state
MIB Values:
Mac Resets: 0
Sync lost: 0
Invalid Maps: 0
Invalid UCDs: 0
Invalid Rng Rsp: 0
Invalid Reg Rsp: 0
T1 Timeouts: 0
T2 Timeouts: 0
T3 Timeouts: 4
T4 Timeouts: 0
Range Aborts: 0
DS ID: 1
DS Frequency: 663000000
DS Symbol Rate: 5056941
DS QAM Mode 64QAM
DS Search:
88 453000000 855000000 6000000
89 93000000 105000000 6000000
90 111250000 117250000 6000000
91 231012500 327012500 6000000
92 333015000 333015000 6000000
93 339012500 399012500 6000000
94 405000000 447000000 6000000
95 123015000 129015000 6000000
96 135012500 135012500 6000000
97 141000000 171000000 6000000
98 219000000 225000000 6000000
99 177000000 213000000 6000000
US ID: 1
US Frequency: 20000000
US Power Level: 34.0 (dBmV)
US Symbol Rate: 1280000
Ranging Offset: 12460
Mini-Slot Size: 8
Change Count: 4
Preamble Pattern: CC CC CC CC CC CC CC CC CC CC CC CC CC CC 0D 0D
A9 17 D9 C3 52 2F B3 86 A4 5F 67 0D 48 BE CE 1A
91 7D 9C 35 22 FB 38 6A 45 F6 70 D4 8B EC E1 A9
17 D9 C3 52 2F B3 86 A4 5F 67 0D 48 BE CE 1A 91
F3 F3 F3 F3 F3 F3 F3 F3 F3 F3 F3 F3 F3 F3 F3 F3
F3 F3 F3 F3 F3 F3 F3 F3 F3 F3 F3 F3 33 F7 33 F7
88 84 04 4C C4 84 C0 0C 44 08 08 CC 8C 0C 80 48
88 40 44 CC 48 4C 00 C4 40 80 8C C8 C0 C8 04 88
Burst Descriptor 0:
5 2 2 2 F4 7 811C24B0
Router#
Field Description
MAC State Current operational state of the MAC layer of the router.
Ranging SID Service ID used for ranging requests.
Registered Indicates whether or not the router is currently registered with the CMTS.
Privacy Established Indicates whether or not keys for baseline privacy have been exchanged
between the router and the CMTS, establishing privacy.
Privacy Version Indicates whether the router is using BPI or BPI+ baseline privacy.
DOCSIS Operating Mode Indicates the DOCSIS revision that the router has been provisioned for
(DOCSIS 1.0 or DOCSIS 1.1).
Snmp Operating Mode Indicates the current SNMP operating mode:
• Co-existence Mode—SNMPv3 co-existence model
• NmAccess Mode—SNMPv2 model
Mac Resets Number of times the router reset or initialized this interface.
Sync lost Number of times the router lost synchronization with the downstream
channel.
Invalid Maps Number of times the router received invalid MAP messages.
Table 6-13 show controller cable-modem mac state Field Descriptions (continued)
Field Description
Invalid UCDs Number of times the router received invalid upstream channel descriptor
(UCD) messages.
Invalid Rng Rsp Number of times the router received invalid ranging response messages.
Invalid Reg Rsp Number of times the router received invalid registration response
messages.
T1 Timeouts Number of timeouts caused by the router not receiving a valid UCD from
the CMTS within the specified time.
T2 Timeouts Number of timeouts caused by the router not receiving a maintenance
broadcast for ranging opportunities from the CMTS within a specified
time.
T3 Timeouts Number of timeouts caused by the router not receiving a response within
a specified time from the CMTS to a RNG-REQ message during initial
maintenance.
T4 Timeouts Number of timeouts caused by the router not receiving a response within
a specified time from the CMTS to a periodic maintenance request.
Range Aborts Number of times the ranging process was aborted by the CMTS.
DS ID Identifier of the downstream channel on which this MAC management
message has been transmitted. This identifier is arbitrarily chosen by the
CMTS and is only unique within the MAC-sublayer domain.
DS Frequency Downstream frequency acquired by the router during its last initialization
sequence.
DS Symbol Rate Downstream frequency in symbols per second.
DS QAM Mode Downstream modulation scheme being used by the router.
DS Search Frequency bands scanned by the router when searching for a downstream
channel. The router’s default frequency bands correspond to the North
American EIA CATV channel plan for 6 MHz channel slots between
90 MHz and 858 MHz.
US ID Identifier of the upstream channel to which this MAC management
message refers. This identifier is arbitrarily chosen by the CMTS and is
only unique within the MAC-sublayer domain.
US Frequency Transmission frequency used by the router in the upstream direction.
US Power Level Transmit power level of the router in the upstream direction.
US Symbol Rate Upstream frequency in symbols per second.
Ranging Offset Delay correction (in increments of 6.25 microseconds/64) applied by the
router to the CMTS upstream frame time derived at the router. Used to
synchronize the upstream transmissions in the time division multiple
access (TDMA) scheme, this value is roughly equal to the round-trip delay
of the router from the CMTS.
Mini-Slot Size Size T of the mini-slot for this upstream channel in units of the timebase
tick of 6.25 microseconds. Allowable values are 2, 4, 8, 16, 32, 64, or 128.
Table 6-13 show controller cable-modem mac state Field Descriptions (continued)
Field Description
Change Count Incremented by 1 by the CMTS whenever any of the values of this channel
descriptor change. If the value of this count in a subsequent upstream
channel descriptor (UCD) remains the same, the router can quickly decide
that the remaining fields have not changed, and may be able to disregard
the remainder of the message.
Preamble Pattern Byte pattern used for the preamble.
Burst Descriptor: A compound type/length/value (TLV) encoding that defines, for each type
of upstream usage interval, the physical-layer characteristics that are to be
used during that interval. Each burst descriptor is given an identifying
number.
Interval Usage Code Each upstream transmit burst belongs to a class which is given a number
called the interval usage code (IUC). Bandwidth MAP messages are used
by IUC codes to allocate upstream time slots. The following types are
currently defined:
1. Request: bandwidth request slot
2. Request/Data: bandwidth request or data slot
3. Initial Maintenance: initial link registration contention slot
4. Station Maintenance: link keep-alive slot
5. Short Data Grant: short data burst slot
6. Long Data Grant: long data burst slot
Modulation Type Upstream modulation format. (1 = QPSK; 2 = 16-QAM)
Differential Encoding Indicates whether or not differential encoding is used. (1 = yes; 2 = no)
Preamble Length Length of the preamble in bits. This value must be an integral number of
symbols—a multiple of 2 for QPSK; a multiple of 4 for 16-QAM.
FEC Error Correction Length of the forward error correction in bytes. The range is 0 to 10 bytes;
a value of 0 implies no forward error correction.
FEC Codeword Info Number of information bytes in the FEC codeword.
Bytes
Scrambler Seed 15-bit seed value loaded at the beginning of each burst after the register
has been cleared. Not used if scrambler is off.
Maximum Burst Size Maximum number of mini-slots that can be transmitted during this burst
type. When the interval type is Short Data Grant, this value must be
greater than 0. If this value is 0, the burst size is limited elsewhere.
Guard Time Size Amount of time in symbols between the center of the last symbol of a
burst and the center of the first symbol of the preamble of an immediately
following burst in an upstream transmission from the router to the CMTS.
Last Codeword Length Indicates whether or not the length of the last codeword is fixed or
shortened. (1 = fixed; 2 = shortened)
Scrambler on/off Indicates whether or not a scrambler is enabled in the upstream modulator.
(1 = on; 2 = off)
Network Access Indicates whether or not the router has access to the HFC network.
Table 6-13 show controller cable-modem mac state Field Descriptions (continued)
Field Description
Concatenation Indicates whether DOCSIS 1.1 concatenation is enabled or disabled.
Maximum CPEs Maximum number of CPEs supported for this cable modem.
Vendor ID Unique identifier specifying the CM manufacturer.
Auth. Wait Timeout Number of seconds the router waits for a reply after sending the
Authorization Request message to the CMTS.
Reauth. Wait Timeout Number of seconds the router waits for a reply after it has sent an
Authorization Request message to the CMTS in response to a
reauthorization request or an Authorization Invalid message from the
CMTS.
Auth. Grace Time Number of seconds before the current authorization is set to expire that the
grace timer begins, signaling the router to begin the reauthorization
process.
Op. Wait Timeout Number of seconds the TEK state machine waits for a reply from the
CMTS after sending its initial Key Request for its SID’s keying material.
Retry Wait Timeout Number of seconds the TEK state machine waits for a replacement key for
this SID after the TEK grace timer has expired and the request for a
replacement key has been made.
TEK Grace Time Number of seconds before the current TEK is set to expire that the TEK
grace timer begins, signaling the TEK state machine to request a
replacement key.
Auth. Reject Wait Time Number of seconds the router waits before sending another Authorization
Request message to the CMTS after it has received an Authorization
Reject message.
Assigned SID Service ID assigned by the CMTS for the corresponding service class.
Max Downstream Rate Maximum downstream rate in bits per second that the CMTS is permitted
to forward to CPE unicast MAC addresses learned or configured as
mapping to this router. This rate does not include MAC packets addressed
to broadcast or multicast MAC addresses.
Max Upstream Rate Maximum upstream rate in bits per second that the router is permitted to
forward to the RF network. This rate includes packet PDU data packets
addressed to broadcast or multicast addresses.
Upstream Priority Relative priority assigned to this service class for data transmission in the
upstream channel. Higher numbers indicate higher priority.
Min Upstream Rate Date rate in bits per second that will be guaranteed to this service class on
the upstream channel.
Max Upstream Burst Maximum transmit burst in bytes allowed for this service class on the
upstream channel.
Privacy Enable Indicates whether or not Baseline Privacy is enabled for this service class.
Ranging Backoff Start Initial back-off window for initial ranging contention, expressed as a
power of 2. Valid values are from 0 to 15.
Ranging Backoff End Final back-off window for initial ranging contention, expressed as a power
of 2. Valid values are from 0 to 15.
Table 6-13 show controller cable-modem mac state Field Descriptions (continued)
Field Description
Data Backoff Start Initial back-off window for contention data and requests, expressed as a
power of 2. Valid values are from 0 to 15.
Data Backoff End Final back-off window for contention data and requests, expressed as a
power of 2. Valid values are from 0 to 15.
IP Address IP address of the cable interface.
Net Mask Subnet mask of the cable interface.
TFTP Server IP Address IP address of the CMTS TFTP server.
Time Server IP Address IP address of the CMTS Time-of-Day (TOD) server.
Config File Name Name of the configuration file that is downloaded from the TFTP server
to provide the router with operational parameters.
Time Zone Offset Correction received from the DHCP server to synchronize the router time
clock with the CMTS.
Log Server IP Address Displays the IP address for a syslog server, if any has been defined.
Drop Ack Enabled Indicates whether the TCP drop acknowledge feature is enabled or
disabled.
Piggyback when Ccat On Indicates whether the piggybacking of data onto request packets is
enabled when concatenation is also enabled.
Mac Sid Status Displays the service IDs currently in use.
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Cisco uBR905 and Cisco uBR925 cable access routers, and Cisco CVA122 Cable Voice Adapter
Usage Guidelines This command displays the manufacturing certificate for Cisco Systems, which the Secure Software
Download procedure uses to authenticate the software that the router downloads. This command shows
the individual X.509 components of the certificate, starting with the DOCSIS restricted X.501
Distinguished Name and ending with the 1024-bit public key.
Tip This command displays the certificate that is incorporated into the Cisco IOS image that the router is
currently running. Upgrading the Cisco IOS image could also update the manufacturer’s certificate. The
show controllers cable-modem cmcert command displays the cable-modem certificate that is that is
burned into the router at the factory and is not normally changed.
Examples The following example shows the starting lines and ending lines of typical output for the show
controllers cable-modem manuf-cert command:
Router# show controllers cable-modem 0 manuf-cert
OID(3):Country 2.5.4.6
1w3d: PRT(2):US
END
END
SET(57)
SEQ(55)
OID(3):Organization 2.5.4.10
1w3d: PRT(48):Data Over Cable Service Interface Specification
END
END
SET(21)
SEQ(19)
OID(3):Organization Unit 2.5.4.11
1w3d: PRT(12):Cable Modems
END
END
...
1w3d: E1 13 05 10 3C F1 F1 A0 CE 43 74 30 9C 59 F5 70
1w3d: 4B C2 71 8E 79 AC 19 3D AB 94 1E B0 BE BC 15 D8
1w3d: AD A4 79 F5 58 CA 04 25 62 A9 F8 3F E7 40 64 E2
1w3d: 65 B0 D0 53 65 FF F1 12 FF 1B CD DE 1D 47 A2 6E
1w3d: END
Router#
Note You must manually enter a return to redisplay the router prompt after the certificate has been displayed.
Cisco uBR905, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Usage Guidelines This command displays the PHS parameters that are currently in use for both the upstream and
downstream. The information shown corresponds to the PHS parameters that are listed in Appendix C
of the DOCSIS 1.1 specification.
Examples The following shows an excerpt from typical output from the show controllers cable-modem phs
command:
Router# show controllers cable-modem 0 phs
PHS Parameters
PHS Classifier Refer: 2
PHS Classifier ID: 1
PHS Service Flow Reference: 1
PHS Service Flow ID: 3
PHS Dynsrv Change Action: 0
PHS Fields:
PHS Index: 1
PHS Mask: 0x00 0x00 0x00 0x03 0xC0
PHS Size: 0
PHS Verification: 0
PHS Parameters
PHS Classifier Refer: 2
PHS Classifier ID: 1
PHS Service Flow Reference: 1
PHS Parameters
PHS Classifier Refer: 2
PHS Classifier ID: 1
PHS Service Flow Reference: 1
PHS Service Flow ID: 3
PHS Dynsrv Change Action: 0
PHS Fields:
PHS Index: 1
PHS Mask: 0x00 0x00 0x00 0x03 0xC0
PHS Size: 0
PHS Verification: 0
...
PHS Parameters
PHS Classifier Refer: 1
PHS Classifier ID: 2
PHS Service Flow Reference: 2
PHS Service Flow ID: 4
PHS Dynsrv Change Action: 0
PHS Fields: 0x08 0x00 0x45 0x00 0x00 0x56 0x00 0x00 0x00 0x00 0x3B
0x00 0x6D 0xA7 0x01 0x0A 0x28 0x03 0x00 0x00 0x00 0x00
PHS Index: 1
PHS Mask: 0x00 0x03 0xC0
PHS Size: 22
PHS Verification: 0
PHS Parameters
PHS Classifier Refer: 3
PHS Classifier ID: 3
PHS Service Flow Reference: 4
PHS Service Flow ID: 10
PHS Dynsrv Change Action: 0
PHS Fields: 0x08 0x00 0x45 0x00 0x00 0x56 0x00 0x00 0x00 0x00 0x3B
0x00 0x6D 0xA7 0x00 0x00 0x00 0x00 0x01 0x0A 0x28 0x42
PHS Index: 2
PHS Mask: 0x00 0x00 0x3C
PHS Size: 0
PHS Verification: 0
Router#
PHS Parameters
PHS Classifier Refer: 15
Router#
Field Description
PHS Classifier The reference ID for the classifier using this PHS rule.
Refer
PHS Classifier ID The ID for the classifier using this PHS rule.
PHS Service Flow The reference ID for the service flow using this PHS rule.
Reference
PHS Service Flow The ID for the service flow using this PHS rule.
ID
PHS Dynsrv The action taken in a dynamic service change request for this PHS rule:
Change Action
• 0 = Add the PHS rule.
• 1 = Set the PHS rule.
• 2 = Delete the PHS rule.
• 3 = Delete all PHS rules.
PHS Fields The bytes of the headers that must be suppressed and restored during PHS
operation. For the upstream, this includes the PDU bytes starting with the first
byte after the MAC header checksum. For the downstream, this includes the PDU
bytes starting with the 13th byte after the MAC header checksum.
PHS Index The index that references the suppressed byte string in the PHS Fields. The index
is unique per service flow in the upstream direction and unique per the cable
modem in the downstream direction.
PHS Mask The mask used to interpret the bytes in the PHS Fields, where each bit indicates
whether the corresponding byte in the PHS Fields should be suppressed (0 = do
not suppress, 1 = suppress).
PHS Classifier Size The total number of bytes in the header to be suppressed.
PHS Classifier Indicates whether the header bytes are to be verified before suppression (0 =
Verification verify, 1 = do not verify).
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Usage Guidelines To understand the output from this command, consult the Broadcom specifications for the BCM3116 and
BCM3037 chips.
Examples The following is typical output from the show controllers cable-modem phy command:
Router# show controllers cable-modem 0 phy receive
The following example shows typical output for the physical transmit registers:
Router# show controllers cable-modem 0 phy transmit
Preamble values:
CC CC CC CC CC 0D 0D CC CC CC CC CC CC CC CC 0D
04 25 01 01 01 01 02 01 02 03 02 00 40 04 02 00
40 05 01 00 06 01 10 07 02 01 52 08 01 01 09 01
08 0A 01 01 0B 01 02 04 25 03 01 01 01 02 01 02
03 02 00 50 04 02 00 30 05 01 00 06 01 22 07 02
01 52 08 01 00 09 01 30 0A 01 01 0B 01 02 04 25
04 01 01 01 02 01 02 03 02 00 40 04 02 00 40 05
01 00 06 01 22 07 02 01 52 08 01 00 09 01 30 0A
Router#
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Cisco uBR905, Cisco uBR924, and Cisco uBR925 cable access routers, and Cisco CVA122 Cable Voice Adapter
Usage Guidelines When the cable modem is operating in DOCSIS 1.0 or DOCSIS 1.0+ mode, this command displays the
four possible stream queues, the Service ID (SID) associated with each queue (if the queue is currently
in use), and whether the SID is the primary SID, a secondary (static) SID, or a dynamic (on demand)
SID. The display also shows the packets and bytes that have been transmitted and received on each
stream.
When the cable modem is operating in DOCSIS 1.1 mode, this command also displays the modem’s
capabilities and packet classifiers.
Examples The following example shows typical output for a DOCSIS 1.0 or DOCSIS 1.0+ cable modem for the
QoS statistics for each of the router’s four queues:
Router# show controllers cable-modem 0 qos
Router#
In Cisco IOS Release 12.2(15)CZ and later releases, the QoS statistics include information about the
DOCSIS 1.1 operations, including the type of service flow and packet classifiers being used for each
queue. The following is a typical default display:
Router# show controllers cable-modem 0 qos
0 2 F T T F
1 0 T T T T
2 0 T T T T
3 0 F T T T
Router#
0 2 F T T F
1 0 T T T T
2 0 T T T T
3 0 F T T T
Packet Classifiers
Router#
Table 6-15 describes the significant fields shown in the display for a DOCSIS 1.0 or DOCSIS 1.0+ cable
modem:
Field Description
Queue One of the four possible service flow queues that exist in the router.
SID Service identifier, a 14-bit integer assigned by the CMTS to each active
upstream service flow.
SID Type The type of SID:
• Primary—The service flow used for best-effort data traffic and MAC
maintenance messages.
• Secondary—Secondary static service flows that are created at
power-on provisioning for voice calls when dynamic SIDs are not
active.
• Dynamic—Secondary service flows that are created for on-demand
voice calls when using dynamic SIDs.
SFID Service flow identifier, a 32-bit integer assigned by the CMTS to each
service flow on the router.
TX Pkts Number of packets the router has transmitted on this service flow.
TX Bytes Number of bytes the router has transmitted on this service flow.
RX Pkts Number of packets the router has received on this service flow.
RX Bytes Number of bytes the router has received on this service flow.
Queue/SF Type Identifies the type of service flow being used for each queue.
In Cisco IOS Release 12.2(15)CZ and later releases, the QoS statistics include information about the
DOCSIS 1.1 operations, including the type of service flow and packet classifiers being used for each
queue:
Router# show controllers cable-modem 0 qos
Queue SF Type
0 BE
1 BE
2 UGS_AD
3 NA
Packet Classifiers
Classifier id = 1 SFID = 91
IP source: 10.188.1.88
IP dest: 10.188.1.66
UDP/TCP source range: 18416 to 18416
UDP/TCP dest range: 16740 to 16740
IP Protocol: 17
PHS: Inactive
Classifier id = 2 SFID = 93
IP source: 10.188.1.88
IP dest: 10.188.1.66
UDP/TCP source range: 16796 to 16796
UDP/TCP dest range: 19138 to 19138
IP Protocol: 17
PHS: Inactive
Table 6-16 describes the fields shown in the display for a DOCSIS 1.1 cable modem.
Table 6-16 show controllers cable-modem qos Field Descriptions (DOCSIS 1.1)
Field Description
Queue One of the four possible service flow queues that exist in the router.
SID Service Identifier, a 14-bit integer assigned by the CMTS to each active
upstream service flow.
SID Type The type of SID:
• Primary—The service flow used for best-effort data traffic and MAC
maintenance messages.
• Secondary—Secondary static service flows that are created at
power-on provisioning for voice calls when dynamic SIDs are not
active.
• Dynamic—Secondary service flows that are created for on-demand
voice calls when using dynamic SIDs.
SFID Service Flow Identifier, a 32-bit integer assigned by the CMTS to each
service flow on the router.
Table 6-16 show controllers cable-modem qos Field Descriptions (DOCSIS 1.1) (continued)
Field Description
TX Pkts Number of packets the router has transmitted on this service flow.
TX Bytes Number of bytes the router has transmitted on this service flow.
RX Pkts Number of packets the router has received on this service flow.
RX Bytes Number of bytes the router has received on this service flow.
Capabilities These four fields describe whether the following features are enabled.
cbr Indicates whether committed bit rate traffic (CBR) is supported (T) or not
(F). This could indicate either UGS or UGS-AD service flows.
cc Indicates whether concatenation is supported (T) or not (F).
fr Indicates whether DOCSIS fragmentation is supported (T) or not (F).
nbr Indicates the Not Broadcast status, depending on whether the classifier
supports broadcasts (F) or not (T).
Queue/SF Type Identifies the type of service flow being used for each queue.
Packet Classifiers Describes the classifiers defined on the router.
Class id ID used to uniquely identify the classifier in each service flow.
SFID ID that uniquely identifies the service flow.
Pri Traffic Priority parameter that was assigned to this classifier. If no value
was set, the priority defaults to 0 (lowest priority).
Table 6-16 show controllers cable-modem qos Field Descriptions (DOCSIS 1.1) (continued)
Field Description
valid A 13-bit bitmask showing which Type/Length/Value (TLV) fields were set
on the classifier. The following shows the meaning of each bit, with the
least significant bit on the far right. The bit is set to 1 if the corresponding
TLV was set for the classifier:
• 0x0001—IP Type of Service Range and Mask
• 0x0002—IP Protocol
• 0x0004—IP Source Address
• 0x0008—IP Source Mask
• 0x0010—IP Destination Address
• 0x0020—IP Destination Mask
• 0x0040—TCP/UDP Source Port Start and TCP/UDP Source Port End
• 0x0080—TCP/UDP Destination Port Start and TCP/UDP Destination
Port End
• 0x0100—Destination MAC Address
• 0x0200—Source MAC Address
• 0x0400—Ethertype/DSAP/MacType
• 0x0800—IEEE 802.1P User_Priority
• 0x1000—IEEE 802.1Q VLAN_ID
For example, a value of D6 translates to the bit-mask “1101 0110”, which
indicates that the following fields were set for the classifier: IP Protocol,
IP Source Address, IP Destination Address, and the TCP/UDP Source and
Destination Port values.
Match Number of packets matching the classifier.
SIDT Address for the classifier in the internal SID table (SIDT).
Packet Classifier Details Describes each packet classifier in detail.
Classifier ID ID used to uniquely identify the classifier in each service flow.
SFID ID that uniquely identifies the service flow.
IP source The matching IP source address.
IP dest The matching IP destination address.
UDP/TCP source range The low-end and high-end matching source TCP/UDP port values.
UDP/TCP dest range The low-end and high-end matching destination TCP/UDP port values.
IP Protocol The matching IP protocol type, as given in RFC 1700. A value of 256
matches any IP protocol, and a value of 257 matches TCP and UDP traffic.
PHS Indicates whether Payload Header Suppression (PHS) is active or inactive.
Downstream Payload Indicates that PHS is being used on the downstream.
Header Suppression
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Cisco uBR905, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Usage Guidelines This command displays the Quality of Service (QoS) parameters that make up each of the service flows
that are defined on the router for the upstream and downstream. The information shown corresponds to
the QoS parameters that are listed in Appendix C of the DOCSIS 1.1 specification.
Examples The following example shows typical output for the default form of the show controllers cable-modem
service-flows command.
Router# show controllers cable-modem 0 service-flows
Router#
The following example shows typical output for the summary option of the show controllers
cable-modem service-flows command.
Router# show controllers cable-modem 0 service-flows summary
Router#
The following example shows typical output for the show controllers cable-modem service-flows
command, when displaying information for individual service flows:
Router# show controllers cable-modem 0 service-flows 3
Router#
Table 17 describes the significant fields shown by this command. The information shown corresponds to
the QoS parameters that are listed in Appendix C of the DOCSIS 1.1 specification.
Field Description
Flow Type, Sf type Identifies whether the type of service-flow:
• Primary—The primary service-flow for the upstream or downstream.
• Static—A permanent secondary service-flow.
• Dynamic—A dynamically created secondary service-flow.
Flow Reference, Sf Ref The service flow reference ID that is used to establish the Service Flow ID.
Field Description
Service Flow ID, Sfid The ID that unique identifies this service flow on the upstream or
downstream.
Service ID, Sid The service identifier (SID) that the CMTS assigns to the service flow.
QoS Set Type The QoS parameter set type for the service flow. This is a three-bit value,
where bit 0 is set for the Provisioned Set, bit 1 is set for the Admitted Set,
and bit 2 is set for the Active Set. Multiple bits can be set to produce the
following possible values:
• 0 = Set Active and Admitted Sets to null.
• 1 = Apply to Provisioned Set only.
• 2 = Perform admission control and apply to Admitted Set only.
• 3 = Perform admission control and apply to Provisioned and Admitted
Sets.
• 4 = Check against Admitted set in separate Service Flow encoding,
perform admission control if needed, activate this service flow, and
apply to Active Set.
• 5 = Perform admission control, apply to Provisioned and Active Sets,
and activate this service flow.
• 6 = Perform admission control, activate this service flow, and apply to
Admitted and Active Sets.
• 7 = Perform admission control, activate this service flow, and apply to
Provisioned, Admitted, and Active Sets.
QoS Traffic Priority The priority assigned to the service flow (0 to 7, where 7 is the highest
priority).
QoS Max Sustained The maximum traffic rate, in bits, for a token-bucket rate limit for packets.
Traffic Rate
QoS Max Traffic Burst The maximum size of a single packet on this service flow.
QoS Min Reserved The minimum rate, in bits per second, for traffic on this service flow.
Traffic Rate
QoS Min Reserved Rate The minimum packet size, in bytes, for which the minimum rate can be
Pkt Size sustained on this service flow.
QoS Timeout For Active The maximum time, in seconds, that resources on a service flow can
Param remain unused before the CMTS sets the flow’s Admitted and Active Sets
to null. A value of 0 indicates no timeout period.
Qos Timeout For The maximum time, in seconds, that Admitted resources on a service flow
Admitted Param can remain without being activated. After this timeout period, the CMTS
will release Admitted resources on a service flow and retain only the
activated ones.
Max Concatenated Burst The maximum burst size, in bytes, for concatenated traffic on the service
flow. A value of 0 indicates no limit.
Field Description
Scheduling Type The type of service used on the upstream for grant requests:
• 1 = Undefined
• 2 = Best effort
• 3 = Non-real-time polling service (NRTPS)
• 4 = Real-time polling service (RTPS)
• 5 = Unsolicited grant service with activity detection (UGS-AD)
• 6 = Unsolicited grant service (UGS)
Request/Transmission The allowable means of grant request and transmission on the upstream.
Policy This value is a 9-bit mask where the bits have the following meanings
when set to 1:
• Bit 0 = Do not use broadcast request opportunities.
• Bit 1 = Do not use priority request multicast request opportunities.
• Bit 2 = Do not use Request/Data grants for requests.
• Bit 3 = Do not use Request/Data grants for data.
• Bit 4 = Do not piggyback data on grant requests.
• Bit 5 = Do not use concatenation.
• Bit 6 = Do not use DOCSIS fragmentation.
• Bit 7 = Do not use payload header suppression (PHS).
• Bit 8 = UGS service flows must drop packets that do not fit.
See Table 18 for the possible values of each bit for each of the supported
flow types.
Nominal Polling Interval The interval, in microseconds, between successive unicast grant requests
for the service flow on the upstream.
Tolerated Poll Jitter The maximum amount of time, in microseconds, that a unicast request
interval may be delayed from the typical polling schedule.
Unsolicited Grant Size The size of unsolicited grants, in bytes.
Nominal Grant Interval The interval, in microseconds, between successive data grant opportunities
for the service flow on the upstream.
Tolerated Grant Jitter The maximum amount of time, in microseconds, that transmission
opportunities may be delayed from the typical polling schedule.
Grants Per Interval The actual number of grants per Nominal Grant Interval for UGS service
flows, and the maximum number of active grants per Nominal Grant
Interval for UGS-AD service flows.
Max DS Latency The maximum latency, in microseconds, between the reception of a packet
by the CMTS on its network interface and the transmission of the packet
on its downstream cable interface.
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Examples The following example shows typical tuner settings. Table 6-19 describes the output field possibilities
and descriptions.
Router# show controllers cable-modem 0 tuner
Tuner: status=0x00
Rx: tuner_freq 507000000, symbol_rate 5360736, local_freq 11520000
snr_estimate 17488, ber_estimate 0, lock_threshold 26000
QAM not in lock, FEC not in lock, qam_mode QAM_64
Tx: tx_freq 20000000, power_level 0x3E, symbol_rate 1280000
Router#
Field Description
tuner_freq Indicates the current downstream frequency.
symbol_rate Indicates the downstream symbol rate in symbols per second.
local_freq Frequency on which the transmitter and tuner communicate.
snr_estimate Signal-to-noise ratio (SNR) estimate in dB multiplied by 1000.
ber_estimate Bit error rate estimate (always 0).
lock_threshold Minimum SNR that the router will accept as a valid lock.
QAM status Indicates if QAM/FEC lock has been acquired and the modulation mode in use.
tx_freq Upstream frequency sent to the router by the CMTS in the UCD message.
Field Description
power_level Transmit power level as set in the hardware, given as a hexadecimal value. The
units are unique to the hardware used. Use the show controllers cable-modem
mac state command to see the power level in dBmV.
symbol_rate Indicates the upstream symbol rate in symbols per second that is negotiated
between the CMTS and the cable access router.
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Cisco uBR925 cable access router, Cisco CVA122 Cable Voice Adapter
Examples The following example shows sample output from the show controllers usb command:
Router# show controllers usb 0
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Syntax Description control (Optional) Displays out the number of control commands that are queued
for execution by the hardware accelerator crypto engine.
packet (Optional) Displays out the contents and status information for the transmit
packet rings that are used by the hardware accelerator crypto engine.
pool (Optional) Displays out the contents and status information for the receive
packet rings that are used by the hardware accelerator crypto engine.
Examples The following example shows a typical display of the number of control commands that are waiting to
be executed by the router’s hardware accelerator.
Router# show crypto engine accelerator ring control
Router#
The following truncated example displays typical output from the show crypto engine accelerator ring
command about the transmit packet rings that are used by the router’s hardware accelerator.
Router# show crypto engine accelerator ring packet
.
.
.
123: 0x00A0 0x007B 0x0012 0x05B2 0x870C
124: 0x00A0 0x007C 0x0011 0x05DC 0x0000
125: 0x00A0 0x007D 0x0012 0x05B3 0x870E
126: 0x00A0 0x007E 0x0011 0x05DC 0x0000
127: 0x00A0 0x007F 0x0012 0x05B4 0x8710
Head = 59 Tail = 59 Taken = 59
Router#
The following example shows typical output from the show crypto engine accelerator ring pool
command about the contents of the receive rings that are used by the router’s hardware accelerator.
Router# show crypto engine accelerator ring pool
Router#
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Command Description
crypto engine accelerator Enables the use of the Cisco uBR905 and Cisco uBR925 router’s
onboard hardware accelerator for IPSec encryption.
crypto ipsec Defines the IPSec security associations and transformation sets.
crypto isakmp Enables and defines the IKE protocol and its parameters.
crypto key Generates and exchanges keys for a cryptographic session.
crypto map Creates and modifies a crypto map for a session.
debug crypto engine Displays each control command as it is given to the crypto engine.
accelerator control
debug crypto engine Displays information about each packet sent for encryption and
accelerator packet decryption.
show crypto engine accelerator Displays the active (in-use) entries in the crypto engine security
sa-database association (SA) database.
show crypto engine accelerator Displays the current run-time statistics and error counters for the
statistic crypto engine.
show crypto engine brief Displays a summary of the configuration information for the crypto
engine.
show crypto engine Displays the version and configuration information for the crypto
configuration engine.
show crypto engine Displays a list of the current connections maintained by the crypto
connections engine.
Note For information about these additional commands, see the IP Security and Encryption section in the
Cisco IOS Security Command Reference.
Examples The following example displays the security associations database for the router’s hardware accelerator.
Router# show crypto engine accelerator sa-database
Flow Summary
Index Algorithms
001 transport inbound esp-des
002 transport outbound esp-des
003 transport inbound esp-md5-hmac esp-3des ah-md5-hmac
004 transport outbound esp-md5-hmac esp-3des ah-md5-hmac
005 transport inbound esp-md5-hmac esp-3des ah-md5-hmac
006 transport outbound esp-md5-hmac esp-3des ah-md5-hmac
007 transport inbound esp-md5-hmac esp-3des ah-md5-hmac
008 transport outbound esp-md5-hmac esp-3des ah-md5-hmac
009 transport inbound esp-md5-hmac esp-3des ah-md5-hmac
010 transport outbound esp-md5-hmac esp-3des ah-md5-hmac
011 tunnel inbound esp-3des
012 tunnel outbound esp-3des
013 tunnel inbound esp-3des ah-sha-hmac
014 tunnel outbound esp-3des ah-sha-hmac
015 tunnel inbound esp-des
016 tunnel outbound esp-des
017 tunnel inbound esp-des ah-md5-hmac
018 tunnel outbound esp-des ah-md5-hmac
019 tunnel inbound esp-des ah-md5-hmac
020 tunnel outbound esp-des ah-md5-hmac
036 tunnel inbound esp-des ah-sha-hmac
037 tunnel outbound esp-des ah-sha-hmac
038 tunnel inbound esp-md5-hmac esp-3des ah-md5-hmac
039 tunnel outbound esp-md5-hmac esp-3des ah-md5-hmac
SA Summary:
Index DH-Index Algorithms
001 007 DES SHA
002 001(deleted) DES SHA
003 001(deleted) DES SHA
Table 6-20 describes the fields shown in the display for this command.
Field Description
Flow Summary
Index Unique identifier for the flow.
Algorithms The Flow Algorithm field displays the transformation set for each SA:
Mode
• tunnel—Original IP packet is encrypted and encapsulated.
• transport—Only the data portion of the IP packet is encrypted and
encapsulated.
Direction
• inbound—Encryption is performed on incoming packets.
• outbound—Encryption is performed on outgoing packets.
Table 6-20 show crypto engine accelerator sa-database Field Descriptions (continued)
Field Description
Algorithms The transformation algorithm set for this SA:
• Encryption: DES or 3DES.
• Authentication: MD5 or SHA.
DH Summary
Index Unique DH index.
Group Identifies the DH group.
Config The type of keys:
• Shared Secret—Keys were pre-shared.
• Valid Pub/Priv—Keys were negotiated.
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Command Description
show crypto engine Displays the version and configuration information for the crypto
configuration engine.
show crypto engine Displays a list of the current connections maintained by the crypto
connections engine.
Note For information about these additional commands, see the IP Security and Encryption section in the
Cisco IOS Security Command Reference.
Examples The following example shows typical output of the current statistics and error counters for the router’s
hardware accelerator.
Router# show crypto engine accelerator statistics
HIFN79xx:
ds: 0x80D92A64 idb:0x80D6F39C
Statistics for Virtual Private Network (VPN) Module:
1292 packets in 1292 packets out
2 paks/sec in 2 paks/sec out
6 Kbits/sec in 6 Kbits/sec out
rx_no_endp: 0 rx_hi_discards: 0 fw_failure: 0
invalid_sa: 0 invalid_flow: 0
fw_qs_filled: 0 fw_resource_lock:0 lotx_full_err: 0
null_ip_error: 0 pad_size_error: 0 out_bound_dh_acc: 0
esp_auth_fail: 0 ah_auth_failure: 0 crypto_pad_error: 0
ah_prot_absent: 0 ah_seq_failure: 0 ah_spi_failure: 0
esp_prot_absent:0 esp_seq_fail: 0 esp_spi_failure: 0
obound_sa_acc: 0 invalid_sa: 0 out_bound_sa_flow: 0
invalid_dh: 0 bad_keygroup: 0 out_of_memory: 0
no_sh_secret: 0 no_skeys: 0 invalid_cmd: 0
dsp_coproc_err: 0 comp_unsupported:0 pak_too_big: 0
pak_mp_length_spec_fault: 0
tx_lo_queue_size_max 2 cmd_unimplemented: 0
tx_lo_count 60
15124 seconds since last clear of counters
Interrupts: Notify = 0, Reflected = 1292, Spurious = 0
packet_loop_max: 2 packet_loop_limit: 512
Router#
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Note For information about these additional commands, see the IP Security and Encryption section in the
Cisco IOS Security Command Reference.
Examples The following example shows typical output for the show crypto engine brief command:
Router# show crypto engine brief
Compression: No
3 DES: Yes
Privileged Mode: 0x0000
Maximum buffer length: 4096
Maximum DH index: 0010
Maximum SA index: 0020
Maximum Flow index: 0040
Maximum RSA key size: 0256
Router#
Field Description
crypto engine name Name of the crypto engine as assigned with the key-name
argument in the crypto key generate dss command. If no name
has been assigned, this field shows “unknown.”
crypto engine type The type of encryption engine running, always “ISA/ISM” and
“software” for the Cisco uBR905 and Cisco uBR925 cable
access routers.
hifn chip id, rev, and api rev Identifies the hardware accelerator, the revision of its onboard
firmware, and the revision of the software application layer.
Compression Identifies whether packets are compressed as well as encrypted.
3DES Identifies whether Triple DES (3DES) 168-bit encryption is
supported.
crypto engine state The current run-time state of the crypto engine:
• installed—Indicates that the crypto engine is present but is
not configured for encryption.
• dss key generated—Indicates that the crypto engine has
DSS keys already generated.
crypto engine in slot The chassis slot number containing the crypto engine. This
field is always N/A for the Cisco uBR905 and Cisco uBR925
cable access routers because the engine is not in a slot but is
permanently onboard the routers.
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Command Description
debug crypto engine Displays each control command as it is given to the crypto engine.
accelerator control
debug crypto engine Displays information about each packet sent for encryption and
accelerator packet decryption.
show crypto engine accelerator Displays the contents of command and transmit rings for the crypto
ring engine.
show crypto engine accelerator Displays the active (in-use) entries in the crypto engine security
sa-database association (SA) database.
show crypto engine accelerator Displays the current run-time statistics and error counters for the
statistic crypto engine.
show crypto engine Displays the version and configuration information for the crypto
configuration engine.
show crypto engine Displays a list of the current connections maintained by the crypto
connections engine.
Note For information about these additional commands, see the IP Security and Encryption section in the
Cisco IOS Security Command Reference.
Usage Guidelines This command displays the version, capabilities, and other information for the hardware accelerator
engine that performs IPSec encryption/decryption for the router.
Examples The following example shows typical output from the show crypto engine configuration command:
Router# show crypto engine configuration
Compression: No
3 DES: Yes
Privileged Mode: 0x0000
Maximum buffer length: 4096
Maximum DH index: 0010
Maximum SA index: 0020
Maximum Flow index: 0040
Maximum RSA key size: 0256
Field Description
crypto engine name Name of the crypto engine as assigned with the key-name
argument in the crypto key generate dss command. If no name
has been assigned, this field shows “unknown.”
crypto engine type Type of encryption engine running, always “ISA/ISM” and
“software” for the Cisco uBR905 and Cisco uBR925 cable
access routers.
hifn chip id, rev, and api rev Identifies the hardware accelerator, the revision of its onboard
firmware, and the revision of the software application layer.
Compression Identifies whether packets are compressed as well as encrypted.
3 DES Identifies whether Triple DES (3DES) 168-bit encryption is
supported.
Maximum buffer length Maximum size of the data buffer for each connection.
Maximum DH index, SA index, and Maximum size of each index that is supported per connection.
Flow index
Maximum RSA key size Maximum size of the RSA encryption key that is supported.
Lock Count Number of connections that have requested access to the crypto
engine and are waiting for processing time.
Unlock Count Number of connections that have finished encryption
processing and are waiting to release the crypto engine.
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Command Description
debug crypto engine Displays information about each packet sent for encryption and
accelerator packet decryption.
show crypto engine accelerator Displays the contents of command and transmit rings for the crypto
ring engine.
show crypto engine accelerator Displays the active (in-use) entries in the crypto engine security
sa-database association (SA) database.
show crypto engine accelerator Displays the current run-time statistics and error counters for the
statistic crypto engine.
show crypto engine brief Displays a summary of the configuration information for the crypto
engine.
show crypto engine Displays a list of the current connections maintained by the crypto
connections engine.
Note For information about these additional commands, see the IP Security and Encryption section in the
Cisco IOS Security Command Reference.
Syntax Description active (Optional) Displays the configuration information for each active session.
dh (Optional) Displays the Diffie-Hellman connection status.
dropped-packet (Optional) Displays the number of packets that the crypto engine has
dropped.
flow (Optional) Displays the definition for each flow that has been defined.
Usage Guidelines This command displays the version, capabilities, and other information for the hardware accelerator
engine that performs IPSec encryption/decryption for the router.
Examples The following example shows typical output from the show crypto engine connections active
command:
Router# show crypto engine connections active
Field Description
ID Identifies the connection by its number. Each active encrypted
session connection is identified by a positive number from 1 to
299. These connection numbers correspond to the table entry
numbers.
Interface Interface involved in the encrypted session connection.
IP-Address IP address of the interface.
State Current state of the connection:
• alloc—the connection is requesting resources.
• set—an active connection (normal state).
Algorithm The encryption algorithms used for this connection. If this field
reads “NONE,” this connection is still being allocated and has
not yet requested an algorithm.
Encrypt Total number of encrypted outbound IP packets.
Decrypt Total number of encrypted outbound IP packets.
The following example shows typical output from the show crypto engine connections dh command:
Router# show crypto engine connections dh
Conn ID Status
0 0 1
0 14 1
0 0 1
0 0 1
0 18 1
Router#
Field Description
Conn Identifies the connection by its number. Each active encrypted
session connection is identified by a positive number from 1 to
299. These connection numbers correspond to the table entry
numbers.
ID Identifies the Diffie-Hellman group.
Status Identifies the Diffie-Hellman status:
1—768-bit Diffie-Hellman prime modulus group.
2—1024-bit Diffie-Hellman prime modulus group.
The following example shows typical output from the show crypto engine connections
dropped-packet command:
Router# show crypto engine connections dropped-packet
Router#
Field Description
Interface Interface involved in the encrypted session connection.
IP-Address IP address of the interface.
Drop Count Total number of dropped packets since the last reset of the
router.
The following example shows typical output for the show crypto engine connections flow command:
Router# show crypto engine connections flow
Router#
Field Description
flow_id Unique identifier for this flow.
ah_conn_id Unique identifier for the flow’s Authentication Header.
esp_conn_id Unique Identifier for the flow’s Encapsulating Security
Protocol (ESP).
comp_spi Security Parameter Index (SPI)—An arbitrary number that
unique identifies the flow’s security association.
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Note For information about these additional commands, see the IP Security and Encryption section in the
Cisco IOS Security Command Reference.
Examples The following example shows a typical display from the show crypto ipsec client ezvpn command for
an active virtual private network (VPN) connection when the router is in client mode:
Router# show crypto ipsec client ezvpn
The following example shows a typical display from the show crypto ipsec client ezvpn command for
an active VPN connection when the router is in network-extension mode:
Router# show crypto ipsec client ezvpn
Mask : 255.255.255.128
Protocol : 0x0
Source Port: 0
Dest Port : 0
Router#
The following example shows a typical display from the show crypto ipsec client ezvpn command for
an inactive VPN connection:
Router# show crypto ipsec client ezvpn
Table 6-27 describes the fields shown by the show crypto ipsec client ezvpn command:
Field Description
Current State Displays whether the VPN tunnel connection is active or idle. Typically, when
the tunnel is up, the current state is IPSEC ACTIVE.
Last Event Displays the last event performed on the VPN tunnel. Typically, the last event
before a tunnel is created is SOCKET UP.
Address Displays the IP address used on the outside interface.
Mask Displays the subnet mask used for the outside interface.
DNS Primary Displays the primary domain name system (DNS) server provided by the
dynamic host configuration protocol (DHCP) server.
DNS Secondary Displays the secondary DNS server provided by the DHCP server.
Domain Name Displays the domain name provided by the DHCP server.
NBMS/WINS Displays the primary NetBIOS Microsoft Windows Name Server provided by the
Primary DHCP server.
NBMS/WINS Displays the secondary NetBIOS Microsoft Windows Name Server provided by
Secondary the DHCP server.
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Command Description
crypto ipsec client (Interface configuration mode) Assigns a Cisco Easy VPN Remote
ezvpn (interface configuration to an interface.
configuration)
crypto ipsec client Manually connects to a specified IPSec VPN tunnel.
ezvpn connect
ip http ezvpn Enables the Cisco Easy VPN Remote web server interface.
show crypto ipsec Displays the specific configuration for one or all transformation sets.
transform
show dhcp
To display the current Dynamic Host Configuration Protocol (DHCP) settings on point-to-point
interfaces, use the show dhcp command in privileged EXEC mode.
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Usage Guidelines You can use this command on any point-to-point type of interface that uses DHCP for temporary IP
address allocation.
Examples The following is typical output from the show dhcp lease command:
Router# show dhcp lease
Field Description
Temp IP addr IP address leased from the DHCP server for the cable interface.
Temp subnet mask Temporary subnet mask assigned to the cable interface.
Field Description
DHCP Lease server IP address of the DHCP server that assigned an IP address to this client.
state Current state of this client (the cable interface). Possible states are Bound,
Renew, or Rebinding. For descriptions of these states, see RFC 2131.
DHCP transaction id Unique number established by the router before the first request message is
sent to the DHCP server. The same transaction ID is used as long as the
lease keeps getting renewed and is valid. If a new “discover” message is
sent, a new transaction ID is used.
Lease Time (in seconds) for which the leased IP address is valid; the duration of
the lease.
Renewal Time interval (in seconds) from address assignment until the client
transitions to the renewing state. When the renewal (T1) time expires, the
client sends a unicast dhcprequest message to the server to extends its lease.
The default value of this timer is 0.5 times the duration of the lease.
Rebind Time interval (in seconds) from address assignment until the client
transitions to the rebinding state and sends a broadcast dhcprequest message
to any DHCP server to extends its lease. The default value of this timer (T2)
is 0.875 times the duration of the lease.
Temp default-gateway IP address of the router closest to this client on the network.
addr
Next timer fires after Time in hours, minutes, and seconds until the next timer expires.
Retry count Number of times the client has sent any message to the DHCP server—most
likely a request message to extend its lease. When the lease is renewed, the
Retry count is reset to 0.
Client-ID MAC address (with optional media type code) that uniquely identifies the
client on the subnet for binding lookups.
The following example shows typical output for the show dhcp server command:
Router# show dhcp server
Field Description
DHCP server MAC address used by the DHCP server.
Leases Number of current leased IP addresses.
Offers Number of offers for an IP address sent to a proxy client from the server.
Field Description
Requests Number of requests for an IP address to the server.
Acks Number of acknowledge messages sent by the server to the proxy client.
Naks Number of not acknowledge messages sent by the server to the proxy client.
Declines Number of offers from the server that have been declined by the proxy
client.
Releases Number of times IP addresses have been relinquished gracefully by the
client.
Bad Number of bad packets received due to wrong length, wrong field type, or
other causes.
TFTP Server Name Name (if any) configured for the server providing TFTP downloads to the
CM.
TIME0 IP address of the primary Time-of-Day (ToD) server.
TIME1 IP address of the secondary ToD server.
Subnet Subnet containing the DHCP server.
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Defaults When this command is entered without a keyword, general information about the cable interface is
displayed.
Examples The following example shows typical output for the cable interface when traffic is passing through the
interface:
Router# show interfaces cable-modem 0
Router#
Field Description
cable-modem0 is up Indicates that the interface is currently active. “Disabled”
indicates the interface has received more than 5000 errors in
one keepalive interval (10 seconds by default if keepalive is
set); “administratively down” indicates the interface has been
taken down by an administrator.
line protocol is up Indicates that the software processes that handle the line
protocol believe the interface is usable.
Hardware Hardware type and MAC address.
Internet address Internet address followed by the shorthand notation for the
subnet mask.
MTU Maximum Transmission Unit (equivalent of the maximum
packet size) for the interface.
BW Bandwidth of the interface in kilobits per second.
DLY Delay of the interface in microseconds.
reliability Reliability of the interface, expressed as a fraction of 255,
calculated as an exponential average over a 5-minute period.
(255/255 equals 100% reliability.)
tx load/rx load Load on the interface caused by transmitting and receiving,
expressed as a fraction of 255, calculated as an exponential
average over a 5-minute period.
Encapsulation/loopback/keepalive Encapsulation method assigned to the interface.
loopback Indicates whether or not loopback is set.
keepalive Indicates whether or not keepalives are set.
Field Description
ARP type Type of Address Resolution Protocol configured for the
interface.
ARP Timeout Number of hours, minutes, and seconds an ARP cache entry
will stay in the cache.
Last input/output Number of hours, minutes, and seconds since the last packet
was successfully received/transmitted by the interface.
output hang Number of hours, minutes, and seconds since the interface was
last reset because of a transmission that took too long. When the
number of hours in any of the “Last...” fields exceeds 24, the
number of days and hours is displayed. If the field overflows,
asterisks are printed.
Last clearing of “show interface” Time at which the counters that measure cumulative statistics
counters (such as number of bytes transmitted and received) shown in
this report were last reset to zero. Note that variables that might
affect routing (for example, load and reliability) are not cleared
when the counters are cleared.
*** indicates the elapsed time is too large to be displayed.
0:00:00 indicates the counters were cleared more than 231
milliseconds (and less than 232 milliseconds) ago.
Queueing strategy Type of queueing strategy in effect on the interface.
Output queue/drops Number of packets in the output queue followed by the size of
the queue and the number of packets dropped due to a full
queue.
input queue/drops Number of packets in the input queue followed by the size of
the queue and the number of packets dropped due to a full
queue.
5 minute input rate Average number of bits and packets received and transmitted
5 minute output rate per second in the last 5 minutes. If the interface is not in
promiscuous mode, it senses network traffic it sends and
receives (rather than all network traffic).
The 5-minute input and output rates should be used only as an
approximation of traffic per second during a given 5-minute
period. These rates are exponentially weighted averages with a
time constant of 5 minutes. A period of four time constants
must pass before the average will be within two percent of the
instantaneous rate of a uniform stream of traffic over that
period.
packets input Total number of error-free packets received by the system.
bytes Total number of bytes, including data and MAC encapsulation,
in the error-free packets received by the system.
no buffer Number of received packets discarded because there was no
buffer space in the main system. Compare with ignored count.
Broadcast storms on Ethernet networks and bursts of noise on
serial lines are often responsible for no input buffer events.
Field Description
Received broadcasts Total number of broadcast or multicast packets received by the
interface.
runts Number of packets discarded because they were smaller than
the medium’s minimum packet size. For example, any Ethernet
packet less than 64 bytes is considered a runt.
giants Number of packets discarded because they were larger than the
medium’s maximum packet size. For example, any Ethernet
packet larger than 1518 bytes is considered a giant.
throttles Number of times the receiver on the port was disabled, possibly
due to buffer or processor overload.
input errors Includes runts, giants, no buffer, CRC, frame, overrun, and
ignored counts. Other input-related errors can also cause the
input errors count to be increased, and some datagrams may
have more than one error; therefore, this sum may not balance
with the sum of enumerated input error counts.
CRC Number of cyclic redundancy checks (CRCs) generated by the
originating LAN station or far-end device that do not match the
checksum calculated from the data received. On a LAN, this
field usually indicates noise or transmission problems on the
LAN interface or the LAN bus itself. A high number of CRCs
is usually the result of collisions or a station sending bad data.
frame Number of packets received incorrectly, having a CRC error
and a noninteger number of octets. On a LAN, this value is
usually the result of collisions or a malfunctioning Ethernet
device.
overrun Number of times the receiver hardware was unable to hand
received data to a hardware buffer because the input rate
exceeded the receiver’s ability to handle the data.
ignored Number of received packets ignored by the interface because
the interface hardware ran low on internal buffers. These
buffers are different from the system buffers mentioned
previously in the buffer description. Broadcast storms and bursts
of noise can cause the ignored count to be increased.
abort Number of packets whose receipt was aborted.
packets output Total number of messages sent by the system.
bytes Total number of bytes, including data and MAC encapsulation,
sent by the system.
underruns Number of times the transmitter has been running faster than
the router can handle.
output errors Sum of all errors that prevented the final transmission of
datagrams out of the interface being examined. Note that this
may not balance with the sum of the enumerated output errors,
as some datagrams might have more than one error, and others
might have errors that do not fall into any of the specifically
tabulated categories.
Field Description
collisions Number of messages retransmitted due to an Ethernet collision.
Collisions are usually the result of an overextended LAN
(Ethernet or transceiver cable too long, more than two repeaters
between stations, or too many cascaded multiport transceivers).
A packet that collides is counted only once in output packets.
interface resets Number of times an interface has been completely reset. A reset
can happen if packets queued for transmission were not sent
within several seconds. On a serial line, this can be caused by a
malfunctioning modem that is not supplying the transmit clock
signal, or by a cable problem. If the system notices that the
carrier detect line of a serial interface is up, but the line protocol
is down, it periodically resets the interface in an effort to restart
it. Interface resets can also occur when an interface is looped
back or shut down.
output buffer failures Number of times the output buffer has failed.
output buffers swapped out Number of times the output buffer has been swapped out.
The following example shows typical output of the show interfaces cable-modem accounting
command, which shows the number of packets and bytes of each protocol type that is passing through
the cable interface:
Router# show interfaces cable-modem 0 accounting
cable-modem0
Protocol Pkts In Chars In Pkts Out Chars Out
IP 545 185502 159 90240
Trans. Bridge 3878 964995 12597 1611142
ARP 73 3066 86 4128
Router#
Field Description
Protocol List of protocols operating on the cable-modem interface.
Pkts In Number of packets of each protocol received on the interface.
Chars In Number of bytes of each protocol received on the interface.
Pkts Out Number of packets of each protocol sent on the interface.
Chars Out Number of bytes of cache protocol sent on the interface.
The following example shows typical output for the show interfaces cable-modem counters command:
Router# show interfaces cable-modem 0 counters
Router#
Field Description
Ranging requests sent Number of ranging requests sent by the router to the CMTS.
Downstream FIFO full Number of times the downstream input first-in first-out (FIFO) buffer
became full on the router.
Re-requests Number of times a bandwidth request generated by the router was not
responded to by the CMTS.
DS MAC Message Number of times the DMA controller had a downstream MAC message
Overruns and there were no free MAC message buffer descriptors to accept the
message.
DS Data Overruns Number of times the DMA controller had downstream data and there were
no free data PDU buffer descriptors to accept the data.
Received MAPs Number of times a MAP message passed all filtering requirements and
was received by the router.
Received Syncs Number of times a time-stamp message was received by the router.
Message CRC failures Number of times a MAC message failed a cyclic redundancy check
(CRC).
Header CRC failures Number of times a MAC header failed its 16-bit CRC check. The MAC
header CRC is a 16-bit Header Check Sequence (HCS) field that ensures
the integrity of the MAC header even in a collision environment.
Data PDUs Total number of data PDUs (protocol data units) of all types received by
the router.
DS MAC messages Number of MAC messages received by the router.
Valid Headers Number of valid headers received by the router, including PDU headers,
MAC headers, and headers only.
Sync losses Number of times the router lost timebase sync with the CMTS.
Pulse losses Number of times the router did not receive expected timestamp messages
from the CMTS.
BW request failures Number of times the router sent the maximum number of re-requests for
bandwidth allocation and the request was still not granted.
The following example shows typical output for the show interfaces cable-modem crb command,
which displays information about the bridging and routing protocols being used on the cable interface:
Router# show interfaces cable-modem 0 crb
cable-modem0
Field Description
Hash Hash key/relative position in the keyed list for this MAC address filter.
Len Length of this entry to the beginning element of this hash chain.
Address Canonical (Ethernet ordered) MAC address of this filter.
Matches Number of received packets that match this MAC address.
Act Action to be taken when this address is looked up; choices are to receive or
discard the packet.
Type MAC address type.
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Cisco uBR925 cable access router, Cisco CVA122 Cable Voice Adapter
Examples The following shows typical output from the show interfaces usb command:
Router# show interface usb0
Router#
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
show tech-support
To display general information about the router when reporting a problem to Cisco technical support,
use the show tech-support command in Privileged EXEC mode.
Syntax Description page Pages the output of the command so that it is displayed one screen at a time
password Displays passwords in the configuration file
ipmulticast Displays the IP multicast related information by the show ip pim, show ip
igmp, show ip mroute, and other IP multicast show commands.
rsvp Displays the IP RSVP related information that is generated by the different
show ip rsvp commands.
Defaults Does not display passwords and does not page the output.
Usage Guidelines The show tech-support command displays a large amount of configuration, run-time status, and other
information about the router for troubleshooting problems. The output of this command can be provided
to technical support representatives when reporting a problem.
The show tech-support command automatically displays the output of a number of different show
commands. The exact output depends on the platform, configuration, and type of protocols being used.
Typically, the output includes the output from the following commands, depending on platform:
Configuration Information
• show version
• show runningconfig
Memory Information
• show region
• show buffers
Tip Depending on the platform and configuration, the output from the show tech-support command can
easily exceed the buffers found in most communications programs. To capture this output so it can be
sent to Cisco TAC, use a Telnet program that allows you to capture the output directly to disk.
Examples The following shows how to give the show tech-support command:
Router# show tech-support
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Cisco uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Syntax Description number Identifies the voice port. Valid entries are 0 (which corresponds to the RJ-11
connector labeled V1) and 1 (which corresponds to the RJ-11 connector labeled
V2).
Examples The following example shows typical output from the show voice port command for a cable access
router:
Router# show voice port 0
Field Description
Type of VoicePort Type of voice port: always FXS for the cable access router.
Operations State Operation state of the port.
Administrative State Administrative state of the voice port.
Interface Down Failure Last interface down failure that was reported, if any.
Description Description of the voice port, if any.
Noise Regeneration Whether or not background noise should be played to fill silent
gaps if VAD is activated.
Non Linear Processing Whether or not nonlinear processing is enabled for this port.
Music On Hold Threshold Configured music-on-hold threshold value for this interface.
In Gain Amount of gain inserted at the receiver side of the interface.
Out Attenuation Amount of attenuation inserted at the transmit side of the interface.
Echo Cancellation Whether or not echo cancellation is enabled for this port.
Echo Cancel Coverage Echo cancel coverage for this port.
Connection Mode Connection mode of the interface.
Connection Number Full E.164 telephone number used to establish a connection with
the trunk or PLAR mode.
Initial Time Out Amount of time the system waits for an initial input digit from the
caller.
Interdigit Time Out Amount of time the system waits for a subsequent input digit from
the caller.
Call-Disconnect Time Out Number of seconds for an idle call to be disconnected.
Ringing Time Out Ringing time out duration.
Region Tone Configured regional tone for this interface.
Currently Processing Type of call currently being processed: none, voice, or fax.
Maintenance Mode Maintenance mode of the voice port.
Number of signaling protocol Number of signalling protocol errors.
errors
Impedance Configured terminating impedance for the E&M interface.
Field Description
Signal Type Type of signalling for a voice port: loop-start, ground-start,
wink-start, immediate, and delay-dial.
Ring Frequency Configured ring frequency for this interface.
Hook Status Hook status of the FXO/FXS interface.
Ring Active Status Ring active indication.
Ring Ground Status Ring ground indication.
Tip Ground Status Tip ground indication.
Digit Duration Timing DTMF digit duration in milliseconds.
InterDigit Duration Timing DTMF interdigit duration in milliseconds.
InterDigit Pulse Duration Pulse dialing interdigit timing in milliseconds.
Timing
Alias User-supplied alias for this voice port, if any.
Coder Type Voice compression mode used.
Hook Flash Duration Timing Maximum length of hook flash signal.
Ring Cadence Configured ring cadence for this interface.
Tip In Cisco IOS Release 12.2(8)T and later releases, you can add a timestamp to show commands using the
exec prompt timestamp command in line configuration mode.
Cisco uBR905 and Cisco uBR925 cable access routers, and Cisco CVA122 Cable Voice Adapter
snmp-server enable traps docsis-cm [bpi | bpkm | dccack | dccreq | dccrsp | dhcp | dsack | dsreq
| dsrsp | dynsa | swupcvc | swupfail | swupinit | swupsucc | tlv]
no snmp-server enable traps docsis-cm [bpi | bpkm | dccack | dccreq | dccrsp | dhcp | dsack |
dsreq | dsrsp | dynsa | swupcvc | swupfail | swupinit | swupsucc | tlv]
Syntax Description bpi (Optional) Enables Baseline Privacy Interface (BPI) initialization failure
traps.
bpkm (Optional) Enables Baseline Privacy Key Management (BPKM)
initialization failure traps.
dccack (Optional) Enables dynamic channel change acknowledgement failure
traps.
dccreq (Optional) Enables dynamic channel change request failure traps.
dccrsp (Optional) Enables dynamic channel change response failure traps.
dhcp (Optional) Enables DHCP failure traps.
dsack (Optional) Enables dynamic service acknowledgement failure traps.
dsreq (Optional) Enables dynamic service request failure traps.
dsrsp (Optional) Enables dynamic service response failure traps.
dynsa (Optional) Enables dynamic SA failure traps.
swupcvc (Optional) Enables secure software upgrade code verification certificate
(CVC) failure traps.
swupfail (Optional) Enables secure software upgrade failure traps.
swupinit (Optional) Enables secure software upgrade initialization failure traps.
swupsucc (Optional) Enables secure software upgrade success traps.
tlv (Optional) Enables unknown Type/Length/Value (TLV) traps.
Defaults No traps are enabled. If no options are specified, all DOCSIS-related traps are enabled.
Usage Guidelines This command enables the sending of SNMP traps when DOCSIS-related events occur. Multiple traps
can be enabled at the same time.
Note The traps are described in the DOCS-CABLE-DEVICE-TRAP-MIB MIB, which is an extension of the
CABLE DEVICE MIB that is defined in RFC 2669.
Examples The following example shows the BPI+ and secure software download traps being enabled:
Router# config terminal
Router(config)# snmp-server enable traps docsis-cm bpi bpkm swupcvc swupfail swupinit
swupsucc
Router(config)#
voice-port
To enter voice-port configuration mode, use the voice-port command in global configuration mode.
Cisco uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
voice-port number
Syntax Description: number Identifies the voice port. Valid entries are 0 (which corresponds to the RJ-11
connector labeled V1) and 1 (which corresponds to the RJ-11 connector
labeled V2).
Usage Guidelines Use the voice-port global configuration command to enter voice-port configuration mode. Use the exit
command to exit the voice-port configuration mode and return to the global configuration mode. See the
Cisco IOS Multiservice Applications Command Reference, available on Cisco.com and the
Documentation CD-ROM for a list of subcommands that are supported by the voice-port command.
Examples The following example shows how to enter the voice-port configuration mode for port 0, the first voice
port (labeled “V1+V2”) on the router.
Router# configure terminal
Router(config)# voice-port 0
Router(config-voice-port)#
Debug Commands
This section describes the following debug commands, which are not normally needed to install or
configure the Cisco cable CPE devices. These commands are used to troubleshoot the device’s
installation or configuration.
• debug cable-modem bpkm
• debug cable-modem bridge
• debug cable-modem error
• debug cable-modem interrupts
• debug cable-modem mac log
• debug cable-modem mac messages
• debug cable-modem mac messages dynsrv
• debug cable-modem map
• debug cable-modem up-dis
• debug crypto ipsec client ezvpn
• debug docsis ssd
• debug usb
Additional debug commands are documented in the Cisco IOS Debug Command Reference, available on
Cisco.com and the Documentation CD-ROM.
Caution The debug commands are primarily intended for use in controlled test and troubleshooting situations
with a limited volume of traffic. You should use caution when enabling debug messages because sending
these messages to the console consumes system resources. Turning on too many types of debug messages
can adversely affect the router’s network performance, depending on what messages are being displayed
and the type of traffic that is occurring.
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Usage Guidelines Baseline privacy key management exchanges take place only when both the router and the CMTS are
running code images that support baseline privacy, and the privacy class of service is enabled via the
configuration file that is downloaded to the cable access router. Baseline privacy code images for the
router contain k1, k8, or k9 in the code image name.
In Cisco IOS Release 12.0(5) and later releases, this command is available only under the direction of
TAC or field service, and should be used only while debugging CM operation. Displaying debugging
messages consumes system resources, and turning on too many messages could negatively affect system
performance.
Examples The following example shows typical debug output when the CMTS does not have privacy enabled:
Router# debug cable-modem bpkm errors
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Usage Guidelines When the interface is down, all bridge table entries learned on the Ethernet interface are set to discard
because traffic is not bridged until the cable interface has completed initialization. After the interface
(the line protocol) is completely up, bridge table entries learned on the Ethernet interface program the
cable’s MAC data filters. The cable MAC hardware filters out any received packets whose addresses are
not in the filters. In this way, the cable interface only receives packets addressed to its own MAC address
or an address it has learned on the Ethernet interface.
In Cisco IOS Release 12.0(5) and later releases, this command is available only under the direction of
TAC or field service, and should be used only while debugging CM operation. Displaying debugging
messages consumes system resources, and turning on too many messages could negatively affect system
performance.
Examples The following shows typical output for the debug cable-modem bridge command:
Router# debug cable-modem bridge
Router#
%LINEPROTO-5-UPDOWN: Line protocol on Interface cable-modem0, changed state to downshut
cm_tbridge_add_entry(): MAC not initialized, discarding entry: 00e0.fe7a.186fno shut
cm_tbridge_add_entry(): MAC not initialized, discarding entry: 00e0.fe7a.186f
%LINEPROTO-5-UPDOWN: Line protocol on Interface cable-modem0, changed state to up
cm_tbridge_add_entry(): Adding entry 00e0.fe7a.186f to filter 2
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Usage Guidelines This command displays detailed output about the sanity checking of received frame formats, the
acquisition of downstream QAM/FEC lock, the receipt or non-receipt of SYNC messages from the
CMTS, reception errors, and bandwidth request failures.
In Cisco IOS Release 12.0(5) and later releases, this command is available only under the direction of
TAC or field service, and should be used only while debugging CM operation. Displaying debugging
messages consumes system resources, and turning on too many messages could negatively affect system
performance.
Examples The following shows typical output for the debug cable-modem error command:
Router# debug cable-modem error
Router#
*Mar 7 20:16:29: AcquireSync(): Update rate is 100 Hz
*Mar 7 20:16:30: 1st Sync acquired after 1100 ms.
*Mar 7 20:16:30: Recovery loop is locked (7/9)
*Mar 7 20:16:30: 2nd Sync acquired after 100 ms.
*Mar 7 20:16:30: Recovery loop is locked (10/15)
Command Description
debug cable-modem interrupts Displays information about CM interrupts.
debug cable-modem mac log Displays comprehensive debugging messages for the cable interface
MAC layer.
debug cable-modem map Displays the timing of MAP and sync messages.
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Usage Guidelines In Cisco IOS Release 12.0(5) and later releases, this command is available only under the direction of
TAC or field service, and should be used only while debugging CM operation. Displaying debugging
messages consumes system resources, and turning on too many messages could negatively affect system
performance.
Examples The following shows typical output for the debug cable-modem interrupts command:
Router# debug cable-modem interrupts
Router#
*** bcm3220_rx_mac_msg_interrupt ***
*** bcm3220_rx_mac_msg_interrupt ***
### bcm3220_tx_interrupt ###
*** bcm3220_rx_mac_msg_interrupt ***
### bcm3220_tx_interrupt ###
*** bcm3220_rx_mac_msg_interrupt ***
### bcm3220_tx_interrupt ###
### bcm3220_tx_interrupt ###
### bcm3220_tx_interrupt ###
### bcm3220_tx_interrupt ###
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Syntax Description verbose (Optional) Displays periodic MAC layer events, such as ranging.
Usage Guidelines The debug cable-modem mac log command is one of the most useful debugging tools because
MAC-layer log messages are written to a circular log file even when debugging is not turned on. These
messages include timestamps, events, and information pertinent to these events. Enter the debug
cable-modem mac log command to view MAC log messages. If you want to view this information
without entering debug mode, use the show controllers cable-modem number mac log command. The
same information is displayed by both commands.
Tip The debug cable-modem mac log command displays details about the MAC-layer processes. In
particular, this command displays the details of the CM’s registration and initialization process.
If the router interface fails to come up or resets periodically, the MAC log will show what happened. For
example, if an address is not obtained from the DHCP server, an error is logged, initialization starts over,
and the CM scans for a downstream frequency. The debug cable-modem mac log command displays
the log from oldest entry to newest entry.
After initial ranging is successful (dhcp_state has been reached), further RNG-REQ/RNG-RSP
messages and watchdog timer entries are suppressed from output unless the verbose keyword is used.
Note that CMAC_LOG_WATCHDOG_TIMER entries while in the maintenance_state are normal when
using the verbose keyword.
Note This command should be used only while debugging CM operation. Displaying debugging messages
consumes system resources, and turning on too many messages could negatively affect system
performance.
Examples This example shows typical output from the debug cable-modem mac log command. The fields of the
output are the time since bootup, the log message, and in some cases a parameter that gives more detail
about the log entry.
uBR924# debug cable-modem mac log
Cable Modem mac log debugging is on
528438.798 CMAC_LOG_RNG_RSP_MSG_RCVD
528444.102 CMAC_LOG_WATCHDOG_TIMER
528444.492 CMAC_LOG_LINK_DOWN
528444.494 CMAC_LOG_RESET_FROM_DRIVER
528444.494 CMAC_LOG_STATE_CHANGE wait_for_link_up_state
528444.494 CMAC_LOG_DRIVER_INIT_IDB_SHUTDOWN 0x08098D02
528444.494 CMAC_LOG_LINK_DOWN
528474.494 CMAC_LOG_WATCHDOG_TIMER
528504.494 CMAC_LOG_WATCHDOG_TIMER
528534.494 CMAC_LOG_WATCHDOG_TIMER
Note The line “0 events dropped due to lack of a chunk” at the end of the display indicates that no log
entries were discarded due to a temporary lack of memory. This means the log is accurate and reliable.
The following example shows typical output of the debug cable-modem mac log verbose command.
The verbose keyword displays periodic events such as ranging.
Router# debug cable mac log verbose
Cable Modem mac log debugging is on (verbose)
Router#
574623.810 CMAC_LOG_RNG_REQ_TRANSMITTED
574623.812 CMAC_LOG_RNG_RSP_MSG_RCVD
574627.942 CMAC_LOG_WATCHDOG_TIMER
574633.880 CMAC_LOG_RNG_REQ_TRANSMITTED
574633.884 CMAC_LOG_RNG_RSP_MSG_RCVD
574643.950 CMAC_LOG_RNG_REQ_TRANSMITTED
574643.954 CMAC_LOG_RNG_RSP_MSG_RCVD
574654.022 CMAC_LOG_RNG_REQ_TRANSMITTED
574654.024 CMAC_LOG_RNG_RSP_MSG_RCVD
574657.978 CMAC_LOG_WATCHDOG_TIMER
574664.094 CMAC_LOG_RNG_REQ_TRANSMITTED
574664.096 CMAC_LOG_RNG_RSP_MSG_RCVD
574674.164 CMAC_LOG_RNG_REQ_TRANSMITTED
574674.166 CMAC_LOG_RNG_RSP_MSG_RCVD
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Syntax Description message-type Selects the specific type of MAC-layer message type to display:
• dcc-ack—Displays the Dynamic Channel Change Acknowledge
(DCC-ACK) messages received by the CM.
• dcc-req—Displays the Dynamic Channel Change Request (DCC-REQ)
messages received by the CM.
• dcc-rsp—Displays the Dynamic Channel Change Response (DCC-RSP)
messages transmitted by the CM.
• dynsrv—Displays the Dynamic Service messages transmitted and
received by the CM (for more information, see the debug cable-modem
mac messages dynsrv command).
• map—Displays the MAP messages received by the CM.
• reg-ack—Displays the Registration Acknowledge (REG-ACK) messages
transmitted by the CM.
• reg-req —Displays the Registration Request (REG-REQ) messages
transmitted by the CM.
• reg-rsp—Displays the Registration Response (REG-RSP) messages
received by the CM.
• rng-req—Displays the Ranging Request (RNG-REQ) messages
transmitted by the CM.
• rng-rsp—Displays the Ranging Response (RNG-RSP) messages
received by the CM.
• sync—Displays the Time Synchronization (SYNC) messages received by
the CM.
• ucc-req—Displays the Upstream Channel Change Request (UCC-REQ)
messages received by the CM.
• ucc-rsp—Displays the Upstream Channel Change Response (UCC-RSP)
messages transmitted by the CM.
• ucd—Displays the Upstream Channel Descriptor (UCD) messages
received by the CM.
• up-dis—Displays the Upstream Transmitter Disable (UP-DIS) messages
received by the CM.
Usage Guidelines The output from this command is very verbose, displaying the details of the DOCSIS MAC-layer
messages, and is usually not needed for normal interface debugging. The command is most useful when
attempting to attach a router to a CMTS that is not DOCSIS-qualified.
Caution This command should be used only while debugging CM operation. Displaying debugging messages
consumes system resources, and turning on too many messages could negatively affect system
performance.
Examples The following example shows typical output from the debug cable-modem mac messages command. A
separate command must be given for each message type to be displayed.
Much of the information, such as REG-REQ messages, is displayed in hexadecimal dump format, using
the Type/Length/Value (TLV) format required by the DOCSIS specification.
Note For complete descriptions of the MAC-layer management messages, see the DOCSIS Radio Frequency
Interface Specification (SP-RFIv1.1-I07-010829 or later), available from CableLabs at
http://www.cablemodem.com/specifications.html.
Command Description
debug cable-modem mac Displays the dynamic service messages.
messages dynsrv
debug cable-modem up-dis Displays debugging for Upstream Transmitter Disable (UP-DIS)
messages.
Cisco uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Usage Guidelines This command begins the display of debug messages that show the dynamic service MAC messages that
are generated when a voice call is made using the dynamic SID feature. Dynamic SIDs use the following
DOCSIS MAC-layer messages to create a new SID when a voice call is made and to delete it when the
call is over:
• DSA-REQ—Dynamic Service Addition Request, sent to establish a new service flow.
• DSA-RSP—Dynamic Service Addition Response, sent in reply to DSA-REQ to confirm or deny the
new service flow.
• DSA-ACK—Dynamic Service Addition Acknowledge, sent in reply to DSA-RSP to acknowledge
the creation of the service flow.
• DSD-REQ—Dynamic Service Deletion Request, sent to delete an existing service flow when it is
no longer needed (for example, when a voice call has terminated).
• DSD-RSP—Dynamic Service Deletion Response, sent in response to DSD-REQ to delete an
existing service flow.
Note Dynamic Services are described in the DOCSIS 1.1 specification (SP-RFIv1.1-I03-991105 or later
revision), available from CableLabs at http://www.cablemodem.com/specifications.html.
Examples The following example shows how to enable the display of debug messages related to dynamic service
operations:
Router# debug cable-modem mac messages dynsrv
Router#
The following example shows how to turn off the display of debug messages related to dynamic service
operations:
Router# no debug cable-modem mac messages dynsrv
Router#
The following example shows the types of debug messages that are displayed when a voice call is made.
This example shows that dynamic SID 52 is created for this particular call.
DSA-REQ TLV's:
--------------
US Flow Scheduler(24):
Unsolicited Grant Size - 19:2:89
Nominal Grant Interval - 20:4:20000
Created New Dynamic Service State, Transaction_id = 3
597.721 CMAC_LOG_DSA_REQ_MESSAGE_EVENT
DSA-REQ MESSAGE
---------------
FRAME HEADER
FC - 0xC2 == MAC Management
MAC_PARM - 0x00
LEN - 0x26
MAC MANAGEMENT MESSAGE HEADER
DA - 0010.abcd.ef00
SA - 0050.abcd.ef00
msg LEN - 14
DSAP - 0
SSAP - 0
control - 03
version - 01
type - 0F == DSA-REQ
RSVD - 0
Transaction ID - 3
597.725 CMAC_LOG_DSA_RSP_MSG_RCVD
DSA-RSP MESSAGE
---------------
FRAME HEADER
FC - 0xC2 == MAC Management
MAC_PARM - 0x00
LEN - 0x26
MAC MANAGEMENT MESSAGE HEADER
DA - 0050.abcd.ef00
SA - 0010.abcd.ef00
msg LEN - 14
DSAP - 0
SSAP - 0
control - 03
version - 01
type - 10 == DSA-RSP
RSVD - 0
Transaction ID - 3
Response - 0 == DSA-RSP-OK
SID - 52
Cisco uBR904, uBR905, uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter
Usage Guidelines In Cisco IOS Release 12.0(5) and later releases, this command is available only under the direction of
TAC or field service, and should be used only while debugging CM operation. Displaying debugging
messages consumes system resources, and turning on too many messages could negatively affect system
performance.
Examples The following shows typical output from the debug cable map command:
Router# debug cable-modem map
Cable Modem MAP debugging is on
Router#
*Mar 7 20:12:08: 595322.942: Min MAP to sync=72
*Mar 7 20:12:08: 595322.944: Max map to map time is 40
*Mar 7 20:12:08: 595322.982: Min MAP to sync=63
*Mar 7 20:12:08: 595323.110: Max map to map time is 41
*Mar 7 20:12:08: 595323.262: Min MAP to sync=59
*Mar 7 20:12:08: 595323.440: Max map to map time is 46
*Mar 7 20:12:09: 595323.872: Min MAP to sync=58
Command Description
debug cable-modem interrupts Displays information about cable interface interrupts.
debug cable-modem mac log Displays comprehensive debugging messages for the cable interface
MAC layer.
Usage Guidelines This command shows debugging messages about the Upstream Transmitter Disable (UP-DIS) messages
that the CMTS sends to a CM. The CMTS can send an UP-DIS message to a cable modem to suspend
its operation on the cable network. The UP-DIS message can instruct the cable modem to suspend its
operations for a limited period of time or permanently.
After sending the UP-DIS message, the CMTS allows the cable modem back on the network only if the
cable modem is power-cycled, or if the CMTS sends another UP-DIS message re-enabling the cable
modem’s upstream transmitter. If a cable modem is already in the suspended state, it must ignore any
further UP-DIS messages except a UP-DIS message re-enabling its operations.
Note See the DOCSIS 1.1 specification (revision SP-RFIv1.1-I09-020830 and above) for information on the
content and format of the UP-DIS messages.
Examples The following examples show typical output for the debug cable up-dis command, which displays the
MAC frame header and UP-DIS Timeout Interval value (in milliseconds):
Router# debug cable up-dis
up-dis message debugging is on
Router#
UP-DIS MESSAGE");
--------------");
*Mar 7 01:44:06: FRAME HEADER
*Mar 7 01:44:06: FC - 0xC2 == MAC Management
*Mar 7 01:44:06: MAC_PARM - 0x00
Related Commands debug cable-modem mac Displays debugging messages for specific MAC-layer messages.
messages
Usage Guidelines To force the Cisco Easy VPN Remote feature to reestablish the virtual private network (VPN)
connections, use the clear crypto sa and clear crypto isakmp commands to delete the IPSec security
associations and Internet Key Exchange (IKE) connections, respectively.
Examples The following example shows debugging of the Cisco Easy VPN Remote feature being turned on, as well
as typical debugging messages that appear when the VPN tunnel is created:
Router# debug crypto ipsec client ezvpn
EzVPN debugging is on
router#
00:02:28: EZVPN(hw1): Current State: IPSEC_ACTIVE
00:02:28: EZVPN(hw1): Event: RESET
00:02:28: EZVPN(hw1): ezvpn_close
00:02:28: EZVPN(hw1): New State: CONNECT_REQUIRED
00:02:28: EZVPN(hw1): Current State: CONNECT_REQUIRED
00:02:28: EZVPN(hw1): Event: CONNECT
00:02:28: EZVPN(hw1): ezvpn_connect_request
00:02:28: EZVPN(hw1): New State: READY
00:02:29: EZVPN(hw1): Current State: READY
00:02:29: EZVPN(hw1): Event: MODE_CONFIG_REPLY
00:02:29: EZVPN(hw1): ezvpn_mode_config
00:02:29: EZVPN(hw1): ezvpn_parse_mode_config_msg
00:02:29: EZVPN: Attributes sent in message:
00:02:29: Address: 8.0.0.5
00:02:29: Default Domain: cisco.com
00:02:29: EZVPN(hw1): ezvpn_nat_config
00:02:29: EZVPN(hw1): New State: SS_OPEN
00:02:29: EZVPN(hw1): Current State: SS_OPEN
00:02:29: EZVPN(hw1): Event: SOCKET_READY
The following example shows the typical display for a VPN tunnel that is reset with the clear crypto
ipsec client ezvpn command:
3d17h: EZVPN: Current State: READY
3d17h: EZVPN: Event: RESET
3d17h: ezvpn_reconnect_request
3d17h: ezvpn_close
3d17h: ezvpn_connect_request
3d17h: EZVPN: New State: READY
3d17h: EZVPN: Current State: READY
3d17h: EZVPN: Event: MODE_CONFIG_REPLY
3d17h: ezvpn_mode_config
3d17h: ezvpn_parse_mode_config_msg
3d17h: EZVPN: Attributes sent in message:
3d17h: DNS Primary: 172.168.0.250
3d17h: DNS Secondary: 172.168.0.251
3d17h: NBMS/WINS Primary: 172.168.0.252
3d17h: NBMS/WINS Secondary: 172.168.0.253
3d17h: Split Tunnel List: 1
3d17h: Address : 172.168.0.128
3d17h: Mask : 255.255.255.128
3d17h: Protocol : 0x0
3d17h: Source Port: 0
3d17h: Dest Port : 0
3d17h: Split Tunnel List: 2
3d17h: Address : 172.168.1.128
3d17h: Mask : 255.255.255.128
3d17h: Protocol : 0x0
3d17h: Source Port: 0
3d17h: Dest Port : 0
3d17h: Default Domain: cisco.com
3d17h: ezvpn_nat_config
3d17h: EZVPN: New State: SS_OPEN
3d17h: EZVPN: Current State: SS_OPEN
3d17h: EZVPN: Event: SOCKET_READY
3d17h: EZVPN: No state change
3d17h: EZVPN: Current State: SS_OPEN
3d17h: EZVPN: Event: SOCKET_READY
3d17h: EZVPN: No state change
3d17h: EZVPN: Current State: SS_OPEN
3d17h: EZVPN: Event: MTU_CHANGED
3d17h: EZVPN: No state change
3d17h: EZVPN: Current State: SS_OPEN
3d17h: EZVPN: Event: SOCKET_UP
3d17h: EZVPN: New State: IPSEC_ACTIVE
3d17h: EZVPN: Current State: IPSEC_ACTIVE
3d17h: EZVPN: Event: MTU_CHANGED
3d17h: EZVPN: No state change
3d17h: EZVPN: Current State: IPSEC_ACTIVE
3d17h: EZVPN: Event: SOCKET_UP
The following example shows the typical display for a VPN tunnel that is removed from the interface
with the no crypto ipsec client ezvpn command:
4d16h: EZVPN: Current State: IPSEC ACTIVE
Cisco uBR905 and Cisco uBR925 cable access routers, and Cisco CVA122 Cable Voice Adapter
Usage Guidelines This command displays whether the Secure Software Download procedure could validate the
manufacturer’s CVC and optional cosigner’s CVC (if present) that are part of the downloaded software
image.
Examples The following example shows typical output for a successful Secure Software Download procedure for
a software image that has been signed by both the manufacturer and by a cosigner:
Router# debug docsis ssd
Router#
If the manufacturer’s signature on the software image file cannot be validated using the manufacturer’s
CVC on the router, the following messages are displayed:
MFG code signature does not validate
MFG CVC validation has failed
If the MSO cosigner’s signature on the software image file cannot be validated using the cosigner’s CVC
on the router, the following messages are displayed:
Co-signer code signature does not validate
Co-signer CVC validation has failed
If the software image was signed either before or after the allowable time range specified as part of the
manufacturer’s CVC, one of the following messages is displayed:
signingTime is before saved codeAccessStart
signingTime is before CVC validNotBefore
signingTime is after CVC validNotAfter
CVC validity start is less than save cvcAccessStart
debug usb
To display the packets that are transmitted and received over the USB interface, use the debug usb
command in privileged EXEC mode. To turn off debugging for the USB interface, use the no form of
this command.
Cisco uBR925 cable access router, Cisco CVA122 Cable Voice Adapter
Usage Guidelines This command displays a hexadecimal dump of each packet transmitted or received on the USB interface
and should be used only while debugging CM operation. Displaying debugging messages, especially for
each packet transmitted or received, consumes system resources. Turning on too many messages could
negatively affect system performance.
Examples The following shows typical output from the debug usb command.
Router# debug usb rx
USB Rx debugging is on
Router# debug usb tx
USB Tx debugging is on
Nov 22 11:01:36.909: 0x040: 72 6C 19 E7 0C 12
Nov 22 11:12:18.447: USB transmit packet data (size=114):
Nov 22 11:12:18.447: 0x000: 00 01 64 FF E1 13 00 01 64 FF E1 12 08 00 45 00
Nov 22 11:12:18.447: 0x010: 00 64 16 32 00 00 FF 01 62 FF 20 01 01 01 20 01
Nov 22 11:12:18.451: 0x020: 01 65 08 00 40 5D 1E 3D 07 2D 00 00 00 00 04 19
Nov 22 11:12:18.451: 0x052: AB CD AB CD AB CD AB CD AB CD AB CD AB CD
Nov 22 11:12:18.455: 0x060: AB CD AB CD AB CD AB CD AB CD AB CD AB CD AB CD
Nov 22 11:12:18.455: 0x070: AB CD
Nov 22 11:12:18.459: USB receive packet data (size=60):
Nov 22 11:12:18.459: 0x000: FF FF FF FF FF FF 00 01 64 FF E1 13 08 06 00 01
Nov 22 11:12:18.463: 0x010: 08 00 06 04 00 01 00 01 64 FF E1 13
Nov 22 11:12:18.463: 0x01C: 20 01 01 65
Nov 22 11:12:18.463: 0x020: 00 00 00 00 00 00 20 01 01 01 00 00 00 00 00 00
Nov 22 11:12:18.467: 0x030: 00 00 00 00 00 00 00 00 00 00 00 00
Nov 22 11:12:18.467: USB transmit packet data (size=60):
This appendix describes the ROM monitor (ROMMON) that is used by the Cisco CMTS routers. The
Cisco CMTS runs the ROM monitor when it is initially powered on or reset, and the ROM monitor
determines what other software, such as a Cisco IOS boot helper image or software image, should be
loaded next.
Because the ROM monitor is in the permanent memory on the processor card, it is always available and
can help in troubleshooting possible hardware or software problems. It contains a small set of commands
that allow access to the router’s internal memory and other memory devices.
This appendix contains the following major sections:
• Entering the ROM Monitor, page A-1
• Command Conventions, page A-3
• ROM Monitor Command Reference, page A-5
Caution The ROM monitor should be used only by trained service technicians or under the direction of a
Cisco TAC engineer. Many of the commands available in the ROM monitor put the router in a diagnostic
mode or in a non-functional state. Do not enter any commands in the ROM monitor unless you
thoroughly understand their function and how to reverse their effects so that you can restore the router
to normal operations.
Tip In this example, a CTRL-] is used to enter Telnet command mode, where the send brk command
is used to send the BREAK signal. Other terminal programs might use different commands.
...
Router# ^] <-- in this example, a CTRL-] is used to enter telnet command mode
rommon 1 >
Caution When you enter ROM monitor mode, the Cisco IOS software no longer is executing, and all of the
router’s normal functions end. Do not enter ROM monitor mode on a Cisco CMTS that is being used for
production purposes because this immediately halts all network and subscriber traffic through that
Cisco CMTS until you restart the Cisco IOS software.
Tip To resume execution after interrupting the boot process or Cisco IOS software, use the cont command
at the ROM monitor prompt. To boot another software image, use the boot command at the ROM monitor
prompt.
(router reboots)
rommon 1 >
Tip To set the configuration register for normal operations, use the config-reg 0x2102 command. For a
complete description of the configuration register, see the description of the confreg command.
You must reset or power cycle for new config to take effect
Router>
Tip To set the configuration register for normal operations, use the confreg 0x0 command. For a complete
description of the configuration register, see the description of the confreg command.
Command Conventions
Use the following conventions when giving commands at the ROM monitor prompt:
• Brackets [ ] denote an optional field.
• A word in italics is a variable for which you must supply a valid value.
• The default ROM monitor prompt is “rommon x >”, where x is the number of the command, as used
in the command history table. The ROM monitor prompt is determined by the PS1 environment
variable (see the set command).
• Give the help or ? command to display a help screen listing all of the commands that are available
in ROM monitor mode. For usage information about a specific command, give the command
followed by -? (for example, alias -?).
• All address and size arguments to the memory-related commands are hexadecimal values (using a
“0x” prefix).
• To specify more than one command on a command line, separate the commands with the semicolon
(;) delimiter.
Note You cannot include the repeat command as part of a command line that has multiple
commands.
alias
To define an alias to be used at the ROM monitor prompt, use the alias command in ROM monitor mode.
alias [name=value]
Syntax Description name=value (Optional) Specifies the name of the alias to be defined and its corresponding
command string. If the value parameter includes spaces, you must include the
string within double quotes.
Defaults If no arguments are given, displays the aliases that are currently defined.
Usage Guidelines Aliasing allows you to abbreviate commands or to set up a command so that it is automatically run with
certain options. The ROM monitor’s alias function is based on the syntax used in the Korn shell on Unix
systems.
Normally, only the first word at the ROM monitor prompt is checked for an alias. However, when you
define an alias that contains a space as its last character, the ROM monitor also checks the next word at
the ROM monitor prompt for an alias.
Note If an alias contains any spaces, the entire command must be enclosed within quotes when you define it
with the alias command. To create an alias for multiple commands, separate the commands with a
semicolon (;) delimiter.
Examples The following example shows how to display the currently defined aliases:
rommon 13 > alias
r=repeat
h=history
?=help
b=boot
ls=dir
i=reset
k=stack
rommon 14 >
The following example defines an alias named “cpuinfo” that executes three separate CPU-related
commands:
rommon 31 > alias cpuinfo="cpu_card_type;meminfo;context"
rommon 32 >
The following example shows how to define an alias dird that lists the file contents of the Flash Disk in
the disk0 slot:
rommon 18 > alias dird="dir disk0:"
rommon 19 > alias
r=repeat
h=history
?=help
b=boot
ls=dir
i=reset
k=stack
dird=dir disk0:
rommon 20 >
boot
To boot a router manually, use the boot command in ROM monitor mode.
boot [-xv]
Syntax Description x (Optional) Loads the specified image into the router’s memory but does not
execute it.
v (Optional) Enables verbose mode to display debugging information as the
image is loaded and executed.
device: (Optional) Specifies that the router should boot an image on the specified
device. If not specified, the router boots from the default memory device.
imagename (Optional) Specifies the filename for the image to be booted and loaded. If not
specified, the router boots the first file on the specified device.
Note When specifying both a device: and imagename, do not put any
spaces between the two arguments.
filename Specifies the path and filename for the image that the router should download
from a Trivial File Transfer Protocol (TFTP) server.
Note You must specify the full path for the desired file, as it exists on
the TFTP server.
tftp-ip-address (Optional) Specifies the IP address for the TFTP server from which the router
should download and boot the specified filename. If not specified, the router
sends a TFTP request to the IP broadcast address of 255.255.255.255 and uses
the first TFTP server that responds.
tftp://server/path/filename Specifies the complete TFTP URL for the filename to be downloaded and run.
This URL should specify the fully-qualified server name (or IP address), full
path on the TFTP server, and filename to be downloaded.
Defaults If specified without any options, the boot command loads and executes the first file on the default memory
device. If a device is specified without a filename, the boot command loads and executes the first file on that
device. If a filename is specified without a TFTP server IP address, the boot command advertises for a TFTP
server using the IP broadcast address of 255.255.255.255 and uses the first TFTP server that responds.
Release Modification
12.1(5)EC Support was added for Cisco uBR7100 series routers.
12.2(4)BC1 Support was added for the Cisco uBR10012 router. Changes were also made
to the boot procedure after breaking into ROMMON to ensure that all
hardware and software registers are in a known state before loading the new
image.
Usage Guidelines The boot command allows a network administrator to boot the router from the ROM monitor
(ROMMON) prompt. The router can enter ROMMON for the following reasons:
• The administrator interrupted the boot sequence or Cisco IOS software by pressing the BREAK
signal.
• The router’s configuration register is set to boot into ROMMON (0x00).
• The router entered ROMMON because of a software exception or error.
The boot command allows the administrator to continue the boot process or to load a new software
image.
Note To upgrade the router to a new Cisco IOS software image, you can use either the boot command in
ROMMON mode or the boot system commands in global configuration mode.
Step 1 At the router's console prompt, send a BREAK signal to interrupt the boot process and enter ROMMON.
Step 2 Set the configure register to boot into ROMMON by giving the confreg 0x0 command.
Step 3 Use the reset command to reset the NPE and to boot into ROMMON. This ensures a clean boot into
ROMMON, with all registers set to a known state.
Step 4 Set the configure register to boot an IOS image by giving the confreg 0x2102 command.
Step 5 Use the boot command to boot the desired Cisco IOS image.
Examples The following example shows how to boot the router using the first file in the default device:
rommon 1 > boot
Router>
The following example shows how to specify that the router should download and boot the file named
“newimage.bin” in the subdirectory named “ubrimages” on the TFTP server with the IP address of
10.10.10.31:
rommon 45> boot tftp://10.10.10.31/ubrimages/newimage.bin
Router>
The following example shows how to use the alternate syntax to specify that the router should download
and boot the file named newimage.bin on the TFTP server with the IP address of 10.10.10.31:
rommon 45> boot newimage.bin 10.10.10.31
Router>
The following example shows the new ROMMON boot procedure that is required when using a
Cisco IOS Release 12.2 (or later) boot image:
Router-NPE#
You must reset or power cycle for new config to take effect
Router>
break
To set or clear the debugger breakpoint, use the break command in ROM monitor mode.
Syntax Description -s address (Optional) Sets the breakpoint to the specified address in memory. The address
must be specified in hexadecimal.
-c (Optional) Clears the currently-defined breakpoint.
Defaults If no arguments are given, the command displays the currently-defined breakpoint.
Usage Guidelines The ROM monitor supports one breakpoint. If set, the processor runs normally, but when its program
counter reaches the breakpoint address, the system breaks into ROM monitor mode. You can examine
memory locations or register contents, and then continue normal program execution by using the cont
command.
Examples The following example shows how to set a breakpoint so that when the processor breaks into ROM
monitor mode when its program counter reaches 0xbfc02708:
rommon 37 > break -s 0xbfc02708
rommon 38 >
rommon 39 >
breakpoint is cleared
rommon 40 >
confreg
To change the value of the router’s configuration register, use the confreg command in ROM monitor
mode.
confreg [value]
Syntax Description value (Optional) New value for the configuration register, expressed as a 16-bit
hexadecimal value. The valid range for value is 0x0 to 0xFFFF. If value is not
specified, the command interactively prompts you for the individual register
settings.
Defaults 0x2102 (boots the Cisco IOS software image and allows the use of the BREAK signal to enter
ROMMON)
Usage Guidelines The configuration register determines the router’s behavior when it boots. Typically, an administrator
changes the configuration register so that it boots either into ROMMON mode or boots a Cisco IOS
software image, but other options are also available.
If given without an argument, the confreg command interactively prompts you for the new values of the
individual register settings, using English descriptions. You can either keep the current settings
unchanged or change them as desired. The new value of the configuration register is written into the
router’s nonvolatile Flash memory (NVRAM) immediately, but does not take effect until you reset the
router.
If you specify an argument with the confreg command, it must be a 16-bit hexadecimal value in the
following format:
Bit Description
15 If set, enables the router’s diagnostic mode (for example, 0x8000).
14 If set, uses the network number in IP broadcasts (for example, 0x4000).
13 If set, allows the router to fall back into ROMMON mode if the boot procedure fails.
If not set, the router attempts each valid boot command (as specified by bits 3–0) for
a total of 5 times each, until one of the commands is successful (for example,
0x2000).
Bit Description
12–11 Defines the speed, in bps, for the console port:
00 = 0x0000 = 9600
01 = 0x0800 = 4800
10 = 0x1000 = 1200
11 = 0x1800 = 2400
Note On the Cisco CMTS routers, the console port speed is fixed at 9600 bps and
cannot be changed.
10 If set, uses an IP broadcast address that consists of all ones (for example, 0x0400).
9 If set, disables the secondary bootstrap (for example, 0x0200).
8 If set, the router enables the BREAK key, allowing users to break into ROMMON
during the boot process (for example, 0x0100).
7 Unused on the Cisco CMTS routers.
6 If set, the router ignores the configuration file in its Flash memory. This is typically
done when the user has forgotten the router’s enable password (for example, 0x0040).
5–4 Unused on the Cisco CMTS routers.
3–0 Defines the router’s boot behavior:
0x0000 = Boots to the ROMMON prompt
0x0001 = Boots the ROMMON boot helper software (first file in bootflash:)
0x0002 to 0x000F = Boots a Cisco IOS software image, based on the values of the
router’s boot variables. Each boot system command in the configuration file is tried
until a valid image is booted.
For example, for normal operations the configuration register is set to 0x2102, which sets bit 13 (allows
the router to fall into ROMMON mode if the boot fails), bit 8 (allows the user to break into ROMMON),
and bit 1 (boots a Cisco IOS software image). Bits 11 and 12 are cleared, which sets the console port to
9600 bps.
The following are the most commonly-used configuration register values:
• 0x0 = Boot into ROMMON.
• 0x2002 = Normal boot for standard operations, but the BREAK signal cannot be used to break into
ROM monitor mode.
• 0x2102 = Normal boot for standard operations, enabling the BREAK signal.
• 0x2142 = Normal boot but the router ignores the configuration file in Flash memory.
Tip The confreg command is identical in function to the config-register command that is available in global
configuration mode.
Examples The following example shows how to change the configuration register by using the English prompts. In
this example, the only change is to have the router boot the Cisco IOS software image instead of entering
ROMMON mode:
rommon 1 > confreg
Configuration Summary
enabled are:
break/abort has effect
console baud: 9600
boot: the ROM Monitor
Configuration Summary
enabled are:
break/abort has effect
console baud: 9600
boot: image specified by the boot system commands
or default to: cisco2-C10000
You must reset or power cycle for new config to take effect.
rommon 2 >
Note After changing the configuration register in interactive mode, the system displays the new values and
prompts you again as to whether you want to change them. If the values are correct, answer no and the
system returns you to the ROMMON prompt. If you made any changes, the system reminds you that you
must reset or power cycle the router before the new configuration register takes effect.
The following example shows how to set the configuration register to the typical value of 0x2102, so that
it boots a Cisco IOS software image:
rommon 7 > confreg 0x2102
You must reset or power cycle for new config to take effect.
rommon 8 >
cont
To continue the execution of the Cisco IOS software image that has been interrupted by a BREAK signal
or debugger breakpoint, use the cont command in ROM monitor mode.
cont [address]
Syntax Description address (Optional) Specifies the address in memory at which the router should continue
execution. If address is not specified, the command continues execution at the
address currently stored in the program counter (PC) register.
Caution Do not use the address option unless instructed to do so by Cisco TAC
engineers.
Defaults If given without any arguments, the command continues execution at the address currently stored in the
processor’s program counter (PC) register.
Usage Guidelines The cont command typically is used when a user has interrupted the operation of the Cisco IOS software
by using the BREAK signal to enter ROM monitor mode, and then wants to continue with the original
Cisco IOS software image. This command can also be used to continue program execution when the user
uses the BREAK signal to interrupt the Cisco IOS software boot procedure, or has used the break
command to set a debug breakpoint.
Examples In the following example, the cont command continues executing the Cisco IOS software image, after
the user has interrupted the software by sending a BREAK signal:
Router#
Router#
context
To display the processor context at the time of the most recent fault or exception, use the context
command in ROM monitor mode.
context
Usage Guidelines When the processor fault or exception occurs, the ROM monitor preserves the processor context at the
time of the fault. The context command displays this processor context, which includes information
about the kernel registers and the process mode of the booted image (if available).
Examples The following example shows how to display the CPU context at the time of the most recent fault or
exception:
rommon 21 > context
rommon 22 >
cpu_card_type
To display the type of processor card that is installed in the router, use the cpu_card_type command in
ROM monitor mode.
cpu_card_type
Examples The following example shows that the router is using an NPE-225 processor card:
rommon 92 > cpu_card_type
rommon 93 >
dev
To list the known storage and memory devices for the router, use the dev command in ROM monitor
mode.
dev
Examples The following example shows how to display the known file systems on a router:
rommon 3 > dev
rommon 4 >
Note The disk2 device is available only on a Cisco uBR7246VXR router using the NPE-G1 processor card.
dir
To list the files on one of the router’s file systems, use the dir command in ROM monitor mode.
dir device:
Examples The following example shows how to list the files on the slot0: and bootflash: devices.
rommon 40 > dir slot0:
File size Checksum File name
65 bytes (0x41) 0xb49d basic.cm
2229799 bytes (0x220627) 0x469e uBR7200-k.z
rommon 42 >
dis
To disassemble a segment of main memory, use the dis command in ROM monitor mode.
Syntax Description address (Optional) Address in main memory at which the disassembly should begin.
num-of-bytes (Optional) Number of bytes to disassemble.
Defaults If no arguments are given, the command prompts for the address and num-of-bytes parameters.
rommon 24 >
The following example shows the command’s interactive mode being used to perform the same
disassembly:
rommon 25 > dis
rommon 26 >
The dis command displays an exception if you attempt to disassemble a non-existent address or if you
specify an argument that the system interprets as a non-existent address. For example, the following
command shows the dis disk0: command being given. The system interprets the disk0: argument as a
memory address of 0xd, and because this address does not exist, displays the exception message:
rommon 3 > dis disk0:
rommon 4 >
frame
To display an individual stack frame, use the frame command in ROM monitor mode.
frame [number]
Syntax Description number (Optional) Number of the stack frame to be displayed. The default is 0 (the most
current frame).
Usage Guidelines The frame command displays a particular stack frame. Use the stack command to list the available stack
frames and their frame numbers.
Examples The following example shows the frame command being used to display the details of an individual
frame displayed by the stack command:
rommon 5 > stack 6
Stack trace:
PC = 0x02004adc
Frame 00: FP = 0x02003938 RA = 0x02005f2a
Frame 01: FP = 0x02003948 RA = 0x02005df0
Frame 02: FP = 0x02003960 RA = 0x020050ee
Frame 03: FP = 0x02003994 RA = 0x02004034
Frame 04: FP = 0x02003b00 RA = 0x00012ca6
Frame 04: FP = 0x02003b34 RA = 0x020a703c
rommon 7 >
help
To display a short list of the commands that are available at the ROM monitor prompt, use the help
command in ROM monitor mode.
help
Usage Guidelines The help command displays a list of available ROM monitor commands, along with a brief description
of each. To display additional details for a specific command, enter the command name followed by the
-? option.
Examples The following example shows a typical display of the help screen:
rommon 12 > help
rommon 13 >
The following example shows how to display additional help for the alias command:
rommon 14 > alias -?
rommon 15 >
history
To display the last 16 commands given at the ROM monitor prompt, use the history command in ROM
monitor mode.
history
Usage Guidelines The ROM monitor keeps a record of the last commands given at the ROM monitor prompt (up to 16),
similar to the way this is done with the Korn shell. Use the history command to display these commands,
and the repeat command to repeat them one or more times.
Tip When you use an alias, the history list includes the alias and not the actual commands that were
executed.
Examples The following example shows how to reset the ROM monitor and return it to a known state:
rommon 9 > history
1 boot sysfiles/ubr10k-k8p6-mz.12211BC3
2 dev
3 dir disk0:
4 confreg
5 confreg 0x00
6 cont
7 break -c
8 break
9 history
rommon 10 >
meminfo
To display information about the available range of main memory and Flash memory, use the meminfo
command in ROM monitor mode.
meminfo
Usage Guidelines The meminfo command displays the size of available main memory, its starting address, the size of
available packet memory, and the size of nonvolatile Flash memory.
Examples The following example shows how to display information about the current memory usage:
rommon 9 > meminfo
rommon 10 >
repeat
To repeat a particular ROM monitor command from the history list, use the repeat command in ROM
monitor mode.
Syntax Description number (Optional) Specifies the number, as listed in the history command, of the
command to be repeated.
string (Optional) Specifies a string to be compared against the commands in the
history list. The most recent command that matches the string is repeated. If
the string includes spaces, it must be enclosed within quotes.
count (Optional) Specifies the number of times the command should be executed. The
default is 1.
Defaults If given without any arguments, repeats the previous command once.
Usage Guidelines The repeat command repeats one of the commands in the history list (which can contain up to 16
commands). You can specify the command to be repeated by its history number (as shown by the history
command) or by a string that will match the command.
If you do not give any arguments with the command, it repeats the last command in the history list once.
Note The repeat command is not added to the history list, so you cannot repeat the repeat command. You
also cannot include the repeat command on a command line that has multiple commands separated by
a semicolon delimiter.
Examples The following example shows how to use the repeat command to execute one of the commands in the
history list:
rommon 9 > history
1 boot sysfiles/ubr10k-k8p6-mz.12211BC3
2 dev
3 dir disk0:
4 confreg
5 confreg 0x00
6 cont
7 break -c
8 break
9 history
1 boot sysfiles/ubr10k-k8p6-mz.12211BC3
2 dev
3 dir disk0:
4 confreg
5 confreg 0x00
6 cont
7 break -c
8 break
9 history
10 history
rommon 11 >
reset
To reinitialize the ROM monitor and return it to a known state, use the reset command in ROM monitor
mode.
reset [-s]
Syntax Description -s (Optional) Saves the current environment (environment variables and aliases)
to nonvolatile memory before performing the reset.
Defaults If given without any arguments, resets all environment variables and aliases to their initialized states.
Usage Guidelines The reset command returns the ROM monitor to its initial state, without requiring a complete system
reboot by performing a warm reset. This is useful if you have been setting and unsetting registers and
variables, and no longer know whether the system is in a stable state.
If you specify the -s option, the system saves the current environment variables and aliases to nonvolatile
memory before resetting the ROM monitor, so as to preserve their current values.
Examples The following example shows how to reset the ROM monitor and return it to a known state:
rommon 59 > reset
rommon 1 >
Related Commands
Command Description
boot Boots the router manually.
sysreset Displays the return information from the system image that was last booted.
set
To display the contents of the currently-defined environment variables, use the set command in ROM
monitor mode.
set
Usage Guidelines The set command displays the environment variables that are currently defined in the ROM monitor.
Variables are defined at the ROM monitor prompt in a manner similar to that of the Korn shell, by
specifying variable=value.
Examples The following example shows how to display the values of the currently defined monitor variables:
rommon 13 > set
PS1=rommon ! >
RET_2_RTS=17:28:46 PST Tue Oct 12 1993
BSI=0
RET_2_RUTC=
?=1
rommon 14 >
The following example shows the PS1 variable (which defines the ROM monitor prompt) being changed,
and the set command displaying the new value:
rommon 12 > PS1=”Rommon-CMTS ! >”
Rommon-CMTS 13 > set
PS1=Rommon-CMTS ! >
RET_2_RTS=17:28:46 PST Tue Oct 12 1993
BSI=0
RET_2_RUTC=
?=1
Rommon-CMTS 14 >
show_spd
To display the contents of the processor’s Serial Presence Detect (SPD) device (an electrically erasable
programmable read-only memory (EEPROM) device), use the show_spd command in ROM monitor
mode.
show_spd
Usage Guidelines The show_spd command displays the contents of the processor card’s SPD/EEPROM memory device.
This information is typically useful only to Cisco TAC engineers.
Note The show_spd command displays a large volume of data. Enable the capture buffer on your terminal
program so that you can preserve this data and review it later.
Examples The following example shows how to display the SPD data (only a portion of the command’s display is
shown):
rommon 15 > show_spd
byte 0 - 0xff000000
byte 1 - 0xff000000
byte 2 - 0xff000000
...
byte 125 - 0xff000000
byte 126 - 0xff000000
byte 127 - 0xff000000
rommon 16 >
stack
To display a stack trace, use the stack command in ROM monitor mode.
stack [number]
Syntax Description number (Optional) Number of stack frames to display. The default is 5 frames.
Usage Guidelines The stack command displays a stack trace of the most recently booted software image. This trace
includes the value of the program counter and the selected number of frames from the kernel stack and
process stack (if available) from that software image.
Tip To display details for an individual frame stack, use the frame command.
Examples The following example shows how to display a stack trace with 6 frames:
rommon 5 > stack 6
Stack trace:
PC = 0x02004adc
Frame 00: FP = 0x02003938 RA = 0x02005f2a
Frame 01: FP = 0x02003948 RA = 0x02005df0
Frame 02: FP = 0x02003960 RA = 0x020050ee
Frame 03: FP = 0x02003994 RA = 0x02004034
Frame 04: FP = 0x02003b00 RA = 0x00012ca6
Frame 04: FP = 0x02003b34 RA = 0x020a703c
rommon 6 >
The following example shows how to display a stack trace with the default of 5 frames, when a process
stack is available:
rommon 21 > stack
Kernel Level Stack Trace:
Initial SP = 0x61bb4d30, Initial PC = 0x606931b0, RA = 0x6067bca0
Frame 0 : FP= 0x61bb4d30, PC= 0x606931b0, 0 bytes
Frame 1 : FP= 0x61bb4d30, PC= 0x6067bca0, 24 bytes
Frame 2 : FP= 0x61bb4d48, PC= 0x6068db30, 48 bytes
Frame 3 : FP= 0x61bb4d78, PC= 0x6069157c, 32 bytes
Frame 4 : FP= 0x61bb4d98, PC= 0x606905e0, 88 bytes
rommon 22 >
sync
To write the current values of aliases and monitor environment variables to Flash memory, use the sync
command in ROM monitor mode.
sync
Usage Guidelines The sync command writes the current values of the monitor environment variables and aliases to Flash
memory so that they are read on the next reset. If you do not do this, all variables and aliases are deleted
upon reset and replaced with the default values.
Examples The following example shows how to synchronize the monitor variables and aliases:
rommon 39 > sync
rommon 40 >
sysreset
To display information about the system image that was last booted, use the sysreset command in ROM
monitor mode.
sysreset
Usage Guidelines The sysreset command displays the information about the last system image that was booted and then
terminated. This includes the reason for why the last image ended its execution, the values of the
program counter and error address registers when the program ended execution, and a stack trace holding
the last eight frames. Any exception information is also shown.
Examples The following example shows a typical display from the sysret command:
rommon 22 > sysret
rommon 23 >
unalias
To delete a currently-defined alias, use the unalias command in ROM monitor mode.
Usage Guidelines The unalias command deletes one or more aliases that you have previously defined for the ROM monitor
using the alias command.
rommon 14 >
rommon 21 >
The following example shows the error message that is displayed when you try to delete an alias that
does not exist:
rommon 11 > unalias gobbledegook
rommon 12>
unset
To delete the current contents of a monitor environment variable, use the unset command in ROM
monitor mode.
Usage Guidelines The unset command clears the contents of one or more monitor variables that have been defined in the
ROM monitor. Variables are defined at the ROM monitor prompt in a manner similar to that of the Korn
shell, by specifying variable=value.
Examples The following example shows how to delete a variable named “temp-var”:
rommon 13 > unset temp-var
rommon 14 >
rommon 18 >
specifying an access group for CMs 2-153 boot flash command A-8
Address Resolution Protocol, see ARP 5-7 system software, configuration register A-14
admission control, specifying for the upstream 2-286 boot registers A-14
ARP broadcast
adding a certificate to the hotlist 2-186 cable clock source-midplane command 2-26
debugging TEK and KEK key management 5-41 cable dci-response command 2-33
cable source-verify command 2-222 cable upstream freq-adj averaging command 2-313
cable source-verify leasequery-filter downstream cable upstream frequency command 2-314
command 2-227
cable upstream hopping blind command 2-319
cable source-verify leasequery-filter upstream
cable upstream hop-priority command 2-317
command 2-229
cable upstream ingress-noise-cancellation 2-321
cable spectrum-group command 2-231, 2-235, 2-349
cable upstream max-ports command 2-325, 2-327
cable spectrum-group hop period command 2-237
cable upstream minislot-size command 2-329
cable spectrum-group hop threshold command 2-239
cable upstream modulation-profile command 2-332
cable spectrum-group shared command 2-242
cable upstream power-adjust command 2-336
cable submgmt default command 2-244
cable upstream power-level command 2-340
cable sync-interval command 2-249
cable upstream range-backoff command 2-342
cable telco-return enable command 2-250
cable upstream rate-limit command 2-344
cable telco-return interval command 2-252
cable upstream scrambler command 2-346
cable telco-return registration-ip command 2-254
cable upstream shutdown command 2-348
cable telco-return spd dhcp-authenticate command 2-256
cable upstream snr-polling command 2-351
cable telco-return spd dhcp-server command 2-258
cable upstream threshold command 2-353
cable telco-return spd dial-timer command 2-260
cable upstream timing-adjust command 2-355
cable telco-return spd factory-default command 2-262
cable upstream unfrag-slot-jitter command 2-357
cable telco-return spd manual-dial command 2-264
cable vc-map command 2-358
cable telco-return spd password command 2-266
card command 2-360
cable telco-return spd phonenum command 2-268
channel-id command 2-364
cable telco-return spd ppp-authenticate command 2-270
Cisco Cable Clock card
cable telco-return spd radius-realm command 2-272
clearing counters 2-22
cable telco-return spd service-provider command 2-274
displaying clock reference information 3-180
cable telco-return spd threshold command 2-276
displaying clock reference status 3-15
cable telco-return spd username command 2-278
displaying TDM clock reference 3-192
cable tftp-enforce command 2-66, 2-70, 2-72, 2-280, 2-366
selecting external timing source 2-24
cable time-server command 2-285
setting midplane clock reference 2-26
cable upstream admission-control command 2-286
CISCO-DOCS-EXT-MIB 2-78
cable upstream channel-width command 2-290
clear cable dsg command 2-366
cable upstream concatenation command 2-294
clear cable flap-list command 2-368
cable upstream data-backoff command 2-297
clear cable host command 2-370, 2-372
cable upstream description command 2-299
clear cable modem counters command 2-378, 2-380, 2-386
cable upstream differential-encoding command 2-300
clear cable modem flap-counters command 2-382
cable upstream equalization-coefficient command 2-305
clear cable modem lock command 2-384, 3-20
cable upstream fec command 2-307
clear cable modem reset command 2-388
cable upstream fec-strength command 2-308
clear cable secondary-ip command 2-391
cable upstream fragmentation command 2-309
clear crypto engine accelerator counter command 6-22
cable upstream fragment-force command 2-311
clear facility-alarm command 4-10
debug cable receive command 5-63 enabling for telco-return use 2-256
debug cable registration command 5-64 filtering leasequeries 2-227, 2-229, 3-40
debug cable remote-query command 5-67 inserting CM MAC address 2-441
debug cable reset command 5-69 LEASEQUERY requests 2-222
debug cable rfmib command 5-70 relay agent option 2-204
debug cable specmgmt command 5-72 setting GIADDR field 2-41
debug cable startalloc command 5-73 setting the UDP broadcast server address 2-109
debug cable subscriber-monitoring command 5-74 smart-relay command for CMs 6-55
debug cable telco-return command 5-76 specifying the IP address for telco-return use 2-258
debug cable telco-return msg command 5-77 verifying a host’s IP address 2-222
debug cable tlvs command 5-78, 5-81 differential encoding, enabling on the upstream 2-300
debug cable transmit command 5-82 dir command A-23
debug cable ucc command 5-83 dis command A-24
debug cable ucd command 5-84 displaying rogue cable modems 3-116
debug cable upconverter command 5-87 DMA
debug cable up-dis command 6-205 displaying counters 4-78
debug cable us-adm-ctrl command 5-88 DMA counters, clearing 4-12
debug checkpoint command 5-90 DOCSIS 2-58
debug cr10k-rp command 5-90, 5-91 configuration file editor, debugging 5-14
debug hccp authentication command 5-97 configuring a service class 2-206
debug hccp channel-switch command 5-99 configuring the modulation profile 2-167, 2-194
debug hccp docsis-recovery command 5-101, 5-103 configuring the QoS profile 2-199
debug hccp events command 5-102 creating a configuration file 2-30
debug hccp inter-db command 5-105 creating an IP filter group 2-92
debug hccp plane command 5-107 default max burst 2-37
debug hccp sync command 5-109 enabling concatenation 2-294
debug hccp timing command 5-112 enabling fragmentation 2-309
debug packetcable cops command 5-119 event generation 2-86
debug packetcable ipc command 5-131 event messages reporting 2-80
debug packetcable subscriber command 5-133 event throttling 2-88, 2-90
debug pxf command 5-135 forcing fragmentation 2-311
debug redundancy command 5-140 ping command 2-465
debug usb command 6-212 QoS MIB 2-214
Description requiring a download of the configuration file 2-72,
2-280
assigning to an upstream 2-299
dev command A-22
service flow logging 2-214
G interface bundling
configuring 2-19
gates, creating the maximum number for PacketCable
operation 2-459 debugging command 5-12
displaying configuration 3-11
GIADDR field, setting 2-41
interface cable-modem command 6-49
interface usb command 6-51
H interleave depth, setting 2-54
ip address dhcp command 6-53
h323-gateway voip bind srcaddr command 6-47
ip address docsis command 6-53
hccp authentication command 2-407
ip address negotiated command 6-53
hccp authentication key-chain command 2-409
ip dhcp relay information option command 2-441
hccp bypass version command 2-411
ip dhcp smart-relay command 2-443, 6-55
hccp check version command 2-416
ip http cable-monitor command 6-57
hccp ds-switch command 2-413, 2-418
ip http server command 6-58, 6-60
hccp lockout command 2-420
ip multicast
hccp protect command 2-422
enabling on a cable interface 2-151
hccp resync command 2-424
hccp revert command 2-426
hccp reverttime command 2-428
hccp switch command 2-430
MPEG framing format, setting 2-46 password, telco-return PPP authentication 2-266
show cable device command 3-17 show controllers cable-modem filters command 6-90
show cable filter group command 3-24 show controllers cable-modem lookup-table
command 6-93, 6-115, 6-129
show cable flap-list command 3-26
show controllers cable-modem mac command 6-97
show cable hop command 3-30
show controllers cable-modem phy command 6-119
show cable host command 3-33
show controllers cable-modem qos command 6-38, 6-40,
show cable l2-vpn vc-map command 3-38
6-42, 6-80, 6-85, 6-113, 6-122, 6-210
show cable leasequery-filter command 3-40
show controllers cable-modem tuner command 6-135
show cable modem cnr command 3-70
show controllers cable upstream spectrum
show cable modem command 3-52, 3-65, 3-68, 3-81, 3-83, command 3-176
3-113
show controllers clock-reference command 3-180
setting the vendor field 2-165
show controllers usb command 6-137
show cable modem connectivity command 3-73
show cr10k-rp command 4-45
show cable modem counters command 3-78
show cr10k-rp queue command 4-49
show cable modem flap command 3-86
show crypto ca certificates command 3-186
show cable modem mac command 3-89
show crypto ca trustpoints 3-187
show cable modem maintenance command 3-94
show crypto engine accelerator ring command 6-140
show cable modem offline command 3-97
show crypto engine accelerator sa-database
show cable modem phy command 3-101 command 6-143
show cable modem qos command 3-105 show crypto engine accelerator statistic command 6-147
show cable modem registered command 3-109 show crypto engine brief command 6-149
show cable modem rogue command 3-116 show crypto engine configuration command 6-152
show cable modem summary command 3-119 show crypto engine connections command 6-155
show cable modem unregistered command 3-124 show dhcp command 6-162
show cable modem vendor command 3-128 show diag command 3-189
show cable modulation-profile command 3-132 show facility-alarm status command 4-51
show cable noise command 3-140 show frame-clocks command 3-192
show cable privacy command 3-141, 3-224 show hardware pxf commands 4-52
show cable qos enforce-rule command 3-143 See show pxf commands
show cable qos permission command 3-146 show hccp command 3-193
show cable qos profile command 3-148 show hccp interface command 3-201
show cable service-class command 3-151 show interface cable command 3-203
show cable spectrum-group command 3-154 show interface cable downstream command 3-209
show cable subscriber-usage command 3-157 show interface cable intercept command 3-212
show cable tech-support command 3-161 show interface cable mac-scheduler command 3-143, 3-214
show checkpoint command 3-165 show interface cable modem command 3-219
show controllers cable command 3-167 show interface cable monitor command 3-222
show controllers cable-modem bpkm command 6-75 show interface cable qos paramset command 3-226
show controllers cable-modem command 6-69 show interface cable service-flow command 3-228
show controllers cable-modem des command 6-87 show interface cable sid command 3-234
show interface cable signal-quality command 3-241 configuring the hop threshold value 2-239
show interface cable upstream command 3-243 creating 2-231, 2-235, 2-349
show interfaces cable-modem command 6-165 debugging 5-38
show interfaces usb command 6-172 displaying 3-154, 3-176
show packetcable event command 3-250 spectrum management
show packetcable global command 3-257 debugging 5-91
show processor cpu command 4-67 stack command A-42
show pxf cable command 4-53 switchover pxf restart command 4-96
show pxf cable interface command 4-58 switchover timeout command 4-98
show pxf cpu command 4-61 sync command A-44
show pxf dma command 4-78 SYSLOG server
show pxf microcode command 4-85 DOCSIS messages 2-83
show pxf xcm command 4-88 sysreset command A-45
show redundancy command 4-91 system messages
show tech-support command 3-259 logging BAD IP source address messages 2-143
show version command 3-262
show voice port command 6-177
T
SIDs
debugging 5-91 T9 timer, setting 2-203
sniffing packets on the cable interface 2-175 TCC+ card
SNMP clearing clock counters 2-22
enabling cable-related traps 2-477, 2-479 displaying clock reference information 3-180
enabling cable traps 2-477 displaying clock reference status 3-15
enabling CM state change traps 2-78 displaying TDM clock reference 3-192
enabling DOCSIS traps 2-479 selecting external timing source 2-24
polling CMs 2-162 setting midplane clock reference 2-26
setting default values for the Subscriber Management TEK, setting values 2-190
MIB 2-244
telco-return
specifying a manager in the DOCSIS configuration
enabling 2-250
file 2-475
enabling DHCP server 2-256
snmp manager command 2-475
setting for manual-dial mode 2-264
snmp-server enable cable command 2-477, 2-479
setting the authentication method 2-270
snmp-server enable traps cable command 2-477
setting the authentication password 2-266
snmp-server enable traps docsis-cmts command 2-479
setting the authentication username 2-278
software configuration boot register A-14
setting the default SPD value 2-262
specifying the maximum number of hosts 2-149
setting the idle timeout value 2-260
spectrum group
setting the RADIUS server 2-272
configuring shared spectrum groups 2-242
setting the registration IP addresses 2-254
configuring the hop period 2-237
setting the service provider name 2-274