Cisco IOS CMTS Cable Command Reference
Cable Commands: d through h

Table Of Contents

Cable Commands: d through h

description (cable fiber-node)

docsis cvc mfg

docsis cvc mso

docsis cvc test

download

downstream cable

downstream local upstream

downstream modular-cable rf-channel (interface)

downstream modular-cable rf-channel

dtmf-relay

duration

enabled (enforce-rule)

enforced qos-profile

exception pxf

facility-alarm (ubr10012)

flowcontrol

h323-gateway voip bind srcaddr

hccp authentication

hccp authentication key-chain

hccp bypass version

hccp channel-switch

hccp check version

hccp ds-switch

hccp lockout

hccp protect

hccp resync

hccp revertive

hccp reverttime

hccp switch

hccp timers

hccp track

hccp unlockout

hccp working

hold-queue

hw-module bay reload

hw-module sec-cpu reset

hw-module shutdown (ubr10012)

hw-module slot pos

hw-module slot srp


Cable Commands: d through h


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

New Commands

Command
Cisco IOS Software Release

downstream local upstream

12.3(23)BC

downstream modular-cable rf-channel (interface)

12.3(23)BC


Modified Commands

Command
Cisco IOS Software Release

downstream local upstream

12.2(33)SCB

downstream modular-cable rf-channel

12.2(33)SCB

downstream modular-cable rf-channel (interface)

12.2(33)SCB

flowcontrol

12.2(33)SCB

hold-queue

12.2(33)SCB

hw-module bay reload

12.2(33)SCB


Replaced Commands

The following commands have been replaced by new commands beginning in the following Cisco IOS software releases:

Command
Replacement Command
Beginning Cisco IOS Release

enforced qos-profile

qos-profile enforced

12.3(9a)BC


description (cable fiber-node)

To specify a description for a fiber node, use the description command in cable fiber-node configuration mode. To remove a description for a fiber node, use the no form of this command.

description description

no description

Syntax Description

description

Specifies a description for the cable fiber node. The character-string can be up to 80 characters long.


Command Default

If the description command is not issued, a description does not exist.

Command Modes

Cable fiber-node configuration (config-fiber-node)

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.


Usage Guidelines

The description command adds a comment to the configuration to provide information about the fiber node.

Examples

The following example shows how to specify a description for fiber node 5:

Router# configure terminal 
Router(config)# cable fiber-node 5 
Router(config-fiber-node)# description Branch office 5 

Related Commands

Command
Description

cable fiber-node

Enters cable fiber-node configuration mode to configure a fiber node.

downstream cable

Assigns a primary downstream channel for a fiber node.

downstream modular-cable rf-channel

Specifies the RF channels that are available for wideband channels on a fiber node.

upstream cable connector

Specifies the upstream channel ports for a fiber node.


docsis cvc mfg

To configure the access start times and organization name for the manufacturer's code verification certificate (CVC) to enable the DOCSIS 1.1 secure software download feature on the router, use the docsis cvc mfg command in global configuration mode. To delete this information, use the no form of this command.

Cisco uBR905 and Cisco uBR925 cable access routers, and Cisco CVA122 Cable Voice Adapter

docsis cvc mfg {codeAccessStart start-time | cvcAccessStart start-time | organization name}

no docsis cvc mfg {codeAccessStart start-time | cvcAccessStart start-time | organization name}

Syntax Description

codeAccessStart start-time

Specifies the code Access Start Time as a UTC time value (YYMMDDhhmmssZ) in Greenwich Mean Time.

cvcAccessStart start-time

Specifies the CVC Access Start Time as a UTC time value (YYMMDDhhmmssZ) in Greenwich Mean Time.

organization name

Specifies the name of the manufacturer of the code file. Use quotes if the name value contains more than one word.


Command Default

The codeAccessStart and cvcAccessStart times default to 011219000000Z (midnight on December 19, 2001 Greenwich Mean Time). The organization defaults to Cisco Systems.


Note Typically, the default values should not be changed unless you are instructed to do so by Cisco TAC or field service engineers.


Command Modes

Global configuration

Command History

Release
Modification

12.2(15)CZ

This command was introduced on the Cisco uBR905 and Cisco uBR925 cable access routers, and the Cisco CVA122 Cable Voice Adapter.


Usage Guidelines

This command configures the access start times and organization name that are required by Appendix D in the DOCSIS BPI+ specification. The time values are specified as UTC time values in Greenwich Mean Time, with a two-digit year. If the year is between 50 and 99, it is interpreted as 1950 to 1999. If the year is between 00 and 49, it is interpreted as 2000 to 2049.

The router uses the codeAccessStart value to verify the Code Verification Signature (CVS) that is affixed to the code file downloaded using the secure software download feature. The router uses the ccvAccessStart value to verify the CVC for the code file. The router also uses the organization value to verify that the code file has been created by the proper manufacturer.


Tip These values are the same that are set using the docsBpi2CodeMfgCodeAccessStart, docsBpi2CodeMfgCvcAccessStart, and docsBpi2CodeMfgOrgName attributes in the BPI+ MIB (DOCS-BPI2-MIB).


Examples

The following example shows the default configuration for the docsis cvc mfg commands:

Router(config)# docsis cvc mfg organization "Cisco Systems" 
Router(config)# docsis cvc mfg codeAccessStart 011219000000Z 
Router(config)# docsis cvc mfg cvcAccessStart 011219000000Z 
Router(config)# 

Note You must set the organization name using the docsis cvc mfg organization command before you can set either access start time.


Related Commands

Command
Description

docsis cvc mso

Configures the access start times and organization name for the optional MSO cosigned code verification certificate (CVC).

docsis cvc test

Tests the root CA public key and CM private key that are installed on the router.


docsis cvc mso

To configure the access start times and organization name for the optional Multi-Service Operator (MSO) cosigned code verification certificate (CVC) for the DOCSIS 1.1 secure software download feature, use the docsis cvc mso command in global configuration mode. To delete the information, use the no form of this command.

Cisco uBR905 and Cisco uBR925 cable access routers, and Cisco CVA122 Cable Voice Adapter

docsis cvc mso {codeAccessStart start-time | cvcAccessStart start-time | organization name}

no docsis cvc mso {codeAccessStart start-time | cvcAccessStart start-time | organization name}

Syntax Description

codeAccessStart start-time

Specifies the code Access Start Time as a UTC time value (YYMMDDhhmmssZ) in Greenwich Mean Time.

cvcAccessStart start-time

Specifies the CVC Access Start Time as a UTC time value (YYMMDDhhmmssZ) in Greenwich Mean Time.

organization name

Specifies the name of the manufacturer of the code file. Use quotes if the name value contains more than one word.


Command Default

No default values or behavior (no cosigner is used).

Command Modes

Global configuration

Command History

Release
Modification

12.2(15)CZ

This command was introduced on the Cisco uBR905 and Cisco uBR925 cable access routers, and the Cisco CVA122 Cable Voice Adapter.


Usage Guidelines

This command configures the optional cosigner access start times and organization name that are specified by Appendix D in the DOCSIS BPI+ specification. The time values are specified as UTC time values in Greenwich Mean Time, with a two-digit year. If the year is between 50 and 99, it is interpreted as 1950 to 1999. If the year is between 00 and 49, it is interpreted as 2000 to 2049.

You do not need to use this command unless the MSO or service provider is digitally signing the Cisco IOS software images that it plans to download to the Cisco cable modems. If so, then this command must be used to set the appropriate access times and organization name, so that the cable modem can properly authenticate the software images during a secure software download.

The router uses the codeAccessStart value to verify the cosigner's Code Verification Signature (CVS) that is affixed to the code file downloaded using the secure software download feature. The router uses the ccvAccessStart value to verify the cosigner's CVC that is affixed to the code file. The router also uses the organization value to verify that the code file has been signed by the proper MSO or cable operator.


Tip These values are the same that are set using the docsdocsBpi2CodeCoSignerCodeAccessStart, Bpi2CodeCoSignerCvcAccessStart, and docsBpi2CodeCoSignerOrgName attributes in the BPI+ MIB (DOCS-BPI2-MIB).


Examples

The following example shows the docsis cvc mso commands being used to configure the router for a cosigned CVC from an organization named "MSO Organization" and with certificate access times of midnight on March 1, 2002 Greenwich Mean Time:

Router(config)# docsis cvc mfg organization "MSO Organization" 
Router(config)# docsis cvc mfg codeAccessStart 020301000000Z 
Router(config)# docsis cvc mfg cvcAccessStart 020301000000Z 
Router(config)# 

Note You must set the organization name using the docsis cvc mso organization command before you can set either access start time.


Related Commands

Command
Description

docsis cvc mfg

Configures the access start times and organization name for the manufacturer's code verification certificate (CVC).

docsis cvc test

Tests the root CA public key and CM private key that are installed on the router.


docsis cvc test

To test the root CA public key and CM private key that are installed on the router, use the docsis cvc test command in global configuration mode.

Cisco uBR905 and Cisco uBR925 cable access routers, and Cisco CVA122 Cable Voice Adapter

docsis cvc test

Syntax Description

This command has no arguments or keywords.

Command Default

No default behavior or values.

Command Modes

Global configuration

Command History

Release
Modification

12.2(15)CZ

This command was introduced on the Cisco uBR905 and Cisco uBR925 cable access routers, and the Cisco CVA122 Cable Voice Adapter.


Usage Guidelines

This command verifies that the root CA public key and the private key that are installed in the router at the factory are valid. The command uses the root CA public key to encrypt a string, and then it uses the router's private key to decrypt the key.

Typically, the root CA public key and private key are installed at the factory and never need to be updated. However, DOCSIS allows the keys to be updated as part of the secure software download procedure. If this occurs, you can use the docsis cvc test command to verify that the keys are valid and are properly installed.

Examples

The following example shows a typical successful result of the docsis cvc test command:

Router# config terminal 
Router(config)# docsis cvc test 
Encrypted sting: This is a test
Encrypt result: xxxxxxxxxxxxxxxxxxxxxxxxxxx 

Decrypt result: This is a test 
Router(config)# 


Note If the decrypt result is not "This is a test," then the test failed, which indicates that either the public key or the private key is not valid.


Related Commands

Command
Description

docsis cvc mfg

Configures the manufacturer's CVC access start time and organization values.

docsis cvc mso

Configures the MSO cosigned CVC access start time and organization values.


download

To create a DOCSIS configuration file that instructs the CM to download a new software image, use the download command in cable config-file configuration mode. To disable the specification, use the no form of this command.

download {image filename [oui oui-list] | server ip-address}

no download {image filename [oui oui-list] | server ip-address}


Note Because of conflicts with other Cisco IOS commands, you cannot abbreviate the no form of this command. You must specify the complete command name and option, such as no download image or no download server.


Syntax Description

image filename

Specifies to download an image file.

oui oui-list

Specifies the list of Organizational Unique Identifiers (OUIs), up to a maximum of 8. (An OUI is the first 3 octets of the CM MAC address and typically indicates the vendor for the CM.)

Tip The Institute of Electrical and Electronics Engineers (IEEE) is the official issuer of OUI values. The IEEE OUI web site is at http://standards.ieee.org/regauth/oui/index.shtml.

server ip-address

Specifies the TFTP server IP address. If no IP address is specified, the CM defaults to using the same TFTP server that provided the configuration file.


Command Default

The CM does not download a new software image.

Command Modes

Cable config-file configuration

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.


Usage Guidelines

This command sets the Software Upgrade Filename and Software Upgrade TFTP Server fields in the DOCSIS configuration file. The DOCSIS specification allows the DOCSIS configuration file to specify that the CM must be running a particular software image. If the CM is not currently using that image, it must then download the image before continuing the registration process. For security, performance, and scalability reasons, a particular TFTP server can be specified from which the CM must download the new software image.

The filename specified by download image command must be a fully qualified file and pathname that exactly matches the file and pathname as they exist on the TFTP download server. For example, if the software image is named ubr920-k1v4y556i-mz and is in a subdirectory named cisco_cms on the TFTP server, the filename specified with this command should be cisco_cms/ubr920-k1v4y556i-mz.

If the oui-list parameter is specified, the download image filename is provided only to the CMs that contain those particular OUIs. This helps ensure that the CM does not download a software image that is intended for another vendor's CMs.


Note For each configuration file, multiple download images can be specified. Because each filename can be listed only once, entering a different list of OUIs for a single filename clears the old list. To support more than eight OUIs with the same file, use a different download software image name, and create a duplicate file or alias on the TFTP server.


The download server command is not required. If it is not specified, the CM uses the same server that provided its DOCSIS configuration file. However, the download server command requires that the image filename also be specified using the download image command.

Examples

The following command shows how to setup a DOCSIS configuration file so that the cable modem will upgrade its software image:

Router(config)# cable config-file upgrade.cm
Router(config-file)# download image ubr920-k1v4y556i-mz.121-3a.T1 oui 00.50.73 00.D0.BA 
00.D0.58 00.01.96 
Router(config-file)# download server 10.15.24.33 
Router(config-file)# exit 
Router(config)# 

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.

cpe max

Specifies CPE information.

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.


downstream cable

To assign a primary downstream channel for a fiber node, use the downstream cable command in cable fiber-node configuration mode. To remove a primary downstream channel for a fiber node, use the no form of the command.

downstream cable slot/subslot/port

no downstream cable slot/subslot/port

Syntax Description

slot

The slot used for the cable interface line card. Valid values are 5 to 8.

subslot

The subslot used for the cable interface line card. Valid values are 0 or 1.

port

The downstream port that can be used as a primary downstream channel. Valid values are 0 to 4.


Command Default

If the downstream cable command is not issued, no primary downstream channel is assigned to the fiber node.

Command Modes

Cable fiber-node configuration

Command History

Release
Modification

12.3(21)BC

This command was introduced for the uBR10012 router.

12.2(33)SCA

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


Usage Guidelines

For each fiber node, a traditional DOCSIS downstream channel is used to carry MAC management and signaling messages, and the associated traditional DOCSIS upstream channel is used for return data traffic and signaling. The traditional DOCSIS downstream channel used in this way is called the primary downstream channel.

The downstream cable command assigns a primary downstream channel for a fiber node. Each fiber node must be assigned at least one primary downstream channel and can be assigned multiple primary downstream channels. Cisco IOS software decides which primary downstream channel to use for the fiber node from the set of channels assigned with downstream cable. Assigning more than one primary channel to a fiber node with the downstream cable command can be useful for load-balancing purposes.


Note If the primary downstream channel for the fiber node is assigned from a SPA downstream, then the downstream cable command is not required.


If a wideband-capable modem registers as a traditional DOCSIS 2.0 modem, it will register on a downstream channel as follows:

If the modem's fiber node has been assigned a primary downstream channel with the downstream cable command, the modem registers on that downstream channel.

If the modem's fiber node has not been assigned a primary downstream channel with the downstream cable command, the modem can register on any downstream channel that is visible to it.

For more information on using this command, refer to the Cisco uBR10012 Universal Broadband Router SIP and SPA Software Configuration Guide.

Examples

The following example shows how to assign a primary downstream channel for fiber node 5. The primary downstream channel is the downstream port located on the cable interface line card at slot/subslot/port 6/0/0.

Router# configure terminal 
Router(config)# cable fiber-node 5 
Router(config-fiber-node)# downstream cable 6/0/0 

Related Commands

Command
Description

cable fiber-node

Enters cable fiber-node configuration mode so that you can configure a fiber node.

description (cable fiber-node)

Specifies a description for a fiber node.

downstream modular-cable rf-channel

Specifies the RF channels that are available for wideband channels on a fiber node.

upstream cable connector

Specifies the upstream channel ports for a fiber node.


downstream local upstream

To restrict the set of Cisco uBR10-MC5X20 upstreams associated with the Cisco uBR10-MC5X20 downstreams, use the downstream local upstream command in interface configuration mode.

downstream local upstream grouplist

Syntax Description

grouplist

Specifies the number of upstreams associated with the
Cisco uBR10-MC5X20 downstream channels.


Command Default

All upstreams under the cable interface are associated with the Cisco uBR10-MC5X20 downstreams.

Command Modes

Interface configuration mode (config-if)

Command History

Release
Modification

12.3(23)BC

This command was introduced for the Cisco uBR10012 router.

12.2(33)SCB

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


Usage Guidelines

Use this command to restrict a set of Cisco uBR10-MC5X20 upstreams to Cisco uBR10-MC5X20 downstreams. This restricts MAC management messages (MMM) to be sent to the specified upstreams only.

Examples

The following example shows how the downstream local upstream command is used in the
Cisco uBR10012 router.

Router# configure terminal
Router (config)# interface cable 5/1/0	
Router(config-if)# downstream local upstream 0-1

Related Commands

Command
Description

downstream cable

Assigns a primary downstream channel for a fiber node.


downstream modular-cable rf-channel (interface)

To specify association of a set of Cisco uBR10-MC5X20 upstreams with individual modular downstream channels from the SPA into a given cable MAC domain, use the downstream modular-cable rf-channel command in interface configuration mode.

Cisco IOS Release 12.3(23)BC

downstream modular-cable slot/subslot/bay rf-channel rf channels [upstream grouplist]

Cisco IOS Release 12.2(33)SCB

downstream modular-cable slot/bay/port rf-channel rf channels [upstream grouplist]

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.

rf-channel

Specifies the association of a continuous range of RF channels within the SPA downstream.

rf channels

Range of RF channel physical ports on the SPA FPGA.

upstream

Specifies a set of ranges of upstream to allow association of a noncontiguous list of upstreams to one or more SPA downstreams.

grouplist

Specifies the number of upstreams with the modular cable downstream channel.


Command Default

No default upstream channels are configured with the modular downstream channels.

Command Modes

Interface configuration (config-if)

Command History

Release
Modification

12.3(23)BC

This command was introduced for the Cisco uBR10012 router.

12.2(33)SCB

This command was integrated into Cisco IOS Release 12.2(33)SCB. This command was modified to change the addressing format for the modular cable interface from slot/subslot/bay to slot/bay/port.


Usage Guidelines

Use this command to create primary-capable channels by associating a single or a set of
Cisco uBR10-MC 5X20 upstream channels with individual modular downstream channels on a fiber node. When a primary-capable channel is created, the same modular downstream channel cannot be used as a primary-capable channel in another MAC domain. However, it can be used as non-primary-capable channel in another MAC domain.

Examples

The following example shows how the downstream modular-cable rf-channel command is used in the Cisco uBR10012 router.

Router# configure terminal
Router (config)# interface cable 5/1/0	
Router(config-if)# downstream modular-cable 1/0/0 rf-channel 0-2  upstream 0-1 4-5

Related Commands

Command
Description

downstream modular-cable rf-channel

Specifies the RF channels that are available for wideband channels on a fiber node.

rf-channel cable downsteam channel-id

Assigns a downstream channel ID toan RF channel.


downstream modular-cable rf-channel

To specify the RF channels that are available for wideband channels on a fiber node, use the downstream modular-cable rf-channel command in cable fiber-node configuration mode. To remove RF channels that are available for wideband channels on a fiber node, use the no form of this command.

Cisco IOS Release 12.3(23)BC

downstream modular-cable slot/subslot/bay rf-channel {rf-port | low-high}

no downstream modular-cable slot/subslot/bay rf-channel {rf-port | low-high}

Cisco IOS Release 12.2(33)SCB

downstream modular-cable slot/bay/port rf-channel {rf-port | low-high}

no downstream modular-cable slot/bay/port rf-channel {rf-port | low-high}

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.

rf-port

Specifies the RF channel physical port on the Wideband SPA FPGA. Valid values for rf-port depend on the configuration set with the annex modulation command.

low-high

A range of RF channel physical ports on the Wideband SPA FPGA. The low and high values are separated by a hyphen.


Command Default

If the downstream modular-cable rf-channel command is not issued, no RF channels are configured for wideband channels on the fiber node.

Command Modes

Cable fiber-node configuration (fiber-node)

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 interface from slot/subslot/bay to slot/bay/port.


Usage Guidelines

The downstream modular-cable rf-channel command makes RF channels available for use on a fiber node. Fiber node software configuration mirrors the physical topology of the cable network. The cable rf-channel command configures the RF channels that will be used for a wideband channel on a Wideband SPA.

The Cisco uBR10012 router supports two Wideband SPAs. Each Wideband SPA supports up to 24 RF channels depending on how the SPA is configured with the annex modulation command.


Note Effective with Cisco IOS Release 12.3(23)BC, the annex modulation command is obsolete and annex and modulation are included as keyword options in the rf-channel frequency command.


For annex A and 256 QAM, each Wideband SPA supports 18 RF channels. In this case, valid values for the rf-port argument are 0 to 17.

For all other cases, the SPA supports 24 RF channels. In these cases, valid values for the rf-port argument are 0 to 23.

A fiber node can be configured to have RF channels from one or both Wideband SPAs. However, a wideband channel cannot be comprised of RF channels from two different SPAs.

Each time the downstream modular-cable rf-channel command is issued for a fiber node, the set of RF channels that are available for use on that fiber node is added to in a cumulative manner. For example, if the following downstream modular-cable rf-channel commands were issued, the set of RF channels available for fiber node 1 is RF channels 0 to 10 on the Wideband SPA in slot/subslot/bay 1/0/0.

Router# configure terminal 
Router(config)# cable fiber-node 1 
Router(config-fiber-node)# downstream modular-cable 1/0/0 rf-channel 0-5 
Router(config-fiber-node)# downstream modular-cable 1/0/0 rf-channel 6-10 

Examples

The following example shows how to specify that RF channels 0 to 7 on a Wideband SPA will be available for use on fiber node 5. The Wideband SPA is located in slot/subslot/bay 1/0/0.

Router# configure terminal 
Router(config)# cable fiber-node 5 
Router(config-fiber-node)# downstream modular-cable 1/0/0 rf-channel 0-7 

Related Commands

Command
Description

cable fiber-node

Enters cable fiber-node configuration mode to configure a fiber node.

description (cable fiber-node)

Specifies a description for a fiber node.

downstream cable

Assigns a primary downstream channel for a fiber node.

upstream cable connector

Specifies the upstream channel ports for a fiber node.


dtmf-relay

To configure the router so it transmits Dual-Tone Multifrequency (DTMF) tones as out-of-band signals during H.323 voice calls, use the dtmf-relay command in dial-peer voice configuration mode. To return to the default configuration of transmitting DTMF tones as part of the voice traffic, use the no form of this command.

Cisco uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter

dtmf-relay [cisco-rtp] [h245-alphanumeric] [h245-signal]

no dtmf-relay

Syntax Description

cisco-rtp

(Optional) Forwards DTMF tones using the Real-Time Transport Protocol (RTP) with a Cisco proprietary payload type.

Note RTP is a proprietary Cisco protocol that interoperates only between two Cisco access servers or routers running Cisco IOS images that support the RTP protocol. The RTP protocol typically requires Cisco IOS 12.0(5)T or later releases; see the router's release notes for complete information.

h245-alphanumeric

(Optional) Forwards DTMF tones using the H.245 Alphanumeric User Input Indication method. This option transmits each tone using a fixed duration of 500 milliseconds. Supports tones 0-9, *, #, and A-D.

h245-signal

(Optional) Forwards DTMF tones using the H.245 Signal User Input Indication method. This option transmits each tone using the original duration and supports tones 0-9, *, #, and A-D.


Defaults

By default, DTMF tones are transmitted inband, as part of the voice traffic.

Command Modes

Dial-peer voice configuration mode

Command History

Release
Modification

11.3(2)NA

This command was introduced on the Cisco AS5300 universal access server.

12.0(2)XH

The cisco-rtp, h245-alphanumeric, and h245-signal keywords were added.

12.0(5)T

This command was integrated into Cisco IOS Release 12.0(5)T.

12.0(7)XK and 12.1(2)T

Support was added for the MC3810 multiservice concentrator.

12.0(7)XR and 12.1(1)T

Support was added for the Cisco uBR924 cable access router.

12.1(5)XU1

Support was added for the Cisco CVA122 Cable Voice Adapter.

12.2(2)XA

Support was added for the Cisco uBR925 cable access router.


Usage Guidelines

DTMF tones are generated when you press the keypad digits on a touch-tone phone. DTMF tones are most commonly used to dial calls, but they can also be used during a call to interact with an Interactive Voice Response (IVR) system, such as voicemail, automated banking services and so on. By default, DTMF tones are transmitted along with the regular voice traffic, but this can cause problems with some IVR systems.

In particular, IVR systems might not recognize DTMF tones when using highly compressed CODECs such as G.729a. These CODECs are highly optimized for voice frequencies, but they can distort DTMF tones, preventing IVR systems from recognizing the tones. To avoid this problem, use one or more of the following methods of transmitting DTMF tones in an out-of-band channel, separately from the voice traffic:

Cisco RTP—This option transmits the DTMF tones using a proprietary encoding that allows them to use the same RTP channel as the voice traffic. This method accurately transports DTMF tones but requires the use of Cisco gateways at both the originating and terminating endpoints of the H.323 call.

H.245 Alphanumeric—This option transmits DTMF tones through a separate H.245 signaling channel using H.245 User Input Indication messages. Tones are transmitted as alphanumeric digits with a fixed duration of 500 milliseconds. This method is required for all H.323v2 compliant systems.

H.245 Signal—This option transmits DTMF tones through a separate H.245 signaling channel using H.245 User Input Indication messages. This method preserves both the tone information and the original duration of the tone, which allows the caller to use services that require you to press a key for a particular length of time. For example, a popular calling card feature allows you to break out of an existing call by pressing the pound (#) key for more than two seconds and then make a second call without having to hang up in between.

You can enable more than one DTMF relay option for a particular dial peer to support multiple destinations that might use different methods. If you enable more than one option, and if the peer is capable of receiving DTMF in more than one of these formats, the router selects the DTMF format with the highest priority:

1. Cisco RTP (highest priority)

2. H.245 Signal

3. H.245 Alphanumeric

4. None—DTMF is sent inband

Examples

The following example shows how to configure an outgoing dial peer so that DTMF tones to that destination are transmitted using the Cisco RTP protocol, if it is supported by the remote end; otherwise, the DTMF tones are transmitted using the H.245 signaling protocol.

Router(config)# dial-peer voice 100 voip 
Router(config-dial-peer)# destination-pattern 555-1212 
Router(config-dial-peer)# session target ipv4:192.168.100.110 
Router(config-dial-peer)# dtmf-relay cisco-rtp h245-signal 
Router(config-dial-peer)# exit 

The following example shows how to reconfigure the above dial peer and disables out-of-band DTMF signaling, so that the DTMF tones are sent inband, as part of the voice traffic:

Router(config)# dial-peer voice 100 voip 
Router(config-dial-peer)# no dtmf-relay 
Router(config-dial-peer)# exit 

Related Commands

Command
Description

codec

Specifies the voice coder rate of speech for a dial peer.

dial-peer

Enters dial peer voice configuration mode.


duration

To specify the time period and sample rate to be used for monitoring subscribers, use the duration command in enforce-rule configuration mode. To reset an enforce-rule to its default values, use the no form of this command.

duration minutes avg-rate rate sample-interval minutes {upstream | downstream} [enforce]

no duration

Syntax Description

minutes

Specifies the size of the sliding window (in minutes) during which subscriber usage is monitored. The valid range is 10 to 44640 with a default of 360 (6 hours).

avg-rate rate

Specifies the average sampling rate in kilobits per second for the specified duration. The valid range is 1 to 400000 with no default.

sample-interval minutes

Specifies how often (in minutes) the CMTS router should sample a service flow to get an estimate of subscriber usage. The valid range is 1 to 30, with a default value of 15.

upstream

Specifies monitoring of traffic in the upstream direction.

downstream

Specifies monitoring of traffic in the downstream direction.

enforce

(Optional) Specifies that the enforce-rule QoS profile should be applied automatically if a user violates their registered QoS profile.


Command Default

The duration value defaults to 360 minutes (6 hours), and the sample-interval value defaults to 15 minutes.

Command Modes

Enforce-rule configuration (enforce-rule)

Command History

Release
Modification

12.3(9a)BC

This command is introduced. This command replaces the monitoring-duration command.

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 enable an enforce-rule, the CMTS router periodically checks the bandwidth being used by subscribers to determine whether any subscribers are consuming more bandwidth than that specified by their registered QoS profile. The CMTS router keeps track of the subscribers using a sliding window that begins at each sample interval and continues for the duration period and average rate.

For example, with the default sample interval of 15 minutes and the default sliding window period of 360 minutes, the CMTS router samples the bandwidth usage every 15 minutes and counts the total bytes transmitted at the end of each 360-minute period. Each sample interval begins a new sliding window period for which the CMTS router keeps track of the total bytes transmitted.


Note Changing the duration minutes, avg-rate rate, or sample-interval minutes values resets the byte counters for that particular enforce-rule and begins a new sliding window period.


When you change the configuration of a currently active enforce-rule, that rule begins using the new configuration immediately to manage the cable modems tracked by this enforce-rule.

When you use the show running-configuration command to display the configuration, the keyword options for the duration command are truncated. In the following example, "do" represents downstream, and "enf" represents enforce:

Router# show running-configuration
.
.
.
duration 10 avg-rate 1 sample-interval 10 do enf

For more information about the Subscriber Traffic Management feature and to see an illustration of a sample monitoring window, refer to the Subscriber Traffic Management for the Cisco CMTS Routers feature document on Cisco.com.

Examples

The following example shows an enforce-rule being configured for a sliding window that is 20 minutes in length, an avg-rate of 1 kilobit per second, and a sampling interval of every 10 minutes.

Router# configure terminal 
Router(config)# cable qos enforce-rule residential 
Router(enforce-rule)# duration 20 avg-rate 1 sample-interval 10

Related Commands

Command
Description

cable qos enforce-rule

Creates an enforce-rule to enforce a particular QoS profile for subscriber traffic management and enters enforce-rule configuration mode.

enabled (enforce-rule)

Activates an enforce-rule and begins subscriber traffic management on a Cisco CMTS router.

debug cable subscriber-monitoring

Displays enforce-rule debug messages for subscriber traffic management on the Cisco CMTS routers.

monitoring-basics

Specifies the type of monitoring for subscriber traffic management on a Cisco CMTS router.

peak-time1

Specifies peak and offpeak monitoring times on a Cisco CMTS router.

qos-profile registered

Specifies the registered QoS profile that should be used for this enforce-rule.

qos-profile enforced

Specifies a QoS profile that should be enforced when users violate the registered QoS profiles.

show cable qos enforce-rule

Displays the QoS enforce-rules that are currently defined.

show cable subscriber-usage

Displays subscribers who are violating their registered QoS profiles.

weekend duration

Configures different subscriber monitoring options over weekends on a Cisco CMTS router.


enabled (enforce-rule)

To activate an enforce-rule and begin subscriber traffic management on a Cisco CMTS router, use the enabled command in enforce-rule configuration mode. To disable the enforce-rule without deleting it, use the no form of this command.

enabled

no enabled

Syntax Description

This commands has no keywords or arguments.

Command Default

Enforce-rules are disabled.

Command Modes

Enforce-rule configuration (enforce-rule)

Command History

Release
Modification

12.2(15)BC1

This command was introduced.

12.3(9a)BC

This command was integrated into Cisco IOS Release 12.3(9a)BC.

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

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


Usage Guidelines

An enforce-rule is created and configured using the cable qos enforce-rule command, but it is not activated until you run the enabled command. Use the no enabled command to disable an enforce-rule without removing it from the CMTS configuration. When you disable an enforce-rule, all cable modems with that rule's registered QoS profile are no longer tracked by the Subscriber Traffic Management feature and all cable modems in penalty are moved to their registered QoS profile.

Examples

The following example shows an enforce-rule being enabled:

Router# configure terminal 
Router(config)# cable qos enforce-rule residential 
Router(enforce-rule)# enabled 

The following example shows an enforce-rule being disabled. The rule remains in the CMTS configuration file.

Router# configure terminal 
Router(config)# cable qos enforce-rule residential 
Router(enforce-rule)# no enabled 

Related Commands

Command
Description

cable qos enforce-rule

Creates an enforce-rule to enforce a particular QoS profile for subscriber traffic management and enters enforce-rule configuration mode.

qos-profile enforced

Specifies a QoS profile that should be enforced when users violate their registered QoS profiles.

duration

Specifies the time period and sample rate to be used for monitoring subscribers.

penalty-period

Specifies the time period that an enforced QoS profile should be in effect for subscribers that violate their registered QoS profiles.

qos-profile registered

Specifies the registered QoS profile that should be use for this enforce-rule.

show cable qos enforce-rule

Displays the QoS enforce-rules that are currently defined.

show cable subscriber-usage

Displays subscribers who are violating their registered QoS profiles.


enforced qos-profile


Note Effective with Cisco IOS Release 12.3(9a)BC, the enforced qos-profile command is replaced by the qos-profile enforced command.


To specify a quality of service (QoS) profile that should be enforced when users violate their registered QoS profiles, use the enforced qos-profile command in enforce-rule configuration mode. To delete the enforced QoS profile from the enforce-rule, use the no form of this command.

enforced qos-profile profile-id [no-persistence]

no enforced qos-profile profile-id [no-persistence]

Syntax Description

profile-id

Specifies the QoS profile to be enforced. The valid range is 0 to 16383, with a default of 0.

no-persistence

(Optional) Specifies that the enforced QoS profile should not remain in force when a cable modem reboots. Instead, when a cable modem (CM) that is in the penalty period reboots, it is automatically removed from the penalty period and assigned the QoS profile that is specified in its DOCSIS configuration file.

The default is without this option, so that enforced QoS profiles remain in effect for cable modems across reboots.


Command Default

The profile ID defaults to 0, and enforced QoS profiles are persistent across cable modem reboots.

Command Modes

Enforce-rule configuration (enforce-rule)

Command History

Release
Modification

12.2(15)BC1

This command was introduced.

12.3(9a)BC

This command was replaced by the qos-profile enforced command.


Usage Guidelines

Both the originally provisioned QoS profile and the enforced QoS profile must be created on the Cisco CMTS router. This command does not support profiles that are created by the cable modem.

An enforce-rule can specify an enforced QoS profile, which is automatically applied to subscribers that transmit more traffic than what is allowed by their registered QoS profile. The enforced QoS profile remains in effect during the penalty time period (see the penalty-period command). At the end of the penalty period, the subscriber returns to their registered QoS profile.

If a cable modem reboots while it is in its penalty time period, it continues using the enforced QoS profile, unless the service provider has manually changed the cable modem's registered QoS profile using the cable modem qos profile command.

When you change the enforced QoS profile for a currently active enforce-rule, any cable modems using this rule that are currently in the penalty period continue using the previously configured enforced QoS profile. Any cable modems that enter the penalty period after this configuration change, however, use the new enforced QoS profile.

An enforced QoS profile must already have been created on the Cisco CMTS router before you can assign it to an enforce-rule. If the rule does not exist, the system displays an error message.

When the no-persistence option is specified, the enforced QoS profile is still automatically applied to subscribers that violate their bandwidth requirements. However, when the cable modem reboots, the Cisco CMTS router allows the cable modem to use the QoS profile that is specified in its DOCSIS configuration file.

The no-persistence option can be used when initially using subscriber traffic management to identify potential problem applications and users. When repeat offenders are identified, they can then be assigned enforce-rules that do not use the no-persistence option, so that they remain in the penalty period even if they reboot their cable modems.


Note In software releases prior to Cisco IOS Release 12.3(9a)BC, the system automatically applies the enforced QoS profile to violators only if the enforce keyword has been used with the activate-rule at-byte-count command.


Examples

The following example shows profile 12 being assigned as the enforced QoS profile to an enforce-rule:

Router# configure terminal 
Router(config)# cable qos enforce-rule residential 
Router(enforce-rule)# enforced qos-profile 12 

The following example shows profile 12 being assigned as the enforced QoS profile to an enforce-rule, but with the no-persistence option specified, so that the enforced QoS profile does not remain in force if the cable modem reboots:

Router# configure terminal 
Router(config)# cable qos enforce-rule residential 
Router(enforce-rule)# enforced qos-profile 12 no-persistence 

The following example shows the error message that is displayed when the specified QoS profile does not exist on the CMTS:

Router# configure terminal 
Router(config)# cable qos enforce-rule test 
Router(enforce-rule)# enforced qos-profile 98 

The qos profile 98 doesn't exist or it's a cm created QoS profile

Related Commands

Command
Description

activate-rule at-byte-count

Specifies the number of bytes that a subscriber can transmit during the monitoring period on a Cisco CMTS router.

cable qos enforce-rule

Creates an enforce-rule to enforce a particular QoS profile for subscriber traffic management and enters enforce-rule configuration mode.

enabled (enforce-rule)

Activates an enforce-rule and begins subscriber traffic management on a Cisco CMTS router.

duration

Specifies the time period and sample rate to be used for monitoring subscribers.

penalty-period

Specifies the time period that an enforced QoS profile should be in effect for subscribers that violate their registered QoS profiles.

qos-profile registered

Specifies the registered QoS profile that should be used for this enforce-rule.

show cable qos enforce-rule

Displays the QoS enforce-rules that are currently defined.

show cable subscriber-usage

Displays subscribers who are violating their registered QoS profiles.


exception pxf

To control the core dumps that are generated when an exception occurs in one of the Parallel eXpress Forwarding (PXF) columns, use the exception pxf command in global configuration mode. To disable the creation of core dumps during PXF exceptions, use the no form of this command.

exception pxf {core-file filename | flash device | style {full | localized | minimal | smart} }

no exception pxf {core-file | flash | style }

Syntax Description

core-file filename

Sets the filename for the core-dump file generated during a PXF exception.

flash device

Specifies the Flash memory device on which to save the core-dump file generated during a PXF exception.

style

Specifies the type of core-dump file to be generated during a PXF exception.

full

Creates a full core-dump file of all PXF columns.

localized

Creates a core-dump file of the PXF column that failed, along with its neighboring columns.

minimal

Creates a minimal core-dump file of the PXF exception.

smart

Creates a core-dump file that contains the data related to the PXF exception.


Defaults

Core dumps are not generated during PXF exceptions.

Command Modes

Global configuration

Command History

Release
Modification

12.2(4)XF1

This command was introduced for the Cisco uBR10012 router.


Usage Guidelines


Caution Use the exception pxf command only under the direction of a technical support representative. Creating a core dump can disrupt network operations. The core dump is a large binary file that can be interpreted only by technical personnel who have access to source code and detailed memory maps.

Examples

The following example shows how to specify that the Cisco uBR10012 router should create a minimal core-dump file for PXF exceptions, and that this file should be named ubr10k-pxf and be written to the disk1 device:

Router# configure terminal 
Router(config)# exception pxf style minimal 
Router(config)# exception pxf core-file ubr10k-pxf 
Router(config)# exception pxf flash disk1: 
Router(config)# 

Related Commands

Command
Description

show pxf xcm

Displays the current state of error checking and correcting (ECC) for the External Column Memory (XCM) on the Parallel eXpress Forwarding (PXF) processor.


facility-alarm (ubr10012)

To set the temperature thresholds at which the Performance Routing Engine (PRE) module generates a critical, major, or minor alarm to warn of potential equipment damage, use the facility-alarm command in global configuration mode. To disable the temperature alarms, use the no form of this command.

facility-alarm {core-temperature | intake-temperature}
{
critical exceed-action shutdown | major [temp] | minor [temp]}

no facility-alarm {core-temperature | intake-temperature}
{
critical exceed-action shutdown | major [temp] | minor [temp]}

Syntax Description

core-temperature

Specifies the temperature threshold for the temperature sensors near the center of the PRE module.

intake-temperature

Specifies the temperature threshold for the temperature sensors at the air intake slots.

critical exceed-action shutdown

In Cisco IOS Release 12.2(11)BC1 and later releases, specifies that a critical temperature alarm should shut down the router after two minutes. This was the default behavior in previous releases.

major [temp]

Specifies the temperature, in degrees Centigrade, at which the PRE module generates a major alarm to warn of potential damage from excessive temperatures.

The valid range for temp is 20 to 67 degrees Centigrade, with a default of 58 for the core temperature threshold and 54 for the intake-temperature threshold.

minor [temp]

Specifies the temperature, in degrees Centigrade, at which the PRE module generates a minor alarm to warn of potential damage from excessive temperatures.

The valid range for temp is 20 to 67 degrees Centigrade, with a default of 50 for the core temperature threshold and 45 for the intake-temperature threshold.


Defaults

If no specific temperature is given, that particular facility alarm is reset to its default value. The default core temperature thresholds are 85 (critical), 58 (major), and 50 (minor). The default intake-temperature thresholds are 72 (critical), 54 (major), and 45 (minor) degrees Centigrade.

In Cisco IOS releases previous to Cisco IOS Release 12.2(11)BC1, a critical alarm automatically shuts down the router after two minutes to prevent temperature damage. In Cisco IOS Release 12.2(11)BC1 and later, a critical alarm by default does not shut down the router.


Note The default temperature thresholds for the critical core and intake temperatures were changed in Cisco IOS Release 12.2(11)BC1.


Command Modes

Global configuration (config)

Command History

Release
Modification

12.2(1)XF1

This command was introduced for the Cisco uBR10012 router.

12.2(11)BC1

The critical exceed-action shutdown option was added. In addition, the default value for the core critical temperature threshold was raised from 57 to 67 degrees Centigrade, and the default value for the intake critical temperature threshold was raised from 60 to 85 degrees Centigrade.

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


Note The facility-alarm core-temperature critical and facility-alarm intake-temperature critical commands are available only if the service internal command is defined in the configuration.


The PRE module on the Cisco uBR10012 router contains temperature sensors that monitor the temperature at the air intake slots and on the PRE module itself. The facility-alarm command configures the router for the temperature thresholds that will generate a minor, major, or critical alarm, so as to notify the system operators of the temperature problem before excessive heat can damage the router or any of its components.

Before Cisco IOS Release 12.2(11)BC1, a critical alarm would also automatically shut down the router after two minutes. Cisco IOS Release 12.2(11)BC1 made this automatic shutdown a configurable option, so that the system operators can decide whether or not a critical alarm should power down the router.

As a general rule, do not disable the automatic shutdown of the router unless you have a systems operator available to immediately respond to any critical temperature alarms, because this could result in system damage. Typically, the primary reason to disable the automatic shutdown would be if you are replacing the fan tray assembly and want to ensure that the router does not power down if the procedure takes longer than expected.


Note A line card also automatically shuts itself down if the temperature exceeds operational levels. In addition, the AC and DC PEMs also automatically power down if they exceed their operational temperature. However, high temperatures could still cause damage to other components if the problem is not quickly resolved.


Examples

The following example shows how to configure the Cisco uBR10012 router so that it generates a minor alarm when the intake temperature exceed 55°C:

Router# configure terminal 
Router(config)# facility-alarm intake-temperature minor 55 

The following example shows how to configure the Cisco uBR10012 router to automatically shut down if the high temperature continues for more than two minutes:

Router# configure terminal 
Router(config)# service internal
Router(config)# facility-alarm core-temperature critical exceed-action shutdown

The following example shows how to disable the automatic shutdown feature for both the core and intake temperatures. A critical alarm is still generated when the default critical temperatures are exceeded, but the router does not automatically shut itself down:

Router# configure terminal 
Router(config)# no facility-alarm core-temperature critical exceed-action shutdown
Router(config)# no facility-alarm intake-temperature critical exceed-action shutdown

The following commands disable major and minor alarms for both the core and intake temperature thresholds (but critical alarms are still generated):

Router# configure terminal 
Router(config)# no facility-alarm core-temperature major 
Router(config)# no facility-alarm core-temperature minor 
Router(config)# no facility-alarm intake-temperature major 
Router(config)# no facility-alarm intake-temperature minor

Related Commands

Command
Description

clear facility-alarm

Clears some or all of the facility alarms on the Cisco uBR10012 router.

show facility-alarm status

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


flowcontrol

To set the method of data flow control between the terminal or other serial device and the router, use the flowcontrol command in line configuration mode. To disable flow control, use the no form of this command.

flowcontrol {none | software [lock] [in | out] | hardware [in | out]}

no flowcontrol {none | software [lock] [in | out] | hardware [in | out]}

Catalyst 6500 Series Switches and Cisco 7600 Series Routers

To configure a port to send or receive pause frames, use the flowcontrol command in interface configuration mode. To return to the default settings, use the no form of this command.

flowcontrol {send | receive} {desired | off | on}

no flowcontrol {send | receive} {desired | off | on}

Cisco uBR10012 Universal Broadband Router

To temporarily stop the transmission of data between two peers to prevent packet drops in the event of data overflow, use the flowcontrol command in interface configuration mode. To return to the default settings, use the no form of this command.

flowcontrol receive off

no flowcontrol receive off

Syntax Description

none

Turns off flow control.

software

Sets software flow control.

lock

(Optional) Makes it impossible to turn off flow control from the remote host when the connected device needs software flow control. This option applies to connections using the Telnet or rlogin protocols.

[in | out]

(Optional) Specifies the direction of software or hardware flow control: the keyword in causes the Cisco IOS software to listen to flow control from the attached device, and the out keyword causes the software to send flow control information to the attached device. If you do not specify a direction, both directions are assumed.

hardware

Sets hardware flow control. For more information about hardware flow control, see the hardware manual that was shipped with your router.

Catalyst 6500 Series Switches and Cisco 7600 Series Routers

send

Specifies that a port sends pause frames.

receive

Specifies that a port processes pause frames.

desired

Obtains predictable results regardless of whether a remote port is set to on, off, or desired.

off

Prevents a local port from receiving and processing pause frames from remote ports or from sending pause frames to remote ports.

on

Enables a local port to receive and process pause frames from remote ports or send pause frames to remote ports.


Command Default

Flow control is disabled.

Catalyst 6500 Series Switches and Cisco 7600 Routers

Flow-control defaults depend upon port speed. The defaults are as follows:

Gigabit Ethernet ports default to off for receive and desired for send.

Fast Ethernet ports default to off for receive and on for send.

On the 24-port 100BASE-FX and 48-port 10/100 BASE-TX RJ-45 modules, the default is off for receive and off for send.

You cannot configure how WS-X6502-10GE 10-Gigabit Ethernet ports respond to pause frames. WS-X6502-10GE 10-Gigabit Ethernet ports are permanently configured to respond to pause frames.

Cisco uBR10012 Universal Broadband Router

Flow control is enabled by default.

Command Modes

Line configuration

Catalyst 6500 Series Switches, Cisco 7600 Series Routers, and Cisco uBR10012 Universal Broadband Router

Interface configuration

Command History

Release
Modification

10.0

This command was introduced.

12.2(31)SB2

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

Catalyst 6500 Series Switches and Cisco 7600 Series Routers

12.2(14)SX

Support for this command was introduced on the Supervisor Engine 720.

12.2(17d)SXB

Support for this command on the Supervisor Engine 2 was extended to the 12.2 SX release.

12.2(33)SRA

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

12.2(33)SCB

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


Usage Guidelines

When software flow control is set, the default stop and start characters are Ctrl-S and Ctrl-Q (XOFF and XON). You can change them using the stop-character and start-character commands.

If a remote Telnet device requires software flow control, the remote system should not be able to turn it off. Using the lock option makes it possible to refuse "dangerous" Telnet negotiations if they are inappropriate.

Catalyst 6500 Series Switches and Cisco 7600 Series Routers

The send and desired keywords are supported on Gigabit Ethernet ports only.

Pause frames are special packets that signal a source to stop sending frames for a specific period of time because the buffers are full.

Gigabit Ethernet ports on the Catalyst 6500 series switches and on the Cisco 7600 series routers use flow control to inhibit the transmission of packets to the port for a period of time; other Ethernet ports use flow control to respond to flow-control requests.

If a Gigabit Ethernet port receive buffer becomes full, the port transmits a "pause" packet that tells remote ports to delay sending more packets for a specified period of time. All Ethernet ports (1000 Mbps, 100 Mbps, and 10 Mbps) can receive and act upon "pause" packets from other devices.

You can configure non-Gigabit Ethernet ports to ignore received pause frames (disable) or to react to them (enable).

When used with receive, the on and desired keywords have the same result.

All the Gigabit Ethernet ports on the Catalyst 6500 series switches and the Cisco 7600 series routers can receive and process pause frames from remote devices.

To obtain predictable results, follow these guidelines:

Use send on only when remote ports are set to receive on or receive desired.

Use send off only when remote ports are set to receive off or receive desired.

Use receive on only when remote ports are set to send on or send desired.

Use send off only when remote ports are set to receive off or receive desired.

Cisco uBR10012 Universal Broadband Router

Flow control is supported only on the 1-Port 10-Gigabit Ethernet SPA installed on a Cisco ubR10012 router.

Examples

The following example sets hardware flow control on line 7:

line 7
 flowcontrol hardware

Catalyst 6500 Series Switches and Cisco 7600 Series Routers

These examples show how to configure the local port to not support any level of flow control by the remote port:

Router(config-if)# flowcontrol receive off
Router(config-if)#

Router(config-if)# flowcontrol send off
Router(config-if)#

Cisco uBR10012 Universal Broadband Router

The following example shows how to disable flow control on the Cisco 1-Port 10-Gigabit Ethernet SPA:

Router# configure terminal 
Router(config)#interface TenGigabitEthernet1/0/0
Router(config-if)#flowcontrol receive off

Related Commands

Command
Description

start-character

Sets the flow control start character.

stop-character

Sets the flow control stop character.

Catalyst 6500 Series Switches and Cisco 7600 Series Routers

show interfaces flowcontrol

Displays flow-control information.


h323-gateway voip bind srcaddr

To configure the cable access router so that H.323 VoIP traffic is sent using the Ethernet interface's IP address, use the h323-gateway voip bind srcaddr command in cable interface configuration mode. To return to the default configuration, so that the router uses the cable interface's IP address for H.323 VoIP traffic, use the no form of this command.

Cisco uBR924, uBR925 cable access routers, Cisco CVA122 Cable Voice Adapter

h323-gateway voip bind srcaddr ip-address

no h323-gateway voip bind srcaddr

Syntax Description

ip-address

Specifies the IP address to be used for outgoing H.323 traffic, which includes H.225, H.245, and RAS messages. This IP address typically is the IP address assigned to the Ethernet interface.


Defaults

No defaults assigned. By default, H.323 traffic is transmitted with the IP address assigned to the cable interface.

Command Modes

Interface configuration (cable interface only)

Command History

Release
Modification

12.1(2)T

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

12.1(5)XU1

Support was added for the Cisco CVA122 Cable Voice Adapter.

12.2(2)XA

Support was added for the Cisco uBR925 cable access router.


Usage Guidelines

The h323-gateway voip bind srcaddr command can be used with any interface, but it is primarily used with the cable access router's Ethernet interface when configuring a virtual private network (VPN). In this configuration, the h323-gateway voip bind srcaddr command configures the router so that VoIP traffic is sent using the IP address of the Ethernet interface (as opposed to the default behavior, which is to use the IP address of the default outgoing interface, which is the cable interface).

The h323-gateway voip bind srcaddr command allows the enterprise network to maintain the H.323 gatekeeper and gateway in the enterprise network's address space. Without the h323-gateway voip bind srcaddr command, outgoing voice traffic uses the IP address of the cable interface. This method requires that the H.323 gatekeeper and gateway be maintained in the cable service provider's address space, which is not desirable if the enterprise needs to control the voice network and VPN configuration.


Note The h323-gateway voip bind srcaddr command can be used only when the cable access router is operating in routing mode. This command has no effect when the router is operating in DOCSIS bridging mode.


Examples

The following example shows how to configure the Ethernet interface with the IP address of 192.168.100.94, and then how to configure the interface so that H.323 traffic will be transmitted using that IP address:

Router(config)# interface ethernet0 
Router(config-if)# ip address 192.168.100.94 255.255.255.0 
Router(config-if)# h323-gateway voip bind srcaddr 192.168.100.94 
Router(config-if)# 

The following example shows how to remove the H.323 binding, so that H.323 voice traffic is transmitted using the cable interface's IP address:

Router(config-if)# no h323-gateway voip bind srcaddr 
Router(config-if)# 

Related Commands

Command
Description

h323-gateway voip h323-id

Defines the H.323 name that identifies this cable access router gateway to its associated gatekeeper.

h323-gateway voip id

Defines the name and IP address of the gatekeeper for this gateway.

h323-gateway voip interface

Configures the interface as an H.323 interface.

h323-gateway voip tech-prefix

Defines the technology prefix that the gateway uses to register with the gatekeeper.


hccp authentication

To specify the authentication algorithm on a working or protect cable interface, or both use the hccp authentication command in cable interface configuration mode. To disable authentication on a Working CMTS or Protect CMTS, use the no form of this command.

hccp group authentication {md5 | text}

no hccp group authentication {md5 | text}

Syntax Description

group

The group number for the specified interface. Valid values are any number from 1 to 255, inclusive.

md5

Authentication algorithm. In Cisco IOS Release 12.1(3a)EC, MD5 is the only authentication algorithm supported.

text

Unencrypted text specification. Rather than automatically encrypting the authentication key-chain when using the MD5 authentication algorithm, Cisco IOS software simply passes the authentication key-chain as standard, unencrypted text.


Command Default

The default authentication algorithm is MD5.

Command Modes

Interface configuration (cable interface only)

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.2(15)BC1

Support was added for the Cisco uBR-MC5X20U/S BPE on the Cisco uBR10012 router.

12.3(17a)BC2

Support was added for the Cisco uBR-MC5X20H BPE on the Cisco uBR10012 router.

12.3(21)BC

This command is obsolete on the Cisco uBR7246VXR router.


Usage Guidelines

Use this command together with the hccp authentication key-chain command to enable and specify the type of N+1 redundancy authentication you will use in your protection scheme.

Examples

The following example shows how to specify MD5 as the authentication algorithm for group 1:

Router(config-if)# hccp 1 authentication md5

Related Commands

Command
Description

hccp authentication key-chain

Enables authentication on a given interface and specifies one or more keys that can be used to perform authentication for a specified group.

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.


hccp authentication key-chain

To enable authentication and define one or more authentication keys to use in a specified group, use the hccp authentication key-chain command in cable interface configuration mode. To disable authentication, use the no form of this command. The key chains you define must match one or more key chains configured in the Working CMTS or Protect CMTS configuration file.

hccp group authentication key-chain key-chain

no hccp group authentication key-chain [key-chain]

Syntax Description

group

The group number for the specified interface. Valid values are any number from 1 to 255, inclusive.

key-chain

A text string matching a key chain in the Working CMTS or Protect CMTS configuration file. A key chain must have at least one key and can have up to 2,147,483,647 keys.


Command Default

No default behavior or values

Command Modes

Interface configuration (cable interface only)

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.2(15)BC1

Support was added for the Cisco uBR-MC5X20U/S BPE on the Cisco uBR10012 router.

12.3(17a)BC2

Support was added for the Cisco uBR-MC5X20H BPE on the Cisco uBR10012 router.

12.3(21)BC

This command is obsolete on the Cisco uBR7246VXR router.


Usage Guidelines

Use this command in conjunction with the hccp authentication command to enable and specify the type of 1+1 redundancy authentication you will use in your protection scheme.


Note You cannot perform authentication on a specified group until you have first defined at least one authentication key chain in global configuration mode.


Examples

The following excerpt from a configuration file enables authentication using the MD5 algorithm and defines the authentication key "cisco1" for group 1:

!
key chain cisco1
 key 1
   key-string abcdefg
 key 2
   key-string 123456789
!
...
!
interface cable 3/0
   hccp 1 authentication md5
   hccp 1 authentication key-chain cisco1
!

Related Commands

Command
Description

hccp authentication

Specifies the authentication algorithm for the Working CMTS or Protect CMTS.

hccp authentication key-chain

Enables authentication on a given interface and specifies one or more keys that can be used to perform authentication for a specified group.

key-chain

Defines one or more key chains for authentication between the Working CMTS or Protect 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.


hccp bypass version

To enter bypass version mode for a specific Hot Standby Connection-to-Connection Protocol (HCCP) group, in which the hardware and software version checks are not performed before switching over to a protect interface, use the hccp bypass version command in privileged EXEC mode.

hccp group bypass version

Syntax Description

group

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


Command Default

Normal HCCP operations (hccp group check version), where hardware and software version checks are made between the Working and Protect cable interface line cards.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(4)XF1, 12.2(4)BC1

This command was introduced for the Cisco uBR10012 router and Cisco uBR-LCP-MC28C card with the Cisco RF Switch.

12.2(8)BC2

Support was added for the Cisco uBR10012 router using the Cisco uBR-LCP-MC16C, Cisco uBR-LCP-MC16E, and Cisco uBR-LCP-MC16S cards with the Cisco RF Switch.

12.2(11)BC1

Support was added for the Cisco uBR7246VXR router and
Cisco uBR-MC16C, Cisco uBR-MC16S, and Cisco uBR-MC28C cards with the Cisco RF Switch.

12.2(15)BC1

Support was added for the Cisco uBR-MC5X20U/S BPE on the Cisco uBR10012 router.

12.3(17a)BC2

Support was added for the Cisco uBR-MC5X20H BPE on the Cisco uBR10012 router.

12.3(21)BC

This command is obsolete on the Cisco uBR7246VXR router.


Usage Guidelines

By default, the Cisco CMTS verifies that the Working and Protect cable interfaces are using the same versions of software and hardware, so as to avoid potential incompatibilities during a switchover. The hardware check verifies that the Working and Protect cable interface line cards are compatible. The software check verifies that the two cards are running the same major versions of software. If either of these two conditions is not true, the CMTS by default does not perform the switchover.

You can override these version checks for a particular HCCP group by using the hccp bypass version command. After you give this command, the Cisco CMTS does not check the hardware or software versions of the two cable interfaces before performing a switchover. To return to normal HCCP operations, so that version checks are made for a group, use the hccp check version command.


Note Two cable interface line cards are compatible when the Protect card has at least the same number of upstreams or downstreams as the Working card. The exceptions to this are that the Cisco uBR-MC16E card can be protected only by another Cisco uBR-MC16E card. Also, the DOCSIS versions of the Cisco uBR-MC16 card can be protected only by another Cisco uBR-MC16C card. You cannot use the Cisco uBR-MC28C card to protect a Cisco uBR-MC16B/C/S card.


Examples

The following example shows how to disable the hardware and software version checks for HCCP group number 20. After giving this command, the Cisco CMTS will switchover from the Working to Protect interface in group 20 without first verifying the cards' compatibility:

Router# hccp 20 bypass version 
Router# 

Related Commands

Command
Description

hccp check version

Exits bypass version mode, and returns to normal HCCP operation.

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.


hccp channel-switch

To configure the Cisco CMTS so that a Cisco RF Switch or Vecima (Wavecom) upconverter becomes a Hot Standby Connection-to-Connection Protocol (HCCP) member in a particular HCCP group, use the hccp channel-switch command in cable interface configuration mode. To remove the configuration for the Cisco RF Switch or upconverter, use the no form of this command.

hccp group channel-switch member-id switch-name rfswitch-group rfswitch-ip-address module-bitmap position

hccp group channel-switch member-id switch-name rfswitch-module rfswitch-ip-address module-number position

hccp group channel-switch member-id switch-name tty-switch [aux | console | vty] line-number port

hccp group channel-switch member-id switch-name {wavecom-hd | wavecom-ma} prot-ip-address protect-module work-ip-address work-module

no hccp group channel-switch member-id switch-name

Syntax Description

group

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

member-id

The member number within the specified group. The valid range is 1 to 255.

switch-name

(Optional) Alpha-numeric string specifies the name of the
Cisco RF Switch.

rfswitch-group

Specifies that this is the configuration for a Cisco RF Switch group.

rfswitch-module

Specifies that this is the configuration for a Cisco RF Switch module.

rfswitch-ip-address

Specifies the IP address of the Cisco RF Switch to which the CMTS is connected.

module-bitmap

Specifies the module-bitmap in hexadecimal. The valid range is 0 to FFFFFFFF.

Tip See the TAC-authored N+1 Tips and Configuration document on Cisco.com for more information on the format of the bitmap, and for a worksheet that can be used to calculate the bitmap.

module-number

Specifies the module number on the Cisco RF Switch. The valid range is 1 to 255.

Note This setting must be configured on the Cisco RF Switch as well as the Cisco CMTS.

position

Specifies the position for the Working channel on the Cisco RF Switch. The valid range is 1 to 8.

tty-switch

Specifies the configuration of a Cisco RF Switch that is controlled by its TTY line. You can further specify the type of port being used to control the switch. By default, one of the Cisco RF Switch's serial ports is used, or you can use the aux, console, or vty lines.

Note Ensure that the switch's DIP switch is set to 00.

aux

(Optional) Specifies that the auxiliary port is being used to control the Cisco RF Switch.

console

(Optional) Specifies that the console port is being used to control the Cisco RF Switch.

vty

(Optional) Specifies that a Virtual Terminal connection (Telnet connection) is being used to control the Cisco RF Switch.

line-number

Specifies the line number on which the Cisco RF Switch is receiving control information for this CMTS. The valid range is 0 to 17 for the default serial port, 0 for the aux port, 0 for the console port, and 0 to 99 for the vty port.

port

Specifies the port number being used on the Cisco RF Switch. The valid range is 1 to 255.

wavecom-hd

Specifies that this is the configuration for a Vecima (Wavecom) HD4040 and QHD4040 upconverter.

wavecom-ma

Specifies that this is the configuration for a Vecima (Wavecom) DUAL4040D, MA4040D, or UC4040D upconverter.

prot-ip-address

Specifies the IP address for the upconverter used for the Protect interface used for this cable interface.

protect-module

Specifies the module number on the upconverter used for the Protect interface to be used for this cable interface. The valid range is 1 to 255.

work-ip-address

Specifies the IP address for the upconverter used for the Working interface used for this cable interface.

work-module

Specifies the module number on the upconverter used for the Working interface to be used for this cable interface. The valid range is 1 to 255.


Command Default

The CMTS is not configured to use a Cisco RF Switch by default, and no cable interfaces are configured for N+1 redundancy by default.

Command Modes

Interface configuration—cable interface only (config-if)

Command History

Release
Modification

12.2(4)XF1, 12.2(4)BC1

This command was introduced for the Cisco uBR10012 router, replacing the hccp ds-switch command for use with the Cisco RF Switch.

12.2(8)BC2

Support was added for the Cisco uBR-LCP-MC16C, Cisco uBR-LCP-MC16E, and Cisco uBR-LCP-MC16S cards on the Cisco uBR10012 router.

12.2(11)BC1

Support was added for 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

You must configure each Working and Protect cable interface for use with the Cisco RF Switch, typically specifying one hccp channel-switch command to configure the Cisco RF Switch information, and another hccp channel-switch command to configure the upconverter.

The Protect interface is configured with the same hccp channel-switch commands as those that are used on the Working interface. However, typically, the same Protect interface is configured with multiple hccp channel-switch commands to protect multiple Working interfaces.

Examples

The following example shows the cable interface 8/1/0 being configured as member 1 for the Working interface of HCCP group 1. This interface is configured to use the Wavecom HD4040 upconverter with the IP address of 10.97.1.21. The upconverter's module number 2 (B) is used for the Protect interface, and module number 16 (P) is used for the Working interface. The interface uses the Cisco RF Switch at IP address 10.97.1.20, using a module bitmap of AA200000 in switch slot 1.

Router# configure terminal 
Router(config)# interface cable8/1/0 
Router(config-if)# hccp 1 working 1 
Router(config-if)# hccp 1 channel-switch 1 uc wavecom-hd 10.97.1.21 2 10.97.1.21 16 
Router(config-if)# hccp 1 channel-switch 1 rfswitch rfswitch-group 10.97.1.20 AA200000 1 

The following example shows the corresponding configuration for the Protect interface for member 1 of HCCP group 1, which is cable interface 5/1/0 on the same chassis. The hccp channel-switch commands are identical to those used for cable interface 8/1/0.

Router# configure terminal 
Router(config)# interface cable5/1/0 
Router(config-if)# hccp 1 protect 1 10.97.1.8 
Router(config-if)# hccp 1 channel-switch 1 uc wavecom-hd 10.97.1.21 2 10.97.1.21 16 
Router(config-if)# hccp 1 channel-switch 1 rfswitch rfswitch-group 10.97.1.20 AA200000 1 

Typically, the same Protect interface is used to protect multiple Working cable interfaces. For example, this same interface could be configured as follows to protect a Working interface that is using module number 14 (N) on the same Wavecom HD4040 upconverter, using slot 2 in the RF Switch.

Router# configure terminal 
Router(config)# interface cable5/1/0 
Router(config-if)# hccp 1 protect 2 10.97.1.8 
Router(config-if)# hccp 1 channel-switch 2 uc wavecom-hd 10.97.1.21 2 10.97.1.21 14 
Router(config-if)# hccp 1 channel-switch 2 rfswitch rfswitch-group 10.97.1.20 AA200000 2 

Related Commands

Command
Description

hccp check version

Exits bypass version mode, and returns to normal HCCP operation.

hccp ds-switch

Specifies the downstream upconverter module for a Working CMTS or Protect CMTS (deprecated command).

hccp protect

Allows you to configure a Cisco CMTS to be a Protect CMTS for a specified Working CMTS in a 1+1 redundancy environment.

hccp working

Allows you to designate a Cisco CMTS to be a Working CMTS in a 1+1 redundancy environment.

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.


hccp check version

To exit bypass version mode and return to normal Hot Standby Connection-to-Connection Protocol (HCCP) operations for a specific HCCP group, use the hccp check version command in privileged EXEC mode.

hccp group check version

Syntax Description

group

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


Command Default

Normal HCCP operations (hccp group check version), where hardware and software version checks are made between the Working and Protect cable interface line cards.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(4)XF1, 12.2(4)BC1

This command was introduced for the Cisco uBR10012 router and Cisco uBR-LCP-MC28C card with the Cisco RF Switch.

12.2(8)BC2

Support was added for the Cisco uBR10012 router using the
Cisco uBR-LCP-MC16C, Cisco uBR-LCP-MC16E, and
Cisco uBR-LCP-MC16S cards with the Cisco RF Switch.

12.2(11)BC1

Support was added for the Cisco uBR7246VXR router and
Cisco uBR-MC16C, Cisco uBR-MC16S, and Cisco uBR-MC28C cards with the Cisco RF Switch.


Usage Guidelines

By default, the Cisco CMTS verifies that the Working and Protect cable interfaces are using the same versions of software and hardware, so as to avoid potential incompatibilities during a switchover. The hardware check verifies that the Working and Protect cable interface line cards are compatible. The software check verifies that the two cards are running the same major versions of software. If either of these two conditions is not true, the CMTS by default does not perform the switchover.

You can override these version checks for a particular HCCP group by using the hccp bypass version command. After you give this command, the Cisco CMTS does not check the hardware or software versions of the two cable interfaces before performing a switchover. To return to normal HCCP operations, so that version checks are made for a group, use the hccp check version command.


Note Two cable interface line cards are compatible when the Protect card has at least the same number of upstreams or downstreams as the Working card. The exceptions to this are that the Cisco uBR-MC16E card can be protected only by another Cisco uBR-MC16E card. Also, the DOCSIS versions of the Cisco uBR-MC16 card can be protected only by another Cisco uBR-MC16C card. You cannot use the Cisco uBR-MC28C card to protect a Cisco uBR-MC16B/C/S card.


Examples

The following example shows how to cancel a previous hccp bypass version command for HCCP group 1 and to return to normal HCCP operations:

Router# hccp 1 check version 
Router# 

Related Commands

Command
Description

hccp bypass version

Enters bypass version mode for a specific HCCP group, in which the hardware and software version checks are not performed before switching over to a protect interface.

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.


hccp ds-switch

To specify the downstream upconverter module for a Working CMTS or Protect CMTS, use the hccp ds-switch command in cable interface configuration mode. To negate a downstream upconverter assignment, use the no form of this command.

hccp group ds-switch member make host-ipaddr host-module peer-ipaddr peer-module

no hccp group ds-switch member


Note This command has been deprecated in current Cisco IOS releases and has been replaced by the hccp channel-switch command.


Syntax Description

group

The group number for the specified interface. Valid values are any number from 1 to 255, inclusive.

member

The member number within the specified group.

make

The maker of the specified upconverter. Currently, only the Wavecom upconverter is supported (wavecom).

host-ipaddr

The IP address of the upconverter module1 to which the host CMTS is connected.

host-module

The upconverter module number to which the host CMTS is connected. This location is expressed as a simple numeric designation.

peer-ipaddr

The IP address of the upconverter module to which the peer (or remote) CMTS is connected.

peer-module

The upconverter module number1 to which the peer (or remote) CMTS is connected. This location is expressed as a simple numeric designation.

1 The identification of the upconverter module is important to define when the host or peer CMTS is connected to a channel switch housing multiple modules. For example, the Wavecom MA4040D upconverter chassis offers a maximum of 10 independent frequency agile upconverters.


Command Default

Upconverter specification and activation is disabled by default and must be specified before switching can take place.

Command Modes

Interface configuration (cable interface only)

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

This command was deprecated and replaced by the hccp channel-switch command.


Usage Guidelines

It is necessary to configure the downstream upconverter module for all Protect CMTS and Working CMTS systems. If you do not specify the downstream upconverter module for all Protect CMTS and Working CMTS systems, you cannot switch between a Protect CMTS and Working CMTS.

Examples

The following excerpt from a configuration file specifies module 2 on a Wavecom upconverter at IP address 1.1.11.3 as the host switch module connected to Working CMTS 1 and module 1 on the same Wavecom upconverter (with the same IP address location) as the peer or remote switch module connected to the Protect CMTS:

hccp 1 working 1
hccp ds-switch 1 wavecom 1.1.11.3 2 1.1.11.3 1

Related Commands

Command
Description

hccp channel-switch

(replaces the hccp ds-switch command).

hccp protect

Allows you to configure a Cisco CMTS to be a Protect CMTS for a specified Working CMTS in a 1+1 redundancy environment.

hccp working

Allows you to designate a Cisco CMTS to be a Working CMTS in a 1+1 redundancy environment.

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.


hccp lockout

To prevent a Working CMTS from automatically switching to a Protect CMTS in the same group, use the hccp lockout command in privileged EXEC mode.


Note This command is applicable only to Working CMTS in a given group. Issuing this command on a Protect CMTS has no effect.


hccp group lockout member

Syntax Description

group

The group number for the specified interface. Valid values are any number from 1 to 255, inclusive.

member

The member number within the specified group.


Command Default

By default, the hccp lockout command is inactive.

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.


Usage Guidelines

Typically the hccp lockout command is used to disable HCCP switchovers before removing the HCCP configuration on the Working interface. Otherwise, when you remove the HCCP configuration from the Working interface, the Protect interface assumes the Working interface has failed and switches over.

You might also want to prevent a Working CMTS from automatically switching back to a Protect CMTS for testing or additional configuration purposes. For example, you might want to fully test protecting cable interfaces on your Cisco CMTS before returning it to protect status.

Examples

The following example shows how to activate the lockout feature of a Working CMTS in group 1:

Router# hccp 1 lockout

Related Commands

Command
Description

hccp unlockout

Negates the effects of the hccp lockout EXEC command, making the CMTS available for automatic switchover from a Working CMTS to a Protect 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.


hccp protect

To configure a particular cable interface to protect another cable interface in the same group, use the hccp protect command in cable interface configuration mode. To undo a particular host cable interface protection assignment, use the no form of this command.

hccp group protect member ipaddr

no hccp group protect member

Syntax Description

group

The group number of both the Working and Protect cable interfaces. Valid values are any number from 1 to 255, inclusive.

member

The member number of the specified Working cable interface. Valid values are any number from 1 to 255, inclusive.

ipaddr

An IP address for any working interface (other than protected cable interfaces) installed in the Working CMTS that can transmit and receive redundancy status messages.


Command Default

No default behavior or values

Command Modes

Interface configuration (cable interface only)

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.


Usage Guidelines

The protect cable interface must be configured identically to the working cable interface, which typically means the interfaces must be the same card type. However, when the Cisco uBR-MC16S card is used, it can be used with either another Cisco uBR-MC16S card or a Cisco uBR-MC16C card.

Table 19 shows how a switchover affects the enhanced spectrum management features of the Cisco uBR-MC16S card.

Table 19 Switchover Operation for a Cisco uBR-MC16C/Cisco uBR-MC16S Configuration

Working Cable Interface
Protect Cable Interface
Operation After Switchover

Cisco uBR-MC16C

Cisco uBR-MC16S

The protect card (Cisco uBR-MC16S) uses the same upstream frequency as the working card, but after the system stabilizes, the protect card begins using the enhanced spectrum management features of the Cisco uBR-MC16S card, as configured on the protect CMTS.

Cisco uBR-MC16S

Cisco uBR-MC16C

The protect card (Cisco uBR-MC16C) uses the same upstream frequency as the working card. If the upstream becomes unstable, the Cisco uBR-MC16C performs only blind frequency hopping.

Cisco uBR-MC16S

Cisco uBR-MC16S

The protect card initially uses the same upstream frequency as the working card, but after the system stabilizes, the protect card continues using the enhanced spectrum management features of the Cisco uBR-MC16S card.


Examples

The following example configures host cable interface 4/0 to protect member 2 of group 2 at IP address 1.1.11.2:

Router(config)# interface cable 4/0 
Router(config-if)# hccp 2 protect 2 1.1.11.2 

Related Commands

Command
Description

cable downstream rf-power

Sets the RF power output level on a cable interface line card with an integrated upconverter (including the ability to specify an override or delta power value for a Protect interface).

hccp working

Configures a specified cable interface to be a working member of a given group.

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.


hccp resync

To manually synchronize the Inter-database between the Working and Protect interfaces for a particular member in an Hot Standby Connection-to-Connection Protocol (HCCP) group, use the hccp resync command in privileged EXEC mode.

hccp group resync member

Syntax Description

group

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

member

The member ID to be resynchronized. The valid range is 1 to 255.


Command Default

No default behavior or values.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(4)XF1, 12.2(4)BC1

This command was introduced for the Cisco uBR10012 router and Cisco uBR-LCP-MC28C card with the Cisco RF Switch.

12.2(8)BC2

Support was added for the Cisco uBR10012 router using the Cisco uBR-LCP-MC16C, Cisco uBR-LCP-MC16E, and Cisco uBR-LCP-MC16S cards with the Cisco RF Switch.

12.2(11)BC1

Support was added for the Cisco uBR7246VXR router and Cisco uBR-MC16C, Cisco uBR-MC16S, and Cisco uBR-MC28C cards with the Cisco RF Switch.


Usage Guidelines

The Cisco CMTS automatically synchronizes the Working and Protect interfaces to ensure that when a switchover occurs, the Protect interface will run with a configuration that is identical to that of the Working interface. However, if you are troubleshooting HCCP problems, you can manually resynchronize the databases using the hccp resync command before performing any switchover tests.


Note When a SYNC event command is occurring, CLI commands might be very slow to respond. In particular, if you enter a show command at the same time a SYNC event is occurring, the command might respond produce a blank display, or it might display an error message similar to the following:

%No response from slot 6/1. Command aborted

If this occurs, wait a minute or so and retry the command.


Examples

The following example shows how to manually resynchronize the Inter-database between the Working and Protect interfaces for member 4 in HCCP group 13:

Router# hccp 13 resync 4 
Router# 

Related Commands

Command
Description

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.


hccp revertive

To configure a cable interface on a Protect CMTS that has assumed working capacity to automatically revert back to the Working CMTS, use the hccp revertive command in cable interface configuration mode. To disable the ability for the specified cable interface to automatically revert back to protect status, use the no form of this command.

hccp group revertive

no hccp group revertive

Syntax Description

group

The group number for the specified interface. Valid values are any number from 1 to 255, inclusive.


Command Default

Enabled

Command Modes

Interface configuration (cable interface only)

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

Using this command in conjunction with the hccp reverttime command gives you the ability to set up your protecting cable interfaces to automatically switch between working and protecting capacity without your intervention. Otherwise, whenever a switchover has occurred, you must manually reactivate the failed Working CMTS and manually return the Protect CMTS to protect status using the hccp switch command.


Tip If you are using the hccp revertive command on a cable interface, do not also configure the hccp track command. Configuring both commands on the same interface can cause multiple switchovers on the same fault.


Using hccp track with hccp revertive

As a general rule, if you are using the hccp track command on a cable interface, do not also configure the hccp revertive command without also configuring no keepalive on the cable interface. Configuring both commands on the same interface, along with keepalives, can cause multiple switchovers on the same fault.

If you want to use keepalives along with both the hccp track and hccp revertive commands,use the hccp track command on both the Working and Protect interfaces, so that the Working interfaces on the same card track each other and the Protect interfaces on the same card track each other. Table 20 summarizes the guidelines for using these three commands:

Table 20 Possible hccp track and hccp revertive Configurations 

hccp track
(Working I/Fs)
hccp track
(Protect I/Fs)
hccp revertive
keepalive Configuration

Yes

No

No

keepalive or no keepalive

Yes

No

Yes

no keepalive

Yes

Yes

Yes

keepalive or no keepalive


Examples

The following example shows cable interface 4/0 on a Protect CMTS in group 2 being configured to automatically revert to protect status after the Working CMTS peer has returned to active duty:

router(config)# interface cable 4/0 
router(config-if)# hccp 2 revertive 

Related Commands

Command
Description

hccp reverttime

Specifies the time that the Working CMTS waits before automatically switching back to a Working CMTS following system switchover.

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.


hccp reverttime

To specify the amount of time a Protect interface waits before automatically reverting back to a Working interface following a system switchover, use the hccp reverttime command in cable interface configuration mode on the Working CMTS. To set the revert-time back to its default value, use the no form of this command.

hccp group reverttime revert-time

no hccp group reverttime

Syntax Description

group

The group number for the specified interface. Valid values are any number from 1 to 255, inclusive.

revert-time

The amount of time (in minutes) that a Protect interface waits before automatically switching back to a Working interface following a system switchover. The allowable range is 1 to 65,535 minutes, with a default of 30 minutes.


Command Default

30 minutes

Command Modes

Interface configuration (cable interface only, on the Working CMTS)

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.


Usage Guidelines

Use this command to configure the revert-time on the cable interfaces on the Working CMTS so that the Working CMTS will automatically resume normal operations and the Protect CMTS will automatically resume normal protect operations, in case an operator forgets to manually switch the Working CMTS back into operation after fixing the original problem.

The Working CMTS first counts down two minutes of suspend time before starting to count down the revert-time. Any failures that occur within this two-minute suspend time are considered part of the same failure.

This means that the actual time that the Working CMTS will attempt to switch back after a switchover is two minutes plus the revert-time. For example, if the revert-time is set to its default of 30 minutes, the Working CMTS will attempt to switch back into operation 32 minutes after the initial switchover to the Protect CMTS.

After the suspend time has occurred, a failure in the Protect CMTS will cause a switchover to the Working CMTS, regardless of whether the revert-time has expired or not. You can force such a failure in the Protect CMTS, and restore the Working CMTS to operation without waiting for the revert-time, by using the cable power off and cable power on commands to turn off and turn on the protect interface on the Protect CMTS.

When choosing a revert-time, take into account all possible sources of failures, including third-party equipment. For example, an upconverter failure can trigger a switchover to the Protect CMTS. You should configure the revert-time so that the Working CMTS does not switch back into operation until technicians have had sufficient time to fix the equipment failure.


Tip To disable the revert-time feature, use the no version of the hccp revertive command on the Protect CMTS.


Examples

The following example shows cable interface 3/0 on a Working CMTS in group 2 being configured to wait 15 minutes before automatically reverting back to working status after a system switchover:

router(config)# interface cable 3/0 
router(config-if)# hccp 2 reverttime 15 

The following example shows how to give the no form of this command, which resets the interface back to its default value of 30 minutes.

router(config)# interface cable 5/1/0 
router(config-if)# no hccp 2 reverttime 

Related Commands

Command
Description

hccp revertive

Configures a cable interface on a Protect CMTS to automatically revert back to 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.


hccp switch

To manually switch a Protect CMTS with its Working CMTS peer (or vice versa), use the hccp switch command in privileged EXEC mode.

hccp group switch member

Syntax Description

group

The group number for the specified interface. Valid values are any number from 1 to 255, inclusive.

member

The member number for the specified interface. Valid values are any number from 1 to 255, inclusive.


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.2(11)BC3

This command is automatically disabled for approximately 2 to 3 seconds after a PRE module switches over to allow the system to stabilize before performing another switchover.


Usage Guidelines

This command overrides any configuration you may have made on your Protect CMTS and Working CMTS using the hccp revert and hccp reverttime commands. In addition, you can issue the hccp switch command on either a Protect CMTS or a Working CMTS to force it to change places with its peer.

Examples

The following example shows the host Protect CMTS being configured to assume traffic responsibility for member 2 Working CMTS in group 2:

Router# hccp 2 switch 2R

Related Commands

Command
Description

hccp lockout

Prevents a Working CMTS from automatically switching to a Protect CMTS in the same group.

hccp unlockout

Negates the effects of the hccp lockout command, making the CMTS available for automatic switchover from a Working CMTS to a Protect 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.


hccp timers

To configure HELLO packet interval and hold time for a specified group on a Protect CMTS, use the hccp timers command in cable interface configuration mode. To erase the HELLO interval and hold time configuration and to assume the default values for each parameter, use the no form of this command.

hccp group timers hello-time hold-time

no hccp group timers [hello-time hold-time]


Note Issuing the no form of this command erases any manual HELLO interval and hold time values and automatically resets them to their default values.


Syntax Description

group

The group number for the specified interface. Valid values are any number from 1 to 255, inclusive.

hello-time

The HELLO packet interval (in milliseconds) between subsequent HELLO packet transmissions. The acceptable range is 1666 to 5,000 milliseconds, inclusive.

hold-time

The time (in milliseconds) that a Protect CMTS will wait before assuming control of voice traffic for a Working CMTS that has failed to acknowledge a series of HELLO packets. The acceptable range is 5,000 to 25,000 milliseconds, inclusive.


Command Default

The default HELLO interval is 2,000 milliseconds, and the default hold time is 6,000 milliseconds.

Command Modes

Interface configuration (cable interface only)

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.


Examples

The following example shows the HELLO interval and hold time on a Protect CMTS in group 2 being configured to 1,750 and 3,000 milliseconds, respectively:

Router(config)# interval c4/0 
Router(config-if)# hccp 2 timers 1750 3000 

Related Commands

Command
Description

hccp protect

Configures a particular cable interface to protect another peer cable interface in the same group.

hccp working

Configures a specified cable interface to be a working member of a given group.

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.


hccp track

To configure a cable interface on a Working CMTS or Protect CMTS to enable automatic switchover based on the interface state, use the hccp track command in cable interface configuration mode. To disable the automatic switchover based on interface state, use the no form of this command.

hccp group track [interface]

no hccp group track [interface]

Syntax Description

group

The group number for the specified interface. Valid values are any number from 1 to 255, inclusive.

interface

Specifies another cable interface (the default is the current cable interface).


Command Default

Enabled for the current interface

Command Modes

Interface configuration (cable interface only)

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.


Usage Guidelines

This command enables automatic switchover of one interface when a tracked interface switches over from "up" to "down."

Typically, this command is used to allow all interfaces on one card to track one another, so that if one interface goes down and switches over to the Protect, all other interfaces can also switch over, allowing the Protect card to assume full operation for these interfaces. This allows support engineers to troubleshoot the problem on the Working interface, or to remove and replace the Working card, if necessary, without interfering with traffic.

Using hccp track with hccp revertive

As a general rule, if you are using the hccp track command on a cable interface, do not also configure the hccp revertive command without also configuring no keepalive on the cable interface. Configuring both commands on the same interface, along with keepalives, can cause multiple switchovers on the same fault.

If you want to use keepalives along with both the hccp track and hccp revertive commands,use the hccp track command on both the Working and Protect interfaces, so that the Working interfaces on the same card track each other and the Protect interfaces on the same card track each other. Table 21 summarizes the guidelines for using these three commands:

Table 21 Possible hccp track and hccp revertive Configurations 

hccp track
(Working I/Fs)
hccp track
(Protect I/Fs)
hccp revertive
keepalive Configuration

Yes

No

No

keepalive or no keepalive

Yes

No

Yes

no keepalive

Yes

Yes

Yes

keepalive or no keepalive


Examples

The following example shows switchover behavior being enabled on a Cisco CMTS in group 2:

Router(config)# interface c3/0 
Router(config-if)# hccp 2 track 
Router(config-if)# keepalive 
Router(config-if)# 

The following example shows two Cisco uBR-LCP2-MC28C cards being used in a Cisco uBR10012 router, with each downstream being configured for a separate HCCP group. The card in slot 5/1 is being configured as the Working interfaces and the card in slot 6/1 is being configured as the Protect interfaces.

The two downstreams on each card track each other, so if one downstream fails and switches over, the other can do so as well, allowing the Protect card to assume full control of both interfaces. Similarly, when the Working interfaces come back into service, both Protect interfaces switch back at the same time.

Router(config)# interface cable c5/1/0 
Router(config-if)# hccp 1 working 1 
Router(config-if)# hccp 1 track c5/1/1 
Router(config-if)# keepalive 3 
Router(config-if)# exit 
Router(config)# interface cable c5/1/1 
Router(config-if)# hccp 2 working 1 
Router(config-if)# hccp 2 track c5/1/0 
Router(config-if)# keepalive 3 
Router(config-if)# exit 
Router(config)# interface cable c6/1/0 
Router(config-if)# hccp 1 protect 1 ip-address-of-mgmt-lan 
Router(config-if)# hccp 1 track c6/1/1 
Router(config-if)# keepalive 3 
Router(config-if)# exit 
Router(config)# interface cable c6/1/1 
Router(config-if)# hccp 2 protect 1 ip-address-of-mgmt-lan 
Router(config-if)# hccp 2 track c6/1/0 
Router(config-if)# keepalive 3 
Router(config-if)# 

Related Commands

Command
Description

keepalive

A global configuration command that allows you to specify the keepalive message transmission interval on a Working CMTS or Protect CMTS. For more specific information, see the Cisco IOS Interface Command Reference on Cisco.com.

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.


hccp unlockout

To reverse the effects of the hccp lockout command—that is, to make a Working CMTS available for automatic switchover to Protect CMTS, use the hccp unlockout command in privileged EXEC mode.

hccp group unlockout member

Syntax Description

group

The group number for the specified interface. Valid values are any number from 1 to 255, inclusive.

member

The member number within the specified group.


Command Default

By default, the hccp unlockout command is active for all groups and members.

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.


Usage Guidelines

This command reverses the effect of the hccp lockout command. Once you have reconfigured or tested your Protect CMTS, issuing this command manually reintroduces the CMTS back into your 1+1 redundancy protection scheme.


Note This command is applicable only on a Working CMTS in a given group. Issuing this command on a Protect CMTS has no effect.


Examples

The following example shows the lockout feature of a Working CMTS in group 1 being deactivated:

hccp 1 unlockout

Related Commands

Command
Description

hccp lockout

Prevents a Working CMTS from automatically switching to a Protect CMTS in the same group.

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.


hccp working

To designate a cable interface on a CMTS in the specified group to be a Working CMTS, use the hccp working command in cable interface configuration mode. To remove a Working CMTS assignment, use the no form of this command.

hccp group working member

no hccp group working member

Syntax Description

group

The group number for the specified interface. Valid values are any number from 1 to 255, inclusive.

member

The member number for the specified interface. Valid values are any number from 1 to 255, inclusive.


Command Default

No default behavior or values

Command Modes

Interface configuration (cable interface only)

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.


Usage Guidelines

When N+1 HCCP redundancy is configured, the Protect interface switches over and becomes the active interface when it detects a situation similar to the following:

The Working interface is removed from the chassis, is powered down, or is reset

The Working interface crashes

The Working interface no longer sends out regular keepalive messages

The Working interface loses connectivity with the cable network

The Protect cable interface must be configured identically to the Working cable interface, which typically means the interfaces should be the same card type. However, when the Cisco uBR-MC16S is used, it can be used with either another Cisco uBR-MC16S card or a Cisco uBR-MC16C card.

Table 22 shows how a switchover affects the enhanced spectrum management features of the Cisco uBR-MC16S card.

Table 22 Switchover Operation for a Cisco uBR-MC16C/Cisco uBR-MC16S Configuration

Working Cable Interface
Protect Cable Interface
Operation After Switchover

Cisco uBR-MC16C

Cisco uBR-MC16S

The protect card (Cisco uBR-MC16S) uses the same upstream frequency as the working card, but after the system stabilizes, the protect card begins using the enhanced spectrum management features of the Cisco uBR-MC16S card, as configured on the protect CMTS.

Cisco uBR-MC16S

Cisco uBR-MC16C

The protect card (Cisco uBR-MC16C) uses the same upstream frequency as the working card. If the upstream becomes unstable, the Cisco uBR-MC16C performs only blind frequency hopping.

Cisco uBR-MC16S

Cisco uBR-MC16S

The protect card initially uses the same upstream frequency as the working card, but after the system stabilizes, the protect card continues using the enhanced spectrum management features of the Cisco uBR-MC16S card.


Examples

The following example shows cable interface 4/0 being designated as a Working CMTS interface as member number 2 of group 2:

Router(config)# interface cable 4/0 
Router(config-if)# hccp 2 working 2 

Related Commands

Command
Description

hccp protect

Configures a particular cable interface to protect another cable interface in the same group.

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.


hold-queue

To limit the size of the IP output queue on an interface, use the hold-queue command in interface configuration mode. To restore the default values, use the no form of this command.

hold-queue length {in | out}

no hold-queue {in | out}

Syntax Description

length

Integer that specifies the maximum number of packets in the queue. The range of valid values is from 0 to 65535.

in

Specifies the input queue. The default is 75 packets. For asynchronous interfaces, the default is 10 packets.

out

Specifies the output queue. The default is 40 packets. For asynchronous interfaces, the default is 10 packets.


Defaults

Input hold-queue limit is 75 packets.
Output hold-queue limit is 40 packets.
Asynchronous interfaces default is 10 packets.

Command Modes

Interface configuration (config-if)

Command History

Release
Modification

10.0

This command was introduced.

11.1

The no hold-queue command was added.

12.2(14)SX

Support for this command was introduced on the Supervisor Engine 720.

12.2(17d)SXB

Support for this command on the Supervisor Engine 2 was extended to Cisco IOS Release 12.2(17d)SXB.

12.2(33)SRA

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

12.2(33)SCB

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


Usage Guidelines

Defaults

The default limits or this command prevent a malfunctioning interface from consuming an excessive amount of memory. There is no fixed upper limit to a queue size.

Back-to-Back Routing Updates

The default of 10 packets allows the Cisco IOS software to queue a number of back-to-back routing updates. This is the default for asynchronous interfaces only; other media types have different defaults.

Hold Queues and Priority Queueing

The hold queue stores packets received from the network that are waiting to be sent to the client. Cisco recommends that the queue size not exceed10 packets on asynchronous interfaces. For most other interfaces, queue length should not exceed 100.

The input hold queue prevents a single interface from flooding the network server with too many input packets. Further input packets are discarded if the interface has too many input packets outstanding in the system.

If you are using priority output queueing, the length of the four output queues is set using the priority-list global configuration command. The hold-queue command cannot be used to set an output hold queue length in this situation.

For slow links, use a small output hold-queue limit to prevent storing packets at a rate that exceeds the transmission capability of the link.

For fast links, use a large output hold-queue limit. A fast link may be busy for a short time (and require the hold queue) but can empty the output hold queue quickly when capacity returns.

You can display the current hold-queue setting and the number of packets that are discarded because of hold-queue overflows by using the show interfaces command in user EXEC mode.


Caution Increasing the hold queue can have detrimental effects on network routing and response times. For protocols that use seq/ack packets to determine round-trip times, do not increase the output queue. Dropping packets instead informs hosts to slow down transmissions to match available bandwidth.

This is generally better than having duplicate copies of the same packet within the network (which can happen with large hold queues).

Examples

The following example shows how to set a small input queue on a slow serial line:

Router(config)# interface serial 0
Router(config-if)# hold-queue 30 in

Cisco uBR10012 Universal Broadband Router

The following example shows how to modify the input hold queue on a Gigabit Ethernet SPA:

Router# configure terminal 
Router(config)#interface GigabitEthernet3/0/0
Router(config-if)#hold-queue 30 in

Related Commands

Command
Description

priority-list

Establishes queueing priorities based on the protocol type.

show interfaces

Displays statistics for all interfaces configured on the router or access server.


hw-module bay reload

To reload the software and restart a SPA, use the hw-module bay reload command in privileged EXEC mode.

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

hw-module bay slot/subslot/bay reload

Cisco IOS Release 12.2(33)SCB

hw-module bay slot/bay/port reload

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

No default behavior or values

Command Modes

Privileged EXEC (#)

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 a SPA from slot/subslot/bay to slot/bay/port.


Usage Guidelines

The hw-module bay reload command reloads the software and restarts a SPA.

Examples

The following example shows how to reload the software for the Cisco Wideband SPA in slot 1, subslot 0, and bay 1.

Router# hw-module bay 1/0/1 reload 
Router#

Related Commands

Command
Description

hw-module shutdown

Shuts down a PRE1 module, line card, SIP, or SPA.


hw-module sec-cpu reset

To reset and reload the standby Route Switch Processor (RSP) with the specified Cisco IOS image and to execute the image, use the hw-module sec-cpu reset command in privileged EXEC mode.

hw-module sec-cpu reset

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC (#)

Command History

Release
Modification

12.0(16)ST

This command was introduced.

12.0(19)ST1

This command was enabled in privileged EXEC mode.

12.0(22)S

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

12.2(4)XF

This command was integrated into Cisco IOS Release 12.2(4)XF on the Cisco uBR10012 router.

12.2(14)S

This command was integrated into Cisco IOS Release 12.2(14)S.

12.3(7)T

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

12.3BC

This command was integrated into Cisco IOS Release 12.3BC.

12.2(33)SRA

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

12.2(31)SB2

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

12.2SX

This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.


Usage Guidelines

Before using this command, you must use the hw-module slot image global configuration command to specify a high availability Cisco IOS image to run on the standby RSP. After the high availability image is loaded in the active RSP, use the hw-module sec-cpu reset command to reset and reload the standby RSP with the specified Cisco IOS image and to execute the image. To load the standby RSP with the default micro-IOS software contained in the active RSP image instead of a high availability Cisco IOS image, use the no form of the hw-module slot image command followed by the hw-module sec-cpu reset command.

Examples

The following example shows a Cisco 7513 router with the standby RSP loaded in slot 7. The standby RSP is reset and reloaded with the rsp-pv-mz high availability Cisco IOS image. Both RSPs have slot 0 flash memory cards.

Router(config)# hw-module slot 7 image slot0:rsp-pv-mz
Router(config)# end
Router# hw-module sec-cpu reset

Related Commands

Command
Description

hw-module slot image

Specifies a high availability Cisco IOS image to run on an active or standby RSP.


hw-module shutdown (ubr10012)

To shut down a particular Performance Routing Engine (PRE1) module, line card, Wideband SIP or Wideband SPA, use the hw-module shutdown (ubr10012) command in global configuration mode. To activate a specific PRE1, line card, Wideband SIP or Wideband SPA, use the no form of this command.

hw-module {main-cpu | pre {A|B} | sec-cpu | slot slot-number | subslot slot/subslot|
bay slot/subslot/bay} shutdown [unpowered]

no hw-module {main-cpu | pre {A|B} | sec-cpu | slot slot-number | subslot slot/subslot |
bay slot/subslot/bay} shutdown

Syntax Description

main-cpu

Shuts down the PRE1 module that is currently acting as the active PRE1 module.

pre {A|B}

Shuts down the PRE1 module that is physically in either PRE slot A (left slot) or PRE slot B (right slot).

sec-cpu

Shuts down the PRE1 module that is currently acting as the standby PRE1 module.

slot slot-number

Shuts down the line cards that are physically present in the specified slot-number (valid range is 1 to 8).

subslot slot/subslot

Shuts down the line card or SIP that is physically present in the slot with the specified slot and subslot numbers. The following are the valid values:

slot = 1 to 8

subslot = 0 or 1

bay slot/subslot/bay

Shuts down the SPA in the location specified by the slot/subslot/bay argument. 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)

unpowered

Used with the Wideband SPA, shuts down the SPA and its interfaces, and leaves them in an administratively down state without power.


Command Default

No default behavior or values

Command Modes

Global configuration

Command History

Release
Modification

12.2(4)XF

This command was introduced for the Cisco uBR10012 router.

12.3(21)BC

Support was added for the Cisco Wideband SIP and Cisco 1-Gbps Wideband SPA.


Usage Guidelines

The hw-module shutdown (ubr10012) command shuts down in a controlled manner a particular Performance Routing Engine (PRE1) module, line card, Wideband SIP or Wideband SPA. To activate a specific PRE1, line card, Wideband SIP, or Wideband SPA, use the no form of this command.


Caution Shutting down the active PRE1 module will trigger a switchover, so that the standby PRE1 module becomes the active PRE1 module.

Examples

The following example shows the standby PRE1 module being shut down:

Router(config)# hw-module sec-cpu shutdown 
Router(config)#

The following example shows the active PRE1 module being shut down (which will trigger a switchover to the standby PRE1 module):

Router(config)# hw-module main-cpu shutdown 
Router(config)# 

The following example shows the PRE1 module in PRE1 slot B being shut down:

Router(config)# hw-module pre B shutdown 
Router(config)# 

Note The hw-module pre B shutdown command shuts down the PRE1 module that is physically present in slot B, regardless of whether the module is the active or standby PRE1 module.


The following example shows how to deactivate and verify deactivation for the Cisco Wideband SPA located in slot 1, subslot 0, bay 0. In the output of the show hw-module bay oir command, notice the "admin down" in the Operational Status field.

Router# configure terminal
Router(config)# hw-module bay 1/0/0 shutdown unpowered
%SPAWBCMTS-4-SFP_MISSING: Wideband-Cable 1/0/0, 1000BASE-SX SFP missing from port 0
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:1, changed state to down
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:2, changed state to down
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:3, changed state to down
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:4, changed state to down
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:5, changed state to down
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:6, changed state to down
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:7, changed state to down
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:8, changed state to down
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:9, changed state to down
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:10, changed state to down
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:11, changed state to down
...
Router# show hw-module bay 1/0/0 oir

Module         Model              Operational Status
-------------- ------------------ -------------------------
bay 1/0/0      SPA-24XDS-SFP      admin down

The following example shows how to activate and verify activation for the Cisco Wideband SPA located in slot 1, subslot 0, bay 0. In the output of the show hw-module bay oir command, notice the "ok" in the Operational Status field.

Router# configure terminal
Router(config)# no hw-module bay 1/0/0 shutdown
%SPAWBCMTS-4-SFP_OK: Wideband-Cable 1/0/0, 1000BASE-SX SFP inserted in port 0
%SPAWBCMTS-4-SFP_LINK_OK: Wideband-Cable 1/0/0, port 0 link changed state to up
%SNMP-5-LINK_UP: LinkUp:Interface Wideband-Cable1/0/0:0 changed state to up
%LINK-3-UPDOWN: Interface Cable1/0/0:0, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:1, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:2, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:3, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:4, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:5, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:6, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:7, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:8, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:9, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:10, changed state to up
%LINK-3-UPDOWN: Interface Wideband-Cable1/0/0:11, changed state to up
%LINEPROTO-5-UPDOWN: Line protocol on Interface Wideband-Cable1/0/0:0, changed state to up
...
Router# show hw-module bay 1/0/0 oir

Module         Model              Operational Status
-------------- ------------------ -------------------------
bay 1/0/0      SPA-24XDS-SFP      ok

Related Commands

Command
Description

hw-module reset

Resets a PRE1 module or line card.

hw-module reload

Reloads the software in and restarts a Cisco 1-Gbps Wideband SPA.

redundancy force-failover main-cpu

Forces a manual switchover between the active and standby PRE1 modules.


hw-module slot pos

To configure a line card slot for Packet over SONET (POS) operation, use the hw-module slot pos command in privileged EXEC mode. To remove the configuration for a line card slot, use the no form of this command.

hw-module slot slot-number pos

no hw-module slot slot-number pos

Syntax Description

slot-number

Resets the line cards that are physically present in the specified slot-number (valid range is 1 to 8).


Defaults

No default behavior or values

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(11)BC3

This command was introduced for the Cisco uBR10012 OC-48 Dynamic Packet Transport (DPT) Interface Module for the Cisco uBR10012 router.


Usage Guidelines

You must first use the hw-module slot pos command to preconfigure a line card slot for POS operation of the Cisco uBR10012 OC-48 DPT card before you can configure the card with any further commands. You must also use the card 1oc48dpt/pos-1 command to configure the card slot for the proper card type.


Note If you have previously used the hw-module slot srp command to configure line card slots for Spatial Reuse Protocol (SRP) operation, you must first cancel that configuration using the no hw-module slot srp command before you can configure the slots for POS operation using the hw-module slot pos command.


Examples

The following example shows the Cisco uBR10012 OC-48 DPT line card in slot 3 being configured for POS operation:

Router# hw-module slot 3 pos 
Router# card 3/0 1oc48dpt/pos-1 

The following example shows the Cisco uBR10012 OC-48 DPT line cards in slots 3 and 4 being reconfigured from SRP operation to POS operation:

Router# no hw-module slot 3 srp 
Router# no hw-module slot 4 srp 
Router# hw-module slot 3 pos 
Router# card 3/0 1oc48dpt/pos-1 
Router# hw-module slot 4 pos 
Router# card 4/0 1oc48dpt/pos-1 

Related Commands

Command
Description

hw-module reset

Resets a PRE1 module or line card.

hw-module shutdown (ubr10012)

Shuts down a PRE1 module or line card.

hw-module slot srp

Configures a line card slot for SRP operation.


hw-module slot srp

To configure a line card slot for Spatial Reuse Protocol (SRP) operation, use the hw-module slot srp command in privileged EXEC mode. To remove the configuration for a line card slot, use the no form of this command.

hw-module slot slot-number srp

no hw-module slot slot-number srp

Syntax Description

slot-number

Resets the line cards that are physically present in the specified slot-number (valid range is 1 to 8).


Defaults

No default behavior or values

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(11)BC3

This command was introduced for the Cisco uBR10012 OC-48 Dynamic Packet Transport (DPT) Interface Module for the Cisco uBR10012 router.

12.2(33)SCB

This command is obsolete.


Usage Guidelines

You must first use the hw-module slot srp command to preconfigure a line card slot for SRP operation of a pair of Cisco uBR10012 OC-48 DPT cards before you can configure the cards with any further commands. You must also use the card 1oc48dpt/pos-1 command to configure each card slot for the proper card type.


Tip The Cisco uBR10012 OC-48 DPT line cards support SRP operation only when installed in adjacent odd- and even-numbered slots (such as slots 1 and 2 or 3 and 4). You need to use the hw-module slot srp command only for the lower-numbered (odd-numbered) slot to preconfigure both slots of the SRP pair.



Note If you have previously used the hw-module slot pos command to configure line card slots for Packet over SONET (POS) operation, you must first cancel that configuration using the no hw-module slot pos command before you can configure the slots for POS operation using the hw-module slot srp command.


Examples

The following example shows the Cisco uBR10012 OC-48 DPT line cards in slots 1 and 2 being configured for POS operation:

Router# hw-module slot 1 srp 
Router# card 1/0 1oc48dpt/pos-1 
Router# card 2/0 1oc48dpt/pos-1 

The following example shows the Cisco uBR10012 OC-48 DPT line cards in slots 3 and 4 being reconfigured from POS operation to SRP operation:

Router# no hw-module slot 3 pos 
Router# no hw-module slot 4 pos 
Router# hw-module slot 3 srp 
Router# card 3/0 1oc48dpt/pos-1 
Router# card 4/0 1oc48dpt/pos-1 

Related Commands

Command
Description

hw-module reset

Resets a PRE1 module or line card.

hw-module shutdown (ubr10012)

Shuts down a PRE1 module or line card.

hw-module slot pos

Configures a line card slot for POS operation.