Cisco CMTS Cable Command Reference

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Book Contents
Find Matches in This Book

Results

Updated:
July 25, 2024

Chapter: Cable Commands: ca through cr

Cable Commands: ca through cr

ca-interface

To configure the conditional access interface for session based scrambling, use the ca-interface command in the DVB scrambling configuration mode. To disable conditional access interface configuration, use the no form of this command.

ca-interface linecard slot/bay ip_address

no ca-interface linecard slot/bay

slot/bay

Specifies the slot and bay of the linecard.

ip_address

Specifies the IP for the conditional access interface.

Command Default

None

Command Modes

DVB scrambling configuration mode (config-video-encrypt-dvb)

Release

Modification

IOS-XE 16.4.1

This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Examples

The following is an example of how to configure the conditional access interface: 


Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#ca-interface linecard 7/0 1.24.10.8

Related Commands

Command

Description

dvb

Enters DVB scrambling configuration mode.

strong-pairing-enforce

Switches on the NDS strong pairing enforcement

mgmt-ip

Configures the manangement IP for EIS/Broadcast ECMG.

scramble-video-audio

Scrambles only video and audio pids.

route-ecmg

Configures the route to the ECMG server.

check-scg-at-prov

Enables Check SCG at provision time.

tier-based

Enters the tier-based scrambling configuration mode.

ecmg

Enters the ECM Generator configuration mode.

eis

Enters the Event Information Scheduler configuration mode.

ca-system-id

To configure the CA system ID, use the ca-system-id command in the DVB scrambling ECMG configuration mode. To void the CA system ID configuration, use the no form of this command.

ca-system-id id sub_id

no ca-system-id id sub_id

id

Specifies the CA system ID in Hex.

sub_id

Specifies the CA sub system ID in Hex.

Command Default

None

Command Modes

DVB scrambling ECMG configuration mode (config-video-encrypt-dvb-ecmg)

Release

Modification

IOS-XE 16.4.1

This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Examples

The following is an example of how to configure the CA system ID: 


Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#ecmg ECMG-7 id 7
Router(config-video-encrypt-dvb-ecmg)#ca-system-id 950 1234

Related Commands

Command

Description

ecmg

Enters the ECM Generator configuration mode.

auto-channel-id

Enables automatic channel ID selection.

connection

Configures the ECMG connection.

ecm-pid-source

Configures the source of ECM PID.

type

Configures the ECMG type.

mode

Configures the application mode of ECMG.

desc-rule

Configures the descriptor rule.

overrule

Overrules the default settings.

channel-group

To add an interface (Gigabit Ethernet or Fast Ethernet) to an EtherChannel Group, and to associate that interface with an EtherChannel link, use the channel-group command in interface configuration mode.

To remove an EtherChannel interface from the EtherChannel group, use the no form of this command.

channel-group n

no channel-group n

Cisco cBR Series Converged Broadband Routers

channel-group n link link-id | mode {active | passive} [ link | link-id]

no channel-group n

Syntax Description

n

The identifying number for the EtherChannel group with which to associate this interface. An EtherChannel group can be identified in the range of 1 to 64.

Each group can have up to four interfaces on the Cisco uBR10012 and Cisco uBR7200 series routers, only one of which is the primary.

Each group can have up to eight interfaces on the Cisco cBR series routers, only one of which is the primary.

link link-id

Assigns a link identifier used for load balancing.

  • link-id —Load balancing link identifier. The range is from 1 to 8.

mode

Specifies the Etherchannel mode for the interface.

active

Enables Link Aggregation Control Protocol (LACP) unconditionally.

passive

Enables LACP only if an LACP device is detected.

Command Default

By default, the channel-group command has the following behaviors:

  • EtherChannel groups and ports are not defined.
  • EtherChannel groups and ports are disabled (off mode) once configured, and must be enabled.
  • The first port assigned to an EtherChannel group is the bundle primary.

Command Modes


Interface configuration (config-if)

Command History

Release

Modification

12.2(11)BC3

This command was introduced on the Cisco uBR7246VXR router.

12.2(9a)BC

This command was introduced on the Cisco uBR10012 router.

12.3BC

This command was integrated into Cisco IOS Release 12.3BC.

12.2(33)SCA

This command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the Cisco uBR7225VXR router was added.

IOS-XE 3.15.0S

This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines

The no form of this command also removes the associated EtherChannel ports within the EtherChannel group. For additional information, refer to the EtherChannel on the Cisco CMTS Routers feature document on Cisco.com.

The Cisco cBR series routers support the channel group configuration on the Ten Gigabit Ethernet interface.

Examples

The following example creates an EtherChannel link with a channel group identifier of 1 on the specified port. If this is the first port assigned to EtherChannel group 1, it becomes the primary in that EtherChannel group. 


Router(config-if)# channel-group etherchannel 1

The following example creates an EtherChannel link with a channel group identifier of 3 on the specified port on a Cisco cBR-8 router: 


Router(config)# interface port-channel 3
Router(config-if)# exit
Router(config)# interface TenGigabitEthernet 5/1/0
Router(config-if)# channel-group 3 mode active

Related Commands

Command

Description

show interface port-channel

Displays the EtherChannel interfaces and channel identifiers, with their mode and operational status.

channel-id (cable configuration file)

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.

Command Default

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.

Command Modes


Cable configuration file (config-file)

Command History

Release

Modification

12.1(2)EC1

This command was introduced.

12.3BC

This command was integrated into Cisco IOS Release 12.3BC.

12.2(33)SCA

This command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the Cisco uBR7225VXR router was added.

IOS-XE 3.15.0S

This command is not supported on the Cisco cBR Series Converged Broadband Routers.

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

Related Commands

Command

Description

cable config-file

Creates a DOCSIS configuration file and enters configuration file mode.

access-denied

Disables access to the network.

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.

check-scg-at-prov

To enable Check SCG at provision time, use the check-scg-at-prov command in the DVB scrambling configuration mode. To disable Check SCG at provision time, use the no form of this command.

check-scg-at-prov

no check-scg-at-prov

Command Default

None

Command Modes

DVB scrambling configuration mode (config-video-encrypt-dvb)

Release

Modification

IOS-XE 16.4.1

This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines

When SCG checking at the time of provisioning is enabled, the Simulcrypt Synchroniser (SCS) does not provision the SCG from EIS if the elementary streams or services in the incoming stream do not match the streams or services in SCG provisioning message. When this configuration is disabled, the input transport stream is verified only during scrambling.

Examples

The following is an example of how to enable Check SCG at provision time: 


Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#check-scg-at-prov

Related Commands

Command

Description

dvb

Enters DVB scrambling configuration mode.

strong-pairing-enforce

Switches on the NDS strong pairing enforcement

mgmt-ip

Configures the manangement IP for EIS/Broadcast ECMG.

scramble-video-audio

Scrambles only video and audio pids.

route-ecmg

Configures the route to the ECMG server.

ca-interface

Configures the conditional access interface.

tier-based

Enters the tier-based scrambling configuration mode.

ecmg

Enters the ECM Generator configuration mode.

eis

Enters the Event Information Scheduler configuration mode.

class

To configure the redundancy class for the redundancy group , use the class command in line card redundancy configuration mode. To remove the configuration, use the no form of this command.

class 1:N

no class

Syntax Description

1:N

Specifies N+1 redundancy class for the redundancy group.

Command Default

None.

Command Modes

Line card redundancy configuration (config-red-lc)

Command History

Release

Modification

IOS-XE Release 3.16.0S

This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines

You cannot change the class while group has members. Remove all the members to change the class.

Examples

The following example shows how to configure 1:N redundancy class on Cisco cBR-8 Series Converged Broadband Routers: 

Router# configure terminal
Enter configuration commands, one per line.  End with CNTL/Z.
Router(config)# redundancy
Router(config-red)#  linecard-group 0 internal-switch
Router(config-red-lc)# class 1:N
Class set to 1:N for Redundancy group (0)
Router(config-red-lc)#

Related Commands

Command

Description

description

Adds a description to the line card group.

linecard-groupinternal-switch

Creates a line card group for the line card.

member slot

Adds a slot to the redundancy group.

redundancy

Enters redundancy configuration mode.

show redundancy linecard

Displays information about a line card or a line card group.

clear cable admission control counters

To reset all the resource counters on the Cisco CMTS to zero, use the clear cable admission control counters command in privileged EXEC mode.

clear cable admission control counters

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.3(13a)BC

This command was introduced.

12.2(33)SCA

This command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the Cisco uBR7225VXR router was added.

IOS-XE 3.15.OS

This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines

The counters are also set to zero when a given resource is reconfigured. Counters can be displayed using the show cable admission-control command.

For additional information, refer to the Admission Control for the Cisco CMTS feature documents on Cisco.com.

Examples

The following example resets configured admission control counters to zero, whether configured in global or interface configuration mode: 


Router# clear cable admission control counters

Related Commands

Command

Description

cable admission-control

Configures the CPU and memory thresholds for the Cisco CMTS and supporting broadband processing engines (BPEs)

cable admission-control event

Configures and enables Admission Control event types on the Cisco CMTS.

cable admission-control ds-bandwidth

Configures Admission Control downstream bandwidth thresholds on the Cisco CMTS.

cable admission-control us-bandwidth

Configures Admission Control upstream bandwidth thresholds on the Cisco CMTS.

debug cable admission-control

Enables automatic Admission Control troubleshooting processes on the Cisco CMTS.

show cable admission-control

Displays the current Admission Control configuration and status on the Cisco CMTS, or on a specified interface.

clear cable arp-filter

To reset Address Resolution Protocol (ARP) filter statistics displayed by the show cable arp-filter command, use the clear cable arp-filter command in privileged EXEC mode.

clear cable arp-filter {bundle number cable slot/port | slot/subslot/port}

Syntax Description

bundle number

Resets the ARP filter statistics for the specified virtual bundle interface, where number is a value from 1 to 255.

cable slot /port

(Cisco uBR7100 and Cisco uBR7200 Series Routers) Specifies removal of CMs on the specified cable interface and downstream port, where:

  • slot —Specifies the chassis slot number of the cable interface line card.
  • port —Specifies the downstream port number.

Valid values for these arguments are dependent on your CMTS router and cable interface line card. Refer to the hardware documentation for your router chassis and cable interface line card for supported slot and port numbering.

cable slot /subslot /port

(Cisco uBR10012 Router) Specifies removal of CMs on the specified cable interface, where:

  • slot —Specifies the chassis slot number of the cable interface line card. Valid slots are 5 to 8.
  • subslot —Specifies the secondary slot number of the cable interface line card. Valid subslots are 0 or 1.
  • port —Specifies the downstream port number. Valid ports are 0 to 4, depending on the cable interface line card.

cable slot /subslot /port

(Cisco cBR Series Routers) Specifies removal of CMs on the specified cable interface, where:

  • slot —Slot number of the card. Valid slots are 0 to 3 and 6 to 9 on the Cisco cBR-8router.
  • subslot —Subslot number of the card. The valid value is 0 on the Cisco cBR-8router.
  • port —Downstream port number. The valid range is from 0 to 15 on the Cisco cBR-8router.

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.3(17a)BC

This command was introduced.

12.2(33)SCA

This command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the Cisco uBR7225VXR router was added.

IOS-XE 3.15.0S

This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines

Use the clear cable arp-filter command to clear the ARP filter statistics that are displayed using the show cable arp-filter command.

Examples

This example shows cable ARP filter statistics for virtual bundle interface number 10, followed by a clearing of the ARP filter statistics on that bundle and the resulting display of cleared statistics. 


Router# show cable arp-filter bundle 10
ARP Filter statistics for Bundle10:
  Replies Rcvd: 3069 total. 3062 unfiltered, 7 filtered
  Requests Forwarded: 1175 total. 1175 unfiltered, 0 filtered
  Requests Sent For IP: 0 total. 0 unfiltered, 0 filtered
Router# clear cable arp-filter bundle 10
Router# show cable arp-filter bundle 10
ARP Filter statistics for Bundle10:
  Replies Rcvd: 0 total. 0 unfiltered, 0 filtered
  Requests Forwarded: 0 total. 0 unfiltered, 0 filtered
  Requests Sent For IP: 0 total. 0 unfiltered, 0 filtered

Related Commands

Command

Description

cable arp filter

Controls the number of ARP packets that are allowable for each SID on a cable interface.

clear arp-cache

Refreshes dynamically created entries from the ARP cache.

show cable arp-filter

Displays the total number of ARP replies and requests that have been sent and received, including the number of requests that have been filtered.

clear cable bgsync counters

To clear the background synchronization information on the Cisco CMTS, use the clear cable bgsync counters command in global configuration mode.

clear cable bgsync counters

Syntax Description

This command has no arguments or keywords.

Command Modes


Global configuration mode (config)

Command History

Release

Modification

12.2(33)SCG

This command was introduced.

IOS-XE 3.15.0S

This command is not supported on the Cisco cBR Series Converged Broadband Routers.

IOS-XE 3.18.0S

This command is implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines

Use the clear cable bgsync counters command to clear the background synchronization information statistics on the Cisco CMTS.

Examples

The following example shows how to clear the background synchronization counters on the Cisco CMTS: 


Router# configure terminal
Router(config)# clear cable bgsync counters
Router(config)#

Related Commands

Command

Description

cable bgsync

Sets the data intervals for background synchronization on the Cisco CMTS.

cable bgsync active

Activates background synchronization process on the Cisco CMTS.

show cable bgsync

Displays the information on the background synchronization process.

clear cable cmc

To clear the Cisco CMC information, use the clear cable cmc command in privileged EXEC mode.

clear cable cmc {all | mac-address}

Syntax Description

all

Specifies that the information on all Cisco CMCs must be cleared.

mac-address

MAC address of the Cisco CMC for which the information must be cleared.

Command Default

None

Command Modes

Privileged EXEC (#)

Command History

Release

Modification

12.2(33)CX

This command was introduced.

IOS-XE 3.15.0S

This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines

The clear cable cmc clears the Cisco CMC. When this command is used, the Cisco CMTS clears all the running data of the Cisco CMC from current database and disconnects the Generic Control Protocol (GCP) connection. Therefore, the Cisco CMC reboots.

Examples

The following example shows how to clear the information for all Cisco CMCs: 

Router# clear cable cmc all

The following example shows how to clear the information on the Cisco CMC with the MAC address 0010.2024.7035: 

Router# clear cable cmc 0010.2024.7035

Related Commands

Command

Description

cable cmc

Configures the downstream RF power and FRx on the Cisco CMC.

show cable cmc

Displays the Cisco CMC information.

clear cable dsg

To reset counters related to DOCSIS Set-top Gateway (DSG) tunnels, use the clear cable dsg command in privileged EXEC mode.

clear cable dsg

Syntax Description

This command has no arguments or keywords.

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.2(15)BC2

This command was introduced for the Cisco uBR7100 series and Cisco uBR7246VXR routers.

12.3(13a)BC

This command is obsolete.

IOS-XE 3.15.0S

This command is not supported on the Cisco cBR Series Converged Broadband Routers.

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
 
DSG statistics information
DSG keepalive is set
Vendor: DDD, Tunnel count: 1
Vendor: BBB, Tunnel count: 2
Vendor name is DDD, tunnel MAC is 0001.0002.0003
Group address is 226.2.2.2, source address is * 
  Interface is Cable5/1,   mapping entry is used 2 
    Received 5968 packets,  forwarded 5289 packets
    Dropped 679 packets,  last second rate 16878 bits/sec
Router# clear cable dsg
 
Router# show cable dsg stats
 
DSG statistics information
Vendor: DDD, Tunnel count: 1
Vendor: BBB, Tunnel count: 2
Vendor name is DDD, tunnel MAC is 0001.0002.0003
Group address is 226.2.2.2, source address is * 
  Interface is Cable5/1,   mapping entry is used 0 
    Received 5968 packets,  forwarded 5289 packets
    Dropped 679 packets,  last second rate 16878 bits/sec

Related Commands

Command

Description

cable dsg

Enables the DOCSIS Set-Top Gateway (DSG) on a cable interface, and configures its tunnel-mapping parameters.

cable dsg keepalive

Enables keepalive messages over DOCSIS Set-Top Gateway (DSG) tunnels on a cable interface.

debug cable dsg

Enables the display of debugging messages for the operation of the DOCSIS Set-Top Gateway (DSG) feature.

show cable dsg

Displays the current DOCSIS Set-Top Gateway (DSG) tunneling parameters.

clear cable flap-list

To reset the flap-list table for a specific CM or for all CMs connected to the Cisco CMTS router, use the clear cable flap-list command in privileged EXEC mode.

clear cable flap-list {mac-addr | all} [save-counters]

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.

Command Default

Clears the flap-list counters.

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

11.3 NA

This command was introduced.

11.3(7)NA

The save-counters option was supported on the Cisco uBR7200 series routers.

12.1(5)EC1

Support was added for the Cisco uBR7100 series routers.

12.2(4)BC1

Support for this command (without the save-counters option) was added for the Cisco uBR10012 router.

12.2(15)BC2

The save-counters option was supported on the Cisco uBR10012 router.

12.3BC

This command was integrated into Cisco IOS Release 12.3BC.

12.2(33)SCA

This command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the Cisco uBR7225VXR router was added.

IOS-XE 3.15.OS

This command was implemented on the Cisco cBR Series Converged Broadband Routers.

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

Related Commands

Command

Description

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 miss-threshold

Specifies miss threshold for recording a flap-list event.

cable flap-list power-adjust threshold

Specifies the power-adjust threshold for recording a CM flap-list event.

cable flap-list size

Specifies the maximum number of CMs that can be listed in the flap-list table.

clear cable modem counters

Zeroes the CM counters, including flap-list counters.

clear cable modem reset

Removes a CM from the Station Maintenance List and resets it.

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.

clear cable hop

To clear the forward error corrections (FEC) hop counters on one or all cable interfaces on a Cisco CMTS, use the clear cable hop command in privileged EXEC mode.

clear cable hop [cable {slot/port | slot/subslot/port} [upstream uport]]

Cisco cBR Series Converged Broadband Routers

clear cable hop [ upstream-cable { slot/card/port} [ us-channel { physical us-channel number} ] ]

Syntax Description

cable slot /port

(Optional—Cisco uBR7100 and Cisco uBR7200 Series Routers) Specifies removal of CMs on the specified cable interface and downstream port, where:

  • slot— Specifies the chassis slot number of the cable interface line card.
  • port— Specifies the downstream port number.

Valid values for these arguments are dependent on your CMTS router and cable interface line card. Refer to the hardware documentation for your router chassis and cable interface line card for supported slot and port numbering.

cable slot/ subslot /port

(Optional—Cisco uBR10012 Router) Specifies removal of CMs on the specified cable interface, where:

  • slot —Specifies the chassis slot number of the cable interface line card. Valid slots are 5 to 8.
  • subslot —Specifies the secondary slot number of the cable interface line card. Valid subslots are 0 or 1.
  • port —Specifies the downstream port number. Valid ports are 0 to 4, depending on the cable interface line card.

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.

upstream-cable slot/card/port

(Optional) Clears the hop counters on a specific upstream-cable controller. The valid values start with 0 for the first upstream port on the cable interface line card.

us-channel physical us-channel number

(Optional) Clears upstream channel information. Valid values are 0 to 11.

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.2(15)BC1

This command was introduced.

12.3(BC)

This command was integrated into Cisco IOS Release 12.3BC.

12.2(33)SCA

This command was integrated into Cisco IOS Release 12.2(33)SCA.

IOS-XE 3.15.OS

This command was implemented on the Cisco cBR Series Converged Broadband Routers.

  • The upstream-cable keyword was added.

  • The

    us-channel keyword was added.

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 
Router# clear cable hop
 
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 * * *  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#

The following example shows how to clear the frequency hop counters on a specific upstream on the Cisco cBR Series Converged Broadband Routers: 

Router# clear cable hop upstream-cable 3/0/3 us-channel 2
Router#

Related Commands

Command

Description

show cable hop

Displays cable-hop statistics on a Cisco CMTS.

show cable modem

Displays CM configuration settings.

clear cable host

To clear the host from the router’s internal address tables, use the clear cable host command in privileged EXEC mode.

clear cable host {ip-address | mac-address | name fqdn}

Cisco cBR Series Converged Broadband Routers

clear cable host {ip-address | mac-address | vrf { VPN Routing/Forwarding instance name ip-address} }

Syntax Description

ip-address

IPv4 or IPv6 address for the device to be cleared.

mac-address

MAC address for the device to be cleared.

name fqdn

Specifies the fully qualified domain name (FQDN) of the cable device to be displayed. This option is only available if the show cable modem domain-name command has been run for the first time to update the cable DNS cache on the CMTS router.

vrf

Specifies VPN Routing/Forwarding instance.

VPN Routing/Forwarding instance name

VPN Routing/Forwarding instance name.

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

11.3 NA

This command was introduced for the Cisco uBR7200 series universal broadband router.

12.1(5)EC1

Support was added for the Cisco uBR7100 series universal broadband router.

12.2(4)BC1

Support was added for the Cisco uBR10012 universal broadband router.

12.3BC

This command was integrated into Cisco IOS Release 12.3BC.

12.2(33)SCA

This command was integrated into Cisco IOS Release 12.2(33)SCA, with the following changes:

  • Support for the Cisco uBR7225VXR router was added.
  • Support for specifying the IPv6 address of a CM or CPE device was added.
  • The name keyword option was added for specifying the fully-qualified domain name of a CM.

IOS-XE 3.15.OS

This command was implemented on the Cisco cBR Series Converged Broadband Routers. The vrf keyword was added.

Usage Guidelines

This command removes a host’s IP, MAC address, or domain name 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.

Note
In Cisco IOS Release 12.2(33)SCA, the show cable modem domain-name (not supported for cBR routers) command must be run first on the route processor (RP) of the CMTS router before any domain name can be used as part of a cable command.

Examples

The following example shows how to remove a host’s MAC address from the internal address tables on the Cisco CMTS router: 


Router# clear cable host 0050.7366.17ab

The following example shows how to remove a host’s domain name from the internal address tables on the Cisco CMTS router: 


Router# clear cable host cisco

The following example shows how to remove a VPN Routing/Forwarding instance on the Cisco cBR Series Converged Broadband Routers: 


Router# clear cable host vrf cisco 3046:1829:fefb::ddd1

Related Commands

Command

Description

cable device

Configures the access list for a CM device or host.

cable host access-group

Configures the access list for the specified hosts.

show cable device access-group

Display the CMs and the hosts behind the CMs on the network.

show cable host access-group

Displays only the hosts behind the CMs on the network.

clear cable ipc-stats

To clear the active database and reset all IPC statistics in the active database to zero, use the clear cable ipc-stats command in privileged EXEC mode.

clear cable ipc-stats

Syntax Description

This command has no arguments or keywords.

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.2(33)SCC

This command was introduced in Cisco IOS Release 12.2(33)SCC.

IOS-XE 3.15.0S

This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines

You must enable the Cable IPC Statistics Collection tool using the cable ipc-stats command before using the clear cable ipc-stats command.

Examples

The following example shows how to clear the active database using the clear cable ipc-stats command on a Cisco CMTS router: 


Router# clear cable ipc-stats
cr10k ipc stats is cleared at 03:38:54 PDT Fri Oct 9 2009
Router#

Related Commands

Command

Description

cable ipc-stats

Enables the Cable IPC Statistics Collection tool on a Cisco CMTS router.

show cable ipc-stats

Displays statistics of all the IPC messages on a Cisco CMTS router.

clear cable load-balance

To clear the counters or state machine used to track load-balancing operations, use the clear cable load-balance command in privileged EXEC mode.

clear cable load-balance { counters | state | move-history cable slot/subslot/controller-interface-index }

Syntax Description

counters

Clears all load balancing statistical counters.

state

Clears all state information in the load balancing state machine. This command will also put all cable interfaces and their upstream channels in the “up” state, unless they are explicitly shut down using the shutdown interface configuration command.

move-history

Clears all of the move history entries for one mac-domain.

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.2(15)BC1

This command was introduced for the Cisco uBR7246VXR and Cisco uBR10012 routers.

12.3BC

This command was integrated into Cisco IOS Release 12.3BC.

12.2(33)SCA

This command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the Cisco uBR7225VXR router was added.

IOS-XE 3.15.OS

This command was implemented on the Cisco cBR Series Converged Broadband Routers.

IOS-XE 17.6.1w

This command was updated. The move-history option was introduced.

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

The following example shows how to clear the state machine that is used for load-balancing operations:


Router# clear cable load-balance state

The following example shows how to clear all the move history entries for one mac-domain:


Router# clear cable load-balance move-history cable slot/subslot/controller-interface-index

Related Commands

Command

Description

cable load-balance exclude

Excludes a particular cable modem, or all cable modems from a particular vendor, from one or more types of load-balancing operations.

cable load-balance group (global configuration)

Creates and configures a load-balance group.

cable load-balance group (interface configuration)

Assigns a downstream to a load-balance group.

cable load-balance group interval

Configures the frequency of the load-balancing policy updates.

cable load-balance group policy ugs

Configures how the Cisco CMTS should load balance cable modems with active unsolicited grant service (UGS) service flows.

cable load-balance group threshold

Configures the threshold values that a load-balance group should use for load-balancing operations.

cable upstream load-balance group

Assigns an upstream to a load-balance group.

show cable load-balance

Displays real-time statistical and operational information for load-balancing operations.

show cable load-balance docsis-group x move-history

Provides detailed information on modem movement through load balancing.

clear cable load-balance error-statistics

To clear all the failure counters in the error statistics, use the clear cable load-balance error-statistics command in privileged EXEC mode.

clear cable load-balance error-statistics

no clear cable load-balance error-statistics

Syntax Description

This command has no arguments or keywords.

Command Default

None.

Command Modes

  Privileged EXEC (#)

Command History

Release Modification
12.2(33)SCI

This command was introduced.

IOS-XE 3.15.0S

This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Examples

The following example shows how to clear all the failure counters in the error statistics. 

Router# clear cable load-balance error-statistics

Related Commands

Command

Description

show cable load-balance

Displays real-time configuration, statistical and operational information for load balancing operations on the router.

show cable load-balance docsis-group

Displays real-time configurational, statistical, and operational information of the DOCSIS group operations on the router.

cable load-balance docsis30-dynamic-enable

Enables the DOCSIS 3.0 dynamic load balancing on the Cisco CMTS.

show cable load-balance statistics error

Displays information of the DOCSIS 3.0 and DOCSIS 2.0 load balance failure.

clear cable logging

To remove all error messages about bad IP source addresses on the cable interfaces from the error log buffer, or to clear the downstream index buffer, use the clear cable logging command in privileged EXEC mode.

clear cable logging {badipsource | downstream-index}

Cisco cBR Series Converged Broadband Routers

clear cable logging {badipsource | downstream-index | layer2events | overlapip}

Syntax Description

badipsource

Clears the log buffer for BADIPSOURCE messages.

downstream-index

Clears the log buffer for downstream index messages.

layer2events

Clears the layer 2 event messages.

overlapip

Clears the overlap ip messages.

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.1(13)EC

This command was introduced for the Cisco uBR7100 series and Cisco uBR7200 series universal broadband routers.

12.2(11)CY

Support was added for the Cisco uBR10012 universal broadband router.

12.2(11)BC2

Support was added to the Release 12.2 BC train for the Cisco uBR7100 series, Cisco uBR7200 series, and Cisco uBR10012 routers.

12.3BC

This command was integrated into Cisco IOS Release 12.3BC.

12.2(33)SCA

This command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the Cisco uBR7225VXR router was added.

12.2(33)SCG

The downstream-index keyword was added.

IOS-XE 3.15.OS

This command was implemented on the Cisco cBR Series Converged Broadband Routers.

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#

The following example shows how to clear the log buffer that contains the downstream index messages: 


Router# show cable logging downstream-index
 
Cable logging: Enabled
                Total buffer size (bytes): 1000000
                Used buffer size (bytes) : 36968 
                Logged messages          : 231 
Router# clear cable logging downstream-index
 
Router# show cable logging downstream-index
Cable logging: 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 logging layer2events

Logs layer 2 messages.

cable logging overlapip

Logs overlap IP messages.

cable logging downstream-index

Logs buffer messages about the downstream indexes.

cable source-verify

Enables verification of IP addresses for CMs and CPE devices on the upstream.

show cable logging

Displays the log of error and buffer messages on the cable interfaces.

clear cable modem attribute-masks

To clear the cable modem attribute masks, use the clear cable modem attribute-masks command in privileged EXEC mode.

clear cable modem {mac-addr | ip-addr | cable slot/port {all | oui string | reject}} attribute-masks

clear cable modem {mac-addr | ip-addr | cable slot/subslot/port {all | oui string | reject}} attribute-masks

clear cable modem {mac-addr | ip-addr | cable slot/subslot/cable-interface-index {all | oui string | reject}} attribute-masks

Syntax Description

mac-addr

Specifies the MAC address for the CM.

ip-addr

Specifies the IP address for the CM.

cable slot /port

(Optional—Cisco uBR7100 and Cisco uBR7200 Series Routers) Specifies removal of CMs on the specified cable interface and downstream port, where:

  • slot —Specifies the chassis slot number of the cable interface line card.
  • port —Specifies the downstream port number.

Valid values for these arguments are dependent on your CMTS router and cable interface line card. Refer to the hardware documentation for your router chassis and cable interface line card for supported slot and port numbering.

cable slot/subslot/port

(Optional—Cisco uBR10012 Router) Specifies removal of CMs on the specified cable interface, where:

  • slot —Specifies the chassis slot number of the cable interface line card. Valid slots are 5 to 8.
  • subslot —Specifies the secondary slot number of the cable interface line card. Valid subslots are 0 or 1.
  • port —Specifies the downstream port number. Valid ports are 0 to 4, depending on the cable interface line card.

cable slot/subslot/cable-interface-index

(Optional—Cisco cBR Series Converged Broadband Routers) Specifies removal of CMs on the specified cable interface, where:

  • slot —Specifies the chassis slot number of the cable interface line card. The valid range is from 0 to 3 and 6 to 9.
  • subslot —Specifies the secondary slot number of the cable interface line card. The valid subslot is 0. Depending on the platform and cable interface line card, subslots 0 to 1 could be added.
  • cable-interface-index — Specifies the cable line card MAC domain. Valid range is from 0 to 15, depending on the cable interface line card

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).

reject

Resets the flapping counters for all CMs that are currently in one of the reject states.

attribute-masks

Specifies the attribute mask bitmap in hexadecimal format.

Example: 0-FFFFFFFF

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.2(33)SCB

This command was introduced.

IOS-XE 3.15.OS

This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines

This command clears the cable modem attribute masks.

Examples

The following example shows how to clear cable modem attribute masks for CMs: 


Router# clear cable modem all attribute-masks
Router# clear cable modem oui SA attribute-masks
Router# clear cable modem c5/0/0 offline attribute-masks

Related Commands

Command

Description

cable upstream attribute-mask

This command specifies an upstream attribute mask in hexadecimal format.

clear cable modem cm-status

To reset the cable modem status events to zero, use the clear cable modem cm-status command in privileged EXEC mode.

Cisco uBR7225VXR and Cisco uBR7246VXR Universal Broadband Routers

clear cable modem [ip address | mac address | cable slot/port] cm-status

Cisco uBR10012 Universal Broadband Router

clear cable modem [ip address | mac address | cable slot/subslot/cable-interface-index] cm-status

Cisco cBR Series Converged Broadband Routers

clear cable modem [ip address | mac address | cable slot/subslot/ cable-interface-index] cm-status

Syntax Description

ip-address

(Optional) IP address of a CM.

mac-address

(Optional) MAC address of a CM.

cable slot / subslot / cable-interface-index

(Optional) Cable interface on the Cisco uBR10012 router. The following are the valid values:

  • slot = 5 to 8
  • subslot = 0 or 1
  • cable-interface-index

    • Cisco uBR10012 router—The valid range for the Cisco uBR-MC20X20V and Cisco uBR-MC5X20 line cards is from 0 to 4. The valid range for the Cisco uBR-MC3GX60V line card is from 0 to 14.

For Cisco cBR Series Converged Broadband Routers, the following are the valid values:
  • slot = 0 to 3 and 6 to 9
  • subslot = 0
  • cable-interface-index = 0 to 15

cable slot /port

(Optional) Displays information for all CMs on the specified cable interface and downstream port on the Cisco uBR7225VXR and Cisco uBR7246VXR routers, where:

  • slot— Slot where the line card resides.

Cisco uBR7246VXR router—The valid range is from 3 to 6

Cisco uBR7225VXR router—The valid range is from 1 to 2

  • port— Specifies the downstream port number.

cm-status

Resets the CM status events to zero for the specified CM's.

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.2(33)SCB

This command was introduced.

12.2(33)SCC

This command was modified to clear the basic receive-statistics of all event code types for a specific CM or a group of CMs.

12.2(33)SCD

This command was modified. Support was added for Cisco uBR7225VXR and Cisco uBR7246VXR routers.

IOS-XE 3.15.OS

This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Related Commands

Command

Description

clear cable flap-list

Resets the flap-list table for a specific CM or for all CMs.

clear cable modem delete

Removes one or more CMs from the internal address and routing tables on a CMTS router and stops DOCSIS station maintenance messages.

clear cable modem lock

Resets the lock on one or more CMs.

clear cable modem name

Removes or resets CMs by domain name.

clear cable modem reset

Removes one or more CMs from the Station Maintenance List and resets them.

clear cable modem counters


Note
Effective with Cisco IOS Release 12.2(15)BC1, the clear cable modem counters command is replaced by the clear counters command. See the clear counters command in the Cisco IOS software command reference documentation for more information.

To reset the cable modem (CM) flap-list counters to zero, use the clear cable modem counters command in privileged EXEC mode.

clear cable modem {mac-addr | ip-addr | [cable {slot/port | slot/subslot/pot}] {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—Cisco uBR7100 and Cisco uBR7200 Series Routers) Specifies removal of CMs on the specified cable interface and downstream port, where:

  • slot— Specifies the chassis slot number of the cable interface line card.
  • port— Specifies the downstream port number.

Valid values for these arguments are dependent on your CMTS router and cable interface line card. Refer to the hardware documentation for your router chassis and cable interface line card for supported slot and port numbering.

cable slot /subslot /port

(Optional—Cisco uBR10012 Router) Specifies removal of CMs on the specified cable interface, where:

  • slot —Specifies the chassis slot number of the cable interface line card. Valid slots are 5 to 8.
  • subslot —Specifies the secondary slot number of the cable interface line card. Valid subslots are 0 or 1.
  • port —Specifies the downstream port number. Valid ports are 0 to 4, depending on the cable interface line card.

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 show cable modem command for a description of these states.)

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.1 T

This command was introduced.

12.2(11)BC2

Support was added for the oui and reject options.

12.2(11)BC3

Support for clearing the counters for a particular cable interface was added.

12.2(15)BC1

This command was replaced by the clear counters command.

IOS-XE 3.15.OS

This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Examples

The following example shows how to clear the counters for the CM at IP address 172.16.23.45: 


Router# clear cable modem 172.16.23.45 counters

The following example shows how to clear the counters for all CMs that have an 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

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

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.

Related Commands

Command

Description

clear cable flap-list

Resets the flap-list table for a specific CM or for all CMs.

clear cable modem delete

Removes one or more CMs from the internal address and routing tables on a CMTS router and stops DOCSIS station maintenance messages.

clear cable modem flap-counters

Resets the CM flap-list counters to zero.

clear cable modem lock

Resets the lock on one or more CMs.

clear cable modem reset

Removes one or more CMs from the Station Maintenance List and resets them.

clear counters

Resets interface counters and those counters associated with the show cable modem counters command.

clear cable modem delete

To remove one or more cable modems (CMs) from the internal address and routing tables on a CMTS router and stop DOCSIS station maintenance messages, use the clear cable modem delete command in privileged EXEC mode.

clear cable modem {ip-addr | mac-addr} delete

clear cable modem [cable {slot/port | slot/subslot/port}] {all | non-bonding-capable [legacy-ranging] | offline | oui string | reject | wideband [registered-traditional-docsis] } delete

Cisco cBR Series Converged Broadband Routers

clear cable modem {ip-addr | cable | {slot/subslot/cable interface index} | mac-addr | all | cm-status | non-bonding-capable | {delete | legacy-ranging | reset } | reject | {attribute-masks | cm-status | delete | flap-counters | rcs-counts | reset | rf-adapt | service-type-id | voice} | offline | {attribute-masks | cm-status | delete | flap-counters | rcs-counts | rf-adapt | service-type-id | voice} | online | {attribute-masks | cm-status | delete | flap-counters | rcs-counts | rf-adapt | service-type-id | voice} | oui | {string } | rcs-counts [Integrated-Cable] | wideband | {delete | registered-traditional-docsis | reset}}

Syntax Description

ip-addr

Specifies removal of an individual CM by its IPv4 or IPv6 address.

mac-addr

Specifies removal of an individual CM by its 48-bit hardware address (MAC address).

cable slot / port

(Optional—Cisco uBR7100 and Cisco uBR7200 Series Routers) Specifies removal of CMs on the specified cable interface and downstream port, where:

  • slot— Specifies the chassis slot number of the cable interface line card.
  • port— Specifies the downstream port number.

Valid values for these arguments are dependent on your CMTS router and cable interface line card. Refer to the hardware documentation for your router chassis and cable interface line card for supported slot and port numbering.

cable slot / cable interface index

(Optional— Cisco cBR Series Converged Broadband Routers) Specifies removal of CMs on the specified cable interface, where:
  • slot—

    Specifies the chassis slot number of the cable interface line card. The valid range is from 0 to 3 and 6 to 9.

  • port— Specifies the secondary slot number of the cable interface line card. The valid subslot is 0.
  • cable-interface-index— Specifies the cable line card MAC domain. Valid range is from 0 to 15, depending on the cable interface line card.

cable slot/subslot/port

(Optional—Cisco uBR10012 Router) Specifies removal of CMs on the specified cable interface, where:

  • slot —Specifies the chassis slot number of the cable interface line card. Valid slots are 5 to 8.
  • subslot —Specifies the secondary slot number of the cable interface line card. Valid subslots are 0 or 1.
  • port —Specifies the downstream port number. Valid ports are 0 to 4, depending on the cable interface line card.

all

Specifies removal of all CMs or all CMs associated with a specified cable interface.

non-bonding-capable

Specifies removal of all narrowband CMs that are not capable of downstream channel bonding or all such CMs associated with a specified interface.

legacy-ranging

(Optional) Specifies removal of narrowband CMs that are accessed with legacy initial ranging or all such CMs associated with a specified interface.

offline

Specifies removal of all offline CMs or all such CMs associated with a specified interface.

offline

Specifies removal of all online CMs or all such CMs associated with a specified interface.

oui string

Specifies removal of all CMs that match the specified Organization Unique Identifier (OUI) or all such CMs associated with a specified interface. 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

Specifies removal of all CMs that are currently in one of the reject states or all such CMs associated with a specified interface. (See the show cable modem command for a description of these states.)

rcs-counts

Specifies removal of MDD, QAM/FEC failure and recovery counts.

wideband

Specifies removal of all wideband CMs or or all such CMs associated with a specified interface.

registered-traditional-docsis

(Optional) Specifies removal of all wideband CMs that are registered as traditional DOCSIS CMs or all such CMs associated with a specified interface.

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.2(11)BC3

This command was introduced for the Cisco uBR7100 series, Cisco uBR7200 series, and Cisco uBR10012 universal broadband routers.

12.2(15)BC1

The cable keyword option was added.

12.3(23)BC

Support was added for the non-bonding-capable, legacy-ranging, wideband , and registered-traditional-docsis keyword options.

12.2(33)SCA

This command was integrated into Cisco IOS Release 12.2(33)SCA, with the following changes:

  • Support for the Cisco uBR7225VXR router was added.
  • Support for specifying the IPv6 address of a CM was added.

IOS-XE 3.15.OS

This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines

This command removes one or more CMs from the CMTS router memory, which causes the CMTS router to stop all DOCSIS station maintenance messages for the specified CMs until they time out and reattempt initial ranging.


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.

Examples

The following example shows how to delete the CM at IP address 172.23.45.67: 


Router# clear cable modem 172.23.45.67 delete

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

The following example shows how to delete all CMs that are currently in one of the reject states: 


Router# clear cable modem reject delete

Related Commands

Command

Description

clear cable flap-list

Resets the flap-list table for a specific CM or for all CMs.

clear cable modem flap -counters

Resets the CM flap-list counters to zero.

clear cable modem lock

Resets the lock on one or more CMs.

clear cable modem name

Removes or resets CMs by domain name.

clear cable modem reset

Removes one or more CMs from the Station Maintenance List and resets them.

show cable modem

Displays information for the registered and unregistered CMs.

clear cable modem device-class

To reset the cable modems by device class type, use the clear cable modem device-class command in privileged EXEC mode.

clear cable modem [Cable slot/port/cable-interface-index] device-class {DVA {delete | reset} | MTA {delete | reset} | PS {delete | reset} | RTR {delete | reset} | STB {delete | reset}}

Syntax Description

Cable slot/port/cable-interface-index

Specifies the cable modems on the specified cable interface.

  • slot—Specifies the chassis slot number of the cable interface line card. The valid range is from 0 to 9.

  • port—Specifies the sub slot number of the cable interface line card. The valid subslot is 0.

  • delete—Removes the cable modems matching the MTA device class.

DVA

Removes or resets the cable modems for DVA devices.

  • reset—Resets the cable modems matching the DVA device class.

  • delete—Removes the cable modems matching the DVA device class.

MTA

Removes or resets the cable modems for MTA devices.

  • reset—Resets the cable modems matching the MTA device class.

  • delete—Removes the cable modems matching the MTA device class.

PS

Removes or resets the cable modems for PS devices.

  • reset—Resets the cable modems matching the PS device class.

  • delete—Removes the cable modems matching the PS device class.

RTR

Removes or resets the cable modems for Erouter devices.

  • reset—Resets the cable modems matching the RTR device class.

  • delete—Removes the cable modems matching the RTR device class.

STB

Removes or resets the cable modems for STB devices.

  • reset—Resets the cable modems matching the STB device class.

  • delete—Removes the cable modems matching the STB device class.

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.2(33)SCJ1

This command was introduced in Cisco uBR Series router.

3.18.1SP

This command was introduced in Cisco cBR Series Converged Broadband Router.

Examples

The following example shows how to reset the MTA device class cable modems on Cable 8/1/0: 


Router# clear cable modem Cable 8/1/0 device-class MTA reset

The following example shows how to remove the STB device class cable modems on Cable 8/1/0: 


Router# clear cable modem Cable 8/1/0 device-class STB delete

Related Commands

Command

Description

clear cable flap-list

Resets the flap-list table for a specific CM or for all CMs.

clear cable modem delete

Removes one or more CMs from the internal address and routing tables on a CMTS router and stops DOCSIS station maintenance messages.

clear cable modem flap-counters

Resets the CM flap-list counters to zero.

clear cable modem lock

Resets the lock on one or more CMs.

clear cable modem reset

Removes one or more CMs from the Station Maintenance List and resets them.

clear counters

Resets interface counters and those counters associated with the show cable modem counters command.

clear cable modem flap-counters

To reset the cable modem (CM) flap-list counters to zero, use the clear cable modem flap-counters command in privileged EXEC mode.

clear cable modem {ip-addr | mac-addr} flap-counters

clear cable modem [cable {slot/port | slot/subslot/port}] {all | offline | oui string | reject} flap-counters

Syntax Description

ip-addr

Resets the flap-list counters for an individual CM by its IPv4 or IPv6 address.

mac-addr

Resets the flap-list counters for an individual CM by its 48-bit hardware address (MAC address).

cable slot/port

(Optional—Cisco uBR7100 and Cisco uBR7200 Series Routers) Resets the flap-list counters for all CMs on the specified cable interface and downstream port, where:

  • slot— Specifies the chassis slot number of the cable interface line card.
  • port— Specifies the downstream port number.

Valid values for these arguments are dependent on your CMTS router and cable interface line card. Refer to the hardware documentation for your router chassis and cable interface line card for supported slot and port numbering.

cable slot/subslot/port

(Optional—Cisco uBR10012 Router) Resets the flap-list counters for all CMs on the specified cable interface, where:

  • slot —Specifies the chassis slot number of the cable interface line card. Valid slots are 5 to 8.
  • subslot —Specifies the secondary slot number of the cable interface line card. Valid subslots are 0 or 1.
  • port —Specifies the downstream port number. Valid ports are 0 to 4, depending on the cable interface line card.

cable slot/subslot/port

(Optional—Cisco cBR Series Routers) Resets the flap-list counters for all CMs on the specified cable interface, where:

  • slot —Specifies the chassis slot number of the interface card. Valid slots are 0 to 3 and 6 to 9 on the Cisco cBR-8 router.
  • subslot —Specifies the secondary slot number of the interface card. Valid subslot is 0 on the Cisco cBR-8 router.
  • port —Specifies the cable interface index number. Valid values are 0 to 15 on the Cisco cBR-8 router.

all

Resets the flap-list counters for all CMs or all CMs associated with a specified cable interface.

offline

Resets the flap-list counters for all offline CMs or for all such CMs associated with a specified interface.

oui string

Resets the flap-list counters for all CMs that match the specified Organization Unique Identifier (OUI) or for all such CMs associated with a specified interface. 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 flap-list counters for all CMs that are currently in one of the reject states or for all such CMs associated with a specified interface. (See the show cable modem command for a description of these states.)

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.2(15)BC1

This command was introduced.

12.3BC

This command was integrated into Cisco IOS Release 12.3BC.

12.2(33)SCA

This command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the Cisco uBR7225VXR router was added.

IOS-XE 3.15.0S

This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines

Use the clear cable modem flap-counters command to reset the flap-list counters associated with the show cable flap-list command.

This command only resets flap-list counters. To reset other cable interface counters and those counters associated with the show cable modem counters command, use the clear counters command.

Examples

The following example shows how to reset the flap-list counters for the CM at IP address 172.16.23.45: 


Router# clear cable modem 172.16.23.45 flap-counters

The following example shows how to reset the flap-list 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

The following example shows how to reset the flap-list counters for all CMs that are currently in one of the reject states: 


Router# clear cable modem reject flap-counters

Related Commands

Command

Description

clear cable flap-list

Resets the flap-list table for a specific CM or for all CMs.

clear cable modem delete

Removes one or more CMs from the internal address and routing tables on a CMTS router and stops DOCSIS station maintenance messages.

clear cable modem lock

Resets the lock on one or more CMs.

clear cable modem name

Removes or resets CMs by domain name.

clear cable modem reset

Removes one or more CMs from the Station Maintenance List and resets them.

clear counters

Resets interface counters and those counters associated with the show cable modem counters command.

clear cable modem lock

To reset the lock on one or more cable modems (CMs), and to reinitialize them so that they can reregister with a valid DOCSIS configuration file, use the clear cable modem lock command in privileged EXEC mode.

clear cable modem {ip-addr | mac-addr} lock

clear cable modem [cable {slot/port | slot/subslot/port}] {all | oui string} lock

Syntax Description

ip-addr

Resets the lock for an individual CM by its IPv4 or IPv6 address.

mac-addr

Resets the lock for an individual CM by its 48-bit hardware address (MAC address).

cable slot/port

(Optional—Cisco uBR7100 and Cisco uBR7200 Series Routers) Resets the lock for all CMs on the specified cable interface and downstream port, where:

  • slot— Specifies the chassis slot number of the cable interface line card.
  • port— Specifies the downstream port number.

Valid values for these arguments are dependent on your CMTS router and cable interface line card. Refer to the hardware documentation for your router chassis and cable interface line card for supported slot and port numbering.

cable slot/subslot/port

(Optional—Cisco uBR10012 Router) Resets the lock for all CMs on the specified cable interface, where:

  • slot —Specifies the chassis slot number of the cable interface line card. Valid slots are 5 to 8.
  • subslot —Specifies the secondary slot number of the cable interface line card. Valid subslots are 0 or 1.
  • port —Specifies the downstream port number. Valid ports are 0 to 4, depending on the cable interface line card.

cable slot/subslot/port

(Optional—Cisco cBR-8 Router) Resets the lock for all CMs on the specified cable interface, where:

  • slot —Specifies the chassis slot number of the cable line card. Valid slots are 0 to 3 and 6 to 9.
  • subslot —Specifies the secondary slot number of the cable line card. Valid subslot is 0.
  • port —Specifies the MAC domain index. Valid range is from 0 to 15.

all

Resets the lock for all CMs or all CMs associated with a specified cable interface.

oui string

Resets the lock for all CMs that match the specified Organization Unique Identifier (OUI) or for all such CMs associated with a specified interface. 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.

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.2(15)BC1

This command was introduced.

12.3BC

This command was integrated into Cisco IOS Release 12.3BC.

12.2(33)SCA

This command was integrated into Cisco IOS Release 12.2(33)SCA. Support for the Cisco uBR7225VXR router was added.

IOS-XE 3.15.0S

This command was implemented on the Cisco cBR Series Converged Broadband Routers.

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 are not 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 allows 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 reset the lock for the CM with the MAC address of 0000.0C01.0203: 


Router# clear cable modem 0000.0C01.0203 lock

The following example shows how to reset the lock for the CM at IP address 172.16.23.45: 


Router# clear cable modem 172.16.23.45 lock

The following example shows how to reset the locks for all CMs that have an 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

Related Commands

Command

Description

cable dynamic-secret

Enables the dynamic shared secret feature, so that DOCSIS configuration files are verified with a Message Integrity Check (MIC) that has been created with a dynamically generated shared secret.

clear cable flap-list

Resets the flap-list table for a specific CM or for all CMs.

clear cable modem flap-counters

Resets the CM flap-list counters to zero.

clear cable modem delete

Removes one or more CMs from the internal address and routing tables on a CMTS router and stops DOCSIS station maintenance messages.

clear cable modem name

Removes or resets CMs by domain name.

clear cable modem reset

Removes one or more CMs from the Station Maintenance List and resets them.

clear cable modem name

To remove or reset cable modems (CMs) by domain name, use the clear cable modem name command in privileged EXEC mode.

clear cable modem name fqdn {delete | reset}

Syntax Description

fqdn

Specifies the fully qualified domain name (FQDN) of the cable device to be displayed. This option is only available if the show cable modem domain-name command has been run for the first time to update the cable Domain Name System (DNS) cache on the CMTS router.

delete

Removes the CM with the specified domain name from the Station Maintenance List.

reset

Removes the CM with the specified domain name from the Station Maintenance List and resets it.

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.2(33)SCA

This command was introduced.

12.2(33)SCD

This command was modified to remove flap-counters and lock keywords.

IOS-XE 3.15.0S

This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines

In Cisco IOS Release 12.2(33)SCA, the show cable modem domain-name command must be run first on the route processor (RP) of the CMTS router before any domain name can be used as part of a cable command.

Examples

The following example shows how to delete a CM with the domain name “example”: 


Router# clear cable modem name example delete

Related Commands

Command

Description

clear cable flap-list

Resets the flap-list table for a specific CM or for all CMs.

clear cable modem flap -counters

Resets the CM flap-list counters to zero.

clear cable modem delete

Removes one or more CMs from the internal address and routing tables on a CMTS router and stops DOCSIS station maintenance messages.

clear cable modem lock

Resets the lock on one or more CMs.

clear cable modem reset

Removes one or more CMs from the Station Maintenance List and resets them.

show cable modem

Displays information for the registered and unregistered CMs.

clear cable modem partial-service

To reset, re-initiate or delete cable modems that are either in downstream or upstream partial service, use the clear cable modem partial-service command in privileged EXEC mode.

clear cable modem partial-service { all | d30 | d31 } [ds-partial | us-partial] { delete | reinit | reset }

Syntax Description

all Specifies all partial service modems
d30 Specifies Docsis 3.0 partial service modems
d31 Specifies Docsis 3.1 partial service modems
delete Delete the partial service modems
reinit Re-initiate the partial service modems
reset Reset the partial service modems
ds-partial Specifies downstream partial service modems
us-partial Specifies upstream partial service modems

Command Default

None.

Command Modes

Privileged EXEC (#)

Command History

Release Modification
Cisco IOS XE Cupertino 17.9.1w

This command is updated on the Cisco cBR Series Converged Broadband Routers. The ds-partial and us-partial keywords are added.

Usage Guidelines

The following example shows how to reset, re-initiate or delete cable modems that are either in downstream:

Examples

router# clear cable modem partial-service all us-partial reset
router# clear cable modem partial-service all ds-partial reset
router# clear cable modem partial-service d30 us-partial delete
router# clear cable modem partial-service d30 us-partial reinit

clear cable modem path-sel

To clear the path selection status for the cable modems, use the clear cable modem path-sel command in privileged EXEC mode.

clear cable modem [ ip address | mac address | all] path-sel

Syntax Description

ip address

Clears the path selection status from the specified IP address.

mac address

Clears the path selection status from the specified MAC address.

all

Clears the path selection status from all the cable modems.

Command Default

None.

Command Modes

Privileged EXEC (#)

Command History

Release Modification
Cisco IOS-XE Release 3.18.0SP

This command was introduced on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines

Use this command to clear the path selection status for the cable modems.

Examples

The following example shows how to clear path selection status for a particular MAC address: 

router#show cable modem c8fb.26a6.c46a path-sel
 CM c8fb.26a6.c46a Path-Sel Info: N/A
 Path-Sel status has been cleared after register online.

Related Commands

Command

Description

show cable modem path-sel

Displays the path selection status of a cable modem.

show cable mac-domain rcc

Displays runtime receive channel configuration (RCC) on a cable line card interface.

show cable mac domain rcc simplified

Shows detailed information for DOCSIS 3.1 capable RCC.

clear cable modem pnm

To clear all the PNM US RxPwr information for cable modems, use the following clear cable modem pnm us-rxpwr command in the privileged EXEC mode.

clear cable modem pnm us-rxpwr

To clear all the PNM US RxPwr information for cable modems on a specific OFDMA channel, use the following clear cable modem pnm us-rxpwr upstream <0-15> command in the privileged EXEC mode.

clear cable modem pnm us-rxpwr upstream <0-15>

To clear all the PNM US RxPwr information for cable modems on a specific cable interface, use the following clear cable modem [Cable<slot/0/interface>] pnm us-rxpwr Cable command in the privileged EXEC mode.

clear cable modem Cable <slot/0/interface> pnm us-rxpwr

To clear the PNM US RxPwr information for a cable modems on a specific cable interface on a specific OFDMA channel, use the following clear cable modem [Cable<slot/0/interface>] pnm us-rxpwr upstream <0-15> command in the privileged EXEC mode.

clear cable modem Cable <slot/0/interface>pnm us-rxpwr upstream <0-15>

To clear the PNM US RxPwr information for a specific cable modem, use the following clear cable modem [H.H.H or A.B.C.D] pnm us-rxpwr upstream command in the privileged EXEC mode.

where [H.H.H] is a specific modem's unique MAC address, and [A.B.C.D] is a specific modem's assigned IP address.

clear cable modem H.H.H pnm us-rxpwr

clear cable modem A.B.C.D pnm us-rxpwr

To clear the PNM US RxPwr information for a specific cable modem on a specific US OFDMA channel, use the following clear cable modem [H.H.H or A.B.C.D] pnm us-rxpwr upstream <0-15> command in privileged EXEC mode.

where [H.H.H] is a specific modem's unique MAC address and [A.B.C.D] is a specific modem's assigned IP address.

where <0-15> is the upstream OFDMA channel the modem is registered on.

clear cable modem pnm H.H.H pnm us-rxpwr upstream <0-15>

clear cable modem A.B.C.D pnm us-rxpwr upstream <0-15>

Table 1. Syntax Description

Syntax

Description

interface

Interface on which the PNM RxPwr data is cleared for a specified upstream channel.

mac address

MAC address of the system for which the PNM RxPwr data is cleared for a specified upstream channel.

ip address

IP address of the system for which the PNM RxPwr data is cleared for a specified upstream channel.

upstream

Modems on a particular upstream channel. The valid range is 0-15.

clear cable modem rcs-counts

To clear the following failure and recovery event counts for all or given RF channels of a CM, use the clear cable modem rcs-counts command in privileged EXEC mode:

  • MAC Domain Descriptor (MDD)
  • QAM/forward error correction (FEC)

clear cable modem [ cable if | mac_addr | ip_addr] rcs-counts [modular-cable slot/bay/port nb-channel-number]

Cisco cBR Series Converged Broadband Routers

clear cable modem [ cable if | mac_addr | ip_addr] rcs-counts [integrated-cable slot/sub-slot/port rf-channel-number]

Syntax Description

cable if

(Optional) The name of the downstream interface.

mac-address

(Optional) Identifies the MAC address of a CM to be displayed. If you specify the MAC address for a CPE device behind a CM, information for that CM is displayed.

ip-address

(Optional) 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.

slot

The slot where a SIP resides. On the Cisco uBR10012 router, slots 1 and 3 can be used for SIPs.

bay

The bay in a SIP where a SPA is located. Valid values are 0 (upper bay) and 1 (lower bay).

sub-slot

The valid value is 0.

sub-plot

The valid value is 1.

port

Specifies the interface number on the SPA.

nb-channel-number

Represents the narrowband channel number.

rf-channel-number

Represents the downstream RF channel number.

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.2(33)SCB

This command was introduced.

IOS-XE 3.15.0S

This command was integrated into Cisco IOS-XE Release 3.15.0S. Support for the Cisco cBR Series Converged Broadband Routers was added.

Related Commands

Command

Description

clear cable flap-list

Resets the flap-list table for a specific CM or for all CMs.

clear cable modem delete

Removes one or more CMs from the internal address and routing tables on a CMTS router and stops DOCSIS station maintenance messages.

clear cable modem lock

Resets the lock on one or more CMs.

clear cable modem name

Removes or resets CMs by domain name.

clear cable modem reset

Removes one or more CMs from the Station Maintenance List and resets them.

clear cable modem reset

To remove one or more cable modems (CMs) from the Station Maintenance List and reset them, use the clear cable modem reset command in privileged EXEC mode.

clear cable modem {ip-addr | mac-addr} reset

clear cable modem [cable {slot/port | slot/subslot/port}] {all | non-bonding-capable [legacy-ranging] | oui string | reject | wideband [registered-traditional-docsis] } reset

Syntax Description

ip-addr

Specifies removal of an individual CM by its IPv4 or IPv6 address.

mac-addr

Specifies removal of an individual CM by its 48-bit hardware address (MAC address).

cable slot/port

(Optional—Cisco uBR7100 and Cisco uBR7200 Series Routers) Specifies removal of all CMs on the specified cable interface and downstream port, where:

  • slot— Specifies the chassis slot number of the cable interface line card.
  • port— Specifies the downstream port number.

Valid values for these arguments are dependent on your CMTS router and cable interface line card. Refer to the hardware documentation for your router chassis and cable interface line card for supported slot and port numbering.

cable slot/subslot/port

(Optional—Cisco uBR10012 Router) Specifies removal of all CMs on the specified cable interface, where:

  • slot —Specifies the chassis slot number of the cable interface line card. Valid slots are 5 to 8.
  • subslot —Specifies the secondary slot number of the cable interface line card. Valid subslots are 0 or 1.
  • port —Specifies the downstream port number. Valid ports are 0 to 4, depending on the cable interface line card.

cable slot/subslot/port

(Optional—Cisco cBR Series Routers) Specifies removal of all CMs on the specified cable interface, where:

  • slot —Specifies the chassis slot number of the interface card. Valid slots are 0 to 3 and 6 to 9 on the Cisco cBR-8 router.
  • subslot —Specifies the secondary slot number of the interface card. Valid subslot is 0 on the Cisco cBR-8 router.
  • port —Specifies the cable interface index number. Valid values are 0 to 15 on the Cisco cBR-8 router.

all

Specifies removal of all CMs or all CMs associated with a specified cable interface.

non-bonding-capable

Specifies removal of all narrowband CMs that are not capable of downstream channel bonding or all such CMs associated with a specified interface.

legacy-ranging

(Optional) Specifies removal of narrowband CMs that are accessed with legacy initial ranging or all such CMs associated with a specified interface.

oui string

Specifies removal of all CMs that match the specified Organization Unique Identifier (OUI) or all such CMs associated with a specified interface. 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

Specifies removal of all CMs that are currently in one of the reject states or all such CMs associated with a specified interface. (See the show cable modem command for a description of these states.)

wideband

Specifies removal of all wideband CMs or all such CMs associated with a specified interface.

registered-traditional-docsis

(Optional) Specifies removal of all wideband CMs that are registered as traditional DOCSIS CMs or all such CMs associated with a specified interface.

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.1(2) EC

This command was introduced.

12.2(4)BC1

Support was added to the Release 12.2 BC train.

12.2(11)BC2

Support was added for the oui and reject options.

12.2(15)BC1

The cable keyword option was added.

12.3(21)BC

Support was added for the wideband and registered-traditional-docsis keyword options.

12.3(23)BC

Support was added for the non-bonding-capable and legacy-ranging keyword options.

12.2(33)SCA

This command was integrated into Cisco IOS Release 12.2(33)SCA, with the following changes:

  • Support for the Cisco uBR7225VXR router was added.
  • Support for specifying the IPv6 address of a CM was added.

IOS-XE 3.15.0S

This command was implemented on the Cisco cBR Series Converged Broadband Routers.

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 until those CMs time out and reattempt initial ranging. 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.

If the clear cable modem {ip-address | mac-address } reset form of the command is used to reset an individual modem, the CMTS router sends a ranging stop message to the specified modem in order to command the modem to reset itself and begin initial ranging more quickly without having to wait for up to 30 seconds to realize it is no longer receiving station maintenance keep-alive opportunities. This behavior is only seen when using the clear cable modem reset command for a specific CM.


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.

In some circumstances, the customer premises equipment (CPE) device 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.)


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.


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.

Examples

The following example shows how to reset the CM at IP address 172.23.45.67: 


Router# clear cable modem 172.23.45.67 reset

The following example shows how to reset all CMs that have an 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

The following example shows how to reset all CMs that are currently in one of the reject states: 


Router# clear cable modem reject reset

For the Cisco uBR10012 router, the following example shows how to reset all wideband CMs that are registered as traditional DOCSIS modems: 


Router# clear cable modem wideband registered-traditional-docsis reset

Related Commands

Command

Description

clear cable flap-list

Resets the flap-list table for a specific CM or for all CMs.

clear cable modem flap-counters

Resets the CM flap-list counters to zero.

clear cable modem delete

Removes one or more CMs from the internal address and routing tables on a CMTS router and stops DOCSIS station maintenance messages.

clear cable modem lock

Resets the lock on one or more CMs.

clear cable modem name

Removes or resets CMs by domain name.

show cable modem

Displays information for registered and unregistered CMs.

clear cable modem rf-adapt

To clear RF adaptation candidates or history information of the cable modems, use the clear cable modem rf-adapt command in privileged EXEC mode.

clear cable modem {ip-addr | mac-addr | [cable {slot/cable-interface-index | slot/subslot/cable-interface-index} ] {all | offline | reject | oui string}} rf-adapt {candidates [downgrade | upgrade] | history}

Syntax Description

ip-addr

IPv4 or IPv6 address of the cable modem.

mac-addr

48-bit MAC address of the cable modem.

cable

Specifies the cable interface line card details.

  • slot —Slot where the cable interface line card resides.
  • subslot —(Cisco uBR10012 router only) Secondary slot number of the cable interface line card.
  • cable-interface-index —Downstream port number or MAC domain index of the cable interface line card.

all

Clears the RF adaptation history or candidate status of all cable modems.

offline

Clears the RF adaptation history or candidate status of all offline cable modems.

reject

Clears the RF adaptation history or candidate status of all cable modems in reject state.

oui string

Clears the RF adaptation history or candidate status of the cable modems that match the specified Organization Unique Identifier (OUI) or for all cable modems associated with a specified interface. 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.

candidates

Clears RF adaptation candidates.

downgrade

(Optional) Clears RF adaptation downgrade candidates.

upgrade

(Optional) Clears RF adaptation upgrade candidates.

history

Clears RF adaptation history.

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.2(33)SCF3

This command was introduced.

IOS-XE 3.15.0S

This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines

The clear cable modem rf-adapt command is used to configure the Cable Modem Upstream RF Adaptation feature.

Use the clear cable modem rf-adapt history command to remove the history of all RF adaptation relocations for a given cable modem.

Use the clear cable modem rf-adapt candidates command to change the status of a cable modem or group of cable modems that are RF adaptation relocation candidates.

Using the clear cable modem rf-adapt history and clear cable modem rf-adapt candidates commands do not affect the MAC state of the cable modem.

The table below displays the interface density information.

Table 2. Interface Density Information

CMTS Router

Line Card

Slot

Subslot

Port

Cable Interface Index

Cisco uBR10012

Cisco uBR-MC3GX60V

5 to 8

0 or 1

0 or 4

0 to 14

Cisco UBR-MC20X20V

0 to 4

Cisco uBR10-MC5X20

Cisco uBR7225VXR

All

1 or 2

0 or 1

0 or 1

—

Cisco uBR7246VXR

All

3 to 6

0 or 1

0 or 1

—

Examples

The following example shows how to reset the RF adaptation history for the cable modem at IP address 192.0.2.255: 


Router# clear cable modem 192.0.2.255 rf-adapt history

The following example shows how to reset the RF adaptation downgrade candidates for all cable modems: 


Router# clear cable modem all rf-adapt candidates downgrade

Related Commands

Command

Description

show cable modem rf-adapt

Displays the RF adaptation history.

show cable rf-adapt

Displays RF adaptation information of upgrade and downgrade candidates.

clear cable modem service-type-id

To clear the cable modem service type ID, use the clear cable modem service-type-id command in privileged EXEC mode.

clear cable modem {ip | mac | name domain name | [ [interface] ] {all | offline | oui oui | reject | wideband | none-bounding-capable}} service-type-id

Cisco cBR Series Converged Broadband Routers

clear cable modem {ip | mac | [ [interface] ] {all | offline | oui oui | reject}} service-type-id

Syntax Description

ip

Specifies removal of an individual CM by its IPv4 or IPv6 address.

mac

Specifies removal of an individual CM by its 48-bit hardware address (MAC address).

name domain name

Specifies the domain name of the cable modem.

interface

(Optional) Resets the attribute masks of the offline CMs.

all

Specifies removal of all CMs or all CMs associated with a specified cable interface.

offline

Specifies removal of all offline CMs or all such CMs associated with a specified interface.

oui oui

Specifies removal of all CMs that match the specified Organization Unique Identifier (OUI) or all such CMs associated with a specified interface. The string parameter can be either the three-byte hexadecimal string (such as 00.00.0C) or a vendor name.

reject

Specifies removal of all CMs that are currently in one of the reject states or all such CMs associated with a specified interface.

wideband

Specifies removal of all wideband CMs or all such CMs associated with a specified interface.

none-bounding-capable

Specifies removal of all narrowband CMs that are not capable of downstream channel bonding or all such CMs associated with a specified interface.

service-type-id

Specifies the service type identifier.

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.2(33)SCB

This command was introduced.

IOS-XE 3.15.0S

This command was implemented on the Cisco cBR Series Converged Broadband Routers. The name , wideband , and none-bounding-capable keywords were removed.

Usage Guidelines

This command clears the cable mdem service type ID.

Examples

The following example shows how to clear cable modem service type ID: 


Router# clear cable modem all service-type-id
Router# clear cable modem oui SA service-type-id
Router# clear cable modem c3/0/0 offline service-type-id

Related Commands

Command

Description

clear cable modem attribute-masks

This command clears the cable modem attribute masks.

show cable modem service-type-id

Displays the modems having service type id.

clear cable modem voice

To clear the voice tag that is set for a cable modem (CM), use the clear cable modem voice command in privileged EXEC mode.

clear cable modem {ip-addr | mac-addr} voice {retries | tag}

clear cable modem [cable slot/subslot/port] {all | offline | oui string | reject} voice {retries | tag}

Syntax Description

ip-addr

Specifies removal of an individual CM by its IPv4 or IPv6 address.

mac-addr

Specifies removal of an individual CM by its 48-bit hardware address (MAC address).

retries

Clears the CM downstream retries record.

tag

Clears the CM voice tag.

cable slot/subslot/port

(Optional—Cisco uBR10012 Router) Specifies clearing of voice tags for CMs on the specified cable interface, where:

  • slot —Specifies the chassis slot number of the cable interface line card. Valid slots are 5 to 8.
  • subslot —Specifies the secondary slot number of the cable interface line card. Valid subslots are 0 or 1.
  • port —Specifies the downstream port number. Valid ports are 0 to 4, depending on the cable interface line card.

cable slot/subslot/port

(Optional—Cisco cBR Series Routers) Specifies clearing of voice tags for CMs on the specified cable interface, where:

  • slot —Specifies the chassis slot number of the interface card. Valid slots are 0 to 3 and 6 to 9 on the Cisco cBR-8 router.
  • subslot —Specifies the secondary slot number of the interface card. Valid subslot is 0 on the Cisco cBR-8 router.
  • port —Specifies the cable interface index number. Valid values are 0 to 15 on the Cisco cBR-8 router.

all

Specifies clearing of voice tags for all CMs or all CMs associated with a specified cable interface.

offline

Specifies clearing of voice tags for all offline CMs or all such CMs associated with a specified interface.

oui string

Specifies clearing of voice tags for all CMs that match the specified Organization Unique Identifier (OUI) or all such CMs associated with a specified interface. 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

Specifies clearing of voice tags for all CMs that are currently in one of the reject states or all such CMs associated with a specified interface. (See the show cable modem command for a description of these states).

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.3(23)BC

This command was introduced for the Cisco uBR10012 router.

IOS-XE 3.15.0S

This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Examples

The following example shows how to clear the voice tag and retries record for the CM at IP address 172.16.23.45: 


Router# clear cable modem 172.16.23.45 voice retries

Related Commands

Commands

Description

show cable modem voice

Displays the detected voice-enabled modems.

test cable voice

Allows you to manually set the voice tag of a cable modem.

clear cable multicast ses-cache

To clear the multicast replication sessions cache, use the clear cable ses-cache command in privileged EXEC mode.

clear cable multicast ses-cable {all | counter | interface integrated-cable slot/subslot/port:rf-channel | modular-cable slot/ {subslot | bay}/port:interface-number | wideband-cable slot/ {subslot | bay}/port:wideband-channel}

Syntax Description

all

Clears the cached multicast replication sessions for all interfaces.

counter

Clears multicast replication sessions cache counters.

interface integrated-cable slot/subslot/port:rf-channel

Clears the cached multicast replication sessions for a integrated-cable interface.

  • slot —Slot where a line card resides.
  • subslot—(Cisco uBR10012 only) Secondary slot number of a line card.
  • port— Downstream port number.
  • rf:channel —RF channel number.

interface modular-cable slot/{subslot | bay}/port:interface-number

Clears the cached multicast replication sessions for a modular-cable interface.

  • slot— Slot where a SPA interface processor (SIP) or a line card resides.
  • subslot— Secondary slot for a shared port adapter (SPA) or a line card.
  • bay— Bay in a SIP where a SPA is located.
  • port— Downstream port number.
  • interface-number— Modular channel number.

interface wideband-cable slot/{subslot | bay}/port:wideband-channel

Clears the cached multicast replication sessions for a wideband-cable interface.

  • slot— Slot where a SPA interface processor (SIP) or a line card resides.
  • subslot— Secondary slot for a shared port adapter (SPA) or a line card.
  • bay— Bay in a SIP where a SPA is located.
  • port— Downstream port number.
  • wideband-channel— Wideband channel number.

Command Modes

Privileged EXEC (#)

Command History

Release

Modification

12.2(33)SCH

This command was introduced.

IOS-XE 3.15.0S

This command is not supported on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines

Use the clear cable multicast ses-cache command to clear the multicast replication sessions configured on the interfaces.

The table below displays the valid values for an integrated-cable interface.

Table 3. Integrated Cable Interface Density Information

CMTS Router

Line Card

Slot

Subslot

Port

RF Channel Number

Cisco uBR10012

Cisco uBR-MC3GX60V

5 to 8

0 or 1

0 to 4

0 to 3

Cisco UBR-MC20X20V

Cisco uBR10-MC5X20

Cisco uBR7225VXR

All

1 or 2

—

0 or 1

—

Cisco uBR7246VXR

All

3 to 6

—

0 or 1

—

The table below displays the valid values for an modular-cable interface.

Table 4. Modular Cable Interface Density Information

Line Card

Slot

Subslot

Bay

Port

Interface Number

Cisco uBR-MC3GX60V

5 to 8

0 or 1

—

0 to 2

0 to 23

Cisco UBR-MC20X20V

—

0 to 5

Cisco Wideband SPA

—

0 or 11

0 to 3

0

Cisco Wideband SIP / Cisco SIP-600

1 or 3

—

—

—

1 Applicable to SPAs when the SIP is in Slot1 or Slot 3. The subslot is not specified from Cisco IOS Release 12.2(33)SCB onwards.

The table below displays the valid values for an wideband-cable interface.

Table 5. Wideband Interface Density Information

CMTS Router

Line Card

Slot

Subslot

Bay

Port

Wideband Channel

Cisco uBR10012

Cisco uBR-MC3GX60V

5 to 8

0 or 1

—

0 to 4

0 to 31

Cisco UBR-MC20X20V

—

0 to 5

Cisco uBR10-MC5X20

—

—

Cisco Wideband SPA

—

0 or 12

0 to 3

0

—

Cisco Wideband SIP / Cisco SIP-600

1 or 3

—

—

—

—

Cisco uBR7225VXR

All

1 to 2

—

—

0 or 1

0 to 5

Cisco uBR7246VXR

All

3 to 6

—

—

2 Applicable to SPAs when the SIP is in Slot1 or Slot 3. The subslot is not specified from Cisco IOS Release 12.2(33)SCB onwards.

Examples

The following example clears the multicast replication session cache for all interfaces on the Cisco uBR10012 router: 

Router# clear cable multicast ses-cache all

Related Commands

Command

Description

cable multicast ses-cache

Configures the multicast replication session cache on the Cisco uBR10012 router.

show cable multicast ses-cache

Displays the multicast replication session cache information both at the global and interface level of the forwarding interface.

clear cable multicast statistics counter

To reset all multicast statistics counters, use the clear cable multicast statistics counter command in privileged EXEC mode.

clear cable multicast statistics counter

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.2(33)SCF

This command was introduced.

IOS-XE 3.15.0S

This command was implemented on the Cisco cBR Series Converged Broadband Routers.

Usage Guidelines

The counters are also set to zero when a given multicast resource is reconfigured. Counters are displayed using the show cable multicast statistics command.

Examples

The following example shows how to reset configured multicast statistics index allocation details to zero: 


Router# clear cable multicast statistics counter
Router#

Related Commands

Command

Description

show cable multicast statistics

Displays the multicast statistics index allocation details.

show cable multicast db

Displays the contents of the multicast explicit tracking database.

clear cable resil-rf-status

To reset flap counts and flap time for all or a given RF channel, use the clear cable resil-rf-status command in privileged EXEC mode.

clear cable resil-rf-status [Integrated-Cable slot/subslot/port rf-channel-number ]

Syntax Description

Integrated-Cable

(Opional) Specifies that the flap counts and flap time is reset for the given RF channel.

slot

Slot where interface card resides. The range is from 0 to 3 and 6 to 9 on the Cisco cBR-8 router.

subslot

Subslot number of the interface card. The value is 0 on the Cisco cBR-8 router.

port

Port number. The range is from 0 to 7 on the Cisco cBR-8 router.

rf-channel-number

Downstream RF channel number. The range is from 0 to 162 on the Cisco cBR-8 router.

Command Default

None

Command Modes


Privileged EXEC (#)