Cisco IOS CMTS Cable Command Reference - Cable Commands: ca through cr [Cisco uBR10000 Series Universal Broadband Routers]

Table Of Contents

Cable Commands: ca through cr

card

channel-group

channel-id (cable configuration file)

clear cable admission control counters

clear cable arp-filter

clear cable dsg

clear cable flap-list

clear cable hop

clear cable host

clear cable load-balance

clear cable logging

clear cable modem attribute-masks

clear cable modem cm-status

clear cable modem counters

clear cable modem delete

clear cable modem flap-counters

clear cable modem lock

clear cable modem name

clear cable modem rcs-counts

clear cable modem reset

clear cable modem service-type-id

clear cable modem voice

clear cable rf-status

clear cable secondary-ip

clear cable modem service-type-id

clear crypto engine accelerator counter

clear crypto ipsec client ezvpn

clear facility-alarm

clear hccp counters

clear packetcable gate counter commit

clear pxf

clear pxf statistics drl cable-wan-ip

clear pxf statistics drl wan-non-ip

clear redundancy

controller modular-cable

cops ip dscp

cops listeners access-list

cops tcp window-size

cpd

cpd cr-id

cpe max

crypto engine accelerator

crypto ipsec client ezvpn (global)

crypto ipsec client ezvpn (interface)

crypto ipsec client ezvpn connect

crypto ipsec client ezvpn xauth

Cable Commands: ca through cr

Revised: March 30, 2009, OL-15510-09

New Commands

Command

Cisco IOS Software Release

clear cable modem name

12.2(33)SCA

clear cable modem voice

12.3(23)BC

clear cable modem attribute-masks

12.2(33)SCB

clear cable modem cm-status

12.2(33)SCB

clear cable modem rcs-counts

12.2(33)SCB

clear cable modem service-type-id

12.2(33)SCB

clear cable rf-status

12.2(33)SCB

clear pxf statistics drl cable-wan-ip

12.2(33)SCB

clear pxf statistics drl wan-non-ip

12.2(33)SCB

Modified Commands

Command

Cisco IOS Software Release

clear cable host

12.2(33)SCA

clear cable modem delete

12.3(23)BC, 12.2(33)SCA

clear cable modem reset

12.3(23)BC, 12.2(33)SCA

card

12.2(33)SCB

controller modular-cable

12.2(33)SCB

Replaced Commands

Command

Replacement Command

Effective Cisco IOS Release

clear cable modem counters

clear counters

12.2(15)BC1

card

To preprovision a router slot for a particular interface card so that you can configure the interface without that card being physically present in the slot, use the card command in global configuration mode. To remove the preprovisioning for a card so that the physical slot reports being empty, use the no form of this command.

card {slot/subslot | slot/subslot/bay} card-type
no card {slot/subslot | slot/subslot/bay}
Cisco 10000 Series Router

card slot/subslot {lchoc12-1 | lgigethernet-l | 1gigethernet-hh-1 | loc12atm-1 | loc12pos-1 | 1oc48dpt-pos-1 | 24che1t1-1 | 4chstm-1 | 4cht3-hh-1| 4oc3atm-1 | 4oc3atm_lr-1 | 4jacket-1 | 6cht3-1 | 6oc3pos-1 | 8e3ds3-1 | 8e3ds3atm-1 | 8fastethernet-1 [ mode {e1 | t1}] | spa-type}
no card slot/subslot
Cisco uBR10012 Universal Broadband Router - Cisco IOS Release 12.2(33)SCB

card {slot | slot/bay} card-type
no card {slot | slot/bay}
Syntax Description

slot/subslot

Identifies the chassis slot and subslot for the card. The following are the valid values:

•slot—1 to 8

•subslot—0 or 1

slot/subslot/bay

(Cisco uBR100012 router) Identifies the chassis slot and subslot for the Cisco Wideband SIP, and the bay number in the SIP where the Cisco Wideband SPA is located. The following are the valid values:

•slot—1 to 3

•subslot—0 or 1 (0 is always specified)

•bay—0 (upper bay) or 1 (lower bay)

card-type

Specifies the type of card for which to preprovision the slot. See Table 0-18 for a list of the supported cards, which varies by platform.

lchoc12-1

Preprovisions a line card slot for a 1-Port Channelized OC-12/STM-4 line card.

lgigethernet-l

Preprovisions a line card slot for a 1-Port Gigabit Ethernet line card.

1gigethernet-hh-1

Preprovisions a line card slot for a 1-Port Gigabit Ethernet Half-Height line card.

loc12atm-1

Preprovisions a line card slot for a 1-Port OC-12 ATM line card.

loc12pos-1

Preprovisions a line card slot for a 1-Port OC-12 Packet over SONET line card.

1oc48dpt-pos-1

Preprovisions a line card slot for a 1-Port OC-48/STM-16 Packet over SONET line card.

24che1t1-1

Preprovisions a line card slot for a 24-Port Channelized E1/T1 line card.

4chstm-1

Preprovisions a line card slot for a 4-Port Channelized OC-3/STM-1 line card.

4cht3-hh-1

Preprovisions a line card slot for a 4-port Channelized Half-Height line card.

4oc3atm-1

Preprovisions a line card slot for a 4-Port OC-3/STM-1 ATM line card with intermediate-reach optics.

4oc3atm_lr-1

Preprovisions a line card slot for a 4-Port OC-3/STM-1 ATM line card with long-reach optics.

4jacket-1

Preprovisions a line card slot in the Cisco 10000 series router to accept a Cisco 10000 SIP-600.

6cht3-1

Preprovisions a line card slot for a 6-Port Channelized T3 line card.

6oc3pos-1

Preprovisions a line card slot for a 6-Port OC-3/STM-1 Packet over SONET line card.

8e3ds3-1

Preprovisions a line card slot for an 8-Port Unchannelized E3/T3 line card.

8e3ds3atm-1

Preprovisions a line card slot for an 8-Port E3/DS3 ATM line card.

8fastethernet-1

Preprovisions a line card slot for an 8-Port Fast Ethernet Half-Height line card.

mode {e1 | t1}

Indicates the mode of operation of the 24-Port Channelized E1/T1 line card.

spa-type

Specifies the SPA type to preprovision a SPA interface.

Command Default

An empty card slot is not preprovisioned and cannot be configured or displayed.

The default mode of operation for the 24-Port Channelized E1/T1 line card is E1.

Command Modes

Global configuration

Command History

Release

Modification

12.0(17)ST

This command was introduced on the Cisco 10000 series routers.

12.0(21)SX

This command was integrated into Cisco IOS Release 12.0(21)SX.

12.0(22)S

This command was integrated into Cisco IOS Release 12.0(22)S.

12.2(1)XF1

This command was introduced on the Cisco uBR10012 Universal Broadband Router for the following line cards:

•Cisco uBR-LCP-MC28C cable interface line card

•Cisco uBR-LCP-MC28C-BNC cable interface line card

•Cisco uBR10-1GE Gigabit Ethernet (GigE) uplink line card

•Cisco uBR10-1OC12/P-SMI OC-12 POS uplink line card

12.2(4)XF1

Support was added for the Cisco uBR-LCP-MC16C and Cisco uBR-LCP-MC16E cable interface line cards.

12.2(4)BC1

Support was added for the Cisco uBR10-SRP-OC12SML DPT WAN uplink line card.

12.2(8)BC1

Support was added for the Cisco LCP2 line card processor, and all of its combinations with the supported cable interface line cards.

12.2(11)BC3

Support was added for the Cisco uBR10012 OC-48 DPT/POS Interface Module uplink line card and Cisco uBR-MC5X20S cable interface line card.

12.2(15)BX

This command was integrated into Cisco IOS Release 12.2(15)BX.

12.2(15)CX1

Support was added for the Cisco uBR-MC16U/X and Cisco uBR-MC28U/X cable interface line cards.

12.2(15)BC2

Support was added for the Cisco uBR-MC16U/X, Cisco uBR-MC28U/X, and Cisco uBR-MC5X20U cable interface line cards.

12.2(28)SB

This command was integrated into Cisco IOS Release 12.2(28)SB. This command was modified to support the 4-port Channelized Half-Height line card and the 4-Port OC-3/STM-1 ATM line card with long-reach optics by adding the 4cht3-hh-1 and the 4oc3atm_lr-1 keywords.

12.3(7)XI1

This command was integrated into Cisco IOS Release 12.3(7)XI1.

12.3(21)BC

Support was added for the Cisco Wideband SIP and Wideband SPA.

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

This command was enhanced to provide the 4jacket-1 keyword and the spa-type option, which enable you to preprovision a line card slot to accept a Cisco 10000 SIP-600 and a SPA interface, respectively. This enhancement was implemented on the Cisco 10000 series router for the PRE3 and PRE4.

12.2(33)SCB

This command was integrated into Cisco IOS Release 12.2(33)SCB. Support for the Cisco SIP-600 was added. This command was modified to change the addressing format for:

•SIPs—From slot/subslot to slot

•SPAs—From slot/subslot/bay to slot/bay

Usage Guidelines

This command is supported on the Cisco uBR10012 Universal Broadband Router and the Cisco 10000 series routers. For platform-specific information about using this command, see the other platform-specific sections of this topic.

Use this command to preprovision a slot in the router to accept a particular line card, so that you can configure the interface without the card being physically present in the chassis. This command allows system administrators to plan for future configurations, without having to wait for the physical hardware to first arrive. When the line card does arrive, the installer can bring the card online by inserting the card into the chassis and connecting the necessary cables, without having to do any further configuration using the command-line interface.

The type of card must be appropriate for the slot being specified. The list of supported card types depends on the Cisco IOS software release in use and your platform. For the latest information about supported hardware for your platform, see the release notes that correspond to your Cisco IOS software release and platform.

Table 0-18 lists the types of cards that are supported as card-types for the card command:

Table 0-18 Card Types Supported by the card Command

Card Type

Description

1cable-mc16c

(Cisco uBR10012 router) Preprovisions a slot for a Cisco uBR-LCP-MC16C or Cisco uBR-LCP2-MC16C cable interface line card.

1cable-mc16e

(Cisco uBR10012 router) Preprovisions a slot for a Cisco uBR-LCP-MC16E or Cisco uBR-LCP2-MC16E cable interface line card.

1cable-mc16s

(Cisco uBR10012 router) Preprovisions a slot for a Cisco uBR-LCP-MC16S or Cisco uBR-LCP2-MC16S cable interface line card.

lchoc12-1

(Cisco 10000 series router) Preprovisions a line card slot for a 1-Port Channelized OC-12/STM-4 line card.

1gigethernet-1

(Cisco 10000 series and Cisco uBR10012 routers) Preprovisions a slot for a Cisco uBR10-1GE Gigabit Ethernet (GigE) uplink line card.

1gigethernet-hh-1

(Cisco 10000 series router) Preprovisions a line card slot for a 1-Port Gigabit Ethernet Half-Height line card.

loc12atm-1

(Cisco 10000 series router) Preprovisions a line card slot for a 1-Port OC-12 ATM line card.

1oc12pos-1

(Cisco 10000 series and Cisco uBR10012 routers) Preprovisions a slot for a Cisco uBR10-1OC12/P-SMI OC-12 POS uplink line card.

1oc48dpt-pos-1

(Cisco 10000 series and Cisco uBR10012 routers) Preprovisions a slot for a Cisco uBR10012 OC-48 DPT/POS Interface Module uplink line card.

2cable-mc28bnc

(Cisco uBR10012 router) Preprovisions a slot for a Cisco uBR-LCP-MC28C-BNC or Cisco uBR-LCP2-MC28C-BNC cable interface line card.

2cable-mc28c

(Cisco uBR10012 router) Preprovisions a slot for a Cisco uBR-LCP-MC28C or Cisco uBR-LCP2-MC28C cable interface line card.

2cable-tccplus

(Cisco uBR10012 router) Preprovisions a slot for a Timing, Control, and Communications Plus (TCC+) utility card.

Note This option is informational only, because slots 1/1 and 2/1 can be used only for the TCC+ card.

24che1t1-1

(Cisco 10000 series router) Preprovisions a line card slot for a 24-Port Channelized E1/T1 line card.

2jacket-1

(Cisco uBR10012 router) Preprovisions a slot for the Cisco Wideband SPA Interface Processor (SIP).

2oc12srp-sm-lr

(Cisco uBR10012 router) Preprovisions a slot for a Cisco uBR10-SRP-OC12SML DPT WAN uplink line card.

24rfchannel-spa-1

(Cisco uBR10012 router) Preprovisions a bay in the Cisco Wideband SIP for the Cisco 1-Gbps Wideband Shared Port Adapter (SPA).

4chstm-1

(Cisco 10000 series router) Preprovisions a line card slot for a 4-Port Channelized OC-3/STM-1 line card.

4cht3-hh-1

(Cisco 10000 series router) Preprovisions a line card slot for a 4-port Channelized Half-Height line card.

4oc3atm-1

(Cisco 10000 series router) Preprovisions a line card slot for a 4-Port OC-3/STM-1 ATM line card with intermediate-reach optics.

4oc3atm_lr-1

(Cisco 10000 series router) Preprovisions a line card slot for a 4-Port OC-3/STM-1 ATM line card with long-reach optics.

5cable-mc520s-d

(Cisco uBR10012 router) Preprovisions a slot for a Cisco uBR10-MC5X20S-D cable interface line card.

5cable-mc520u-d

(Cisco uBR10012 router) Preprovisions a slot for a Cisco uBR10-MC5X20U-D cable interface line card.

6cht3-1

(Cisco 10000 series router) Preprovisions a line card slot for a 6-Port Channelized T3 line card.

6oc3pos-1

(Cisco 10000 series router) Preprovisions a line card slot for a 6-Port OC-3/STM-1 Packet over SONET line card.

8e3ds3-1

(Cisco 10000 series router) Preprovisions a line card slot for an 8-Port Unchannelized E3/T3 line card.

8e3ds3atm-1

(Cisco 10000 series router) Preprovisions a line card slot for an 8-Port E3/DS3 ATM line card.

8fastethernet-1 [mode {e1 | t1}]

(Cisco 10000 series router) Preprovisions a line card slot for an 8-Port Fast Ethernet Half-Height line card and optionally specifies its mode of operation. E1 is the default.

4jacket-1

(Cisco uBR10012 router) Preprovisions a slot for the Cisco SIP-600.

Cisco uBR10012 Universal Broadband Router Usage Guidelines

On the Cisco uBR10012 router, you can use the card command to preprovision a router slot for a line card or to preprovision one or more slots for a SPA interface processor (SIP), such as the Cisco Wideband SIP. You can also use the card command to preprovision a SIP bay for a shared port adapter (SPA), such as the Cisco Wideband SPA.

The Cisco uBR10012 Universal Broadband Router has the following card slot requirements:

Note Slot 0/0 is an invalid value for this command.

•Slots 1/1 and 2/1 are reserved for TCC+ utility cards. A utility card and a SPA can co-exist on a Cisco uBR10012 router with an index of 1/1.

•Slots 1/0 through 4/0 are reserved for network uplink line cards.

•Slots 1 and 3 can be used for SIPs. Each SIP occupies two physical slots in a Cisco uBR10012 router (slot pair 1/2 or slot pair 3/4). Slot 1 is recommended for the Cisco Wideband SIP.

•Slot 5/0 through 8/1 are reserved for cable interface line cards.

Tip When a card has been preprovisioned and is not physically present in the chassis, the show interface command for that slot displays the message "Hardware is not present." Some show commands might also list the preprovisioned card in their displays. In addition, using the card command does not change the output of the ENTITY-MIB, which shows only the equipment that is physically installed in the router.

When a line card is inserted in the Cisco uBR10012 chassis, the router performs the following actions, depending on whether the card slot is preprovisioned for the card:

•If the inserted line card matches the type of line card preprovisioned for the slot, the system applies the preprovisioned configuration to the line card.

•If the line card slot was not preprovisioned, the system applies a basic configuration to the line card and adds that configuration to the running configuration file.

•If the line card slot was preprovisioned for one type of line card, but another type of line card has been inserted, the system replaces the preprovisioned configuration (in the running configuration file) with a basic configuration for the line card that was actually inserted. The startup configuration file is not changed.

Tip Use the show running-config | include card command to display which slots, if any, are preprovisioned for a particular card type.

The no version of the command removes the preprovisioning information from the given card slot. This also removes all configuration information for that card slot, as well as any information in the SNMP MIB database about the card and its card slot.

Cisco 10000 Series Router Usage Guidelines

You must specify a line card slot and subslot, and the line card for which you want to preprovision the line card slot.

If you insert a line card into a line card slot that has been preprovisioned for a different line card, the line card will fail.

You can specify a mode of operation for the 24-Port Channelized E1/T1 line card. If you do not, the line card operates in the E1 mode.

In Cisco IOS releases earlier than 12.0(28)S, 12.2(16)BX, and 12.3(7)XI1, you used only the card command to change the provisioning of a line card slot. It was not necessary to remove the old line card before using the card command to change the line card provisioning.

In Cisco IOS releases after 12.0(28)S, 12.2(16)BX, and 12.3(7)XI1, you must deactivate the installed line card using the hw-module and no card commands before using the card command to provision the line card slot for a different line card. This is a general best practice when using the card command.

Examples

Cisco uBR10012 Universal Broadband Router Examples

The following example shows a list of supported card types for Cisco IOS Release 12.2(8)BC1, and then shows that slot 8/0 is being preprovisioned for a Cisco uBR-LCP2-MC28C cable interface line card. The cable interface for slot 8/0 can then be configured.
Router# config t 
Router(config)# card 5/0 ? 
  1cable-mc16c    create a uBR10000 line card with MC16C
  1cable-mc16e    create a uBR10000 line card with MC16E
  1gigethernet-1  create a GE_1_PORT cardtype
  1oc12pos-1      create a OC12POS_1_PORT cardtype
  2cable-mc28bnc  create a uBR10000 line card with MC28C, BNC connector
  2cable-mc28c    create a uBR10000 line card with MC28C
  2oc12srp-sm-lr  create a uBR10000 oc12 SRP card with SM LR 
Router(config)# card 8/0 2cable-mc28c 
Router(config)# int c8/0 
Router(config-if)# 
The following example shows how to preprovision a Cisco Wideband SIP in Cisco IOS Release 12.2(33)SCB:
Router# configure terminal
Router(config)# card 1 2jacket-1
The following example shows how to preprovision a Cisco Wideband SPA on a Cisco Wideband SIP in Cisco IOS Release 12.2(33)SCB:
Router# configure terminal
Router(config)# card 1/0 24rfchannel-spa-1
The following example shows how to preprovision a Cisco SIP-600 in Cisco IOS Release 12.2(33) SCB:
Router# configure terminal
Router(config)# card 3 4jacket-1
The following example shows how to preprovision a Cisco Wideband SPA on a Cisco SIP-600 in Cisco IOS Release 12.2(33) SCB:
Router# configure terminal
Router(config)# card 3/0 24rfchannel-spa-1
Cisco 10000 Series Router Examples

The following example preprovisions line card slot 2 to accept a 24-Port Channelized E1/T1 line card operating in E1 mode:
Router(config)# card 2/0 24che1t1-1 mode e1
The following example shows how to change the provisioning for line card slot 5 from the 1-Port Gigabit Ethernet Half-Height line card to the 4-Port OC-3/STM-1 ATM line card.
Router(config)# hw-module subslot 5/0 shut
Aug 22 21:52:19.619 UTC: %IPCOIR-3-TIMEOUT: Timeout waiting for a response from slot 5/0.
Aug 22 21:52:19.619 UTC: %IPCOIR-2-CARD_UP_DOWN: Card in slot 5/0 is down.  Notifying 
1gigethernet-hh-1 driver.
Aug 22 21:52:21.627 UTC: %LINK-3-UPDOWN: Interface GigabitEthernet5/0/0, changed state to 
down
Aug 22 21:52:22.627 UTC: %LINEPROTO-5-UPDOWN: Line protocol on Interface 
GigabitEthernet5/0/0, changed state to down
Router(config)# no card 5/0 1gigethernet-hh-1
Aug 22 21:53:20.008 UTC: %C10K-3-DEACTIVATED: card in slot [5/0] disabled. 
Router(config)# card 5/0 4oc3atm-1
[ Remove the 1-Port Gigabit Ethernet Half-Height line card and 
insert the 4-Port OC-3/STM-1 ATM line card ]
Related Commands

Command

Description

show interface

Displays the current configuration and status for a specified interface type.

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

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, and each group can have up to four interfaces, only one of which is the master.

Defaults

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

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.

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.

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 master in that EtherChannel group.
Router(config-if)# channel-group etherchannel 1
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.

Defaults

If no upstream channel ID is specified, the CM uses the upstream channel from the Upstream Channel Description (UCD) messages it receives on the downstream channel.

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.

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.

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

No default behaviors or values

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.

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.

Syntax Descriptionclear cable arp-filter {bundle number cable slot/port |slot/subslot/port

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.

Command Default

No default behavior or values

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.

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

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

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

Command Default

No default behavior or values

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.

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# 
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}
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.

Command Default

No default behavior or values

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.

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

Command Default

No default behavior or values

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.

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

clear cable logging

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

clear cable logging badipsource
Syntax Description

This command has no keywords or arguments.

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.

Usage Guidelines

The cable logging badipsource command creates a circular buffer that contains the BADIPSOURCE error messages that the Cisco CMTS generates when it discovers a CM or CPE device using an unauthorized IP address. When the buffer becomes full, the oldest messages are deleted to make room for newer messages.

When you have viewed all of the error messages in the current buffer, use the clear cable logging command to clear out the buffer to make room for newer messages.

Examples

The following example shows how to clear the log buffer that contains the bad IP source address error messages:
Router# show cable logging summary 
Cable logging: BADIPSOURCE Enabled
                Total buffer size (bytes): 1000000
                Used buffer size (bytes) : 36968 
                Logged messages          : 231 
Router# clear cable logging badipsource 
Router# show cable logging summary 
Cable logging: BADIPSOURCE Enabled
                Total buffer size (bytes): 1000000
                Used buffer size (bytes) : 0 
                Logged messages          : 0 
Router# 
Related Commands

cable logging badipsource

Logs error messages about bad IP source addresses on the cable interfaces.

cable source-verify

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

show cable logging

Displays the log of error messages about bad IP source addresses on the cable interfaces.

clear cable modem 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
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.

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

No default behavior or values for this command

Command Modes

Privileged EXEC (#)

Command History

Release

Modification

12.2(33)SCB

This command was introduced.

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.

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

ip-address

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

mac-address

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

cable slot/subslot/port

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

•slot = 5 to 8

•subslot = 0 or 1

•port = 0 to 4 (depending on the cable interface)

cm-status

Resets the CM status events to zero on the specified cable interface.

Command Default

No default behavior or values.

Command Modes

Privileged EXEC (#)

Command History

Release

Modification

12.2(33)SCB

This command was introduced.

Usage Guidelines

None.

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/port]{all | oui string | reject}} counters
Syntax Description

mac-addr

Specifies the 48-bit hardware address (MAC address) of an individual CM.

ip-addr

Specifies the IP address of an individual CM.

cable slot/port

(Optional—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

No default behavior or values

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.

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

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

No default behavior or values

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.

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

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

No default behavior or values

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.

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.

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

No default behavior or values

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.

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

Resets the flap-list counters to zero for the CM with the specified domain name.

Resets the lock on the CM with the specified domain name.

reset

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

Command Default

No default behavior or values

Command Modes

Privileged EXEC (#)

Command History

Release

Modification

12.2(33)SCA

This command was introduced.

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

port

Specifies the interface number on the SPA.

nb-channel-number

Represents the narrowband channel number.

Command Default

No default behavior or values.

Command Modes

Privileged EXEC (#)

Command History

Release

Modification

12.2(33)SCB

This command was introduced.

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.

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

No default behavior or values

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.

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 abort 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 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
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

No default behavior or values for this command

Command Modes

Privileged EXEC (#)

Command History

Release

Modification

12.2(33)SCB

This command was introduced.

Usage Guidelines

This command clears the CM's 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 c5/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.

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

No default behavior or values

Command Modes

Privileged EXEC (#)

Command History

Release

Modification

12.3(23)BC

This command was introduced for the Cisco uBR10012 router.

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 rf-status

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

clear cable rf-status [modular-cable slot/bay/port nb-channel-number]
Syntax Description

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

port

Specifies the interface number on the SPA.

nb-channel-number

Represents the narrowband channel number.

Command Default

No default behavior or values.

Command Modes

Privileged EXEC (#)

Command History

Release

Modification

12.2(33)SCB

This command was introduced.

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 secondary-ip

To clear the router's table that links secondary IP addresses to the devices that use them, use the clear cable secondary-ip command in privileged EXEC mode.

clear cable secondary-ip interface cable {slot/port | slot/subport/port}[all | sid sid [ip-address]]
Syntax Description

slot/port

(Cisco uBR7100 and Cisco uBR7200 Series Routers) Specifies the 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.

slot/subslot/port

Cisco uBR10012 Router) Specifies the 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 that all IP addresses in the secondary IP address table should be cleared.

sid sid

Specifies that all IP addresses for a particular Service ID (SID) should be cleared. The valid range is 1 to 8191.

ip-address

(Optional) Specifies that the IP address for a particular CM or CPE device should be cleared.

Command Default

No default behavior or values

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

Support was added for the Cisco uBR10012 universal broadband router.

12.2(11)BC2

This command was removed because it is no longer needed, because of database changes.

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.

Usage Guidelines

To support BPI and BPI+ operations with CMs and CPE devices that use secondary IP addresses, the CMTS maintains a database that links the known secondary IP addresses to the SIDs used by those devices. When the CMTS and CM need to renew their public keys, the CMTS uses this database to ensure that all IP addresses are sufficiently updated to allow proper routing and fast switching.

Tip You can display the list of known IP addresses per SID by using the show interface cable sid command.

If you encounter apparent problems with secondary IP addressing, or if you want to manually clear the table of IP addresses for a particular SID, use the clear cable secondary-ip command.

Tip One possible situation that might occur is if a CM first assigns a secondary IP address to one CPE device, but later that same IP address is assigned to another CPE device behind a different CM. If this happens, the IP address will continue to show up as a secondary IP address for the original CM until that CM renews its public keys. This will not affect network connectivity for either CPE or CM. You can, however, clear the unneeded secondary IP address from the CMTS database using the clear cable secondary-ip command.

Examples

The following example shows how to clear all of the secondary IP addresses for a particular cable interface:
Router# clear cable secondary-ip interface cable 3/0 all 
The following example shows how to clear the secondary IP addresses for all CM and CPE devices on cable interface 1/0 that are using SID 5:
Router# clear cable secondary-ip interface cable 1/0 sid 5 
The following example shows how to clear the secondary IP addresses for the CM and CPE devices on cable interface 5/0 that are using SID 113 and IP address 10.10.17.3:
Router# clear cable secondary-ip interface cable 5/0 sid 113 10.10.17.3 
Related Commands

Command

Description

show interface cable sid

Displays information for a particular SID, including the known secondary IP addresses.

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

No default behavior or values for this command

Command Modes

Privileged EXEC (#)

Command History

Release

Modification

12.2(33)SCB

This command was introduced.

Usage Guidelines

This command clears the CM's 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 c5/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 crypto engine accelerator counter

To reset the statistical and error counters of the hardware accelerator of the router or the IPsec Virtual Private Network (VPN) Shared Port Adapter (SPA) to zero, use the clear crypto engine accelerator counter command in privileged EXEC mode.

clear crypto engine accelerator counter
IPsec VPN SPA

clear crypto engine accelerator statistic [slot slot/subslot | all] [detail]
Syntax Description

slot slot/subslot

(IPsec VPN SPA only—Optional) Chassis slot number and secondary slot number on the SPA Interface Processor (SIP) where the SPA is installed. Refer to the appropriate hardware manual for slot information. For SIPs, refer to the platform-specific SPA hardware installation guide or the corresponding "Identifying Slots and Subslots for SIPs and SPAs" topic in the platform-specific SPA software configuration guide.

Resets platform statistics for the corresponding IPsec VPN SPA to zero. This output will not include network interface controller statistics.

all

(IPsec VPN SPA only—Optional) Resets platform statistics for all IPsec VPN SPAs on the router to zero. This reset will not include network interface controller statistics.

detail

(IPsec VPN SPA only—Optional) Resets platform statistics for the IPsec VPN SPA and network interface controller statistics to zero.

Command Modes

Privileged EXEC (#)

Command History

Release

Modification

12.1(3)XL

This command was introduced for the Cisco uBR905 cable access router.

12.2(2)XA

Support was added for the Cisco uBR925 cable access router.

12.2(13)T

This command was integrated into Cisco IOS Release 12.2(13)T and implemented for the AIM-VPN/EPII and AIM-VPN/HPII on the following platforms: Cisco 2691, Cisco 3660, Cisco 3725, and Cisco 3745.

12.2(15)ZJ

This command was implemented for the AIM-VPN/BPII on the following platforms: Cisco 2610XM, Cisco 2611XM, Cisco 2620XM, Cisco 2621XM, Cisco 2650XM, and Cisco 2651XM.

12.3(4)T

The AIM-VPN/BPII was integrated into Cisco IOS Release 12.3(4)T on the following platforms: Cisco 2610XM, Cisco 2611XM, Cisco 2620XM, Cisco 2621XM, Cisco 2650XM, and Cisco 2651XM.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA to support the IPsec VPN SPA on Cisco 7600 series routers and Catalyst 6500 series switches.

12.2(33)SXH

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

Usage Guidelines

No specific usage guidelines apply to the hardware accelerators.

IPsec VPN SPA

Enter the slot keyword to reset platform statistics for the corresponding IPsec VPN SPA to zero. This reset will not include network interface controller statistics.

Enter the all keyword to reset platform statistics for all IPsec VPN SPAs on the router to zero. This reset will not include network interface controller statistics.

Enter the detail keyword to reset both the platform statistics for the IPsec VPN SPA and network interface controller statistics to zero.

Examples

Hardware VPN Module

The following example shows the statistical and error counters of the hardware accelerator being cleared to zero:
Router# clear crypto engine accelerator counter
IPsec VPN SPA

The following example shows the platform statistics for the IPsec VPN SPA in slot 2, subslot 1 being cleared to zero:
Router# clear crypto engine accelerator counter slot 2/1
The following example shows the platform statistics for all IPsec VPN SPAs on the router being cleared to zero:
Router# clear crypto engine accelerator counter all
Related Commands

Command

Description

crypto ca

Defines the parameters for the certification authority used for a session.

crypto cisco

Defines the encryption algorithms and other parameters for a session.

crypto dynamic-map

Creates a dynamic map crypto configuration for a session.

crypto engine accelerator

Enables the use of the onboard hardware accelerator for IPsec encryption.

crypto ipsec

Defines the IPSec security associations and transformation sets.

crypto isakmp

Enables and defines the IKE protocol and its parameters.

crypto key

Generates and exchanges keys for a cryptographic session.

crypto map

Creates and modifies a crypto map for a session.

debug crypto engine accelerator control

Displays each control command as it is given to the crypto engine.

debug crypto engine accelerator packet

Displays information about each packet sent for encryption and decryption.

show crypto engine accelerator ring

Displays the contents of command and transmits rings for the crypto engine.

show crypto engine accelerator sa-database

Displays the active (in-use) entries in the crypto engine SA database.

show crypto engine accelerator statistic

Displays the current run-time statistics and error counters for the crypto engine.

show crypto engine brief

Displays a summary of the configuration information for the crypto engine.

show crypto engine configuration

Displays the version and configuration information for the crypto engine.

show crypto engine connections

Displays a list of the current connections maintained by the crypto engine.

clear crypto ipsec client ezvpn

To reset the Cisco Easy VPN remote state machine and bring down the Cisco Easy VPN remote connection on all interfaces or on a given interface (tunnel), use the clear crypto ipsec client ezvpn command in privileged EXEC mode. If a tunnel name is specified, only the specified tunnel is cleared.

clear crypto ipsec client ezvpn [name]
Syntax Description

name

(Optional) Identifies the IPSec virtual private network (VPN) tunnel to be disconnected or cleared with a unique, arbitrary name. If no name is specified, all existing tunnels are disconnected or cleared.

Defaults

If no tunnel name is specified, all active tunnels on the machine are cleared.

Command Modes

Privileged EXEC (#)

Command History

Release

Modification

12.2(4)YA

This command was introduced for Cisco 806, Cisco 826, Cisco 827, and Cisco 828 routers; Cisco 1700 series routers; and Cisco uBR905 and Cisco uBR925 cable access routers.

12.2(13)T

This command was integrated into Cisco IOS Release 12.2(13)T.

12.2(8)YJ

This command was enhanced to specify an IPSec VPN tunnel to be cleared or disconnected for Cisco 806, Cisco 826, Cisco 827, and Cisco 828 routers; Cisco 1700 series routers; and Cisco uBR905 and Cisco uBR925 cable access routers.

12.2(15)T

This command was integrated into Cisco IOS Release 12.2(15)T.

12.2(33)SRA

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

12.2SX

This command is supported in the Cisco IOS 12.2SX family of releases. Support in a specific 12.2SX release is dependent on your feature set, platform, and platform hardware.

Usage Guidelines

The clear crypto ipsec client ezvpn command resets the Cisco Easy VPN remote state machine, bringing down the current Cisco Easy VPN remote connection and bringing it back up on the interface. If you specify a tunnel name, only that tunnel is cleared. If no tunnel name is specified, all active tunnels on the machine are cleared.

If the Cisco Easy VPN remote connection for a particular interface is configured for autoconnect, this command also initiates a new Cisco Easy VPN remote connection.

Examples

The following example shows the Cisco Easy VPN remote state machine being reset:
Router# clear crypto ipsec client ezvpn
Related Commands

Command

Description

crypto ipsec client ezvpn (global)

Creates a Cisco Easy VPN remote configuration.

crypto ipsec client ezvpn (interface)

Assigns a Cisco Easy VPN remote configuration to an interface.

clear facility-alarm

To clear alarm conditions and rest the alarm contacts, use the clear facility-alarm command in privileged EXEC mode.

clear facility-alarm [critical | major | minor | source pem {0 | 1}]
Syntax Description

critical

(Optional) Clears all critical alarms.

major

(Optional) Clears all major alarms.

minor

(Optional) Clears all minor alarms.

source pem {0 | 1}

(Optional-Cisco uBR10012 only) Clears all alarms for either the first or second Power Entry Module (PEM).

Defaults

If specified without any options, clears all facility alarms.

Command Modes

Privileged EXEC (#)

Command History

Release

Modification

12.0(17)SL

This command was introduced on the Cisco 10000 series router.

12.2(1)XF1

This command was introduced for the Cisco uBR10012 router.

12.2(16)BX

This command was introduced on the PRE2.

12.2(31)SB2

This command was introduced on the PRE3 for the Cisco 10000 series 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.

Usage Guidelines

The clear facility-alarm command clears the contacts to an external alarm panel. Only a reoccurrence of the original alarm source after the original alarm condition is removed can restart the audible alarm. These alarms are displayed by the show facility-alarm status command.

The alarm LEDs remain lit on the Performance Routing Engine (PRE) as long as the alarm condition continues and is not cleared by the clear facility-alarm command. An alarm can only be removed from the list by correcting the issue that is triggering the alarm.

Examples

The following example shows how to clear all facility alarms on the router:
Router# clear facility-alarm 
Clearing all alarms
The following example shows how to clear all critical facility alarms on the router:
Router# clear facility-alarm critical 
Clearing critical alarms
The following example shows how to clear minor facility alarms only:
Router# clear facility-alarm minor
Clearing minor alarms
Cisco uBR10012 Universal Broadband Router

The following example shows how to clear all alarms for both PEM modules on a Cisco uBR10012 universal broadband router:
Router# clear facility-alarm source pem 0 
Router# clear facility-alarm source pem 1 
Related Commands

Command

Description

facility-alarm

Sets the temperature thresholds at which the processor generates a critical, major, or minor alarm to warn of potential equipment damage.

show facility-alarm status

Displays the current temperature thresholds that will trigger a facility alarm.

clear hccp counters

To reset the counters for one or all Hot Standby Connection-to-Connection Protocol (HCCP) groups, use the clear hccp counters command in privileged EXEC mode.

clear hccp [group | all] counters
Syntax Description

group

Clears the counters for the specified group number. The valid range is 1 to 255.

all

Clears the counters for all HCCP groups.

Command Default

No default behavior or values.

Command Modes

Privileged EXEC (#)

Command History

Release

Modification

12.1(3a)EC

This command was introduced for the Cisco uBR7200 series routers.

12.1(7)EC1

Support was added for the Cisco uBR-MC16S cable interface line card.

12.2(4)XF1, 12.2(4)BC1

Support was added for the N+1 (1:n) RF Switch with the Cisco uBR10012 router and Cisco uBR-LCP-MC28C card.

12.2(8)BC2

Support was added for the N+1 (1:n) RF Switch with the Cisco uBR10012 router and Cisco uBR-LCP-MC16C, Cisco uBR-LCP-MC16E, and Cisco uBR-LCP-MC16S cards.

12.2(11)BC1

Support was added for the N+1 (1:n) RF Switch with the Cisco uBR7246VXR router and Cisco uBR-MC16C, Cisco uBR-MC16S, and Cisco uBR-MC28C cards.

12.3(21)BC

This command is obsolete on the Cisco uBR7246VXR router.

Usage Guidelines

This command clears the counters that are displayed by the show hccp and show hccp interface commands. You can clear the counters for a single HCCP group, or all HCCP groups.

Examples

The following example shows the counters for group 1 being reset to 0:
Router# clear hccp 1 counters 
The following example shows the counters for all groups being reset to 0:
Router# clear hccp all counters 
Related Commands

Command

Description

hccp working

Designates a cable interface on a CMTS in the specified group to be a Working CMTS.

show hccp

Displays information for all cable interfaces on which one or more HCCP groups and authentication modes have been configured.

show hccp interface

Displays group information for a specific cable interface on which one or more groups and authentication modes have been configured.

clear packetcable gate counter commit

To clear the specified gate counter for PacketCable Multimedia (PCMM) or Dynamic Quality of Service (DQoS) for PC, use the clear packetcable gate counter commit command in Privileged EXEC mode.

clear packetcable gate counter commit [dqos | multimedia]

Syntax Description

dqos

Clears PC DQoS gate counters.

multimedia

Clears PCMM gate counters.

Command Default

The committed gate counter is reset to zero by default with router restart, and gates are not cleared periodically by default.

Command Modes

Privileged EXEC (#)

Command History

Release

Modification

12.2(8)BC2

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

12.2(15)BC1

Support was added for the Cisco uBR10012 router.

12.3(13a)BC

This command was modified to support PCMM on the Cisco uBR10012 router and the Cisco uBR7246VXR router. The dqos and multimedia keywords were added.

12.2(33)SCA

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

Usage Guidelines

This command is used to reset the gate counter being used to track the total number of committed gates. The CMTS router maintains a count of the total number of gates committed from the router's last startup. This command can be used to either clear all the gate commit counts, or to specifically clear the counts for DQoS- or multimedia-based gates.

A show command is used to display the total number of gates committed on the CMTS.

Examples

The following example shows the committed gate counter being reset to zero:
Router# clear packetcable gate counter commit 
Related Commands

Command

Description

packetcable authorize vanilla-docsis-mta

Allows non-DQoS MTAs to send DOCSIS DSX messages.

packetcable gate maxcount

Sets the maximum number of PCMM gates in the gate database.

packetcable multimedia

Enables and displays PacketCable Multimedia processing on the Cisco CMTS.

packetcable timer multimedia T1

Sets the default timeout value for T1timer used in PCMM gate processing.

clear pxf

To clear Parallel eXpress Forwarding (PXF) counters and statistics, use the clear pxf command in privileged EXEC mode.

clear pxf [dma counters | interface interface | statistics {context | diversion | drop | ip | ipv6} | xcm counters]
Syntax Description

dma counters

(Optional) Clears the direct memory access (DMA) PXF counters.

interface interface

(Optional) Clears the PXF counters on the specified interface.

statistics

(Optional) Type of PXF statistics to clear. The options are:

•context—Current and historical loads on the PXF.

•diversion—Traffic diverted from the PXF.

•drop—Dropped packets and bytes.

•ip— IP and ICMP statistics.

•ipv6—IPv6 statistics.

xcm counters

Clears the PXF Error Code Correction (ECC) counters.

Command Default

No default behavior or values

Command Modes

Privileged EXEC (#)

Command History

Release

Modification

12.0(22)S

This command was introduced on the Cisco 10000 series router.

12.2(1)XF1

This command was introduced on the Cisco uBR10012 router.

12.2(4)XF1

The xcm counters option was introduced to support the Performance Routing Engine (PRE1) module on the Cisco uBR10012 router.

12.3(7)XI1

This command was integrated into Cisco IOS Release 12.3(7)XI1.

12.3BC

This command was integrated into Cisco IOS Release 12.3BC. The context and ipv6 keyword options are not supported.

12.2(31)SB

This command was integrated into Cisco IOS Release 12.2(31)SB.

12.2(33)SCA

This command was integrated into Cisco IOS Release 12.2(33)SCA. The ipv6 keyword option is not supported.

Usage Guidelines

If no interface is specified, the command clears PXF counters on all interfaces. The clear pxf command clears counters associated with the show pxf dma, show pxf interface, show pxf statistics, and show pxf xcm commands.

Cisco uBR10012 Universal Broadband Router

Not all keyword options are supported in the Cisco IOS software for the Cisco uBR10012 universal broadband router. See the command history table for the unsupported keyword options by release.

The clear pxf xcm counters command is supported only on the PRE1 and later processors for the Cisco uBR10012 router. This command is not supported on the PRE processor.

Examples

The following example clears PXF statistics for serial interface 1/0/0:
Router# clear pxf interface serial 1/0/0 
The following example clears PXF statistics on all interfaces:
Router# clear pxf interface 
Related Commands

Command

Description

show pxf cpu statistics

Displays PXF CPU statistics.

show pxf dma

Displays the current state of DMA buffers, error counters, and registers on the PXF engine.

show pxf interface

Displays a summary of the statistics accumulated by column 0 of the PXF for an interface.

show pxf statistics

Displays chassis-wide, summary PXF statistics.

show pxf xcm

Displays PXF XCM information.
clear pxf statistics drl cable-wan-ip

To clear the PXF DRL cable/wan-ip statistics table, use the clear pxf statistics drl cable-wan-ip command in privileged EXEC mode.

clear pxf statistics drl cable-wan-ip
Syntax Description

This command has no arguments or keywords.

Command Default

No default behavior or values.

Command Modes

Privileged EXEC (#)

Command History

Release

Modification

12.2(33)SCB

This command was introduced.

Usage Guidelines

This command sets the drop count to zero for all entries in the PXF DRL cable/wan-ip statistics table. It does not change any other value.

Examples

The following example shows how to clear cable-wan-ip statistics:
Router# clear pxf statistics drl cable-wan-ip
Related Commands

Command

Description

clear pxf statistics drl wan-non-ip

This command set the drop count to zero for all entries in the PXF DRL wan-non-ip statistics table.

clear pxf statistics drl wan-non-ip

To clear the PXF DRL wan-non-ip statistics, use the clear pxf statistics drl wan-non-ip command in privileged EXEC mode.

clear pxf statistics drl wan-non-ip
Syntax Description

This command has no arguments or keywords.

Command Default

No default behavior or values.

Command Modes

Privileged EXEC (#)

Command History

Release

Modification

12.2(33)SCB

This command was introduced.

Usage Guidelines

This command sets the drop count to zero for all entries in the PXF DRL wan-non-ip statistics table.

Examples

The following example shows how to clear the PXF statistics in wan-non-ip:
Router# clear pxf statistics drl wan-non-ip
Related Commands

Command

Description

clear pxf statistics drl cable-wan-ip

This command sets the drop count to zero for all entries in the cable or wan-ip statistics table.

clear redundancy

To clear the counters and history information that are used by the Redundancy Facility (RF) subsystem, use the clear redundancy command in privileged EXEC mode.

clear redundancy {counters | history}
Syntax Description

counters

Clears the RF counters that are maintained by the RF subsystem.

history

Clears the history of RF activity that is maintained by the RF subsystem.

Defaults

No default behavior or values

Command Modes

Privileged EXEC (#)

Command History

Release

Modification

12.2(4)XF1

This command was introduced for 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.

Usage Guidelines

The clear redundancy command clears the following information, which is shown by the show redundancy command:

•counters—Number of messages sent and received, buffers used, and synchronization errors.

•history—RF subsystem activity, such as checkpoint messages sent between RF clients.

Examples

The following example shows how to clear the RF counters that are displayed by the show redundancy command:
Router# clear redundancy counters 
The following example shows how to clear the RF history information that is displayed by the show redundancy command:
Router# clear redundancy history 
Related Commands

Command

Description

show redundancy

Displays the current redundancy state.

controller modular-cable

To enter controller configuration mode to configure the SPA controller, use the controller modular-cable command in global configuration mode.

Cisco IOS Releases 12.3(23)BC and 12.2(33)SCA

controller modular-cable slot/subslot/bay
Cisco IOS Release 12.2(33)SCB

controller modular-cable slot/bay/port
Syntax Description

slot

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

subslot

The subslot where a SIP resides. On the Cisco uBR10012 router, subslot 0 is always specified.

bay

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

port

Specifies the interface number on the SPA.

Command Default

The command mode is unchanged.

Command Modes

Global configuration (config)

Command History

Release

Modification

12.3(21)BC

This command was introduced for the Cisco uBR10012 router.

12.2(33)SCA

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

12.2(33)SCB

This command was modified to change the addressing format for the modular cable interfacefrom slot/subslot/bay to slot/bay/port.

Usage Guidelines

This command indicates where the SPA is located and enters controller configuration mode.

Examples

The following example shows how to enter controller configuration mode for the Cisco Wideband SPA in slot 1, subslot 0, and bay 0.
Router# configure terminal 
Router(config)# controller modular-cable 1/0/0
Related Commands

Command

Description

annex modulation

Sets the annex and modulation for the Wideband SPA.

cable rf-channel

Associates an RF channel on a Wideband SPA with a wideband channel.

ip-address (controller)

Sets the IP address of the Wideband SPA FPGA.

modular-host subslot

Specifies the modular-host line card.

rf-channel frequency

Sets the frequency for each RF channel.

rf-channel ip-address mac-address udp-port

Sets the IP address, MAC address and UDP port for each RF channel.

rf-channel network delay

Specifies the CIN delay for each RF channel.

rf-channel description

Specifies the description for each RF channel.

rf-channel cable downstream channel-id

Assigns a downstream channel ID to an RF channel.

cops ip dscp

To specify the Common Open Policy Service (COPS) Differentiated Services Code Point (DSCP) markings for COPS messages that are transmitted by the Cisco router, use the cops ip dscp command in global configuration mode. To remove this configuration, use the no form of this command.

cops ip dscp [0-63 | default | af11-af43 | cs1-cs7]

no cops ip dscp [0-63 | default | af11-af43 | cs1-cs7]

The values for this command specify the markings with which COPS messages are transmitted. The following values are supported for the Cisco CMTS router.

Syntax Description

0-63

DSCP value ranging from 0-63.

af11

Use AF11 dscp (001010)

af12

Use AF12 dscp (001100)

af13

Use AF13 dscp (001110)

af21

Use AF21 dscp (010010)

af22

Use AF22 dscp (010100)

af23

Use AF23 dscp (010110)

af31

Use AF31 dscp (011010)

af32

Use AF32 dscp (011100)

af33

Use AF33 dscp (011110)

af41

Use AF41 dscp (100010)

af42

Use AF42 dscp (100100)

af43

Use AF43 dscp (100110)

cs1

Use CS1 dscp (001000) [precedence 1]

cs2

Use CS2 dscp (010000) [precedence 2]

cs3

Use CS3 dscp (011000) [precedence 3]

cs4

Use CS4 dscp (100000) [precedence 4]

cs5

Use CS5 dscp (101000) [precedence 5]

cs6

Use CS6 dscp (110000) [precedence 6]

cs7

Use CS7 dscp (111000) [precedence 7]

default

Use default dscp (000000)

ef

Use EF dscp (101110)

Defaults

•This command is disabled by default.

•For messages transmitted by the Cisco router, the default DSCP value is 0.

•For incoming connections to the Cisco router, by default, the COPS engine takes the DSCP value used by the COPS server that initiates the TCP connection.

Command Modes

Global configuration (config)

Command History

Release

Modification

12.3(13a)BC

This command was introduced to the Cisco CMTS.

12.2(33)SCA

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

Usage Guidelines

This feature allows you to change the Differentiated Services Code Point (DSCP) marking for COPS messages that are transmitted or received by the Cisco router. Cisco IOS Release 12.3(13a)BC supports this function with the cops ip dscp command. The cops ip dscp command changes the default IP parameters for connections between the Cisco router and COPS servers in the cable network.

DSCP values are used in Quality of Service (QoS) configurations on a Cisco router to summarize the relationship between DSCP and IP precedence. This command allows COPS to remark the packets for either incoming or outbound connections.

The default setting is 0 for outbound connections. On default incoming connections, the COPS engine takes the DSCP value from the COPS server initiating the TCP connection.

Note This feature affects all TCP connections with all COPS servers.

•The cops ip dscp command allows the Cisco router to re-mark the COPS packets for either incoming or outbound connections.

•This command affects all TCP connections with all COPS servers.

•This command does not affect existing connections to COPS servers. Once you issue this command, this function is supported only for new connections after that point in time.

•For messages transmitted by the Cisco router, the default DSCP value is 0.

•For incoming connections to the Cisco router, the COPS engine takes the DSCP value used by the COPS server that initiates the TCP connection, by default.

For additional information about this feature and related commands, refer to the "COPS Engine Operation on the Cisco CMTS Routers" feature document on Cisco.com.

Examples

The following basic example illustrates the use of this command:

The following example illustrates the cops ip dscp command with supported command variations:
Router(config)# cops ip dscp ?
 <0-63>   DSCP value 
 af11     Use AF11 dscp (001010) 
 af12     Use AF12 dscp (001100) 
 af13     Use AF13 dscp (001110) 
 af21     Use AF21 dscp (010010) 
 af22     Use AF22 dscp (010100) 
 af23     Use AF23 dscp (010110) 
 af31     Use AF31 dscp (011010) 
 af32     Use AF32 dscp (011100) 
 af33     Use AF33 dscp (011110) 
 af41     Use AF41 dscp (100010) 
 af42     Use AF42 dscp (100100) 
 af43     Use AF43 dscp (100110) 
 cs1      Use CS1  dscp (001000) [precedence 1] 
 cs2      Use CS2  dscp (010000) [precedence 2] 
 cs3      Use CS3  dscp (011000) [precedence 3] 
 cs4      Use CS4  dscp (100000) [precedence 4] 
 cs5      Use CS5  dscp (101000) [precedence 5] 
 cs6      Use CS6  dscp (110000) [precedence 6] 
 cs7      Use CS7  dscp (111000) [precedence 7] 
 default  Use default dscp (000000) 
 ef       Use EF   dscp (101110) 
Router(config)# cops ip dscp 0-63
The following example specifies the COPS server and enables COPS for RSVP on the server. Both of these functions are accomplished by using the ip rsvp policy cops command. By implication, the default settings for all remaining COPS for RSVP commands are accepted.
Router# configure terminal
Enter configuration commands, one per line.  End with CNTL/Z.
Router(config)# ip rsvp policy cops servers 161.44.130.168 161.44.129.6
Router(config)# exit
The following examples display three views of the COPS for RSVP configuration on the router, which can be used to verify the COPS for RSVP configuration.

The following example displays the policy server address, state, keepalives, and policy client information:
Router# show cops servers
COPS SERVER: Address: 161.44.135.172. Port: 3288. State: 0. Keepalive: 120 sec
Number of clients: 1. Number of sessions: 1. 
    COPS CLIENT: Client type: 1.  State: 0.
The following example displays the policy server address, the ACL ID, and the client/server connection status:
Router# show ip rsvp policy cops
COPS/RSVP entry. ACLs: 40 60 
PDPs: 161.44.135.172 
Current state: Connected
Currently connected to PDP 161.44.135.172, port 0
The following example displays the ACL ID numbers and the status for each ACL ID:
Router# show ip rsvp policy
Local policy: Currently unsupported
COPS: 
ACLs: 40 60 . State: CONNECTED. 
ACLs: 40 160 . State: CONNECTING. 
Related Commands

Command

Description

cops listeners access-list

Configures access control lists (ACLs) for inbound connections to all COPS listener applications on the Cisco CMTS.

cops tcp window-size

Overrides the default TCP receive window size that is used by COPS processes.

debug packetcable cops

Enables debugging processes for PacketCable with the COPS engine.

debug packetcable gate control

Enables and displays debugging processes for PacketCable gate control.

debug packetcable subscriber

Enables and displays debugging processes for PacketCable subscribers.

show cops servers

Displays COPS server addresses, port, state, keepalives, and policy client information.

show debug

Displays current debugging information that includes PacketCable COPS messages on the Cisco CMTS.

show ip rsvp policy

Displays policy server addresses, ACL IDs, and client/server connection status.

cops listeners access-list

To configure access control lists (ACLs) for inbound connections to all Common Open Policy Service (COPS) listener applications on the Cisco CMTS router, user the cops listeners access-list command in global configuration mode. To remove this setting from the Cisco CMTS router, us the no form of this command.

cops listeners access-list {acl-num | acl-name}

no cops listeners access-list {acl-num | acl-name}

Syntax Description

acl-num

Alphanumeric identifier of up to 30 characters, beginning with a letter that identifies the ACL to apply to the current interface.

acl-name

Numeric identifier that identifies the access list to apply to the current interface. For standard access lists, the valid range is 1 to 99; for extended access lists, the valid range is 100 to 199.

Command Default

Access lists are not configured by default on the Cisco router.

Command Modes

Global configuration (config)

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.

Usage Guidelines

When using ACLs with cable monitor and the Cisco uBR10012 router, combine multiple ACLs into one ACL, and then configure cable monitor with the consolidated ACL. For more information about cable monitor, refer to the "Cable Monitor and Intercept Features for the Cisco CMTS" documentation on Cisco.com.

Examples

The following example illustrates a short access list configuration for the COPS listener feature:

Router# cops listeners access-list 40
Related Commands

Command

Description

cops ip dscp

Specifies the COPS DSCP markings for COPS messages that are transmitted by the Cisco router

cops tcp window-size

Overrides the default TCP receive window size that is used by COPS processes.

debug packetcable cops

Enables debugging processes for PacketCable with the COPS engine.

debug packetcable gate control

Enables and displays debugging processes for PacketCable gate control.

debug packetcable subscriber

Enables and displays debugging processes for PacketCable subscribers.

show cops servers

Displays COPS server addresses, port, state, keepalives, and policy client information.

show debug

Displays current debugging information that includes PacketCable COPS messages on the Cisco CMTS.

show ip rsvp policy

Displays policy server addresses, ACL IDs, and client/server connection status.

cops tcp window-size

To override the default TCP receive window size on the Cisco CMTS router, use the cops tcp window-size command in global configuration mode. This setting allows you to prevent the COPS server from sending too much data at one time. To return the TCP window size to a default setting of 4K, use the no form of this command.

cops tcp window-size bytes

no cops tcp window-size

Syntax Description

bytes

This is the TCP window size setting in bytes. This value can range from 516 to 65535 bytes.

Defaults

The default COPS TCP window size is 4000 bytes.

Command Modes

Global configuration (config)

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.

Usage Guidelines

This command does not affect existing connections to COPS servers. Once you issue this command, this function is supported only for new connections after that point in time.

Examples

The following example configures the TCP window size to be 64000 bytes.
Router(config)# cops tcp window-size 64000 
Related Commands

Command

Description

cops ip dscp

Specifies the Common Open Policy Service (COPS) Differentiated Services Code Point (DSCP) markings for COPS messages that are transmitted by the Cisco router

cops listeners access-list

Configures access control lists (ACLs) for inbound connections to all COPS listener applications on the Cisco CMTS.

debug packetcable cops

Enables debugging processes for PacketCable with the COPS engine.

debug packetcable gate control

Enables and displays debugging processes for PacketCable gate control.

debug packetcable subscriber

Enables and displays debugging processes for PacketCable subscribers.

show cops servers

Displays COPS server addresses, port, state, keepalives, and policy client information.

show debug

Displays current debugging information that includes PacketCable COPS messages on the Cisco CMTS.

show ip rsvp policy

Displays policy server addresses, ACL IDs, and client/server connection status.

cpd

To enable the Control Point Discovery (CPD) feature, use the cpd command in global configuration mode. To disable CPD, use the no form of this command.

cpd
no cpd
Syntax Description

This command has no keywords or arguments.

Command Default

CPD is enabled.

Command Modes

Global configuration (config)

Command History

Release

Modification

12.3(21a)BC3

This command was introduced.

12.2(33)SCA

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

Examples

The following example shows the cpd enabled on a router:
Router(config)# cpd
Related Commands

Command

Description

cpd cr-id

Configures a control relationship identifier.

cpd cr-id

To configure a Control relationship identifier (CR ID), the the cpd cr-id command in global configuration mode. To disable the CR ID, use the no form of this command.

cpd cr-id cr id number
no cpd cr-id
Syntax Description

cr id number

Control relationship identifier. The valid range is 1 to 65535.

Command Default

The cr-id is configured as 1.

Command Modes

Global configuration (config)

Command History

Release

Modification

12.3(21a)BC3

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.

Examples

The following example shows the control relationship identifier configured as 236:
Router(config)# cpd cr-id 236
Related Commands

Command

Description

cpd

Enables CPD functionality.

cpe max

To create a DOCSIS configuration file that specifies the maximum number of CPE devices that can use the CM to connect to the cable network, use the cpe max command in cable config-file configuration mode. To remove the CPE specification, use the no form of this command.

cpe max cpe-num
no cpe max
Syntax Description

cpe-num

Specifies the number of CPEs. Valid range is 1 to 254.

Command Default

A maximum of one CPE device can use the CM to connect to the cable network.

Command Modes

Cable config-file configuration (config-file)

Command History

Release

Modification

12.1(2)EC1

This command was introduced.

12.2(4)BC1

Support was added to the Release 12.2 BC train.

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.

Usage Guidelines

The CM enforces the limitation imposed by the cpe max command, but the CMTS might enforce its own lower number of CPE devices. On Cisco CMTS routers, a cpe-num value of 0 enables an unlimited number of hosts, but on some CMs, this value provides only 0 hosts.

Examples

The following example shows how to set the maximum CPE value for the configuration file:
Router(config)# cable config-file channeloverride.cm
Router(config-file)# cpe max 3 
Router(config-file)# exit 
Related Commands

Command

Description

cable config-file

Creates a DOCSIS configuration file and enters configuration file mode.

access-denied

Disables access to the network.

channel-id

Specifies upstream channel ID.

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.

crypto engine accelerator

To enable the router's onboard hardware accelerator for IPSec encryption, use the crypto engine accelerator command in global configuration mode. To disable the use of the onboard hardware IPSec accelerator, and thereby perform IPSec encryption/decryption in software, use the no form of this command.

Cisco uBR905, uBR925 cable access routers

crypto engine accelerator
no crypto engine accelerator
Syntax Description

This command has no arguments or keywords.

Command Default

The hardware accelerator for IPSec encryption is enabled by default.

Command Modes

Global configuration

Command History

Release

Modification

12.1(3)T

This command was introduced for the Cisco 1700 series router and other Cisco routers that support hardware accelerators for IPSec encryption.

12.1(3)XL

Support was added for the Cisco uBR905 cable access router.

12.2(2)XA

Support was added for the Cisco uBR925 cable access router.

Usage Guidelines

This command is not normally needed for typical operations because the router's onboard hardware accelerator for IPSec encryption is enabled by default. The hardware accelerator should not be disabled except on instruction from Cisco TAC personnel.

Examples

The following example shows how to enable the router's onboard hardware accelerator for IPSec encryption. This is normally needed only after the accelerator has been disabled for testing or debugging purposes.
Router# crypto engine accelerator 
Router# 
The following example shows how to disable the router's onboard hardware accelerator. If IPSec encryption is configured, all current connections are brought down. Future encryption is performed by the Cisco IOS software, which has the same functionality as the hardware accelerator, but performance is significantly slower.
Router# no crypto engine accelerator 
 Warning! all current connections will be torn down.
 Do you want to continue? [yes/no]: y 
 ...Crypto accelerator in slot 0 disabled
 ...switching to SW IPSec crypto engine
Router# 
Related Commands

Command

Description

clear crypto engine accelerator counter

Resets the statistical and error counters for the hardware accelerator to zero.

crypto ca

Defines the parameters for the certification authority used for a session.

crypto cisco

Defines the encryption algorithms and other parameters for a session.

crypto dynamic-map

Creates a dynamic map crypto configuration for a session.

crypto ipsec

Defines the IPSec security associations and transformation sets.

crypto isakmp

Enables and defines the IKE protocol and its parameters.

crypto key

Generates and exchanges keys for a cryptographic session.

crypto map

Creates and modifies a crypto map for a session.

debug crypto engine accelerator control

Displays each control command as it is given to the crypto engine.

debug crypto engine accelerator packet

Displays information about each packet sent for encryption and decryption.

show crypto engine accelerator ring

Displays the contents of command and transmit rings for the crypto engine.

show crypto engine accelerator sa-database

Displays the active (in-use) entries in the crypto engine security association (SA) database.

show crypto engine accelerator statistic

Displays the current run-time statistics and error counters for the crypto engine.

show crypto engine brief

Displays a summary of the configuration information for the crypto engine.

show crypto engine configuration

Displays the version and configuration information for the crypto engine.

show crypto engine connections

Displays a list of the current connections maintained by the crypto engine.

crypto ipsec client ezvpn (global)

To create a Cisco Easy VPN Remote configuration and enter the Cisco Easy VPN Remote configuration mode, use the crypto ipsec client ezvpn command in global configuration mode. To delete the Cisco Easy VPN Remote configuration, use the no form of this command.

crypto ipsec client ezvpn name
no crypto ipsec client ezvpn name

Note A separate crypto ipsec client ezvpn command exists in interface configuration mode that assigns a Cisco Easy VPN Remote configuration to the interface.

Syntax Description

name

Identifies the Cisco Easy VPN Remote configuration with a unique, arbitrary name.

Command Default

Newly created Cisco Easy VPN Remote configurations default to client mode.

Command Modes

Global configuration

Command History

Release

Modification

12.2(4)YA

This command was introduced for Cisco 806, Cisco 826, Cisco 827, and Cisco 828 routers; Cisco 1700 series routers; and Cisco uBR905 and Cisco uBR925 cable access routers.

12.2(8)YJ, 12.2(15)T

This command was enhanced to enable you to manually establish and terminate an IPSec VPN tunnel on demand for Cisco 806, Cisco 826, Cisco 827, and Cisco 828 routers; Cisco 1700 series routers; and Cisco uBR905 and Cisco uBR925 cable access routers.

Usage Guidelines

The crypto ipsec client ezvpn command creates a Cisco Easy VPN Remote configuration and then enters the Cisco Easy VPN Remote configuration mode, at which point you can enter the following subcommands:

•connect [auto | manual]—To manually establish and terminate an IPSec VPN tunnel on demand.

–The auto option is the default setting, because it was the initial Phase I functionality. The IPSec Virtual Private Network (VPN) tunnel is automatically connected when the Cisco Easy VPN Remote feature is configured on an interface.

–The manual option specifies the manual setting to direct the Cisco Easy VPN Remote to wait for a command or API call before attempting to establish the Cisco Easy VPN Remote connection. When the tunnel times out or fails, subsequent connections have to wait for the command to reset to manual or an application program interface (API) call.

•default—Sets the following command to its default values.

•exit—Exits the Cisco Easy VPN configuration mode and returns to global configuration mode.

•group group-name key group-key—Specifies the group name and key value for the VPN connection.

•local-address interface-name—To inform the Cisco Easy VPN router which interface is used to determine the public IP address, which is used to source the tunnel. This applies only to the Cisco uBR905 and Cisco uBR925 cable access routers.

–The value of interface-name specifies the interface used for tunnel traffic.

After specifying the local address used to source tunnel traffic, the IP address can be obtained in two ways:

–The local-address subcommand can be used with the cable-modem dhcp-proxy {interface loopback number} command to obtain a public IP address and automatically assign it to the loopback interface.

–The IP address can be manually assigned to the loopback interface.

•mode {client | network-extension}—Specifies the router's VPN mode of operation:

–The client option (default) automatically configures the router for Cisco Easy VPN client mode operation, which uses NAT/PAT address translations. When the Cisco Easy VPN client configuration is assigned to an interface, the router automatically creates the NAT/PAT and access-list configuration needed for the VPN connection.

–The network-extension option specifies that the router should become a remote extension of the enterprise network at the other end of the VPN connection. The PCs that are connected to the router typically are assigned an IP address in the enterprise network's address space.

•no—Removes the command or sets it to its default values.

•peer {ipaddress | hostname}—Sets the peer IP address or hostname for the VPN connection. A hostname can be specified only when the router has a DNS server available for hostname resolution.

Note The Cisco Easy VPN Remote feature attempts to resolve the hostname when the peer command is given, not when the VPN tunnel is created. If the hostname cannot be resolved at that time, the peer command is not accepted.

After configuring the Cisco Easy VPN Remote configuration, use the exit command to exit the Cisco Easy VPN Remote configuration mode and return to global configuration mode.

Note You cannot use the no crypto ipsec client ezvpn command to delete a Cisco Easy VPN Remote configuration that is assigned to an interface. You must remove that Cisco Easy VPN Remote configuration from the interface before you can delete the configuration.

Examples

The following example shows a Cisco Easy VPN Remote configuration named telecommuter-client being created on a Cisco uBR905 or Cisco uBR925 cable access router and being assigned to cable interface 0:
Router# config t 
Router(config)# crypto ipsec client ezvpn telecommuter-client 
Router(config-crypto-ezvpn)# group telecommute-group key secret-telecommute-key 
Router(config-crypto-ezvpn)# peer telecommuter-server 
Router(config-crypto-ezvpn)# mode client 
Router(config-crypto-ezvpn)# exit 
Router(config)# interface c0 
Router(config-if)# crypto ezvpn telecommuter-client 
Router(config-if)# exit 
Router(config)# 
Note Specifying the mode client option as shown above is optional, because this is default configuration for these options.

The following example shows the Cisco Easy VPN Remote configuration named telecommuter-client being removed from the interface and then deleted:
Router# config t 
Router(config)# int e1 
Router(config-if)# no crypto ipsec client ezvpn telecommuter-client 
Router(config-if)# exit 
Router(config)# no crypto ipsec client ezvpn telecommuter-client 
Router(config)# 
Related Commands

Command

Description

clear crypto ipsec client ezvpn

Resets the Cisco Easy VPN Remote state machine and bring down the Cisco Easy VPN Remote connection.

crypto ipsec client ezvpn xauth

Responds to a pending VPN authorization request.

crypto ipsec client ezvpn (interface configuration)

(Interface configuration mode) Assigns a Cisco Easy VPN Remote configuration to an interface.

crypto ipsec client ezvpn connect

Manually connects to a specified IPSec VPN tunnel.

ip http ezvpn

Enables the Cisco Easy VPN Remote web server interface.

crypto ipsec client ezvpn (interface)

To assign a Cisco Easy VPN Remote configuration to an interface, specify whether that interface is outside or inside, and configure multiple outside and inside interfaces, use the crypto ipsec client ezvpn command in interface configuration mode. To remove the Cisco Easy VPN Remote configuration from the interface, use the no form of this command.

crypto ipsec client ezvpn name [outside | inside]
no crypto ipsec client ezvpn name [outside | inside]

Note A separate crypto ipsec client ezvpn command exists in global configuration mode that creates a Cisco Easy VPN Remote configuration.

Syntax Description

name

Specifies the Cisco Easy VPN Remote configuration to be assigned to the interface.

outside

(Optional) Specifies the outside interface of the IPSec client router. This is optional for outside interfaces. You can add up to four outside tunnels, one tunnel per outside interface, for all platforms.

inside

(Optional) Specifies the inside interface of the IPSec client router. The Cisco 1700 series has no default inside interface and any inside interface must be configured. The Cisco 800 series routers, and Cisco uBR905 and Cisco uBR925 cable access routers have default inside interfaces. However, you can configure any inside interface. You can add up to three inside interfaces for all platforms.

Command Default

The default inside interface is the Ethernet interface on Cisco 800 series routers and Cisco uBR905 and Cisco uBR925 cable access routers.

Command Modes

Interface configuration

Command History

Release

Modification

12.2(4)YA

This command was introduced on Cisco 806, Cisco 826, Cisco 827, and Cisco 828 routers; Cisco 1700 series routers; and Cisco uBR905 and Cisco uBR925 cable access routers.

12.2(8)YJ, 12.2(15)T

This command was enhanced to enable you to configure multiple outside and inside interfaces for Cisco 806, Cisco 826, Cisco 827, and Cisco 828 routers; Cisco 1700 series routers; and Cisco uBR905 and Cisco uBR925 cable access routers.

Usage Guidelines

The crypto ipsec client ezvpn command assigns a Cisco Easy VPN Remote configuration to an interface, enabling the creation of a virtual private network (VPN) connection over that interface to the specified VPN peer. If the Cisco Easy VPN Remote configuration is configured for the client mode of operation, this also automatically configures the router for network address translation (NAT)/port address translation (PAT) and an associated access list.

Cisco IOS Release 12.2(8)YJ and Cisco IOS Release 12.2(15)T enhanced the command to allow you to configure multiple outside and inside interfaces. To configure multiple outside and inside interfaces, you must use the interface interface-name command to first define type of interface on the IPSec client router.

•In client mode for the Cisco Easy VPN Remote feature, a single security association (SA) connection is used for encrypting and decrypting the traffic coming from all the inside interfaces. In network extension mode, one SA connection is established for each inside interface.

•When a new inside interface is added or an existing one is removed, all established security association (SA) connections are deleted and new ones are initiated.

•Configuration information for the default inside interface is shown with the crypto ipsec client ezvpn name inside command. All inside interfaces, whether they belong to a tunnel, are listed in interface configuration mode, as an inside interface, along with the tunnel name.

The following Cisco IOS Release 12.2(4)YA restrictions apply to the crypto ipsec client ezvpn command:

•In Cisco IOS Release 12.2(4)YA, the Cisco Easy VPN Remote feature supports only one tunnel, so the crypto ipsec client ezvpn command can be assigned to only one interface. If you attempt to assign it to more than one interface, an error message is displayed. You must use the no form of this command to remove the configuration from the first interface before assigning it to the second interface.

•The crypto ipsec client ezvpn command should be assigned to the outside interface of the NAT/PAT translation. This command cannot be used on the inside NAT/PAT interface. On some platforms, the inside and outside interfaces are fixed.

For example, on Cisco uBR905 and Cisco uBR925 cable access routers, the outside interface is always the cable interface. On Cisco 1700 series routers, the Fast Ethernet interface defaults to being the inside interface, so attempting to use the crypto ipsec client ezvpn command on the Fast Ethernet interface displays an error message.

Note You must first use the global configuration version of the crypto ipsec client ezvpn command to create a Cisco Easy VPN Remote configuration before assigning it to an interface.

Examples

The following example shows a Cisco Easy VPN Remote configuration named telecommuter-client being assigned to the cable interface on a Cisco uBR905/uBR925 cable access router:
Router# config t 
Router(config)# interface c0 
Router(config-if)# crypto ipsec client ezvpn telecommuter-client 
Router(config-if)# exit 
Router(config)# 
The following example first shows an attempt to delete the Cisco Easy VPN Remote configuration named telecommuter-client, but the configuration cannot be deleted because it is still assigned to an interface. The configuration is then removed from the interface and then deleted:
Router# config t 
Router(config)# no crypto ipsec client ezvpn telecommuter-client 
Error: crypto map in use by interface; cannot delete
Router(config)# int e1 
Router(config-if)# no crypto ipsec client ezvpn telecommuter-client 
Router(config-if)# exit 
Router(config)# no crypto ipsec client ezvpn telecommuter-client 
Router(config)# 
Related Commands

Command

Description

clear crypto ipsec client ezvpn

Resets the Cisco Easy VPN Remote state machine and bring down the Cisco Easy VPN Remote connection.

crypto ipsec client ezvpn xauth

Responds to a pending VPN authorization request.

crypto ipsec client ezvpn (global configuration)

(Global configuration mode) Creates a Cisco Easy VPN Remote configuration.

crypto ipsec client ezvpn connect

Manually connects to a specified IPSec VPN tunnel.

ip http ezvpn

Enables the Cisco Easy VPN Remote web server interface.

crypto ipsec client ezvpn connect

To connect to a specified IPSec VPN tunnel in a manual configuration, use the crypto ipsec client ezvpn connect command in privileged EXEC mode. To disconnect the VPN tunnel, use the no form of this command.

crypto ipsec client ezvpn connect name
no crypto ipsec client ezvpn connect name
Syntax Description

name

Identifies the IPSec VPN tunnel with a unique, arbitrary name.

Command Default

No default behavior or values

Command Modes

Privileged EXEC

Command History

Release

Modification

12.2(8)YJ, 12.2(15)T

This command was introduced on Cisco 806, Cisco 826, Cisco 827, and Cisco 828 routers; Cisco 1700 series routers; and Cisco uBR905 and Cisco uBR925 cable access routers.

Usage Guidelines

This command is used with the connect [auto | manual] subcommand. After the manual setting is designated, the Cisco Easy VPN Remote feature waits for a command or API call before attempting to establish the Cisco Easy VPN Remote connection.

If the configuration is manual, then the tunnel is connected only after the crypto ipsec client ezvpn connect name command is entered in privileged EXEC mode, and after the connect [auto] | manual subcommand is entered.

Examples

The following example shows how to connect an IPSec VPN tunnel named ISP-tunnel on a Cisco uBR905/uBR925 cable access router:
Router# crypto ipsec client ezvpn connect ISP-tunnel 
Related Commands

Command

Description

clear crypto ipsec client ezvpn

Resets the Cisco Easy VPN Remote state machine and bring down the Cisco Easy VPN Remote connection.

crypto ipsec client ezvpn xauth

Responds to a pending VPN authorization request.

crypto ipsec client ezvpn (global configuration)

(Global configuration mode) Creates a Cisco Easy VPN Remote configuration.

crypto ipsec client ezvpn (interface configuration)

(Interface configuration mode) Assigns a Cisco Easy VPN Remote configuration to an interface.

ip http ezvpn

Enables the Cisco Easy VPN Remote web server interface.

crypto ipsec client ezvpn xauth

To respond to a pending VPN authorization request, use the crypto ipsec client ezvpn xauth command in privileged EXEC mode.

crypto ipsec client ezvpn xauth name
Syntax Description

name

Identifies the IPSec VPN tunnel with a unique, arbitrary name.

Command Default

No default behavior or values

Command Modes

Privileged EXEC

Command History

Release

Modification

12.2(4)YA

This command was introduced on Cisco 806, Cisco 826, Cisco 827, and Cisco 828 routers; Cisco 1700 series routers; and Cisco uBR905 and Cisco uBR925 cable access routers.

12.2(8)YJ, 12.2(15)T

The name option was added as a required argument to specify a specific IPSec VPN tunnel.

Usage Guidelines

If the tunnel name is not specified, the authorization request is made on the active tunnel. If there is more than one active tunnel, the command fails with an error requesting that you specify the tunnel name.

When making a VPN connection, individual users might also be required to provide authorization information, such as a username or password. When the remote end requires this information, the router displays a message on the router's console instructing the user to enter the crypto ipsec client ezvpn xauth command. The user then uses the CLI to give this command and reply to the following prompts to provide the required information.

Note If the user does not respond to the Authentication notification, the message is repeated every ten seconds.

Examples

The following example shows the user being prompted to enter the crypto ipsec client ezvpn xauth command. The user then enters the requested information and continues.
Router# 
20:27:39: EZVPN: Pending XAuth Request, Please enter the following command:
20:27:39: EZVPN: crypto ipsec client ezvpn xauth
Router# crypto ipsec client ezvpn xauth 
Enter Username and Password: userid 
Password: ************
Router# 
Related Commands

Command

Description

clear crypto ipsec client ezvpn

Resets the Cisco Easy VPN Remote state machine and bring down the Cisco Easy VPN Remote connection.

crypto ipsec client ezvpn (global configuration)

(Global configuration mode) Creates a Cisco Easy VPN Remote configuration.

crypto ipsec client ezvpn (interface configuration)

(Interface configuration mode) Assigns a Cisco Easy VPN Remote configuration to an interface.

crypto ipsec client ezvpn connect

Manually connects to a specified IPSec VPN tunnel.

ip http ezvpn

Enables the Cisco Easy VPN Remote web server interface.

Table Of Contents

Cable Commands: ca through cr

card

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

Examples

Related Commands

channel-group

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Examples

Related Commands

channel-id (cable configuration file)

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Examples

Related Commands

clear cable admission control counters

Command Default

Command Modes

Command History

Usage Guidelines

Examples

Related Commands

clear cable arp-filter

Syntax Descriptionclear cable arp-filter {bundle number cable slot/port |slot/subslot/port

Command Default

Command Modes

Command History

Usage Guidelines

Examples

Related Commands

clear cable dsg

Syntax Description

Command Modes

Command History

Usage Guidelines

Examples

Related Commands

clear cable flap-list

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

Examples

Related Commands

clear cable hop

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

Examples

Related Commands

clear cable host

Syntax Description

Command Default

Command Modes

Command History

Usage Guidelines

Examples

Related Commands

clear cable load-balance

Syntax Description

Command Default

Command Modes

Command History

Examples

Related Commands

clear cable logging