Cable Commands: d through h

default-nit-reference

To configure Network Information Table (NIT) reference, use the default-nit-reference command in the video configuration mode.

default-nit-reference PID

Syntax Description

PID

The NIT reference PID. The reference PID must be in the range of 1 to 8190.

Command Default

None

Command Modes

Video configuration mode (config-video)

Command History

Release Modification

Cisco IOS XE Fuji 16.7.1

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

Usage Guidelines

The NIT helps in conveying information about the physical organization of the multiplexes and transport streams (TS) carried through a specific network and also the characteristics of the network.

Use the no default-nit-reference command to remove the configured NIT PID.

Examples

The following example shows how to configure the NIT reference.

configure terminal
Enter configuration commands, one per line.  End with CNTL/Z.
 cable video
   default-nit-reference ?
    <1-8190>  1-8190

   default-nit-reference 100
%%All existing sessions will be updated with default-nit-reference.
Re-configure Default NIT reference? [Yes/No][confirm]

default-onid

To set the default ONID number, use the default-onid command in the video configuration mode.

default-onid number

Syntax Description

number

The ONID number. By default, the system ONID is 0, which is commonly used in North America. If the default value of the ONID is used, the TSID must be unique. If you change the ONID, the TSID-ONID pair must be unique. The ONID must be in the range of 0 to 65535.

Command Default

None.

Command Modes

Video configuration mode (config-video)

Command History

Release Modification
Cisco IOS-XE Release 3.18.0S

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

Usage Guidelines

This command is used to change the deault system ONID.

Examples

The following example shows how to change the default ONID number:

configure terminal 
cable video 
default-onid 1580 

default-psi-interval

To set the default Program Specific Information (PSI) interval number, use the default-psi-interval command in the video configuration mode.

default-psi-interval number

Syntax Description

number

The PSI interval number. By default, PSI interval is 100 msec. The PSI interval must be in the range of 40 to 1000 msec.

Command Default

None.

Command Modes

Video configuration mode (config-video)

Command History

Release Modification
Cisco IOS-XE Release 3.18.0S

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

Usage Guidelines

This command is used to change the default PSI interval.

Examples

The following example shows how to change the default PSI interval:

configure terminal 
cable video 
default-psi-interval 400 

depi-class

To create a template of Downstream External PHY Interface (DEPI) control plane configuration settings, which different pseudowire classes can inherit, and to enter the DEPI class configuration mode, use the depi-class command in global configuration mode. To remove a specific DEPI class configuration, use the no form of this command.

depi-class depi-class-name

no depi-class depi-class-name

Syntax Description

depi-class-name

Name of the DEPI class. The depi-class-name argument must be specified to configure multiple sets of DEPI control parameters.

Command Default

No DEPI classes are defined.

Command Modes


Global configuration (config)

Command History

Release

Modification

12.2(33)SCC

This command was introduced.

IOS-XE 3.15.0S

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

Usage Guidelines

The depi-class depi-class-name command allows you to configure a DEPI class template that consists of configuration settings used by different pseudowire classes. The depi-class command enters DEPI class configuration mode, where DEPI control plane parameters are configured.

You must use the same DEPI class in the pseudowire configuration at both ends of a Layer 2 control channel.

Examples

The following example shows how to enter DEPI class configuration mode to create a DEPI class configuration template for the class named SPA0:


Router# configure terminal
Router(config)# depi-class SPA0
Router(config-depi-ctrl SPA0)#

depi-tunnel

To create a template of Downstream External PHY Interface (DEPI) tunnel configuration settings, which different pseudowire classes can inherit, and to enter the DEPI data session configuration mode, use the depi-tunnel command in the global configuration mode or subinterface configuration mode. To remove a configured DEPI tunnel, use the no form of this command.

depi-tunnel depi-tunnel-name

no depi-tunnel depi-tunnel-name

Syntax Description

depi-tunnel-name

Name of the DEPI tunnel.

Command Default

This command has no default behavior or values.

Command Modes


Global configuration (config)


Subinterface configuration (config-subif)

Command History

Release

Modification

12.2(33)SCC

This command was introduced.

IOS-XE 3.15.0S

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

Usage Guidelines

The depi-tunnel creates a template of DEPI tunnel configuration settings. The DEPI data session inherits the control plane configuration settings of a depi-control template.

The following depi data session configuration options are available in this mode:

  • l2tp-class
  • depi-class
  • dest-ip
  • tos

Examples

The following example shows how to create a template of DEPI tunnel configuration settings in the global configuration mode and enter the DEPI data session configuration mode:


Router# configure terminal
Router(config)# depi-tunnel rf6
Router(config-depi-tunnel)#

The following example shows how to create a template of DEPI tunnel configuration settings in the subinterface configuration mode:


Router(config)# interface qam 6/4.1
Router(config-subif)# depi-tunnel 0

depi cin-failover

To enable a failover when Converged Interconnect Network (CIN) failure occurs on Downstream External PHY Interface (DEPI), use the depi cin-failover command in global configuration mode. To disable the failover when the CIN fails on the DEPI, use the no form of this command.

depi cin-failover [cpu-threshold {high threshold_value | low threshold_value}]

no depi cin-failover

Syntax Description

cpu-threshold

Configures the CPU threshold on the line card.

high

Sets the high threshold level. Default value is 95.

low

Sets the low threshold level. Default value is 85.

threshold_value

Threshold value of CPU usage in percentage. The valid range is from 0 to 100.

Command Default

The DEPI CIN failover configuration is disabled by default.

Command Modes


Global configuration (config)

Command History

Release

Modification

12.2(33)SCF

This command was introduced.

12.2(33)SCF4

This command was modified. The cpu-threshold keyword was added to the command.

IOS-XE 3.15.0S

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

Usage Guidelines

If DEPI Control Plane High Availability is configured, the depi cin-failover command, which is configured globally, triggers a cable line card switchover when a CIN failure occurs.

The depi cin-failover cpu-threshold command allows you to set a CPU threshold to alter when a failover due to CIN failure is allowed to happen.

  • When the high threshold is reached, a failover due to CIN failure is disabled.
  • If (and only if) the high threshold was reached, the CPU will have to drop lower than the configured low threshold before a failover due to CIN failure is enabled again.

Note


In Cisco IOS Release 12.2(33)SCE, DEPI CIN triggered failover is automatically enabled with control plane DEPI. The depi cin-failover command is introduced in Cisco IOS Release 12.2(33)SCF and is disabled by default.

Examples

The following example shows how to configure a CIN failover:


Router(config)# depi
Router(config)# depi cin-failover
Router(config)# exit

The following example shows how to set the CPU threshold value:


Router(config)# depi
Router(config)# depi cin-failover cpu-threshold high 95 low 85
Router(config)# exit

depi eqam-stats

To enable debugging information for Downstream External PHY Interface (DEPI) EQAM statistics on the Cisco CMTS router, use the depi eqam-stats command in global configuration mode. To disable debugging information, use the no form of this command.

depi eqam-stats

no depi eqam-stats

Syntax Description

This command has no arguments or keywords.

Command Default

The DEPI EQAM statistics configuration is enabled by default.

Command Modes


Global configuration (config)

Command History

Release

Modification

12.2(33)SCE

This command was introduced.

IOS-XE 3.15.0S

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

Usage Guidelines

Cisco RF Gateway 10 sends EQAM statistics to the Cisco CMTS router. No other EQAM supports the EQAM statistics feature.

Examples

The following example shows how to configure DEPI EQAM statistics on the Cisco CMTS router:


Router# configure terminal
Router(config)# depi eqam-stats

desc-rule

To configure the descriptor rule, use the desc-rule command in the DVB scrambling ECMG configuration mode. To void the descriptor rule configuration, use the no form of this command.

desc-rule descriptor_name [id id]

no desc-rule descriptor_name

descriptor_name

Specifies the descriptor name.

id

Specifies the descriptor ID.

Command Default

None

Command Modes

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

Release

Modification

IOS-XE 16.4.1

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

Examples

The following is an example of how to configure the descriptor rule:


Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#ecmg ECMG-7 id 7
Router(config-video-encrypt-dvb-ecmg)#desc-rule desc_8_1 id 1
Router(config-video-encrypt-dvb-ecmg-desc)#

description (bonding-group)

To add a description for a bonding group on the Cisco CMTS router, use the description command in cable interface configuration mode. To remove a description for a bonding group, use the no form of this command.

description description

no description

Syntax Description

description

Specifies a description for the bonding group. The character-string can be up to 128 characters long.

Command Default

By default, description for a bonding group does not exist.

Command Modes


Interface configuration (config-if)

Command History

Release

Modification

12.2(33)SCG

This command was introduced.

IOS-XE 3.15.OS

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

Usage Guidelines

The description command is used to configure the Upstream Channel Bonding feature.

The description command adds a comment to the configuration to provide information about the bonding group.

Examples

The following example shows how to specify a description for bonding group 1:


Router# configure terminal
 
Enter configuration commands, one per line.  End with CNTL/Z.
Router(config)# interface cable 8/0/0
Router(config-if)# cable upstream bonding-group 1
Router(config-upstream-bonding)# description UBG1
Router(config-upstream-bonding)# end
Router# show running interface cable 8/0/0
Building configuration...
Current configuration : 1443 bytes
!
interface Cable8/0/0
 downstream Modular-Cable 8/0/0 rf-channel 0-3
 cable ip-init apm
 cable mtc-mode
 no cable packet-cache
 cable bundle 6
 cable upstream max-ports 4
 cable upstream bonding-group 1
  description UBG1
  upstream 0
  upstream 1
  upstream 2
  upstream 3
  attributes 80000000

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.

IOS-XE 3.15.OS

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

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
 

description (OFDM channel profile)

To specify a user defined description for the profile, use the description command in OFDM channel profile configuration mode. To remove the description, use no form of this command.

description description

no description

Syntax Description

description

Specify a user defined description for the profile.

Command Default

None

Command Modes


OFDM channel profile configuration (config-ofdm-chan-prof)

Command History

Release

Modification

IOS-XE 3.18.0SP

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

Usage Guidelines

Use this command to specify a user defined description for the profile.

Examples

The following example shows how to specify a user defined description for the profile:


Router# configure terminal
Router(config)# cable downstream ofdm-chan-profile 21
Router(config-ofdm-chan-prof)# description 512-1k-4k

description (OFDM modulation profile)

To specify a user defined description for the profile, use the description command in OFDM modulation profile configuration mode. To remove the description, use no form of this command.

description description

no description

Syntax Description

description

Specify a user defined description for the profile up to 64 characters.

Command Default

None

Command Modes


OFDM modulation profile configuration (config-ofdm-mod-prof)

Command History

Release

Modification

IOS-XE 3.18.0SP

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

Usage Guidelines

Use this command to specify a user defined description for the profile.

Examples

The following example shows how to specify a user defined description for the profile:


Router# configure terminal
Router(config)# cable downstream ofdm-modulation-profile 21
Router(config-ofdm-mod-prof)# description 512-1k-4k

description (redundancy-linecard)

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

description group-description

no description

Syntax Description

group-description

Specifies the description for the line card redundancy groups.

Command Default

Description is not configured.

Command Modes

Line card redundancy configuration (config-red-lc)

Command History

Release

Modification

IOS-XE Release 3.16.0S

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

Usage Guidelines

The description string has a maximum limit of 127 characters.

Examples

The following example shows how to configure redundancy group description on Cisco cBR-8 Series Converged Broadband Routers:

Router# configure terminal
Enter configuration commands, one per line.  End with CNTL/Z.
Router(config)# redundancy
Router(config-red)#  linecard-group 0 internal-switch
Router(config-red-lc)# description Redundancy Group0
Router(config-red-lc)#

dest-ip

To assign an IP address to the edge quadrature amplitude modulation (EQAM), use the dest-ip command in DEPI tunnel configuration mode. To remove a specific destination IP address, use the no form of this command.

dest-ip dest-ip-address

no dest-ip dest-ip-address

Syntax Description

dest-ip-address

IP address of the EQAM.

Command Default

This command has no default behavior or values.

Command Modes


DEPI tunnel configuration

Command History

Release

Modification

12.2(33)SCC

This command was introduced.

IOS-XE 3.15.0S

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

Usage Guidelines

The dest-ip dest-ip-address command allows you to configure the IP address of the EQAM.

Examples

The following example shows how to assign 1.3.4.155 as the destination IP address:


Router# configure terminal
Router(config)# depi-tunnel rf6
Router(config-depi-tunnel)# dest-ip 1.3.4.155

diagnostic load

To load a Field Diagnostic image to the line card for field diagnostic testing, enter the diagnostic load command.

diagnostic load {slot slot | subslot slot/ subslot} image-url [autostart test {all port port-number}]

Syntax Description

slot

Specifies that the line card unloading the Field Diagnostic image is in a full slot as opposed to a subslot.

subslot

Specifies that the line card unloading the Field Diagnostic image is in a subslot as opposed to a full slot.

slot-number

Specifies the number of the slot where the line card unloading the Field Diagnostic image is located on the router.

subslot-number

Specifies the number of the subslot where the line card unloading the Field Diagnostic image is located on the router.

Command Default

No default behavior or values.

Command Modes

Privileged EXEC (#)

Command History

Release

Modification

12.2(16)BX

This command was introduced.

12.3(13)BC

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

IOS-XE 3.15.0S

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

Usage Guidelines

The show diagnostic result output will be lost once a Field Diagnostic image is successfully unloaded off a line card. If you want to retain the results of the Field Diagnostic test, enter show diagnostic result and copy the output into a separate file before entering diagnostic unload to unload the Field Diagnostic image off the line card.

Entering this command successfully will resume normal line card operation.

If a line card needs to be placed back online immediately and a Field Diagnostic test is in progress, enter diagnostic stop to stop the in-progress Field Diagnostic test before entering diagnostic unload to unload the Field Diagnostic image off the line card.

Examples

In the following example, the Field Diagnostic image is unloaded off of the line card in slot 2. Note that the command is not successfully executed until confirmed at the screen prompt.

 Router# diagnostic unload slot 2
******************************************************************************
WARNING:All Field Diagnostics test results and information will be unavailable
to both the "show diagnostic result <target>" and "show
diagnostic content <target>" commands. To save the test results,
cancel the unloading process and enter the "show diagnostic result
<target>" command. Copy the output into a file, then re-enter the
"diagnostic unload <target>" command to restore normal line
card operation.
******************************************************************************
% Are you sure that you want to perform this operation?
[no]:y FDIAG [slot 2]> Unloading the Field
Diagnostics image and restoring the original run-time image, please wait ...
FDIAG [slot 2]> Field Diagnostics image was successfully unloaded
 

diagnostic ondemand action-on-failure

To set an error count limit or to stop testing once a diagnostic error event is detected, use the diagnostic ondemand action-on-failure command.

diagnostic ondemand action-on-failure [continue failure-limit | stop]

Syntax Description

continue failure-limit

Specifies that Field Diagnostic testing should continue on the line card after a failed test occurs. The failure-limit specifies the number of failed tests that can be detected before testing on the line card should stop. A failure-limit of 0 means testing should continue regardless of the number of failed tests.

Note

 
The failure-limit is the number of failed tests, not errors within a single test. For example, if four errors occur during a single test, the failure-limit for that individual test would be 1, not 4.

stop

Specifies that Field Diagnostic testing should stop when an error event occurs.

Command Default

If this command is not entered, a default failure-limit of 0 is used. Therefore, testing will continue regardless of the number of errors unless the diagnostic ondemand action-on-failure command is used to change the default setting.

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.2(16)BX

This command was introduced.

12.3(13)BC

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

IOS-XE 3.15.0S

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

Usage Guidelines

The diagnostic ondemand action-on-failure settings cannot be saved to a Cisco IOS configuration file. Therefore, the diagnostic ondemand action-on-failure command will need to be re-entered each time a router is reset or power cycled if the action-on-failure settings should be maintained.

The show diagnostic ondemand settings command can be used to verify the diagnostic ondemand action-on-failure setting.

The show diagnostic events event-type error command can be used to gather additional information about an error event.

Examples

In the following example, the diagnostic on-demand iteration and action-on-failure settings are changed using diagnostic ondemand iterations and diagnostic ondemand action-on-failure . The changed settings are then confirmed using show diagnostic ondemand settings .


Router# diagnostic ondemand iterations 2
Router# diagnostic ondemand action-on-failure stop
Router# show diagnostic ondemand settings
 
        
Test iterations = 2

diagnostic unload

To unload the Field Diagnostic on the line card and resume normal line card operation, enter the diagnostic unload command.

diagnostic unload {slot slot-number | subslot slot-number/ subslot-number}

Syntax Description

slot

Specifies that the line card unloading the Field Diagnostic image is in a full slot as opposed to a subslot.

subslot

Specifies that the line card unloading the Field Diagnostic image is in a subslot as opposed to a full slot.

slot-number

Specifies the number of the slot where the line card unloading the Field Diagnostic image is located on the router.

subslot-number

Specifies the number of the subslot where the line card unloading the Field Diagnostic image is located on the router.

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

12.2(16)BX

This command was introduced.

12.3(13)BC

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

IOS-XE 3.15.0S

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

Usage Guidelines

The show diagnostic result output will be lost once a Field Diagnostic image is successfully unloaded off a line card. If you want to retain the results of the Field Diagnostic test, enter show diagnostic result and copy the output into a separate file before entering diagnostic unload to unload the Field Diagnostic image off the line card.

Entering this command successfully will resume normal line card operation.

If a line card needs to be placed back online immediately and a Field Diagnostic test is in progress, enter diagnostic stop to stop the in-progress Field Diagnostic test before entering diagnostic unload to unload the Field Diagnostic image off the line card.

Examples

In the following example, the Field Diagnostic image is unloaded off of the line card in slot 2. Note that the command is not successfully executed until confirmed at the screen prompt.


Router# diagnostic unload slot 2
 
 ******************************************************************************
 WARNING:All Field Diagnostics test results and information will be 
          unavailable to both the "show diagnostic result <target>" and
          "show diagnostic content <target>" commands. 
          To save the test results, cancel the unloading process and enter
          the "show diagnostic result <target>" command. Copy the output
          into a file, then re-enter the "diagnostic unload <target>" command
          to restore normal line card operation.
 ******************************************************************************
 
% Are you sure that you want to perform this operation? [no]:y
FDIAG [slot 2]> Unloading the Field Diagnostics image and restoring the original run-time image, please wait ... 
 
FDIAG [slot 2]> Field Diagnostics image was successfully unloaded

disable-auto-restart

To disable the automatic process restart, use the disable-auto-restart command in the process restart configuration mode. To disable this function, use the no form of this command.

disable-auto-restart no disable-auto-restart

Command Default

None

Command Modes


Process restart configuration (config-process-restart)

Command History

Release

Modification

IOS-XE 3.18.0S

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

Usage Guidelines

This command disables the automatic process restart.

The following example shows how to disable the automatic process restart.


Router# configure terminal 
Router(config)# process-restart
Router(config-process-restart)# disable-auto-restart

do-not-insert

To prohibit inserting standard descriptors, use the do-not-insert command in the DVB scrambling ECMG descriptor configuration mode. To void the configuration, use the no form of this command.

do-not-insert {all | ecm-ids id}

no do-not-insert {all | ecm-ids id}

all

Do not insert standard descriptors for all ecm ids.

ecm-ids id

Do not insert standard descriptors for specified ecm ids.

Command Default

None

Command Modes

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

Release

Modification

IOS-XE 16.4.1

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

Examples

The following is an example of how to prohibit inserting standard descriptors:


Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#ecmg ECMG-7 id 7
Router(config-video-encrypt-dvb-ecmg)#desc-rule desc_8_1 id 1
Router(config-video-encrypt-dvb-ecmg-desc)#do-not-insert ecm-ids 81,82,83,84,85

docsis-channel-id

To configure the downstream channel ID, use the docsis-channel-id command in the rf-channel configuration mode. To set the docsis channel ID to its default value, use the no form of this command.

docsis-channel-id dcid

no docsis-channel-id dcid

Syntax Description

dcid

Specifies a downstream channel ID. Valid values are 1 to 255 as 0 is invalid, reserved for network management.

Command Default

The unit number of the downstream device, starting with a value of 1.

Command Modes


rf-channel configuration—(config-rf-chan)

Command History

Release

Modification

IOS-XE 3.15.0S

This command was introduced on the Cisco cBR Series Converged Broadband Routers. This command replaces the cable downstream channel-id command.

Usage Guidelines

Use this command to ensure that each downstream channel has a unique ID when there are multiple Cisco CMTS routers at a headend facility.


Caution


Changing the downstream channel ID of an active channel automatically disconnects all connected CMs and forces them to go offline and reregister with the CMTS router, as required by the DOCSIS specifications.


Examples

The following example shows how to configure the downstream channel on the cable interface line card in slot 6 of a Cisco CMTS router with a channel ID of 44:


Router(config)#controller integrated-Cable 3/0/0
Router(config-controller)#rf-chan 0
Router(config-rf-chan)#docsis-channel-id 1

 

The following example shows how to restore the downstream channel ID configuration to the default configuration:


Router(config-rf-chan)#no docsis-channel-id 1

docsis-policy

To assign a policy to a DOCSIS load balancing group, use the docsis-policy command in the config-lb-group configuration mode. The policy becomes the default policy assigned to the CM, if the CM does not choose a different policy. To remove the assigned policy, use the no form of this command.

docsis-policy n

no docsis-policy

Syntax Description

n

Load balancing group policy number. The policy number can range from 0 to 4294967295.

Command Default

No default behavior or values.

Command Modes


DOCSIS load balancing group mode (config-lb-group)

Command History

Release

Modification

12.2(33)SCC

This command was introduced.

IOS-XE 3.15.OS

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

Examples

The following example shows how to assign a policy to a DOCSIS load balancing group on the CMTS, using the docsis-policy command.


Router# configure terminal
Enter configuration commands, one per line.  End with CNTL/Z.
Router(config)# cable load-balance docsis-group 1
Router(config-lb-group)# docsis-policy 1
Config: Last Batch 0, 63 bytes
cable load-balance docsis-group 1 index 81
docsis-policy 1
end

docsis-version

To configure the DOCSIS version of the CM for the CMTS tag, use the docsis-version command in the cmts-tag configuration mode. To remove the configured DOCSIS version from the CMTS tag, use the no form of this command.

[exclude] docsis-version docsis-version

no docsis-version docsis-version

Syntax Description

exclude

(Optional) Configures the CMTS tag to exclude the specified DOCSIS version.

docsis-version

DOCSIS version for the CMTS tag. You can select one of the following DOCSIS versions to match the DOCSIS modems:

  • docsis10 - Matches DOCSIS 1.0 modems
  • docsis11 - Matches DOCSIS 1.1 modems
  • docsis20 - Matches DOCSIS 2.0 modems
  • docsis30 - Matches DOCSIS 3.0 modems.

Command Default

No default behavior or values.

Command Modes


CMTS tag mode (cmts-tag)

Command History

Release

Modification

12.2(33)SCC

This command was introduced.

IOS-XE 3.15.OS

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

Examples

The following example shows how to configure the specified DOCSIS version for the CMTS tag using the docsis-version command:


Router# configure terminal
 
Enter configuration commands, one per line.  End with CNTL/Z.
Router(config)# cable tag 1
Router(cmts-tag)# docsis-version docsis10

downstream

To set downstream radio frequency (RF) channels, use the downstream command in the config-lb-group configuration mode. To reset the downstream RF channels, use the no form of this command.

Cisco uBR7200 Series Routers

downstream cable {slot | / port}

no downstream cable {slot | / port}

Cisco uBR10012 Router

downstream {cable {slot | / port} | Integrated-Cable {slot | / subslot | / bay} {rf-channel group list} | Modular-Cable {slot | / subslot | / bay} {rf-channel group list}}

nodownstream {cable {slot | / port} | Integrated-Cable {slot | / subslot | / bay} {rf-channel group list} | Modular-Cable {slot | / subslot | / bay} {rf-channel group list}}

Cisco cBR Series Converged Broadband Routers

downstream Integrated-Cable { slot /subslot/downstream controller index } rf-channel group list

no downstream Integrated-Cable { slot /subslot/downstream controller index } rf-channel group list

Syntax Description

cable {slot/port }

Specifies the CMTS interface slot and port numbers.

cable {slot/subslot/port }

Specifies the CMTS interface slot, subslot, and port numbers.

Integrated-Cable {rf-channel group list }{slot/subslot/bay }

Specifies the integrated cable interface with the list of port numbers that range in the associated RF channel. Slot, subslot, and bay numbers of the integrated cable interface is also specified.

Modular-Cable {rf-channel group list }} {slot/subslot/bay }

Specifies the modular cable interface with the list of port numbers that range in the associated RF channel. It also specifies slot, subslot, and bay numbers of the modular cable interface.

Integrated-Cable { slot /subslot/downstream controller index } rf-channel group list

Specifies the downstream channels from a particular downstream controller to include in the DOCSIS load balancing group. The downstream controller is identified by a combination of slot, subslot and the downstream controller index. A list of channel numbers follows the rf-channel keyword.

Command Default

No default behavior or values.

Command Modes


DOCSIS load balancing group mode (config-lb-group)

Command History

Release

Modification

12.2(33)SCC

This command was introduced.

IOS-XE 3.15.OS

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

Examples

The following example shows how to set downstream RF channels to a DOCSIS load balancing group on the CMTS, using the downstream command.


Router# configure terminal
Enter configuration commands, one per line.  End with CNTL/Z.
Router(config)# cable load-balance docsis-group 1
Router(config-lb-group)# downstream cable 1/1
Router(config-lb-group)# downstream Integrated-Cable 5/0/0 rf-channel 2
Router(config-lb-group)# downstream Modular-Cable 1/0/0 rf-channel 4

The following example shows how to set downstream RF channels to a DOCSIS load balancing group on the CMTS, using the downstream command in Cisco cBR Series Converged Broadband Routers.


Router# configure terminal
Enter configuration commands, one per line.  End with CNTL/Z.
Router(config)# cable load-balance docsis-group 1
Router(config-lb-group)# downstream Integrated-Cable 3/0/3 rf-channel 2

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}

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

IOS-XE 3.15.OS

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

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.

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 

downstream downstream-cable

To configure the downstream controller in the fiber node, use the downstream downstream-cable command in the fiber node configuration mode. To void the downstream controller configuration in the fiber node, use the no form of this command.

downstream downstream-cable slot/subslot/port

no downstream downstream-cable slot/subslot/port

Syntax Description

slot/subslot/port

Specifies the slot, subslot and port of the downstream controller.

Command Default

None

Command Modes


Fiber node configuration (config-fiber-node)

Command History

Release

Modification

Cisco IOS XE Everest 16.5.1

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

Usage Guidelines

Use this command to configure the downstream controller in the fiber node.

Examples

The following example shows how to configure the downstream controller in the fiber node:

Router# configure terminal
Router(config)# cable fiber-node 1
Router(config-fiber-node)# downstream downstream-cable 3/0/0

downstream downstream-cable rf-channel

To associate a set of upstream channels to the downstream channels in the Remote-PHY configuration, use the downstream downstream-cable rf-channel command in interface configuration mode. To void the configuration, use the no form of this command.

downstream downstream-cable slot/subslot/port rf-channel rf-channel [profile name [upstream grouplist]]no downstream downstream-cable slot/subslot/port rf-channel rf-channel [profile name [upstream grouplist]]

Syntax Description

slot/subslot/port

Specifies the slot, subslot and port of the downstream controller.

rf-channel

Specifies association of the downstream channels to the channel group domain.

name

Specifies the downstream controller profile.

grouplist

Specifies the logical identifier of upstream channels serving these downstream RF channels.

Command Default

None

Command Modes


Interface configuration (config-if)

Command History

Release

Modification

Cisco IOS XE Everest 16.5.1

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

Usage Guidelines

Use this command to associate a set of upstream channels to the downstream channels in the Remote-PHY configuration.

Examples

The following example shows how to use the downstream downstream-cable rf-channel command on the Cisco cBR Series Converged Broadband Routers.


Router# configure terminal
Router(config)# interface cable 3/0/0
Router(config-if)# downstream downstream-cable 3/0/0 rf-channel 1 upstream 1

downstream integrated-cable rf-channel (interface)

To associate a set of upstream channels to the integrated downstream channels on the Cisco CMTS router, use the downstream integrated-cable rf-channel command in interface configuration mode.

downstream integrated-cable slot/ subslot/ port rf-channel rf-channels [upstream grouplist]

Syntax Description

slot

Identifies the chassis slot where the Cisco cable interface line card resides.

  • Cisco uBR10012 router—The valid range is from 5 to 8.
  • Cisco uBR7225VXR router—The valid value is 1 or 2.
  • Cisco uBR7246VXR router—The valid range is from 3 to 6.
  • Cisco cBR Series Converged Broadband Routers— The valid ranges are from 0 to 3 and 6 to 9.

subslot

(Cisco uBR10012 only) Secondary slot number of the cable interface line card. The valid subslots are 0 or 1.

For Cisco cBR Series Converged Broadband Routers, the valid subslot is 0.

port

Downstream port (controller) number.

  • Cisco uBR7225VXR router and Cisco uBR7246VXR router—The valid value is 0 or 1.
  • Cisco uBR10012 router—The valid range is from 0 to 4.
  • Cisco cBR Series Converged Broadband Routers— The valid range is from 0 to 7.

rf-channel rf-channel

Specifies association of the downstream channels to the channel group domain. The valid range is from 0 to 3. For Cisco cBR Series Converged Broadband Routers, the valid range is from 0 to 162.

upstream grouplist

Specifies the logical identifier of upstream channels serving these downstream RF channels. The valid range is from 0 to 7. For Cisco cBR Series Converged Broadband Routers, the valid range is from 0 to 15.

Command Default

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

Command Modes


Interface configuration (config-if)

Command History

Release

Modification

12.2(33)SCB

This command was introduced.

IOS-XE 3.15.0S

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

IOS-XE 3.18.0SP

This command was modified on the Cisco cBR Series Converged Broadband Routers. The rf-channel range is 0 to 162 now.

Usage Guidelines

The downstream integrated-cable rf-channel command is used for:

Examples

The following example shows how to use the downstream integrated-cable rf-channel command on the Cisco uBR10012 router.


Router# configure terminal
Router(config)# interface cable 7/0/0
Router(config-if)# downstream integrated-Cable 7/0/0 rf-channel 1 upstream 1

The following example shows how to use the downstream integrated-cable rf-channel command on the Cisco cBR Series Converged Broadband Routers.


Router# configure terminal
Router(config)# interface cable 3/0/0
Router(config-if)# downstream integrated-Cable 3/0/0 rf-channel 1 upstream 1

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.

IOS-XE 3.15.0S

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

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

downstream modular-cable rf-channel (channel group)

To configure downstream RF channels for a channel group, use the downstream modular-cable rf-channel command in channel group configuration mode. To disable the configuration, use the no form of the command.

downstream modular-cable slot/subslot/port rf-channel grouplist

no downstream modular-cable slot/subslot/port rf-channel grouplist

Syntax Description

modular-cable slot/subslot/port

Specifies the modular-cable interface.

  • slot —Chassis slot number of the cable interface line card. The valid range is from 5 to 8.

  • subslot —Secondary slot number of the cable interface line card. The valid range is from 0 to 1.

  • port —Port number on the line card. The valid range is from 0 to 2.

rf-channel grouplist

Specifies the list of downstream RF channels.

  • grouplist —Range of downstream RF channel numbers. The valid range is from 0 to 23. The value can be one or more RF channel numbers, a range of channel numbers separated by a hyphen, or a combination of both.

Command Default

Downstream RF channels are not configured.

Command Modes

Channel group configuration (config-ch-group)

Command History

Release

Modification

12.2(33)CX

This command was introduced.

IOS-XE 3.15.0S

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

Usage Guidelines

A channel group can have up to 16 downstream RF channels.

Examples

The following example shows how to configure a downstream RF channel for a channel group:

Router# configure terminal
Router(config)# cable channel-group 1
Router(config-ch-group)# downstream Modular-Cable 7/1/0 rf-channel 0-15

downstream modular-cable rf-channel (interface)

To associate 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 and later

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

Cisco IOS Release 12.2(33)SCE and later

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

Syntax Description

slot

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

For the Cisco uBR-MC3GX60V cable interface line card, the cable interface slot values range from 5 to 8.

subslot

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

bay

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

port

Interface number on the SPA.

controller

Modular-Cable controller number. The valid values are 0 to 2.

Note

 
This option is available only on the Cisco uBR-MC3GX60V cable interface line card and on the Cisco router running Cisco IOS Release 12.2(33)SCE and later releases.

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. If the range is not specified, all the upstreams in the MAC domain are associated.

grouplist

Number of upstreams with the modular cable downstream channel.

Command Default

By default, all upstream channels in an interface are associated with the modular downstream channels in the same interface.

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.

12.2(33)SCE

This command was modified to change the valid range of slot .

IOS-XE 3.15.0S

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

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 to use the downstream modular-cable rf-channel command on 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

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.

IOS-XE 3.15.OS

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

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 

ds-channel

To configure the OOB downstream channel, use the ds-channel command in the profile configuration mode. To void the OOB downstream channel configuration, use the no form of this command.

ds-channel 0 {frequency f-value | poweradjust p-value | rf-mute | shutdown}

no ds-channel 0 {frequency | poweradjust | rf-mute | shutdown}

Syntax Description

f-value

Specifies the OOB downstream channel frequency value.

p-value

Specifies the OOB downstream channel poweradjust value.

Command Default

None

Command Modes


Profile configuration (config-profile)

Command History

Release

Modification

Cisco IOS XE Everest 16.5.1

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

Usage Guidelines

Use this command to configure the OOB downstream channel.

Examples

The following example shows how to configure the OOB downstream channel:


Router# configure terminal
Router(config)# controller downstream-oob 55d1-profile 1
Router(config-profile)# ds-channel 0 frequency 70000000
Router(config-profile)# ds-channel 0 poweradjust 1

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 [penalty minutes] {upstream | downstream} [enforce]

no duration

Cisco cBR Series Converged Broadband Routers

duration minutes avg-rate rate sample-interval minutes [penalty-period 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 kilobits 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.

penalty minutes

(Optional) Specifies the period (in minutes) during which a cable modem (CM) can be under penalty. The valid range is 1 to 10080.

penalty-period minutes

(Optional) Specifies the period for which an enforced quality of service (QoS) profile should be in force for subscribers who violate their registered QoS profile. The valid range is 1 to 10080.

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

12.2(33)SCD2

The penalty keyword option was added.

IOS-XE 3.15.0S

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

IOS-XE 3.17.0S

This command was implemented on the Cisco cBR Series Converged Broadband Routers. The penalty keyword was removed and penalty-period was added.

Usage Guidelines


Note


This command is applicable only after the monitoring-basics command is configured with the keyword legacy .

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 the avg-rate configured in enforce-rule. The CMTS router keeps track of 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.

The penalty duration, which is configured using this command, is unique to weekdays, and takes precedence over the global penalty duration configured using the penalty-period command.

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, “pen” represents penalty , “do” represents downstream , and “enf” represents enforce :


Router# show running-configuration
.
.
.
duration 10 avg-rate 1 sample-interval 10 pen 11 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 penalty 11 do enf
The following example shows an enforce-rule being configured on a Cisco cBR Series Converged Broadband Router:
Router# configure terminal
 
Router(config)# cable qos enforce-rule test 
Router(enforce-rule)# duration 10 avg-rate 2 sample-interval 1 penalty-period 20 downstream enforce

dvb

To enter the DVB scrambling configuration mode, use the dvb command in video encryption configuration mode.

dvb

Syntax Description

This command has no keywords or arguments.

Command Modes


Video encryption configuration (config-video-encrypt)

Command History

Release

Modification

IOS-XE 16.4.1

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

Usage Guidelines

Use this command to enter the DVB scrambling configuration mode.

Examples

The following example shows how to enter the DVB scrambling configuration mode:


Router# configure terminal
Router(config)# cable video
Router(config-video)# encryption
Router(config-video-encrypt)# dvb
Router(config-video-encrypt-dvb)# 

ecm-pid-source

To configure the source of ECM PID, use the ecm-pid-source command in the DVB scrambling ECMG configuration mode.

ecm-pid-source {auto lower_limit upper_limit | ecm-id | sid}

auto lower_limit upper_limit

ECM PID is determined internally by the system in the range between lower limit and upper limit.

ecm-id

ECM ID specified in the SCG will be used as the ECM PID.

sid

ECM PID is choosen automatically from the Service ID PID Range.

Command Default

None

Command Modes

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

Release

Modification

IOS-XE 16.4.1

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

Usage Guidelines

It is recommended to use auto option for the customers using:

  • Session based scrambling by providing pids in the Scrambling Control Group (component based scrambling)

  • Tier based scrambling

Examples

The following is an example of how to configure the source of ECM PID:


Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#ecmg ECMG-7 id 7
Router(config-video-encrypt-dvb-ecmg)#ecm-pid-source sid

ecmg

To enter the ECM Generator configuration mode, use the ecmg command in the DVB scrambling configuration mode. To void the ECMG configuration, use the no form of this command.

ecmg ecmg_name [id id]

no ecmg ecmg_name

ecmg_name

Specifies the ECMG name.

id

Specifies the ECMG ID.

Command Default

None

Command Modes

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

Release

Modification

IOS-XE 16.4.1

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

Examples

The following is an example of how to enter the ECM Generator configuration mode:


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

ecmg (Tier-based)

To configure the tier-based scrambling, use the ecmg command in the tier-based scrambling configuration mode. To void the tier-based scrambling configuration, use the no form of this command.

ecmg {id | id | name | name}access-criteria hex_access_criteria

no ecmg {id | id | name | name}

id id

Specifies the ECMG ID.

name name

Specifies the ECMG name.

access-criteria hex_access_criteria

Specifies the access criteria per ECMG.

Command Default

None

Command Modes

Tier-based scrambling configuration mode (config-video-encrypt-dvb-tier)

Release

Modification

IOS-XE 16.4.1

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

Examples

The following is an example of how to configure the tier-based scrambling:


Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#tier-based
Router(config-video-encrypt-dvb-tier)#ecmg id 1 access-criteria 1234512345

eis

To enter the Event Information Scheduler configuration mode, use the eis command in the DVB scrambling configuration mode. To void the Event Information Scheduler configuration, use the no form of this command.

eis server_name [id id]

no eis server_name

server_name

Specifies the EIS server name.

id

Specifies the EIS connection ID.

Command Default

None

Command Modes

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

Release

Modification

IOS-XE 16.4.1

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

Examples

The following is an example of how to enter the Event Information Scheduler configuration mode:


Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#eis EIS-1 id 1
Router(config-video-encrypt-dvb-eis)#

enable (Tier-based)

To enable the tier-based scrambling, use the enable command in the tier-based scrambling configuration mode. To disable the tier-based scrambling, use the no form of this command.

enable

no enable

Command Default

None

Command Modes

Tier-based scrambling configuration mode (config-video-encrypt-dvb-tier)

Release

Modification

IOS-XE 16.4.1

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

Usage Guidelines

It is recommended to disable tier based scrambling before modifying any configuration under tier-based section. Enable it again after the modification is complete.

Examples

The following is an example of how to enable the tier-based scrambling:


Router>enable
Router#configure terminal
Router(config)#cable video
Router(config-video)#encryption
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#tier-based
Router(config-video-encrypt-dvb-tier)#enable

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.

IOS-XE 3.15.0S

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

IOS-XE 3.17.0S

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

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
 

encrypt

To enable encryption on a virtual carrier group, use the encrypt command in virtual carrier group configuration mode. To disable the encryption, use the no form of this command.

encrypt

no encrypt

Command Default

None.

Command Modes


Virtual carrier group configuration (config-video-vcg)

Command History

Release

Modification

IOS-XE 3.18.0S

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

Usage Guidelines

This command enables encryption on a virtual carrier group.

Examples

The following example shows how to enable encryption on a virtual carrier group:


Router# configure terminal
Router(config)# cable video
Router(config-video)# virtual-carrier-group vod id 1
Router(config-video-vcg)# encrypt

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.

IOS-XE 3.15.0S

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

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

event-profile

To apply a GQI announce event profile to a specific LED, use the event-profile command in global configuration mode.

event-profile name

Syntax Description

Command

Description

name

Name of the GQI announce event profile.

Command Default

None.

Command Modes


Global configuration mode (config).

Command History

Release

Modification

Cisco IOS XE Everest 16.6.1

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

Examples

The following example shows how to apply a GQI announce event profile (gqi-led-1) to a LED (led5) using the event-profile command:


cable video
logical-edge-device led5 id 5
    gqi protocol
       event-profile gqi-led-1

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 core-dump file that contains the data related to the PXF exception.

smart

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

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 for the Cisco uBR10012 router.

IOS-XE 3.15.OS

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

Usage Guidelines


Note


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

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

Cisco cBR Series Converged Broadband Routers

facility-alarm critical exceed-action shutdown

no facility-alarm critical exceed-action shutdown

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.

Command Default

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.

IOS-XE 3.15.OS

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

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

The following commands show how to disable critical temperature alarm on Cisco cBR Series Converged Broadband Routers:

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

factory-reset all

To reset the device to factory defaults, use the factory-reset all command in privileged EXEC mode. This method is called as Fast Factory Reset.


Note


  • Partitions accessed by BinOS only have their file tables cleared; the file content is visible with a raw device dump.

  • The factory-reset all does not sanitize all the storage devices. To perfom factory reset and device sanitization use the Secure Factory Reset command: factory-reset all secure.


factory-reset all

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

Cisco IOS XE Dublin 17.12.1

In this release, instead of only deleting the private configure encryption key, the command deletes all the non-admin users in ACT2.

Cisco IOS XE Cupertino 17.9.1w

In this release, the partitions are cleared, the device is repartitioned and reformated.

In previous releases, the partitions are retained and each partition is cleared and reformated.

Cisco IOS XE Everest 16.6.1

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

Usage Guidelines

The following example shows how to perform Fast Factory Reset.

Examples


Router# factory-reset all
The factory reset operation is irreversible for all operations. Are you sure? [confirm]
The following will be deleted as a part of factory reset: 
1: All writable file systems and personal data
2: OBFL logs
3: Licenses
4: Userdata and Startup config 5: Rommon variables
6: User Credentials
7: nvram private cfg encryption key in ACT2

Only this SUP will be reset. To reset peer SUP, run factory reset 
on peer SUP when this sup is not doing factory reset.

Current running image will be restored to bootflash after reset. If current image 
is a private image with sensitive data, reload with Cisco release image first.

The SUP will reload to perform factory reset.

The reset can take a while to finish with secure option.
1.	DO NOT UNPLUG THE POWER OR INTERRUPT THE OPERATION!
2.	DO NOT RELOAD PEER SUP!
3.	DO NOT START FACTORY RESET ON PEER SUP!

Are you sure you want to continue? [confirm] Y 
Enabling factory reset for this reload cycle

*Jan 01 00:42:08.633: %IOSXEBOOT-4-FACTORY_RESET: (rp/0): Start FAST Factory Reset

.
.
.
.
4,209 100%	6.28kB/s	0:00:00 (xfr#2, to-chk=0/3)
sync cached data to storage. may take a few minutes. please wait ...

*Jan 01 00:46:24.952: %IOSXEBOOT-4-FACTORY_RESET: (rp/0): Factory reset
successful. Continuing with reboot ...
!
!

factory-reset all secure

To perform factory reset and device sanitization use the factory-reset all secure command. This method is called as Secure Reset. The following folders are cleared as part of this procedure:

  • User info in ACT2 is cleared.

  • NVRAM that stores IOS configuration and data. For CBR-8, NVRAM and its backup are partitions on eUSB flash device.

  • /bootflash/ - For CBR-8, bootflash is a partition on eUSB flash device.

  • /obfl/ - For CBR8, OBFL folder is a partition on eUSB flash device.

  • /csl_p/ - For CBR8, csl_p folder is a partition on eUSB flash device.

  • /harddisk/ - For CBR8, the harddisk folder is a partition on SSD.

factory-reset all secure

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes


Privileged EXEC (#)

Command History

Release

Modification

Cisco IOS XE Dublin 17.12.1

In this release, instead of only deleting the private configure encryption key, the command deletes all the non-admin users in ACT2.

Cisco IOS XE Cupertino 17.9.1w

In this release, the partitions are cleared, the device is repartitioned and reformated.

In previous releases, the partitions are retained and each partition is cleared and reformated.

Usage Guidelines

The following example shows how to perform Secure Reset.

Examples


Router# factory-reset all secure
The factory reset operation is irreversible for securely reset all. Are you sure? [confirm]
The following will be deleted as a part of factory reset: 
1: All writable file systems and personal data
2: OBFL logs
3: Licenses
4: Userdata and Startup config
5: Rommon variables
6: User Credentials
7: nvram private cfg encryption key in ACT2

Only this SUP will be reset. To reset peer SUP, run factory reset 
on peer SUP when this sup is not doing factory reset.

Current running image will be restored to bootflash after reset. 
If current image is a private image with sensitive data, reload 
with Cisco release image first.

The SUP will reload to perform factory reset.

The reset can take a while to finish with secure option.
1.	DO NOT UNPLUG THE POWER OR INTERRUPT THE OPERATION!
2.	DO NOT RELOAD PEER SUP!
3.	DO NOT START FACTORY RESET ON PEER SUP!

Are you sure you want to continue? [confirm] Y 
Enabling factory reset for this reload cycle

*May 11 12:21:20.945: %IOSXEBOOT-4-FACTORY_RESET: (rp/0): Start SECURE Factory Reset

.
.
.
.
.
*May 11 14:22:01.374: %IOSXEBOOT-4-FACTORY_RESET: (rp/0): Factory reset successful.
Continuing with reboot ...
!
!

fail-to-clear

To configure fail-to-clear feature, use the fail-to-clear command in global configuration mode. Fail-to-clear feature is applicable only to DVB tier-based scrambling sessions.

fail-to-clear

This command has no arguments or keywords.

Command Default

By default, this feature is not enabled.

Command Modes

Global configuration mode (config)

Command History

Release

Modification

Cisco IOS XE Everest 16.5.1

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

Usage Guidelines

The command is used to control the configured DVB-encrypted sessions to function without encryption, when encryption fails for a session. The fail-to-clear feature is applicable only to DVB tier-based scrambling.

Examples

The following example shows how to configure fail-to-clear .
Router>enable
Router#config terminal
Router(config)#cable video
Router(config-video)#mgmt-intf VirtualPortGroup 0
Router(config-video)#encryption
Router(config-video-encrypt)#linecard 7/0 ca-system dvb scrambler dvb-csa
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#mgmt-ip 10.10.1.1
Router(config-video-encrypt-dvb)#ecmg tier-ecmg-1 id 1
Router(config-video-encrypt-dvb-ecmg)#mode tier-based
Router(config-video-encrypt-dvb-ecmg)#type standard
Router(config-video-encrypt-dvb-ecmg)#ca-system-id 4748 0
Router(config-video-encrypt-dvb-ecmg)#ecm-pid-source sid
Router(config-video-encrypt-dvb-ecmg)#connection id 1 priority 1 10.10.1.1 8888
Router(config-video-encrypt-dvb-ecmg)#exit
Router(config-video-encrypt-dvb)#tier-based
Router(config-video-encrypt-dvb-tb)#ecmg id 1 access-criteria 1234512345
Router(config-video-encrypt-dvb-tb)#fail-to-clear
Router(config-video-encrypt-dvb-tb)#enable

fail-to-clear-duration

To configure fail-to-clear-duration feature, use the fail-to-clear-duration command in global configuration mode. Fail-to-clear-duration feature is applicable only to session-based scrambling for DVB CAS encryption.

fail-to-clear-duration duration in sec

Command Default

By default the duration is set to 0.

Command Modes

Global configuration mode (config)

Command History

Release

Modification

Cisco IOS XE Everest 16.5.1

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

Usage Guidelines

The command is used to control the configured DVB-encrypted sessions to function without encryption for a configured duration, when encryption fails for a session. The fail-to-clear-duration feature is applicable only to session-based scrambling for DVB CAS encryption.

Examples

The following example shows how to configure fail-to-clear-duration. .
Router>enable
Router#config terminal
Router(config)#cable video
Router(config-video)#mgmt-intf VirtualPortGroup 0
Router(config-video)#encryption
Router(config-video-encrypt)#linecard 7/0 ca-system dvb scrambler dvb-csa
Router(config-video-encrypt-dvb-conf)#exit
Router(config-video-encrypt)#dvb
Router(config-video-encrypt-dvb)#scramble-video-audio
Router(config-video-encrypt-dvb)#route-ecmg 10.10.1.1 255.255.255.224 TenGigabitEthernet4/1/2 10.10.1.1
Router(config-video-encrypt-dvb)#mgmt-ip 10.10.1.1
Router(config-video-encrypt-dvb)#eis eis-1 id 1
Router(config-video-encrypt-dvb-eis)#listening-port 8890
Router(config-video-encrypt-dvb-eis)#fail-to-clear-duration 400
Router(config-video-encrypt-dvb-eis)#exit
Router(config-video-encrypt-dvb)#ca-interface linecard 1/0 10.10.1.1 vrf vrf_script_red_1
Router(config-video-encrypt-dvb)#ecmg ecmg-7 id 7

filter pid vcg

To configure PID rule, use the filter pid vcg command in video configuration mode.

filter pid vcg vcg

Syntax Description

vcg

Specifies the virtual carrier group.

Command Default

None.

Command Modes


Video configuration (config)

Command History

Release

Modification

IOS-XE 16.8.1

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

Examples

The following example shows a filter rule for a table-based unicast session on input port number 1 with vei-ip 198.51.100.1

logical-edge-device led1 id 1 
        protocol table-based
              virtual-edge-input-ip 198.51.100.1 input-port-number 1 
              vcg vcg1
              active
table-based
       vcg vcg1 
             rf-channel 2
                   session unicast input-port 1 start-udp-port 49152 processing-type passthru

The corresponding filter rule is shown below:

filter pid vcg vcg1
		 rf-channel 2
		    vei-ip 198.51.100.1 udp-port 49152
			pid 120
			pid 20-30

filter program vcg

To configure program filtering, use the filter program vcg command in video configuration mode.

filter program vcg vcg

Syntax Description

vcg

Specifies the virtual carrier group.

Command Default

None.

Command Modes


Video configuration (config)

Command History

Release

Modification

IOS-XE 16.8.1

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

Examples

The following example shows a program filter rule for a table-based unicast session on input port number 1 with vei-ip 198.51.100.1

logical-edge-device led1 id 1 
        protocol table-based
              virtual-edge-input-ip 198.51.100.1 input-port-number 1 
              vcg vcg1
              active
table-based
       vcg vcg1 
             rf-channel 2
                   session unicast input-port 1 start-udp-port 49152 processing-type passthru

The corresponding filter rule is shown below:

filter program vcg vcg1
		 rf-channel 2
		    vei-ip 198.51.100.1 udp-port 49152
			program 10
			program 20
			program 30-40

freq-profile

To define the frequency profile for the RF port, use the freq-profile command in the RF channel sub configuration mode. This command is available only on CBR-D30-DS-MOD, and is not applicable for CBR-D31-DS-MOD.

freq-profile value

Syntax Description

value

Number of the frequency profile for the RF port. The default value is 0. The valid range for system defined values is 0-3 and for user defined values is 4-15.

Command Default

The default value is 0.

Command Modes

RF channel sub configuration mode (config-rf-chan)

Command History

Release Modification

Cisco IOS-XE Release 3.15.0S

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

Usage Guidelines

This command is used to define the QAM profile number.

Examples

The following example shows how to define the QAM profile number:

router#configure terminal 
router(config)#controller integrated-cable 3/0/0
router(config-controller)#rf-chan 5 10
router(config-rf-chan)#type video
router(config-rf-chan)#frequency 723000000
router(config-rf-chan)#rf-output alt
router(config-rf-chan)#power-adjust 0
router(config-rf-chan)#qam-profile 4
router(config-rf-chan)#exit
router(config-controller)#exit
router(config)#exit
router#show controller integrated-Cable 3/0/0 rf-channel 5 10
Chan State Admin Frequency  Type   Annex Mod  srate Interleaver  dcid  power  output
 5   TEST   UP   723000000  VIDEO  B    256   5361  I32-J4       164  34     ALT
 10  TEST   UP   753000000  VIDEO  B    256   5361  I32-J4       169  34     ALT

frequency

To define the frequency for the RF channel, use the frequency command in the RF channel sub configuration mode.

frequency number

Syntax Description

number

Radio frequency for the RF channel. The valid range is from 48000000-999000000.

Command Default

None.

Command Modes

RF channel sub configuration mode (config-rf-chan)

Usage Guidelines

This command is used to define the RF channel frequency.

Examples

The following example shows how to define the RF channel frequency:

router#configure terminal 
router(config)#controller integrated-cable 3/0/0
router(config-controller)#rf-chan 0 2
router(config-rf-chan)#frequency 93000000
router(config-rf-chan)#exit
router(config-controller)#exit
router#show controller integrated-Cable 3/0/0 rf-channel 0-2

Chan State Admin Frequency  Type   Annex Mod  srate Interleaver  dcid  power  output
0     UP   UP   93000000   DOCSIS  B    256   5361  I32-J4       1    34     NORMAL
1     UP   UP   99000000   DOCSIS  B    256   5361  I32-J4       2    34     NORMAL
2     UP   UP   105000000  DOCSIS  B    256   5361  I32-J4       3    34     NORMAL 

guardband-override (OFDM channel profile)

To configure the guard band of an OFDM channel, use the guardband-override command in OFDM channel profile configuration mode. To undo the guard band configuration, use no form of this command.

guardband-override value

no guardband-override

Syntax Description

value

0 to 4000000 in 50000Hz increments.

Command Default

None.

Command Modes


OFDM channel profile configuration (config-ofdm-chan-prof)

Command History

Release

Modification

IOS-XE 3.18.1SP

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

Usage Guidelines

Use this command to configure the guard band of an OFDM channel with the range of 0 to 4MHz. No guardband override is configured by default. In this case, the guard band is based on the roll off and spacing in OFDM channel profile.

Examples

The following example shows how to specify the guard band:


Router# configure terminal
Router(config)# cable downstream ofdm-chan-profile 21
Router(config-ofdm-chan-prof)# guardband-override 240000

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.

IOS-XE 3.15.OS

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

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

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.

IOS-XE 3.15.OS

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

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
!

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.

IOS-XE 3.15.OS

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

Usage Guidelines

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

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


Note


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

Examples

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


Router# hccp 20 bypass version 
Router# 

hccp channel-switch

To configure the Cisco CMTS so that a Cisco RF Switch or 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.

IOS-XE 3.15.OS

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

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 

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.

IOS-XE 3.15.OS

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

Usage Guidelines

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

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


Note


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

Examples

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


Router# hccp 1 check version
 
Router# 

hccp ds-switch

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


Note


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

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

no hccp group ds-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 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 number 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.

IOS-XE 3.15.OS

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

Usage Guidelines

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

Examples

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


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

hccp lockout

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


Note


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

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.

IOS-XE 3.15.OS

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

Usage Guidelines

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

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

Examples

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


Router# hccp 1 lockout

hccp protect

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

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.

IOS-XE 3.15.OS

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

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.

The following table shows how a switchover affects the enhanced spectrum management features of the Cisco uBR-MC16S card.

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

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.

IOS-XE 3.15.OS

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

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# 

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.

IOS-XE 3.15.OS

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

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. The following table summarizes the guidelines for using these three commands:

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

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 in Cisco IOS Release 12.2(15)BC2 and earlier releases is 1 to 65,535 minutes, with a default of 30 minutes. In Cisco IOS Release 12.3(3)BC and later releases, the allowable range is 1 to 35791 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.

12.3(3)BC

The allowable range for the revert time period was changed to 1 to 35791 minutes (which is approximately 2^31 milliseconds).

IOS-XE 3.15.OS

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

Usage Guidelines

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

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

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

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

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


Tip


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


Examples

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


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

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


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

hccp switch

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

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.

IOS-XE 3.15.OS

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

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

hccp timers

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


Note


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

hccp group timers hello-time hold-time

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

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.

IOS-XE 3.15.OS

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

Examples

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


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

hccp track

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

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.

IOS-XE 3.15.OS

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

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. The following table summarizes the guidelines for using these three commands:

Table 3. 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)# 

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.

IOS-XE 3.15.OS

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

Usage Guidelines

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


Note


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

Examples

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


hccp 1 unlockout

hccp working

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

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.

IOS-XE 3.15.OS

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

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.

The table below shows how a switchover affects the enhanced spectrum management features of the Cisco uBR-MC16S card.

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

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

None

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.

IOS-XE 3.15.0S

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

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#

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 [unpowered]

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

hw-module slot

To control a component in a slot, use the hw-module slot command in Privileged EXEC mode.

hw-module slot slot-inumber{ { logging onboard { disable | enable } } | { reload [ force ] } | { start } | { stop [ force ] } }

Syntax Description

slot-number

The line cards that are physically present in the specified slot. Valid range is 0 to 9, F0 to F1 and R0 to R1.

logging

Specifies the logging commands.

onboard

Specifies the onboard commands.

disable

Disables the onboard logging commands.

enable

Enables the onboard logging commands.

reload

Restarts the line card.

force

Proceeds without prompting for a confirmation.

start

Activates the line card in the slot.

stop

Deactivates the line card in the slot.

Command Default

No default behavior or values.

Command Modes


Privileged EXEC (#)  

Command History

Release

Modification

IOS-XE 3.16.OS

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

Usage Guidelines

Use the hw-module slot command to power-on, shutdown and power-cycle the line card.

Examples

The following example shows the status of line card in slot 4:

Router# show logging onboard slot 4 status
Status: Disabled

The following example shows how to enable onboard logging commands on line card in slot 2:


Router# hw-module slot 4 logging onboard enable

The following example shows how to reload a line card in slot 1:


Warning


All modems will go offline and all the services will be impacted.


Router# hw-module slot 4 reload  

The following example shows how to start a line card in slot 2:

Router# hw-module slot 4 start 

The following example shows how to stop a line card in slot 3:


Warning


All modems will go offline and all the services will be impacted.


Router# hw-module slot 4 stop  

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

Command Default

None

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.

IOS-XE 3.15.0S

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

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
 

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

Command Default

None

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.

IOS-XE 3.15.0S

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

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
 

hw-module subslot

To control a component in subslot, use the hw-module subslot command in Privileged EXEC mode.

hw-module subslot card slot/subslot number { { reload [ force ] } | { start } | { stop [ force ] } }

Syntax Description

reload

Restarts the targeted subslot.

force

Proceeds without prompting for a confirmation.

start

Activates the targeted subslot.

stop

Deactivates the targeted subslot.

Command Default

No default behavior or values.

Command Modes


Privileged EXEC (#)  

Command History

Release

Modification

IOS-XE 3.16.OS

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

Usage Guidelines

Use the hw-module subslot command to enable, stop and restart the RF-PICs after upgrading the RF-PIC firmware. This command does not support SUP-PIC command.

Examples

The following example shows how to force reload a line card present in subslot 1:


Warning


All modems will go offline and all the services will be impacted.


Router# hw-module subslot 0/1 reload force 

The following example shows how to start a line card in subslot 2:

Router# hw-module subslot 0/2 start 

The following example shows how to force stop a line card in subslot 3:


Warning


All modems will go offline and all the services will be impacted.


Router# hw-module subslot 0/3 stop force