Cisco IOS CMTS Cable Command Reference
Cable Commands: i through p

Table Of Contents

Cable Commands: i through p

interface cable

interface cable-modem

interface gigabitethernet

interface modular-cable

interface port-channel

interface usb

interface wideband-cable

ip-address (controller)

ip accounting mac-address

ip address docsis

ip dhcp ping packet 0

ip dhcp pool

ip dhcp relay information option

ip dhcp smart-relay

ip http cable-monitor

ip http ezvpn

ip-address (controller)

ipdr associate

ipdr collector

ipdr exporter start

ipdr session

ipdr session (global configuration)

ipdr template

issu linecard abortversion

issu linecard acceptversion

issu linecard changeversion

issu linecard loadversion

issu linecard prepareversion

issu linecard reloadversion

issu linecard runversion

mac-address

main-cpu

maintenance-mode

match rule

member subslot

microcode (uBR10012)

microcode reload (uBR10012)

mode (redundancy)

modular-host subslot

monitoring-basics

monitoring-duration

mtu

negotiation

network

nls

nls ag-id auth-key

nls resp-timeout

peak-time1

penalty-period

option

packetcable

packetcable authorize vanilla-docsis-mta

packetcable element-id

packetcable gate maxcount

packetcable gate send-subscriberID

packetcable timer

penalty-period

ping docsis

plim qos input map

port (dial-peer)

privacy


Cable Commands: i through p


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

New Commands

Command
Cisco IOS Software Release

packetcable gate send-subscriberID

12.3(23)BC1

ipdr associate

12.2(33)SCB

ipdr collector

12.2(33)SCB

ipdr explorer start

12.2(33)SCB

ipdr session

12.2(33)SCB

ipdr session (global configuration)

12.2(33)SCB

ipdr template

12.2(33)SCB

issu linecard abortversion

12.2(33)SCB

issu linecard acceptversion

12.2(33)SCB

issu linecard changeversion

12.2(33)SCB

issu linecard loadversion

12.2(33)SCB

issu linecard prepareversion

12.2(33)SCB

issu linecard reloadversion

12.2(33)SCB

issu linecard runversion

12.2(33)SCB

match-rule

12.2(33)SCB


Modified Commands

Command
Cisco IOS Software Release

member subslot

12.2(33)SCA

mode (redundancy)

12.2(33)SCA

ping docsis

12.2(33)SCA

interface cable

12.2(33)SCA

interface modular-cable

12.2(33)SCB

interface wideband-cable

12.2(33)SCB

ip accounting mac-address

12.2(33)SCB

mac-address

12.2(33)SCB

mtu

12.2(33)SCB

negotiation

12.2(33)SCB

packetcable gate send-subscriberID

12.2(33)SCB

penalty-period

12.2(33)SCB

plim qos input map

12.2(33)SCB


interface cable

To configure a cable interface, use the interface cable command in global configuration mode. To disable this configuration, use the no form of this command.

interface cable slot/subslot/port

no interface cable slot/subslot/port

Syntax Description

slot

Specifies the chassis slot number of the cable interface line card. Valid values are 5to 8.

subslot

Specifies the secondary slot number of the cable interface line card. Valid subslots are 0 or 1.

port

Specifies the port number. Valid values are 0 to 4 (depending on the cable interface).


Command Default

None

Command Modes

Global configuration (config)

Command History

Release
Modification

12.3(21)BC

This command was introduced.

12.3(23)BC

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

12.2(33)SCA

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


Examples

The following example shows how to configure a cable interface in slot 8, subslot 0, and port 0 on a Cisco uBR10012 router:

Router# configure terminal
Router(config)# interface cable 8/0/0

Related Commands

Command
Description

interface modular-cable

Specifies a modular cable interface.

interface wideband-cable

Specifies a wideband cable interface.


interface cable-modem

To enter interface configuration mode for the cable interface on a router, use the interface cable-modem command in global configuration mode.

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

interface cable-modem number

Syntax Description

number

Identifies the cable interface (always 0).


Command Default

Disabled

Command Modes

Global configuration

Command History

Release
Modification

11.3(4)NA

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

12.0(4)XI1

Support was added for the Cisco uBR924 cable access router.

12.1(3)XL

Support was added for the Cisco uBR905 cable access router.

12.1(5)XU1

Support was added for the Cisco CVA122 Cable Voice Adapter.

12.2(2)XA

Support was added for the Cisco uBR925 cable access router.


Usage Guidelines

When this command is entered, the router switches from global configuration mode to interface configuration mode.

Examples

The following example shows how to enter interface configuration mode for the router's cable interface and then to enter the available interface configuration commands:

Router(config)# interface cable-modem 0
Router(config-if)# cable-modem ?
  compliant    Enter compliant modes for interface
  downstream   Downstream channel characteristics
  fast-search  Enable/disable the DS fast search
  upstream     upstream channel characteristics
  voip         Options for Voice over IP traffic over the cable interface

Router(config-if)#

Related Commands

Command
Description

cable-modem compliant bridge

Enables DOCSIS-compliant bridging on the cable interface.

cable-modem downstream saved channel

Modifies the saved downstream channel setting and upstream power value on the cable interface.

cable-modem upstream preamble qpsk

Enables the QPSK modulation scheme in the upstream direction from the cable interface to the CMTS.

cable-modem voip best-effort

Allows voice traffic to be transmitted on the upstream using a best-effort QoS.


interface gigabitethernet

The interface gigabitethernet command is now documented as the gigabitethernet keyword of the interface command. For more information, see the interface command.

interface modular-cable

To configure a modular cable interface, use the interface modular-cable command in global configuration mode. To disable this configuration, use the no form of this command.

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

interface modular-cable slot/subslot/bay:nb-channel-number

no interface modular-cable slot/subslot/bay:nb-channel-number

Cisco IOS Release 12.2(33)SCB

interface modular-cable slot/bay/port:nb-channel-number

no interface modular-cable slot/bay/port:nb-channel-number

Syntax Description

slot

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

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.

nb-channel-number

Represents the narrowband channel number.


Command Default

None

Command Modes

Global configuration (config)

Command History

Release
Modification

12.3(21)BC

This command was introduced.

12.3(23)BC

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

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:nb-channel-number to slot/bay/port:nb-channel-number.


Examples

The following example shows how to configure a modular cable interface in slot 1, bay 0, and port 0 on a Cisco uBR10012 router:

Router# configure terminal
Router(config)# interface modular-cable 1/0/0:0

Related Commands

Command
Description

cable attribute-mask

Specifies an attribute mask value for a modular cable interface.

interface wideband-cable

Specifies a wideband cable interface.

interface cable

Specifies a cable interface.


interface port-channel

To create an EtherChannel interface on the Cisco Cable Modem Termination System (CMTS), use the interface port-channel command in global configuration mode. To remove this EtherChannel port from the Cisco CMTS, use the no form of this command.

interface port-channel n

no interface port-channel n

Syntax Description

number

Identifying port channel number for this interface (EtherChannel port). The range is 1 to 64.


Command Default

By default, EtherChannel groups and ports are not defined, and they are disabled (off mode) configured.

Command Modes

Global configuration

Command History

Release
Modification

12.2(11)BC3

This command was introduced on the Cisco uBR7246VXR router.

12.2(9a)BC

This command was introduced on the Cisco uBR10012 router.


Usage Guidelines

The first EtherChannel interface configured becomes the bundle master for all EtherChannel interfaces in the group. That is, the MAC address of the first EtherChannel interface is the MAC address for all EtherChannel interfaces in the group. If the first EtherChannel interface is later removed, the second EtherChannel interface to be configured becomes the bundled master by default.

Repeat this configuration on every EtherChannel port to be bundled into a FastEtherChannel (FEC) or GigabitEtherChannel (GEC) group. This configuration must be present on all EtherChannel interfaces before the EtherChannel group can be configured.

For additional information about using the EtherChannel feature on the Cisco CMTS, refer to the following document on Cisco.com:

EtherChannel for the Cisco CMTS

Examples

The following example configures the port to have an EtherChannel port number of 1 within its EtherChannel group. The EtherChannel group is defined with the channel-group command.

Router(config-if)# interface port-channel 1

Related Commands

Command
Description

channel-group

Assigns an EtherChannel port to an EtherChannel group.

show interface port-channel

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


interface usb

To enter the interface configuration mode for the Universal Serial Bus (USB) interface, use the interface usb command in global configuration mode.

Cisco uBR925 cable access router, Cisco CVA122 Cable Voice Adapter

interface usb number

Syntax Description

number

Identifies the USB interface (always 0).


Command Default

Disabled

Command Modes

Global configuration

Command History

Release
Modification

12.1(5) XU1

This command was introduced for the Cisco CVA122 Cable Voice Adapter.

12.2(2)XA

Support was added for the Cisco uBR925 cable access router.


Usage Guidelines

When this command is entered, the router switches from global configuration mode to interface configuration mode for the USB interface.

Examples

The following example shows how to enter interface configuration mode for the USB interface and then to display the available commands:

Router(config)# interface usb 0

Router(config-if)#?

Interface configuration commands:

access-expression Build a bridge boolean access expression

arp Set arp type (arpa, probe, snap) or timeout

bandwidth Set bandwidth informational parameter

bridge-group Transparent bridging interface parameters

carrier-delay Specify delay for interface transitions

cdp CDP interface subcommands

crypto Encryption/Decryption commands

custom-queue-list Assign a custom queue list to an interface

default Set a command to its defaults

delay Specify interface throughput delay

description Interface specific description

exit Exit from interface configuration mode

fair-queue Enable Fair Queuing on an Interface

h323-gateway Configure H323 Gateway

help Description of the interactive help system

hold-queue Set hold queue depth

ip Interface Internet Protocol config commands

keepalive Enable keepalive

load-interval Specify interval for load calculation for an

interface

logging Configure logging for interface

mac-address Manually set interface MAC address

max-reserved-bandwidth Maximum Reservable Bandwidth on an Interface

mtu Set the interface Maximum Transmission Unit (MTU)

no Negate a command or set its defaults

ntp Configure NTP

priority-group Assign a priority group to an interface

random-detect Enable Weighted Random Early Detection (WRED) on an

Interface

service-policy Configure QoS Service Policy

shutdown Shutdown the selected interface

snmp Modify SNMP interface parameters

standby Interface HSRP configuration commands

timeout Define timeout values for this interface

traffic-shape Enable Traffic Shaping on an Interface or

Sub-Interface

transmit-interface Assign a transmit interface to a receive-only

interface

tx-ring-limit Configure PA level transmit ring limit

Router(config-if)# 

Related Commands

Command
Description

show controllers usb

Displays the high-level controller information for the USB interface.

show interfaces usb

Displays configuration information about the USB interface.


interface wideband-cable

To configure a wideband cable interface, use the interface wideband-cable command in global configuration mode. To disable this configuration, use the no form of this command.

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

interface wideband-cable slot/subslot/bay:wideband-channel

no interface wideband-cable slot/subslot/bay:wideband-channel

Cisco IOS Release 12.2(33)SCB

interface wideband-cable slot/bay/port:wideband-channel

no interface wideband-cable slot/bay/port:wideband-channel

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.

wideband-channel

Represents the wideband channel number. The valid range is 0 to 11.


Command Default

None

Command Modes

Global configuration (config)

Command History

Release
Modification

12.3(21)BC

This command was introduced.

12.3(23)BC

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

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


Examples

The following example shows how to configure a wideband cable interface in slot 1, bay 0, and port 0 on a Cisco uBR10012 router:

Router# configure terminal
Router(config)# interface wideband-cable 1/0/0:0

Related Commands

Command
Description

cable downstream attribute-mask

Specifies an attribute mask value for a wideband cable interface.

interface modular-cable

Specifies a modular cable interface.

interface cable

Specifies a cable interface.


ip-address (controller)

To set the IP address of the Wideband SPA FPGA, use the ip-address (controller) command in controller configuration mode. To remove the IP address of the Wideband SPA FPGA, use the no form of this command.

ip-address ip-address

no ip-address ip-address

Syntax Description

ip-address

IP address for the Wideband SPA FPGA.


Command Default

No IP address is set for the Wideband SPA FPGA.

Command Modes

Controller configuration (config-controller)

Command History

Release
Modification

12.3(21)BC

This command was introduced for the Cisco uBR10012 router.

12.2(33)SCA

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


Usage Guidelines

Use this command to set the IP address for the Wideband SPA FPGA. This address is used as the source IP address for packets that the Wideband SPA transmits to the EQAM device.

Examples

The following example shows how to set the IP address of the Wideband SPA FPGA. The SPA is located in slot 1, subslot 0, bay 0.

Router(config)# controller modular-cable 1/0/0 
Router(config-controller)# ip-address 192.168.200.6 

Related Commands

Command
Description

annex modulation

Sets the annex and modulation for the Wideband SPA.

cable rf-channel

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

controller modular-cable

Enters controller configuration mode to configure the Wideband SPA controller.

modular-host subslot

Specifies the modular-host line card.

rf-channel frequency

Sets the frequency for each RF channel.

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

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

rf-channel network delay

Specifies the CIN delay for each RF channel.

rf-channel description

Specifies the description for each RF channel.

rf-channel cable downstream channel-id

Assigns a downstream channel ID to an RF channel.


ip accounting mac-address

To enable IP accounting on a LAN interface based on the source and destination Media Access Control (MAC) address, use the ip accounting mac-address command in interface configuration mode. To disable IP accounting based on the source and destination MAC address, use the no form of this command.

ip accounting mac-address {input | output}

no ip accounting mac-address {input | output}

Syntax Description

input

Performs accounting based on the source MAC address on received packets.

output

Performs accounting based on the destination MAC address on transmitted packets.


Defaults

Disabled

Command Modes

Interface configuration (config-if)

Command History

Release
Modification

11.1CC

This command was introduced.

12.2(33)SRA

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

12.2SX

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

12.2(33)SCB

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


Usage Guidelines

This feature is supported on Ethernet, Fast Ethernet, and FDDI interfaces.

To display the MAC accounting information, use the show interface mac EXEC command.

MAC address accounting provides accounting information for IP traffic based on the source and destination MAC address on LAN interfaces. This calculates the total packet and byte counts for a LAN interface that receives or sends IP packets to or from a unique MAC address. It also records a timestamp for the last packet received or sent. With MAC address accounting, you can determine how much traffic is being sent to and/or received from various peers at NAPS/peering points.

Examples

The following example enables IP accounting based on the source and destination MAC address for received and transmitted packets:

interface ethernet 4/0/0
 ip accounting mac-address input
 ip accounting mac-address output

Cisco uBR10012 Universal Broadband Router

The following example enables IP accounting based on the source MAC address for received packets on a Gigabit Ethernet interface:

Router#configure terminal 
Router(config)#interface GigabitEthernet3/0/0
Router(config-if)#ip accounting mac-address input

Related Commands

Command
Description

show interface mac

Displays MAC accounting information for interfaces configured for MAC accounting.


ip address docsis

To specify that the cable access router should use the DHCP protocol, as required by the DOCSIS specification, to assign an IP address for its cable interface, use the ip address docsis command in cable interface configuration mode. To disable the use of DHCP, use the no form of this command.

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

ip address docsis

no ip address docsis

Syntax Description

There are no key words or arguments for this command.

Command Default

The cable access router uses the DHCP protocol, as required by the DOCSIS specification, to assign an IP address to its cable interface during system power-on.

Command Modes

Interface configuration (cable interface only)

Command History

Release
Modification

12.1(3)XL

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

12.1(4)T

Support was added for the Cisco uBR924 cable access router.

12.1(3)XL

Support was added for the Cisco uBR905 cable access router.

12.1(5)XU1

Support was added for the Cisco CVA122 Cable Voice Adapter.

12.2(2)XA

Support was added for the Cisco uBR925 cable access router.


Usage Guidelines

The ip address docsis command configures the cable access router so that it obtains its IP address from a DHCP server at system power-on, which is a requirement for DOCSIS operation. This is the default mode of operation. If the configuration for the cable interface does not include any form of ip address command, the cable access router defaults to configuring the cable interface with the ip address docsis command.

Configuring the cable interface with any other form of the ip address command or with the no ip address docsis command prevents the cable access router from operating in DOCSIS networks. This mode of operation should be used only in lab or test networks.


Note Earlier Cisco IOS software releases for the cable access routers used either the ip address negotiated or the ip address dhcp command to specify that the cable interface should obtain its IP address from a DHCP server. These commands should no longer be used to configure the router's cable interface.


Examples

The following example shows how to configure the cable access router so that it obtains the IP address for its cable interface from a DHCP server:

Router(config)# interface cable-modem 0 
Router(config-if)# ip address docsis 
Router(config-if)# exit 
Router(config)# 

Related Commands

Command
Description

cable-modem dhcp-proxy

Specifies that a DHCP server should provide the IP address for the router's Ethernet interface or for a NAT address pool.

ip http dhcp

Specifies the use of the DHCP protocol to obtain an IP address for any interface except the cable interface at system power-on.

ip http negotiated

Specifies that a serial interface should use the PPP/IPCP to obtain an IP address at system power-on


ip dhcp ping packet 0

To instruct the DHCP server to assign an IP address from its pool without first sending an ICMP ping to test whether a client is already currently using that IP address, use the ip dhcp ping packet 0 command in global configuration mode. Use the no form of this command to remove this configuration.

ip dhcp ping packet 0

no ip dhcp ping packet 0

Syntax Description

This command has no additional keywords or arguments.

Command Default

By default, the DHCP server pings a pool address twice before assigning a particular address to a requesting client. If the ping is unanswered, the DHCP server assumes that the address is not in use and assigns the address to the requesting client.

Command Modes

Global configuration

Command History

Release
Modification

12.1 EC

Command support introduced on the Cisco CMTS.


Usage Guidelines

Disabling the ping option can speed up address assignment when a large number of modems are trying to connect at the same time. However, disabling the ping option can also result in duplicate IP addresses being assigned if users assign unauthorized static IP addresses to their CPE devices.

For additional information about DHCP configuration on the Cisco CMTS, refer to the following documents on Cisco.com:

Filtering Cable DHCP Lease Queries on the Cisco CMTS

DHCP and Time-of-Day Services on the Cisco CMTS

Examples

The following example of the show version command illustrates configuration of this feature on the Cisco CMTS:

version 12.1
no service pad
! provides nice timestamps on all log messages
service timestamps debug datetime msec localtime
service timestamps log uptime

! turn service password-encryption on to encrypt passwords
no service password-encryption

! provides additional space for longer configuration file
service compress-config

! supports a large number of modems / hosts attaching quickly
service udp-small-servers max-servers no-limit 
!
hostname Router 
!
boot system disk0:
!
no cable qos permission create
no cable qos permission update
cable qos permission modems

! permits cable modems to obtain Time of Day (TOD) from uBR7100
cable time-server

!
! High performance DOCSIS config file, additional options may be added
!   10 Mbit/sec download, 128 Kbit/sec upload speed, 10 Kbit/sec guaranteed upstream
! NOTE: cable upstream 0 admission-control 150 will prevent modems from 
!   connecting after 150% of guaranteed-bandwidth has been allocated to 
!   registered modems. This can be used for peek load balancing.
! max-burst 1600 prevents a modem with concatenation turned on from consuming 
!   too much wire time, and interfering with VoIP traffic.
! cpe max 8 limits the modem to 8 hosts connected before the CMTS refuses 
!   additional host MAC addresses.
! Timestamp option makes the config file only valid for a short period of time.
!
cable config-file platinum.cm
  service-class 1 max-upstream 128
  service-class 1 guaranteed-upstream 10
  service-class 1 max-downstream 10000
  service-class 1 max-burst 1600
  cpe max 8
  timestamp
!
! Medium performance DOCSIS config file, additional options may be added
!   5 Mbit/sec download, 128 Kbit/sec upload speed
!
cable config-file gold.cm
  service-class 1 max-upstream 64
  service-class 1 max-downstream 5000
  service-class 1 max-burst 1600
  cpe max 3
  timestamp
!
! Low performance DOCSIS config file, additional options may be added
!   1 Mbit/sec download, 64 Kbit/sec upload speed
!
cable config-file silver.cm
  service-class 1 max-upstream 64
  service-class 1 max-downstream 1000
  service-class 1 max-burst 1600
  cpe max 1
  timestamp
!
! No Access DOCSIS config file, used to correctly shut down an unused cable modem
!   1 kbit/sec download, 1 Kbit/sec upload speed, with USB/ethernet port shut down.
!
cable config-file disable.cm
  access-denied
  service-class 1 max-upstream 1
  service-class 1 max-downstream 1
  service-class 1 max-burst 1600
  cpe max 1
  timestamp
!
ip subnet-zero
! Turn on cef switching / routing, anything but process switching (no ip route-cache)
ip cef
ip cef accounting per-prefix 

! Disables the finger server 
no ip finger

! Prevents CMTS from looking up domain names / attempting to connect to 
!   machines when mistyping commands
no ip domain-lookup

! Prevents issuance of IP address that is already in use.
ip dhcp ping packets 0

Related Commands

Command
Description

cable dhcp-giaddr policy

Sets the DHCP giaddr field of DHCP request packets to the primary address for cable modems and the secondary address for CPE devices, allowing the use of separate address pools for the different clients.

cable dhcp-parse option

Enables the parsing of certain DHCP options.

cable helper-address

Enables load-balancing of DHCP requests from cable modems and CPE devices by specifying different DHCP servers according to the cable interface or subinterface.

ip dhcp ping packet 0

Instructs the DHCP server to assign an IP address from its pool without first sending an ICMP ping to test whether a client is already currently using that IP address.

ip dhcp relay information option

Configures the DHCP server to validate the relay agent information option in forwarded BOOTREPLY messages.

ip dhcp smart-relay

Enables the DHCP relay agent on the CMTS to automatically switch a cable modem or CPE device to a secondary DHCP server or address pool if the primary DHCP server does not respond to three successive requests.


ip dhcp pool

To create a DHCP address pool and enter DHCP pool configuration file mode, use the ip dhcp pool command in global configuration mode. To remove a configured DHCP pool, use the no form of this command.

Syntax Description

name

The name can be either an arbitrary string, such as service, or a number, such as 1.


Command Default

DHCP pool names are not configured by default.

Command Modes

Global configuration

Command History

Release
Modification

12.1 EC

Command support introduced on the Cisco CMTS.


Usage Guidelines

Disabling the ping option can speed up address assignment when a large number of modems are trying to connect at the same time. However, disabling the ping option can also result in duplicate IP addresses being assigned if users assign unauthorized static IP addresses to their CPE devices.

For additional information about DHCP configuration on the Cisco CMTS, refer to the following documents on Cisco.com:

Filtering Cable DHCP Lease Queries on the Cisco CMTS

DHCP and Time-of-Day Services on the Cisco CMTS

Examples

The following example configures a DHCP pool with the name indicated, and enables additional configuration in the DHCP pool configuration mode:

Router# configure terminal

Router(config)# ip dhcp pool local

Router(dhcp-config)#


The following examples illustrate additional configurations that are typical for a DHCP pool configured when starting with the ip dhcp pool command, or with additional DHCP configuration commands.

ip dhcp pool cm-platinum
   network 10.128.4.0 255.255.255.0
   bootfile platinum.cm
   next-server 10.128.4.1 
   default-router 10.128.4.1 
   option 2 hex ffff.8f80
   option 4 ip 10.1.4.1 
   option 7 ip 10.1.4.1 
   lease 7 0 10
!
ip dhcp pool cm-gold
   network 10.129.4.0 255.255.255.0
   bootfile gold.cm
   next-server 10.129.4.1
   default-router 10.129.4.1
   option 2 hex ffff.8f80
   option 4 ip 10.1.4.1 
   option 7 ip 10.1.4.1 
   lease 7 0 10
!
ip dhcp pool cm-silver
   network 10.130.4.0 255.255.255.0
   bootfile silver.cm
   next-server 10.130.4.1
   default-router 10.130.4.1
   option 2 hex ffff.8f80
   option 4 ip 10.1.4.1 
   option 7 ip 10.1.4.1 
   lease 7 0 10 
!
ip dhcp pool DisabledModem(0010.aaaa.0001)
    host 10.128.1.9 255.255.255.0
    client-identifier  0100.10aa.aa00.01
    bootfile disable.cm
!
ip dhcp pool DisabledModem(0020.bbbb.0002)
    host 10.128.1.10 255.255.255.0
    client-identifier  0100.20bb.bb00.02
    bootfile disable.cm
!
ip dhcp pool DisabledModem(1010.9581.7f66)
   host 10.128.1.11 255.255.255.0
   client-identifier 0100.1095.817f.66
   bootfile disable.cm
!
ip dhcp pool hosts
    network 10.254.1.0 255.255.255.0
    default-router 10.254.1.1
    dns-server 10.254.1.1 10.128.1.1
    domain-name ExamplesDomainName.com
    lease 7 0 10
!

Related Commands

Command
Description

cable dhcp-giaddr policy

Sets the DHCP giaddr field of DHCP request packets to the primary address for cable modems and the secondary address for CPE devices, allowing the use of separate address pools for the different clients.

cable dhcp-parse option

Enables the parsing of certain DHCP options.

cable helper-address

Enables load-balancing of DHCP requests from cable modems and CPE devices by specifying different DHCP servers according to the cable interface or subinterface.

ip dhcp ping packet 0

Instructs the DHCP server to assign an IP address from its pool without first sending an ICMP ping to test whether a client is already currently using that IP address.

ip dhcp relay information option

Configures the DHCP server to validate the relay agent information option in forwarded BOOTREPLY messages.

ip dhcp smart-relay

Enables the DHCP relay agent on the CMTS to automatically switch a cable modem or CPE device to a secondary DHCP server or address pool if the primary DHCP server does not respond to three successive requests.


ip dhcp relay information option

To configure the Cisco CMTS so that it inserts the MAC address of a CM into the DHCP packet received from a CM or host before it forwards the packet to a DHCP server, use the ip dhcp relay information option in global configuration mode. To disable the MAC address insertion, use the no form of this command.

ip dhcp relay information option

no ip dhcp relay information option

Syntax Description

This command has no keywords or arguments.

Command Default

no ip dhcp relay info option

Command Modes

Global configuration

Command History

Release
Modification

12.0(1)T

This command was introduced for non-CMTS platforms.

12.0(7)XR2, 12.1(T), 12.1(2)EC1, 12.0(10)SC

This command was supported for the Cisco uBR7200 series routers, replacing the cable relay-agent-option command, which was used in previous Cisco IOS releases for this purpose.


Usage Guidelines

This functionality enables a DHCP server to identify the user (CM) sending the request. When this option is enabled, the CMTS inserts the DHCP relay agent information option (also called option 82), which contains the CM or host MAC address, in forwarded BOOTREQUEST messages.

Examples

The following example shows how to enable the insertion of DHCP relay agent information into DHCP packets:

Router# configure terminal 
Router(config)# ip dhcp relay information option 

Related Commands

Command
Description

cable dhcp-giaddr

Modifies the GIADDR field of DHCPDISCOVER and DHCPREQUEST packets with a Relay IP address before they are forwarded to the DHCP server.

cable helper-address

Specifies a destination IP address for User Datagram Protocol (UDP) broadcast (DHCP) packets.

cable relay-agent-option

Enables the system to insert the CM MAC address into a DHCP packet received from a CM or host and forward the packet to a DHCP server.

cable source-verify

Turns on CM upstream verification.

cable telco-return spd dhcp-authenticate

Enforces the telco-return CM to use a specific Dynamic Host Configuration Protocol (DHCP) server.

cable telco-return spd dhcp-server

Identifies the IP address of the Dynamic Host Configuration Protocol (DHCP) server that the telco-return CM must access.

ip dhcp smart-relay

Monitors client retransmissions when the IP DHCP address pool depletion occurs.


ip dhcp smart-relay

To monitor client retransmissions when address pool depletion occurs, use the ip dhcp smart-relay in global configuration mode. To disable this function, use the no form of this command.

ip dhcp smart-relay

no ip dhcp smart-relay

Syntax Description

This command has no arguments or keywords.

Command Default

This command is disabled by default.

Command Modes

Global configuration (config)

Command History

Release
Modification

12.1(3a)EC

This command was introduced.

12.1(3)T

Support was added for the Cisco uBR924 cable access router.

12.1(3)XL

Support was added for the Cisco uBR905 cable access router.

12.1(3)XU1

Support was added for the Cisco CVA122 Cable Voice Adapter.

12.2(2)XA

Support was added for the Cisco uBR925 cable access router.

12.2(4)BC1

This command was integrated into Cisco IOS Release 12.2(4)BC1.


Usage Guidelines

When relay detects excessive retransmissions, it changes the GIADDR, which in turn causes the server to index a different address pool.

Examples

The following example shows how to enable the insertion of DHCP smart relay agent information into DHCP packets:

configure terminal 
ip dhcp smart-relay 

The following example shows how to disable the DHCP smart-relay feature, which would be done when the DHCP clients send multiple DHCP request messages at the same time:

no ip dhcp smart-relay 

Related Commands

Command
Description

cable helper-address

Specifies a destination IP address for UDP broadcast (DHCP) packets.

cable dhcp-giaddr

Modifies the GIADDR field of DHCPDISCOVER and DHCPREQUEST packets with a Relay IP address before they are forwarded to the DHCP server.

cable relay-agent-option

Enables the system to insert the CM MAC address into a DHCP packet received from a CM or host and forward the packet to a DHCP server.

cable source-verify

Turns on CM upstream verification.

cable telco-return spd dhcp-authenticate

Enforces the telco-return CM to use a specific DHCP server.

cable telco-return spd dhcp-server

Identifies the IP address of the DHCP server that the telco-return CM must access.

ip dhcp relay information option

Enables the system to insert the CM MAC address into a DHCP packet received from a CM or host and forward the packet to a DHCP server.


ip http cable-monitor

To enable the cable access router's onboard Cable Monitor web server, use the ip http cable-monitor command in global configuration mode. To disable the Cable Monitor and turn off all access to the onboard Cisco web server, use the no form of this command.

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

ip http cable-monitor {basic | advance} [url-ip-address url-mask]

no ip http cable-monitor

Syntax Description

basic

Displays only the basic status and performance pages.

advance

Displays all status and diagnostic pages.

Note The Cable Monitor should not be used in advanced mode without first implementing a secure password strategy on the cable access router. Enabling the Cable Monitor in advanced mode without setting an encrypted enabled password could provide information that would allow remote users to change the router's configuration.

url-ip-address

(Optional) Specifies the IP address for the Cable Monitor. This argument, along with the url-mask argument, also defines the network that provides the IP address pool used by the temporary DHCP server when the cable interface goes down.

url-mask

(Optional) Specifies the subnet mask for the Cable Monitor. This argument, along with the url-ip-address argument, also defines the network that provides the IP address pool used by the temporary DHCP server when the cable interface goes down.


Command Default

For url-ip-address, 192.168.100.1

For url-mask, 255.255.255.0

Command Modes

Global configuration

Command History

Release
Modification

12.1(1)T

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

12.1(3)XL

Support was added for the Cisco uBR905 cable access router.

12.1(5)XU1

Support was added for the Cisco CVA122 Cable Voice Adapter.

12.2(2)XA

Support was added for the Cisco uBR925 cable access router.


Usage Guidelines

This command enables the Cable Monitor, an onboard web server that displays current status, troubleshooting, and performance information. The Cable Monitor can be accessed in two ways:

When the cable access router has established connectivity with the CMTS over the cable interface, a service technician can use a web browser to remotely access the router and display the desired information.

When the cable network is not operational and the cable access router is not online, the subscriber can access the tool with a PC connected to the router's Ethernet ports. Technicians can then prompt the user for the information they need to determine the source of the problem.

Enabling the Cable Monitor also enables the Cisco web server that is onboard the cable access router, which is the equivalent to entering the ip http server command. However, when the Cable Monitor is enabled, all other access, including CLI access, to the onboard web server is automatically disabled.


Note When the Cable Monitor is enabled in the startup configuration file, the messages "Starting DNS process" and "Terminating DNS process" can appear in the messages displayed during boot-up on the console. These messages are normal and can be ignored.


Disabling the Cable Monitor using the no ip http cable-monitor command also automatically disables the Cisco web server, which is the equivalent of giving the no ip http server command. When disabling the Cable Monitor, the console might display warning messages similar to the following:

       % monitor-209.165.202.131 is not in the database. 
       % monitor-192.168.100.1 is not in the database. 
       % Range [209.165.202.131, 209.165.202.131] is not in the database. 
       % Range [192.168.100.1, 192.168.100.1] is not in the database. 

These messages can be ignored because they are simply confirming that the IP addresses used for the Cable Monitor are no longer being used for that purpose.

The URL-IP-address and URL-mask arguments also specify that the class C private network 192.168.100.0 is the default address pool for the temporary DHCP server that activates when the cable interface goes down.


Note The Cable Monitor web interface does not work with the Cisco Easy VPN Remote web interface. To access the Cable Monitor web interface, you must first disable the Cisco Easy VPN Remote web interface with the no ip http ezvpn command, and then enable the Cable Monitor with the ip http cable-monitor command.


Examples

The following example shows how to enable the Cable Monitor for advanced mode, in which all status and diagnostic pages are displayed:

Router(config)# ip http cable-monitor advance 
Router(config)# 

The following example shows how to disable both the Cable Monitor and the Cisco web server, preventing all web server access to the Cisco uBR924 cable access router:

Router(config)# no ip http cable-monitor 
Router(config)# 

Related Commands

Command
Description

ip http ezvpn

Enables the enable the Cisco Easy VPN Remote web server interface.

ip http port

Configures the TCP port number for the router's HTTP web server. The default is the well-known web server port of 80.

ip http server

Enables and disables the router's HTTP web server.



Note The ip http command also supports two options, access-class and authentication, that should not be used when the Cable Monitor is enabled.


ip http ezvpn

To enable the Cisco Easy VPN Remote web server interface, use the ip http ezvpn command in global configuration mode. To disable the Cisco Easy VPN Remote web interface, use the no form of this command.

Cisco uBR905 and BR925 cable access routers

ip http ezvpn

no ip http ezvpn

Syntax Description

This command has no keywords or arguments.

Command Default

The Cisco Easy VPN Remote web interface is disabled by default.

Command Modes

Global configuration

Command History

Release
Modification

12.2(8)YJ, 12.2(15)T

This command was introduced for the Cisco uBR905 and Cisco uBR925 cable access routers.


Usage Guidelines

This command enables the Cisco Easy VPN Remote web server, an onboard web server that allows users to connect an IPSec Easy VPN tunnel and to provide the required authentication information. This allows the user to perform these functions without having to use the Cisco command-line interface.

Before using this command, you must first enable the Cisco web server that is onboard the cable access router by entering the ip http server command. Then use the ip http ezvpn command to enable the Cisco Easy VPN Remote web server. You can then access the web server by entering the IP address for the router's Ethernet interface in your web browser.


Note The Cisco Easy VPN Remote web interface does not work with the Cable Monitor web interface in Cisco IOS Release 12.2(8)YJ. To access the Cable Monitor web interface, you must first disable the Cisco Easy VPN Remote web interface with the no ip http ezvpn command, and then enable the Cable Monitor with the ip http cable-monitor command.


Examples

The following example shows how to enable the Cisco Easy VPN Remote web server interface:

Router# configure terminal 
Router(config)# ip http server 
Router(config)# ip http ezvpn 
Router(config)# exit 
Router# copy running-config startup-config 

Related Commands

Command
Description

clear crypto ipsec client ezvpn

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

crypto ipsec client ezvpn xauth

Responds to a pending VPN authorization request.

crypto ipsec client ezvpn (global configuration)

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

crypto ipsec client ezvpn (interface configuration)

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

crypto ipsec client ezvpn connect

Manually connects to a specified IPSec VPN tunnel.

ip http cable-monitor

Enables and disables the Cable Monitor web server feature.

ip http port

Configures the TCP port number for the router's HTTP web server. The default is the well-known web server port of 80.

ip http server

Enables and disables the router's HTTP web server.


ip-address (controller)

To set the IP address of the Wideband SPA FPGA, use the ip-address (controller) command in controller configuration mode. To remove the IP address of the Wideband SPA FPGA, use the no form of this command.

ip-address ip-address

no ip-address ip-address

Syntax Description

ip-address

IP address for the Wideband SPA FPGA.


Command Default

No IP address is set for the Wideband SPA FPGA.

Command Modes

Controller configuration (config-controller)

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 integrated into Cisco IOS Release 12.2(33)SCB.


Usage Guidelines

Use this command to set the IP address for the Wideband SPA FPGA. This address is used as the source IP address for packets that the Wideband SPA transmits to the EQAM device.

Examples

The following example shows how to set the IP address of the Wideband SPA FPGA. The SPA is located in slot 1, subslot 0, bay 0.

Router(config)# controller modular-cable 1/0/0 
Router(config-controller)# ip-address 192.168.200.6 

Related Commands

Command
Description

annex modulation

Sets the annex and modulation for the Wideband SPA.

cable rf-channel

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

controller modular-cable

Enters controller configuration mode to configure the Wideband SPA controller.

modular-host subslot

Specifies the modular-host line card.

rf-channel frequency

Sets the frequency for each RF channel.

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

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

rf-channel network delay

Specifies the CIN delay for each RF channel.

rf-channel description

Specifies the description for each RF channel.

rf-channel cable downstream channel-id

Assigns a downstream channel ID to an RF channel.


ipdr associate

To associate the Collector with a session, use the ipdr associate command in global configuration mode. To remove the association, use the no form of this command.

ipdr associate session_id collector_name priority

no ipdr associate session_id collector_name

Syntax Description

session_id

The unique IPDR session ID.

collector_name

The collector name. The name should not contain extra spaces.

priority

The priority value between the session and the collector. The value range is 1 to 10. A value of 1 indicates that the highest priority.


Command Default

An association with the session will not be created.

Command Modes

Global configuration mode

Command History

Release
Modification

12.2(33)SCB

This command was introduced.


Usage Guidelines

This command allows the user to associate the Collector with a session. Once the Collector is configured, the Exporter sends data to the Collector. IPDR supports redundant collector and consistent streaming continues when a collector is down or not functioning.

The no form of the command will only remove the association for the stopped session.


Note The collector and the session should be configured before running this command.


Examples

The following example configures a Collector.

Router# configure terminal 
Router(config)#ipdr associate 1 federal 1 

Related Commands

Command
Description

ipdr collector

Configures the IPDR Collector details.

show ipdr collector

Displays the collector information, message statistics and event for all the sessions that are associated with the collector.

ipdr session

Adds a session to the IPDR Exporter.


ipdr collector

To configure the Internet Protocol Detail Record (IPDR) Collector details, use the ipdr collector command in global configuration mode. To remove the Collector, use the no form of this command.

ipdr collector collector_name ip_addr [port]

no ipdr collector collector_name

Syntax Description

collector_name

The collector name. The name should not contain extra spaces.

ip_addr

The collector IP address.

port

(Optional) The collector port value. The default port number will be considered if the value is not entered.


Command Default

A Collector will not be configured.

Command Modes

Global configuration mode

Command History

Release
Modification

12.2(33)SCB

This command was introduced.


Usage Guidelines

This command allows the user to configure an IPDR Collector and authenticate the IPDR protocol. Once the Collector is configured, the Exporter sends data to the Collector. User must provide the collector name and the IP address. Port number is used when an exporter creates an active connection.

The no form of the command will remove a specific IPDR Collector. If the collector is associated with an active session, you should stop the session before using the no command.

Examples

The following example configures a Collector.

Router# configure terminal 
Router(config)#ipdr collector federal 192.0.2.0 

Related Commands

Command
Description

show ipdr collector

Displays the collector information, message statistics and event for all the sessions that are associated with the collector.

ipdr session

Adds a session to the IPDR Exporter.


ipdr exporter start

To enable the CMTS application, to start the Internet Protocol Detail Record (IPDR) Exporter process to connect the exporter and the collector, use the ipdr exporter start command in global configuration mode. To terminate the connection between the exporter and collector, use the no form of this command.

ipdr exporter start

no ipdr exporter start

Syntax Description

This command has no arguments or keywords.

Command Default

By default, the IPDR exporter process will not be started.

Command Modes

Global configuration mode

Command History

Release
Modification

12.2(33)SCB

This command was introduced.


Usage Guidelines

This command allows the user to explicitly start the IPDR Exporter and connect to the collector. As a default behavior, the command will initiate all the sessions configured in the Exporter to a "Start" state.

The no form of the command will stop the IPDR Exporter process. The command will also clear the connection with the collector while retaining other configurations.

Examples

The following example starts the IPDR Exporter process on the CMTS.

Router# configure terminal
Router(config)#ipdr exporter start 

Related Commands

Command
Description

show ipdr exporter

Displays information about the IPDR Exporter state.

show ipdr collector

Displays the collector information, message statistics and event for all the sessions that are associated with the collector.

ipdr collector

Configures the Internet Protocol Detail Record (IPDR) Collector details.


ipdr session

To start or stop a specific session, use the ipdr session command in the privileged EXEC mode.

ipdr session session_id {start | stop}

Syntax Description

session_id

The unique IPDR session ID.

start

The keyword to start the session.

stop

The keyword to stop the session.


Command Default

No sessions are started.

Command Modes

Privileged EXEC mode

Command History

Release
Modification

12.2(33)SCB

This command was introduced.


Usage Guidelines

This command allows the user to start or stop a specific session. This command can be executed only when the IPDR exporter is started.


Note The user has to stop the session before configuring any tasks if the session is active.


Examples

The following example enables the user to start a session.

Router# configure terminal
Router(config)#ipdr session 1 start

Related Commands

Command
Description

ipdr exporter start

Starts the IPDR Exporter and connects to the collector.

show ipdr exporter

Displays information about the IPDR Exporter state.

ipdr associate

Associates the Collector with a session.


ipdr session (global configuration)

To enable the CMTS application to add a session to the Internet Protocol Detail Record (IPDR) exporter, use the ipdr session command in global configuration mode. To remove the session, use the no form of this command.

ipdr session session_id session_name session_descr

no ipdr session session_id

Syntax Description

session_id

The unique IPDR session ID.

session_name

The session name. The name should not contain extra spaces.

session_descr

The description of the session.


Command Default

No sessions are added to the IPDR exporter. It depends on the status of the IPDR exporter. After configuring one session;if the status of exporter is started, then the session is started automatically.

Command Modes

Global configuration mode

Command History

Release
Modification

12.2(33)SCB

This command was introduced.


Usage Guidelines

This command allows the user to add a session to the IPDR exporter. User should provide session ID, session name and session description for every session.

The no form of the command will remove a specific session. Once a session is removed, the template and other information associated with the session is also lost.


Note You can not update template details or other details when a session already created.


Examples

The following example adds a session to the Exporter.

Router# configure terminal
Router(config)#ipdr session  1 test no_descr 

Related Commands

Command
Description

ipdr exporter start

Starts the IPDR exporter and connects to the collector.

show ipdr exporter

Displays information about the IPDR exporter state.

ipdr associate

Associates the IPDR collector with a session.


ipdr template

To add an Internet Protocol Detail Record (IPDR) template to the IPDR Session, use the ipdr template command in global configuration mode. To remove the template, use the no form of this command.

ipdr template session_id template_name

no ipdr template session_id template_name

Syntax Description

session_id

The unique IPDR Session ID.

template_name

The template name.


Command Default

Template is not added to the session.

Command Modes

Global configuration mode

Command History

Release
Modification

12.2(33)SCB

This command was introduced.


Usage Guidelines

This command allows the user to add an IPDR template to the desired session (based on session ID.)

The no form of the command will remove a specific template from the session.


Note User can only add the system supported templates. The list can be viewed by entering a "?" at the command prompt.


Examples

The following example adds a template to the session.

Router# configure terminal
Router(config)#ipdr template 1 SAMIS 

Related Commands

Command
Description

ipdr exporter start

Starts the IPDR Exporter and connects to the collector.

show ipdr exporter

Displays information about the IPDR Exporter state.

ipdr session

Adds a session to the IPDR Exporter.


issu linecard abortversion

To abort or roll back the current image version on a single line card or multiple line cards to the previous version, use the issu linecard abortversion command in the privileged EXEC mode.


Note This command is used to abort or roll back the versions on redundant line cards only.


issu linecard abortversion all | lc_slot[/subslot] [forced]

Syntax Description

all

All redundant line cards.

lc_slot

The line card slot number.

subslot

The line card sub slot number.

forced

(Optional) The ISSU would ignore potential service outage and line card incompatibility errors and proceed with abortversion instead of stopping and error handling.


Command Default

No default behavior or values.

Command Modes

Privileged EXEC mode

Command History

Release
Modification

12.2(33)SCB

This command was introduced.


Usage Guidelines

This command allows the user to roll back to prior image on working or primary line card on a single or multiple line cards to the previous versions.


Note The issu linecard reloadversion command is used to reload a line card with the original version of images.


The following example aborts the specific redundant line card's image version.

Router# configure terminal 
Router(config)#issu linecard abortversion 

Related Commands

Command
Description

issu linecard acceptversion

Accepts the new image version on the working line card.

issu linecard loadversion

Loads a specific image version on the primary line card.

issu linecard prepareversion

Determines if the image version on the line card has to be upgraded or downgraded to the route processor's image version.

issu linecard reloadversion

Reloads the new loaded image on a working or a primary line card.

issu linecard runversion

Runs the new loaded image on a working or a primary line card.

issu linecard changeversion

Starts the upgrade or downgrade activity of the image version for a single line card or multiple line cards.


issu linecard acceptversion

To accept the new image version on the working line card, use the issu linecard acceptversion command in the privileged EXEC mode.

issu linecard acceptversion lc_slot[/subslot]

Syntax Description

lc_slot

The line card slot number.

subslot

The line card sub slot number.


Command Default

No default behavior or values.

Command Modes

Privileged EXEC mode

Command History

Release
Modification

12.2(33)SCB

This command was introduced.


Usage Guidelines

This command allows the user to accept the new image version on the working line card. The command also indicates the completion of changing the image version for the specific line card and allows the ISSU of the next line card in the queue.

Examples

The following example indicates a command accepting the image version on the slot 7 of the line card.

Router# configure terminal
Router(config)#issu linecard acceptversion 7/0

Related Commands

Command
Description

issu linecard abortversion

Rolls back to the prior image on working/primary line card.

issu linecard loadversion

Loads a specific image version on the primary line card.

issu linecard prepareversion

Determines if the image version on the line card has to be upgraded or downgraded to the route processor's image version.

issu linecard reloadversion

Reloads the new loaded image on a working or a primary line card.

issu linecard runversion

Runs the new loaded image on a working or a primary line card.

issu linecard changeversion

Starts the upgrade or downgrade activity of the image version for a single line card or multiple line cards.


issu linecard changeversion

To start the upgrade or downgrade activity of the image version for a single working line card or multiple working line cards, use the issu linecard changeversion command in the privileged EXEC mode.

issu linecard changeversion {all | stop | slot_1[/subslot_1] ... [slot_n[/subslot_n]]} [forced]

Syntax Description

all

All redundant line cards.

slot_1

The slot number for the first line card.

subslot_1

The sub slot number for the first line card.

slot_n

The slot number for the nth line card.

subslot_n

The sub slot number for the nth line card.

forced

(Optional) The ISSU would ignore potential service outage and line card incompatibility errors and proceed with changeversion instead of stopping and error handling.


Command Default

No default behavior or values.

Command Modes

Privileged EXEC mode

Command History

Release
Modification

12.2(33)SCB

This command was introduced.


Usage Guidelines

This command allows the user to start the upgrade or downgrade activity of the image version for a single line card or multiple line cards. Here the line cards are of the primary or working type only.

Using the all option, you can change the image version of all the redundant line cards instead of specifying explicity each of the line card.

Using the stop option, you can abort or stop the version change process for a line card.

Examples

The following example displays the command and uses the all option.

Router# configure terminal
Router(config)#issu linecard changeversion all 

The following example displays the command and uses the slot value of 6.

Router# configure terminal
Router(config)#issu linecard changeversion 6/0

Related Commands

Command
Description

issu linecard abortversion

Rolls back to the prior image on working/primary line card.

issu linecard acceptversion

Accepts the new image version on the working line card.

issu linecard loadversion

Loads a specific image version on the primary line card.

issu linecard prepareversion

Determines if the image version on the line card has to be upgraded or downgraded to the route processor's image version.

issu linecard reloadversion

Reloads the new loaded image on a working or a primary line card.

issu linecard runversion

Runs the new loaded image on a working or a primary line card.


issu linecard loadversion

To load a specific image version on the primary line card, use the issu linecard loadversion command in the privileged EXEC mode.

issu linecard loadversion slot[/subslot]

Syntax Description

slot

The line card slot number.

subslot

The line card sub slot number.


Command Default

No default behavior or values.

Command Modes

Privileged EXEC mode

Command History

Release
Modification

12.2(33)SCB

This command was introduced.


Usage Guidelines

This command allows the user to load a specific image version on the working line card.

Examples

The following example shows the command that loads the image version on a line card with the slot number 7.

Router# configure terminal
Router(config)#issu linecard loadversion 7/0

Related Commands

Command
Description

issu linecard abortversion

Rolls back to the prior image on working/primary line card.

issu linecard acceptversion

Accepts the new image version on the working line card.

issu linecard prepareversion

Determines if the image version on the line card has to be upgraded or downgraded to the route processor's image version.

issu linecard reloadversion

Reloads the new loaded image on a working or a primary line card.

issu linecard runversion

Runs the new loaded image on a working or a primary line card.

issu linecard changeversion

Starts the upgrade or downgrade activity of the image version for a single line card or multiple line cards.


issu linecard prepareversion

To determine if the image version on the line card has to be upgraded or downgraded to the route processor's image version, use the issu linecard prepareversion command in the privileged EXEC mode.

issu linecard prepareversion lc_slot[/subslot] [forced]

Syntax Description

lc_slot

The line card slot number.

subslot

The line card sub slot number.

forced

(Optional) The ISSU would ignore potential service outage and line card incompatibility errors and proceed with prepareversion instead of stopping and error handling.


Command Default

No default behavior or values.

Command Modes

Privileged EXEC mode

Command History

Release
Modification

12.2(33)SCB

This command was introduced.


Usage Guidelines

This command allows the user to check if the image version on the line card has to be upgraded or downgraded to the route processor's image version.

This command also checks if the line card has a valid redundancy configuration. If the line card does not have a valid configuration, then the user has to reload the line card using the issu linecard reloadversion command.

Examples

The following example shows the command executed for a line card with a slot value of 7.

Router# configure terminal
Router(config)#issu linecard prepareversion 7/0

Related Commands

Command
Description

issu linecard abortversion

Rolls back to the prior image on working/primary line card.

issu linecard acceptversion

Accepts the new image version on the working line card.

issu linecard loadversion

Loads a specific image version on the primary line card.

issu linecard reloadversion

Reloads the new loaded image on a working or a primary line card.

issu linecard runversion

Runs the new loaded image on a working or a primary line card.

issu linecard changeversion

Starts the upgrade or downgrade activity of the image version for a single line card or multiple line cards.


issu linecard reloadversion

To reload the new loaded image on a working or a primary line card, use the issu linecard reloadversion command in the privileged EXEC mode.

issu linecard reloadversion {original | target} all | slot_1[/subslot_1] ... [slot_n[/subslot_n]]

Syntax Description

original

The original image version.

all

All redundant line cards.

slot_1

The slot number for the first line card.

subslot_1

The sub slot number for the first line card.

slot_n

The slot number for the nth line card.

subslot_n

The sub slot number for the nth line card.


Command Default

No default behavior or values.

Command Modes

Privileged EXEC mode

Command History

Release
Modification

12.2(33)SCB

This command was introduced.


Usage Guidelines

This command allows the user to reload the new loaded image on a working or a primary line card.

This command can be used for the following line card conditions.

Line cards that are not configured with redundancy, and do not support Minimal Disruptive Restart (MDR.)

Line cards which are capable of line card redundancy which were rolled back due to an unsuccessful changeversion command.

Examples

The following example shows the command executed with the original keyword.

Router# configure terminal
Router(config)#issu linecard reloadversion original 8/0 

The following example shows the command executed with the target keyword.

Router# configure terminal
Router(config)#issu linecard reloadversion target 8/0


Related Commands

Command
Description

issu linecard abortversion

Rolls back to the prior image on working or primary line card.

issu linecard acceptversion

Accepts the new image version on the working line card.

issu linecard loadversion

Loads a specific image version on the primary line card.

issu linecard prepareversion

Determines if the image version on the line card has to be upgraded or downgraded to the route processor's image version.

issu linecard runversion

Runs the new loaded image on a working or a primary line card.

issu linecard changeversion

Starts the upgrade or downgrade activity of the image version for a single linecard or multiple line cards.


issu linecard runversion

To run the new loaded image on a working or a primary line card, use the issu linecard runversion command in the privileged EXEC mode.

issu linecard runversion lc_slot[/subslot] [forced]

Syntax Description

lc_slot

The line card slot number.

subslot

The line card sub slot number.

forced

(Optional) The ISSU would ignore potential service outage and line card incompatibility errors and proceed with runversion instead of stopping and error handling.


Command Default

No default behavior or values.

Command Modes

Privileged EXEC mode

Command History

Release
Modification

12.2(33)SCB

This command was introduced.


Usage Guidelines

This command allows the user to run the new loaded image on a working or a primary line card.

Examples

The following example displays the command executed to run the loaded image in the line card slot 7.

Router# configure terminal
Router(config)#issu linecard runversion 7/0

Related Commands

Command
Description

issu linecard abortversion

Rolls back to the prior image on the working/primary line card.

issu linecard acceptversion

Accepts the new image version on the working line card.

issu linecard loadversion

Loads a specific image version on the primary line card.

issu linecard prepareversion

Determines if the image version on the line card has to be upgraded or downgraded to the route processor's image version.

issu linecard reloadversion

Reloads the new loaded image on a working or a primary line card.

issu linecard changeversion

Starts the upgrade or downgrade activity of the image version for a single linecard or multiple line cards.


mac-address

To modify the default MAC address of an interface to some user-defined address, use the mac-address command in interface configuration mode. To return to the default MAC address on the interface, use the no form of this command.

mac-address ieee-address

no mac-address ieee-address

Syntax Description

ieee-address

48-bit IEEE MAC address written as a dotted triple of four-digit hexadecimal numbers.


Defaults

The interface uses a default MAC address that is derived from the base address stored in the electrically erasable programmable read-only memory (EEPROM).

Command Modes

Interface configuration

Usage Guidelines

Be sure that no other interface on the network is using the MAC address that you assign.

There is a known defect in earlier forms of this command when the Texas Instruments Token Ring MAC firmware is used. This implementation is used by Proteon, Apollo, and IBM RTs. A host using a MAC address whose first two bytes are zeros (such as a Cisco router) will not properly communicate with hosts using that form of this command of TI firmware.

There are two solutions. The first involves installing a static Routing Information Field (RIF) entry for every faulty node with which the router communicates. If there are many such nodes on the ring, this may not be practical. The second solution involves setting the MAC address of the Cisco Token Ring to a value that works around the problem.

This command forces the use of a different MAC address on the specified interface, thereby avoiding the Texas Instrument MAC firmware problem. It is up to the network administrator to ensure that no other host on the network is using that MAC address.

Examples

The following example sets the MAC layer address, where xx.xxxx is an appropriate second half of the MAC address to use:

interface tokenring 0
 mac-address 5000.5axx.xxxx

The following example changes the default MAC address on the interface to 1111.2222.3333:

Router# configure terminal

Router(config)# interface fastethernet 2/1/1

Router(config-if)# mac-address 1111.2222.3333

Related Commands

Command
Description

show interfaces fastethernet

Displays information about the Fast Ethernet interfaces.

show interfaces gigabitethernet

Displays information about the Gigabit Ethernet interfaces.


main-cpu

To enter main-CPU redundancy configuration mode, so that you can configure the synchronization of the active and standby Performance Routing Engine (PRE1) modules, use the main-cpu command in redundancy configuration mode.

main-cpu

Syntax Description

This command has no keywords or arguments.

Defaults

No default behavior or values

Command Modes

Redundancy configuration (config-r)

Command History

Release
Modification

12.2(4)XF

This command was introduced for the Cisco uBR10012 router.

12.2(11)BC3

Support for the switchover timeout command was added.

12.3BC

This command was integrated into Cisco IOS Release 12.3BC.

12.2(33)SCA

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


Usage Guidelines

When you enter main-CPU redundancy configuration mode, the prompt changes to the following:

Router(config-r-mc)# 

After you enter main-CPU redundancy configuration mode, you can use the auto-sync command to specify which files are synchronized between the active and standby PRE1 modules. In Cisco IOS Release 12.2(11)BC3 and later releases, you can also use the switchover timeout command to specify the amount of time that the standby PRE1 module should wait when it first detects that the active PRE1 module is not active and when it initiates a switchover and becomes the active PRE1 module.

To leave main-CPU redundancy configuration mode and to return to redundancy configuration mode, use the exit command.

Examples

The following example shows how to enter main-CPU redundancy mode and the commands that are available there:

Router# config t 
Router(config)# redundancy 
Router(config-r)# main-cpu 
Router(config-r-mc)# ? 

Main Cpu redundancy configuration commands:
  auto-sync   Sync elements
  exit        Exit from main-cpu configuration mode
  no          Negate a command or set its defaults
  switchover  Configuration of switchover

Router(config-r-mc)# 

Related Commands

Command
Description

associate slot

Logically associate slots for APS processor redundancy

auto-sync

Configures which files are synchronized between the active and standby PRE1 modules.

redundancy

Enters redundancy configuration mode.

switchover timeout

Configures the switchover timeout period of the PRE1 module.


maintenance-mode

To configure the PRE1 modules on the router for maintenance mode, use the maintenance-mode command in redundancy configuration mode. To return to normal operations, use the no form of this command.

maintenance-mode

no maintenance-mode

Syntax Description

This command has no keywords or arguments.

Command Default

Normal operations (no maintenance-mode)

Command Modes

Redundancy configuration

Command History

Release
Modification

12.2(4)XF

This command was introduced for the Cisco uBR10012 router.


Usage Guidelines

When the Cisco uBR10012 router is configured with redundant PRE1 modules, the active PRE1 module automatically synchronizes the configuration, network state information, and other information with the standby PRE1 module, so that if a switchover occurs, the standby module can restore normal operations quickly. You can use the maintenance-mode command to disable this automatic synchronization of the PRE1 modules, and to disable the reporting of any faults on the standby module to the active module.


Note The maintenance-mode command disables the ability of the Cisco uBR10012 router to switchover PRE1 modules and should be used only while upgrading the router or troubleshooting network problems.


Examples

The following example shows how to disable the automatic PRE1 module synchronization on the Cisco uBR10012 router and enter maintenance mode:

Router# config t 
Router(config)# redundancy 
Router(config-r)# maintenance-mode 
Router(config-r)# exit 
Router(config)# 

The following example shows how to leave maintenance mode and return to normal operations, which includes the automatic synchronization of the PRE1 modules:

Router# config t 
Router(config)# redundancy 
Router(config-r)# no maintenance-mode 
Router(config-r)# exit 
Router(config)# 

Related Commands

Command
Description

auto-sync

Configures which files are synchronized between the active and standby PRE1 modules.

redundancy

Enters redundancy configuration mode.


match rule

To configure the match rule, rule priority and related action in the selected cable multicast authorization profile, use the match rule command in interface configuration mode. To disable a cable multicast authorization profile match, use the no form of this command.

match rule [ipv4 | ipv6] [source-prefix] [group-prefix] priority [priority-value] [permit | deny]

no match rule [ipv4/ipv6] [source-prefix] [group-prefix] priority [priority-value] [permit/deny]

Syntax Description

match rule [ipv4 | ipv6]

Specifies the matching source rule.


Note Though CLI allows IPv6 to be configured, only IPv4 is supported in the CMTS.


source-prefix

(Optional) Specifies the matching source address prefix.

Example: 223.1.1.1/16

group-prefix

(Optional) Specifies the matching group address prefix.

Example: 223.1.1.1/16

priority [priority-value]

Specifies the priority of the cable multicast authorization profile.

Priority value range is: 0-255.

permit

The argument permit allows specified packets to be forwarded.

deny

The argument deny allows to specified packets to be rejected.


Command Default

Cable multicast authorization is disabled.

Command Modes

Interface configuration—cable interface only (config-mauth)

Command History

Release
Modification

12.2(33)SCB

This command was introduced.


Usage Guidelines

This command specifies the cable multicast authorization profile match to be used.

Examples

The following example shows how to use the selected multicast authorization profile match:

Router(config-mauth)# match rule rule1

Related Commands

Command
Description

cable multicast authorization enable default-action

This command enables the cable multicast authorization features. If the multicast authorization feature is disabled, all defined authorization profiles are ineffective.

cable multicast authorization profile-name

Defines the cable multicast authorization profile.

show cable multicast authorization

Displays the list of defined multicast authorization profiles and all CMs associated with corresponding profiles.


member subslot

To configure the redundancy role of a line card, use the member subslot command in line card redundancy group mode.

member subslot slot/subslot {primary | secondary}

no member subslot slot/subslot {primary | secondary}

uBR10012 Router and uBR7200 Series Universal Broadband Routers

member subslot slot/subslot {protect | working | revertive | reverttime value}

no member subslot slot/subslot {protect | working | revertive | reverttime value}

Syntax Description

slot

Chassis line card slot number.

subslot

Chassis line card subslot number.

primary | secondary

Configures the redundancy role of the line card.

primary—Active line card.

secondary—Standby line card.

protect

Specifies the protect slot in the line card group.

working

Specifies the working slot in the line card group.

revertive

Specifies the revert operation on the protect card.

reverttime value

Specifies the time interval for the revert operation in minutes. If you specify 30, the protect card switches back to the protect mode after 30 minutes.


Command Default

None

Command Modes

Line card redundancy group

Command History

Release
Modification

12.2(28)SB

This command was introduced on the Cisco 10000 series routers.

12.3(23)BC

This comma nd was integrated into Cisco IOS Release 12.3(23)BC.

12.2(33)SCA

Support for the following keywords was removed in Cisco IOS Release 12.2(33)SCA and later:

revertive

reverttime


Note Use the revertive command in line card redundancy group mode to enable the revert operation on a protect card in Cisco IOS Release 12.2(33)SCA and later.



Usage Guidelines

The primary line card must be the first line card configured and must occupy subslot 1. The secondary line card must be the second line card configured and must occupy subslot 0. Only one primary line card and one secondary line card can be configured.

Examples

The following creates line card group number 1 for one-to-one line card redundancy. It also specifies the line card in subslot 1 as the primary (active) line card, and the line card in subslot 0 as the secondary (standby) line card:

Router# configure terminal
Router(config)# redundancy
Router(config-red)# linecard-group 1 y-cable
Router(config-red-lc)# member subslot 2/1 primary
Router(config-red-lc)# member subslot 2/0 secondary

Related Commands

Command
Description

linecard-group

Creates a line card group for one-to-one line card redundancy.

redundancy

Enters redundancy mode.

show redundancy linecard

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


microcode (uBR10012)

To reload the microcode software images on a Parallel eXpress Forwarding (PXF) processor or on all line cards that support downloadable microcode, use the microcode command in global configuration mode.

microcode {pxf filename | reload}

Syntax Description

pxf

Reloads the microcode for the PXF processors on the Performance Routing Engine (PRE1) module.

filename

Specifies the microcode software image for the PXF processors by device name and filename.

reload

Reloads the microcode for all PRE1 modules and other line cards that support downloadable microcode software images.


Command Default

No default behavior or values

Command Modes

Global configuration

Command History

Release
Modification

12.2(1)XF1

This command was introduced for the Cisco uBR10012 router.


Usage Guidelines

By default, the Cisco uBR10012 router automatically loads all required microcode on to the PXF processors and other line cards when it loads the Cisco IOS software image. Also, the PRE1 module automatically reloads the microcode on a card when certain faults occur, allowing the card to recover from the fault.

You can reload the microcode on the PRE1 module or on all line cards that support downloadable microcode by using the microcode command. Typically, this is not needed and should be done only upon the advice of Cisco TAC or field service engineers.


Tip You can also reload the microcode on the PXF processors or on all cards using the microcode reload command in privileged EXEC mode. In particular, use the microcode reload command to reload the PXF processors with the default microcode that was loaded along with the Cisco IOS software image.


Examples

The following example shows how to reload the microcode on all PRE processors and line cards that support downloadable microcode:

Router# configure terminal 
Router(config)# microcode reload 
Reload microcode? [confirm] yes 

00:49:41: Downloading Microcode: file=system:pxf/ubr10k-ucode.1.2.3,
version=1.1.0, description=Release Software created Wed 17-Jul-02 16:58

<<list of interfaces going down or coming up>> 

00:49:42: !!pxf clients started, forwarding code operational!!

Router(config)#

The following example shows how to reload the microcode on the PXF processors on the PRE1 module, using a specific image that is stored in the Flash memory:

Router# configure terminal 
Router(config)# microcode pxf flash:pxf/ubr10k-ucode.122.1.2.3 
Reload microcode? [confirm] yes 

1d04h: Downloading Microcode: file=flash:pxf/ubr10k-ucode.122.1.2.3, version=122.1.2.3, 
description=Release Software created Thu 17-Oct-02 11:33 

<<list of interfaces going down or coming up>> 

1d04h: !!pxf clients started, forwarding code operational!!

Router(config)# 

Related Commands

Command
Description

hw-module reset

Resets a particular PRE1 module or a particular line card.

microcode reload

Reloads the microcode software images on one or all line cards that support downloadable microcode.

show pxf microcode

Displays display identifying information for the microcode being used on the PXF processors.


microcode reload (uBR10012)

To reload the microcode software images on one or all line cards that support downloadable microcode, use the microcode reload command in privileged EXEC mode.

microcode reload {all | pxf [device:[filename]]}

Syntax Description

all

Reloads the microcode for all Performance Routing Engine (PRE1) modules and other line cards that support downloadable microcode software images.

pxf

Reloads the microcode for the Parallel eXpress Forwarding (PXF) processors on the PRE1 module.

device:[filename]

(Optional) Loads the PXF processors with the microcode software image that has the specific filename on the specific device. If no filename is specified, the first image found on the device is loaded by default.


Command Default

For microcode reload pxf, defaults to loading the microcode image that was originally loaded when the Cisco IOS software image was loaded.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(1)XF1

This command was introduced for the Cisco uBR10012 router.


Usage Guidelines

By default, the Cisco uBR10012 router automatically loads all required microcode on to the PXF processors and other line cards when it loads the Cisco IOS software image. Also, the PRE1 module automatically reloads the microcode on a card when certain faults occur, allowing the card to recover from the fault.

You can reload the microcode on the PRE1 module or on all line cards that support downloadable microcode by using the microcode reload command. Typically, this is not needed and should be done only upon the advice of Cisco TAC or field service engineers.


Tip You can also reload the microcode on the PXF processors or on all cards using the microcode command in global configuration mode.


Examples

The following example shows how to reload the microcode on all PRE processors and line cards that support downloadable microcode:

Router# microcode reload all 
Reload microcode? [confirm] yes 

00:49:41: Downloading Microcode: file=system:pxf/ubr10k-1-ucode.122.1.0, version=122.1.0, 
description=Release Software created Wed 17-Jul-02 16:58

<<list of interfaces going down or coming up>> 

00:49:42: !!pxf clients started, forwarding code operational!!

Router#

The following example shows a typical list of devices that you can use when loading microcode for the PXF processors. This list might vary, depending on whether a standby PRE1 module is installed and depending on the version of Cisco IOS software being used.

Router# microcode reload pxf ? 

   bootflash:      location of microcode
   disk0:          location of microcode
   disk1:          location of microcode
   flash:          location of microcode
   ftp:            location of microcode
   null:           location of microcode
   nvram:          location of microcode
   rcp:            location of microcode
   scp:            location of microcode
   sec-bootflash:  location of microcode
   sec-disk0:      location of microcode
   sec-disk1:      location of microcode
   sec-nvram:      location of microcode
   sec-slot0:      location of microcode
   sec-slot1:      location of microcode
   slot0:          location of microcode
   slot1:          location of microcode
   system:         location of microcode
   tftp:           location of microcode
   <cr> 

Router#

The following example shows how to reload the microcode on the PXF processors on the PRE1 module, using a specific image that is stored in the Flash memory:

Router# microcode reload pxf flash:pxf/ubr10k-1-ucode.122.1.0.4 
Reload microcode? [confirm] yes 

3d00h: Downloading Microcode: file=flash:pxf/ubr10k-1-ucode.122.1.0.4, version=122.1.0.4, 
description=Release Software created Thu 27-Jun-02 16:05

<<list of interfaces going down or coming up>> 

3d00h: !!pxf clients started, forwarding code operational!!

Router# 

Related Commands

Command
Description

hw-module reset

Resets a particular PRE1 module or a particular line card.

microcode

Reloads the microcode software images on one or all line cards that support downloadable microcode.

show pxf microcode

Displays display identifying information for the microcode being used on the PXF processors.


mode (redundancy)

To configure the redundancy mode of operation, use the mode command in redundancy configuration mode.

Cisco 7304 Router

mode {rpr | rpr-plus | sso}

Cisco 7500 Series Routers

mode {hsa | rpr | rpr-plus | sso}

Cisco 10000 Series Routers

mode {rpr-plus | sso}

Cisco 12000 Series Routers

mode {rpr | rpr-plus | sso}

Cisco uBR10012 Universal Broadband Router

mode {rpr-plus | sso}

Syntax Description

rpr

Route Processor Redundancy (RPR) redundancy mode.

rpr-plus

Route Processor Redundancy Plus (RPR+) redundancy mode.

sso

Stateful Switchover (SSO) redundancy mode.

hsa

High System Availability (HSA) redundancy mode.


Command Default

The default mode for the Cisco 7500 series routers is HSA.
The default mode for the Cisco 7304 router and Cisco 10000 series routers is SSO.
The default mode for the Cisco 12000 series routers is RPR.
The default mode for the Cisco uBR10012 universal broadband router is SSO.

Command Modes

Redundancy configuration (config-red)

Command History

Release
Modification

12.0(16)ST

This command was introduced.

12.0(22)S

SSO support was added.

12.2(18)S

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

12.2(20)S

Support was added for the Cisco 7304 router. The Cisco 7500 series router is not supported in Cisco IOS Release 12.2(20)S.

12.2(28)SB

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

12.2(33)SRA

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

12.2(33)SXH

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

12.2(33)SCA

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


Usage Guidelines

The mode selected by the mode command in redundancy configuration mode must be fully supported by the image that has been set into both the active and standby Route Processors (RPs). A high availability image must be installed into the RPs before RPR can be configured. Use the hw-module slot image command to specify a high availability image to run on the standby RP.

For Cisco IOS Release 12.2(33)SCA on the Cisco 10000 series routers and the Cisco uBR10012 universal broadband router, the use of SSO redundancy mode is recommended because RPR+ redundancy mode is being removed. If you enable RPR+ redundancy mode, you may see the following message:

*********************************************************
* Warning, The redundancy mode RPR+ is being deprecated *
* and will be removed in future releases. Please change *
* mode to SSO:                                          *
*     redundancy                                        *
*        mode sso                                       *
********************************************************

Examples

The following example configures RPR+ redundancy mode on a Cisco 12000 series or Cisco 1000 series router:

Router# mode rpr-plus

The following example sets the mode to HSA on a Cisco 7500 series router:

Router# mode hsa

Related Commands

Command
Description

clear redundancy history

Clears the redundancy event history log.

hw-module slot image

Specifies a high availability Cisco IOS image to run on an active or standby Route Processor (RP).

redundancy

Enters redundancy configuration mode.

redundancy force-switchover

Forces the standby Route Processor (RP) to assume the role of the active RP.

show redundancy

Displays current active and standby Performance Routing Engine (PRE) redundancy status.



modular-host subslot

To specify the modular-host line card that will be used for DOCSIS 3.0 downstream or downstream channel bonding operations, use the modular-host subslot command in controller configuration mode. To remove the modular-host line card used for DOCSIS 3.0 downstream or downstream channel bonding operations, use the no form of this command.

modular-host subslot slot/subslot

no modular-host subslot slot/subslot

Syntax Description

slot/subslot

The location of the modular-host line card.


Command Default

No modular-host line card is configured for DOCSIS 3.0 downstream or downstream channel bonding operations.

Command Modes

Controller configuration (config-controller)

Command History

Release
Modification

12.3(21)BC

This command was introduced for the Cisco uBR10012 router.

12.2(33)SCA

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


Usage Guidelines

This command specifies the modular-host line card for DOCSIS 3.0 downstream or downstream channel bonding operations. This applies to the cable interface line card (for example, the Cisco uBR10-MC5X20S-D line card) that is used for these operations. The Wideband SPA itself does not support DOCSIS 3.0 downstream channel bonding operations.

Examples

The following example shows how to configure the modular-host line card for DOCSIS 3.0 downstream channel bonding operations for the Wideband SPA located in slot/subslot/bay 1/0/0:

Router(config)# controller modular-cable 1/0/0 
Router(config-controller)# modular-host subslot 7/0 

Related Commands

Command
Description

annex modulation

Sets the annex and modulation for the Wideband SPA.

cable rf-channel

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

controller modular-cable

Enters controller configuration mode to configure the Wideband SPA controller.

ip-address (controller)

Sets the IP address of the Wideband SPA FPGA.

rf-channel frequency

Sets the frequency for each RF channel.

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

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

rf-channel network delay

Specifies the CIN delay for each RF channel.

rf-channel description

Specifies the description for each RF channel.

rf-channel cable downstream channel-id

Assigns a downstream channel ID to an RF channel.


monitoring-basics

To specify the type of monitoring for subscriber traffic management on a Cisco CMTS router, use the monitoring-basics command in enforce-rule configuration mode. To disable the selected monitoring, use the no form of this command.

monitoring-basics {legacy | peak-offpeak} {docsis10 | docsis11}

no monitoring-basics {legacy | peak-offpeak} {docsis10 | docsis11}

Syntax Description

legacy

Provides only one threshold and one monitoring duration.

peak-offpeak

Allows the selection of two peak durations within a day.

docsis10

Specifies application of the enforce-rule to DOCSIS 1.0 cable modems.

docsis11

Specifies application of the enforce-rule to DOCSIS 1.1 cable modems.


Command Default

The default for this command is legacy and docsis10.

Command Modes

Enforce-rule configuration (enforce-rule)

Command History

Release
Modification

12.3(9a)BC

This command was introduced.

12.2(33)SCA

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


Usage Guidelines

Legacy monitoring (using the legacy keyword) occurs 24 hours a day, with no distinction between peak and offpeak hours. The available monitoring duration is between 10 minutes and 31 days.

Use the peak-offpeak keyword to set up monitoring duration and threshold for first peak, second peak, and offpeak monitoring. Each one can be different. After setting up first peak and second peak durations, the remaining hours are treated as offpeak. Monitoring happens during offpeak hours if the offpeak duration and threshold are defined. Monitoring duration is between 60 minutes and 23 hours.

Examples

The following example shows configuration of peak-offpeak monitoring for DOCSIS 1.1 cable modems:

Router(enforce-rule)# monitoring-basics peak-offpeak docsis11

Related Commands

Command
Description

cable qos enforce-rule

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

debug cable subscriber-monitoring

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

duration

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

peak-time1

Specifies peak and offpeak monitoring times.

qos-profile registered

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

qos-profile enforced

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

service-class (enforce-rule)

Identifies a particular service class for cable modem monitoring in an enforce-rule.

show cable qos enforce-rule

Displays the QoS enforce-rules that are currently defined.

show cable subscriber-usage

Displays subscribers who are violating their registered QoS profiles.


monitoring-duration


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


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

monitoring-duration minutes [sample-rate minutes]

no monitoring-duration

Syntax Description

minutes

Specifies the time (in minutes). The valid range is 10 to 10080, with a default of 360 (6 hours).

sample-rate minutes

(Optional) Rate of sampling, in minutes. The valid range is 1 to 30, with a default value of 15.


Defaults

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

Command Modes

Enforce-rule configuration (enforce-rule)

Command History

Release
Modification

12.2(15)BC1

This command was introduced.

12.2(15)BC2

The minimum sample-rate was reduced to 1 minute. Also, the sample-rate is not allowed to be set to a value greater than the monitoring-duration period. If you attempt to do so, the command is ignored and both parameters remain set to their current values.

12.3(9a)BC

This command was replaced by the duration command.


Usage Guidelines

The sample-rate minutes must be less than or equal to the monitoring-duration minutes period.

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

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


Note The sample-rate interval must be less than or equal to the monitoring-duration period. If you attempt to set the sample-rate interval to a value greater than the monitor-duration period, the command is ignored and the parameters are unchanged.


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.

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 monitoring-duration period that is 20 minutes in length, with a sampling rate of every 10 minutes:

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

The following example shows the error message that is displayed when the sample-rate interval is configured to be greater than the monitoring-duration period. In this situation, the command is ignored and the parameters remain unchanged.

Router# configure terminal 
Router(config)# cable qos enforce-rule residential 
Router(enforce-rule)# monitoring-duration 20 sample-interval 30 

Monitoring duration cannot be less than the Sampling interval -- so the values
would remain unchanged 

Related Commands

Command
Description

activate-rule at-byte-count

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

cable qos enforce-rule

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

enabled (enforce-rule)

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

penalty-period

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

qos-profile enforced

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

qos-profile registered

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

show cable qos enforce-rule

Displays the QoS enforce-rules that are currently defined.

show cable subscriber-usage

Displays subscribers who are violating their registered QoS profiles.


mtu

To adjust the maximum packet size or maximum transmission unit (MTU) size, use the mtu command in interface configuration mode or connect configuration submode. To restore the MTU value to its original default value, use the no form of this command.

mtu bytes

no mtu

Syntax Description

bytes

MTU size, in bytes.


Defaults

Table 23 lists default MTU values according to media type.

Table 23 Default Media MTU Values

Media Type
Default MTU (Bytes)

Ethernet

1500

Serial

1500

Token Ring

4464

ATM

4470

FDDI

4470

HSSI (HSA)

4470


Command Modes

Interface configuration (config-if)
Connect configuration submode (for Frame Relay Layer 2 interworking)

Command History

Release
Modification

10.0

This command was introduced.

12.0(26)S

This command was updated to support connect configuration submode for Frame Relay Layer 2 interworking.

12.2(14)SX

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

12.2(17d)SXB

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

12.2(33)SRA

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

12.4(11)T

This command was integrated into Cisco IOS Release 12.4(11)T.

12.2(33)SCB

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


Usage Guidelines

Each interface has a default maximum packet size or MTU size. This number generally defaults to the largest size possible for that interface type. On serial interfaces, the MTU size varies but cannot be set to a value less than 64 bytes.

Changing the MTU Size

Changing the MTU size is not supported on a loopback interface.

Changing an MTU size on a Cisco 7500 series router results in the recarving of buffers and resetting of all interfaces. The following message is displayed:

%RSP-3-Restart:cbus complex.

You can configure native Gigabit Ethernet ports on the Cisco 7200 series router to a maximum MTU size of 9216 bytes. The MTU values range from 1500 to 9216 bytes.

Protocol-Specific Versions of the mtu Command

Changing the MTU value with the mtu interface configuration command can affect values for the protocol-specific versions of the command (the ip mtu command, for example). If the value specified with the ip mtu interface configuration command is the same as the value specified with the mtu interface configuration command, and you change the value for the mtu interface configuration command, the ip mtu value automatically matches the new mtu interface configuration command value. However, changing the values for the ip mtu configuration commands has no effect on the value for the mtu interface configuration command.

ATM and LANE Interfaces

ATM interfaces are not bound by what is configured on the major interface. By default, the MTU on a subinterface is equal to the default MTU (4490); if a client is configured, the default is 1500. The MTU can be changed on subinterfaces, but it may result in recarving of buffers to accommodate the new maximum MTU on the interface.

Cisco 7600 Valid MTU Values

On the Cisco 7600 platform, valid values are from 64 to 9216 for SVI ports; from 1500 to 9170 for the GE-WAN+ ports; and from 1500 to 9216 for all other ports.

If you enable the jumbo frames, the default is 64 for the SVI ports and 9216 for all the other ports. The jumbo frames are disabled by default.

Cisco uBR10012 Universal Broadband Router

When configuring the interface MTU size on a Gigabit Ethernet SPA on a Cisco uBR10012 router, consider the following guidelines:

The default interface MTU size accommodates a 1500-byte packet, plus 22 additional bytes to cover the following additional overhead:

Layer 2 header—14 bytes

Dot1Q header—4 bytes

CRC—4 bytes

If you are using MPLS, be sure that the mpls mtu command is configured for a value less than or equal to the interface MTU.

If you are using MPLS labels, then you should increase the default interface MTU size to accommodate the number of MPLS labels. Each MPLS label adds 4 bytes of overhead to a packet.


Note For the Gigabit Ethernet SPAs on the Cisco uBR10012 router, the default MTU size is 1500 bytes. When the interface is being used as a Layer 2 port, the maximum configurable MTU is 9000 bytes. The SPA automatically adds an additional 22 bytes to the configured MTU size to accommodate some of the additional overhead.


Examples

The following example specifies an MTU of 1000 bytes:

Router(config)# interface serial 1
Router(config-if)# mtu 1000

Cisco uBR10012 Universal Broadband Router

The following example shows how to specify an MTU size on a Gigabit Ethernet SPA on the Cisco uBR10012 router:

Router# configure terminal 
Router(config)#interface GigabitEthernet3/0/0
Router(config-if)#mtu 1800

Related Commands

Command
Description

encapsulation smds

Enables SMDS service on the desired interface.

ip mtu

Sets the MTU size of IP packets sent on an interface.


negotiation

, use the negotiation command in interface configuration mode. To disable automatic negotiation, use the no negotiation auto command.

negotiation {forced | auto}

no negotiation auto

Syntax Description

forced

Disables flow control and configures the Gigabit Ethernet interface in 1000/full-duplex mode.

This keyword is not supported on the 2-port 10/100/1000 Gigabit Ethernet SPA on the Cisco 7304 router.

auto

Enables the autonegotiation protocol to configure the speed, duplex, and automatic flow control of the Gigabit Ethernet interface. This is the default.


Defaults

auto

Command Modes

Interface configuration (config-if)

Command History

Release
Modification

11.1CC

This command was introduced.

12.0(7)S

The forced keyword was added.

12.0(6)T

The forced keyword was added.

12.1(3a)E

This command was integrated into Cisco IOS Release 12.1E and implemented on the Cisco 7200-I/O-GE+E controller.

12.1(5)T

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

12.2(20)S2

This command was implemented on the 2-port 10/100/1000 Gigabit Ethernet SPA on the Cisco 7304 router. The forced keyword is not supported.

12.2(33)SRA

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

12.2SX

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

12.2(33)SCB

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


Usage Guidelines

The negotiation command is applicable to the Gigabit Ethernet interface of the Cisco 7200-I/O-GE+E and interfaces on the 2-port 10/100/1000 Gigabit Ethernet SPA that are using fiber media. The negotiation auto command is used instead of the duplex and speed commands (which are used on Ethernet and Fast Ethernet interfaces, and interfaces on the 2-port 10/100/1000 Gigabit Ethernet SPA that are using RJ-45 media) to automatically configure the duplex and speed settings of the interfaces.

The negotiation forced command is used to configure the Gigabit Ethernet interface of the Cisco 7200-I/O-GE+E to be 1000/full-duplex only and to disable flow control. The negotiation forced command is not supported by the 2-port 10/100/1000 Gigabit Ethernet SPA.

The Gigabit Ethernet interface of the Cisco 7200-I/O-GE+E and the interfaces on the 2-port 10/100/1000 Gigabit Ethernet SPA that are using fiber media are restricted to 1000 Mbps/full duplex only. Autonegotiation advertises and negotiates only to these values.

Cisco uBR10012 Universal Broadband Router

Autonegotiation is enabled by default and can be disabled on the 5-Port Gigabit Ethernet SPA. During autonegotiation, advertisement for flow control, speed, and duplex occurs. If autonegotiation is disabled on one end of a link, it must be disabled on the other end of the link. If one end of a link has autonegotiation disabled while the other end of the link does not, the link does not come up properly on both ends. Flow control is always negotiated when autonegotiation is enabled.


Note Autonegotiation is not supported on the 1-Port 10-Gigabit Ethernet SPA in Cisco IOS Release 12.2(33)SCB.


Examples

The following example enables the second interface (port 1) on a 2-port 10/100/1000 Gigabit Ethernet SPA for autonegotiation, where the SPA is installed in the bottom subslot (1) of the MSC, and the MSC is installed in slot 2 of the Cisco 7304 router:

Router(config)# interface gigabitethernet 2/1/1
Router(config-if)# media-type gbic
Router(config-if)# negotiation auto

The following example disables the second interface (port 1) on a 2-port 10/100/1000 Gigabit Ethernet SPA for autonegotiation, where the SPA is installed in the bottom subslot (1) of the MSC, and the MSC is installed in slot 2 of the Cisco 7304 router:

Router(config)# interface gigabitethernet 2/1/1
Router(config-if)# no negotiation auto

Related Commands

Command
Description

show interfaces gigabitethernet

Displays information about the Gigabit Ethernet interfaces.


network

To configure the DHCP address pool with the specified network-number and subnet mask, which are the DHCP yiaddr field and Subnet Mask (DHCP option 1) field, use the network command in global configuration mode. To remove this configuration, use the no form of this command.

network network-number [mask]

no network network-number [mask]

Syntax Description

network-number

The DHCP yiaddr field.

mask

Subnet Mask (DHCP option 1). If you do not specify the mask value, it is supported to 255.255.255.255.


Command Default

DHCP settings are not configured by default.

Command Modes

DHCP configuration

Command History

Release
Modification

Release 12.2(4)BC1

Supoported on the Cisco uBR7100 series, Cisco uBR7200 series, and Cisco uBR10012 routers.


Usage Guidelines

This command requires that you first use the dhcp ip dhcp pool name command in global configuration mode to enter DHCP configuration mode.


Note To create an address pool with a single IP address, use the host command instead of network.


For additional information about DHCP support on the Cisco CMTS, refer to the following document on Cisco.com:

DHCP and ToD Servers on the Cisco CMTS

Examples

The following example illustrates use of the network command with the ip dhcp pool name command.

Router# configure terminal

Router(config)# ip dhcp pool name platinum

Router(dhcp-config)# network 10.10.10.0 255.255.0.0

Router(dhcp-config)#


Related Commands

ip dhcp pool name

Creates a DHCP address pool and enters DHCP pool configuration file mode.


nls

To enable Network Layer signaliing (NLS) functionality, use the nls command in global configuration mode. To disable NLS functionality, use the no form of this command.

nls [authentication]

no nls [authentication]

Syntax Description

authentication

(Optional) Enables NLS protocol security authentication.


Command Default

Disabled.

Command Modes

Global configuaration

Command History

Release
Modification

12.3(21a)BC3

This command was introduced.


Usage Guidelines

It is recommended that NLS message authentication is enabled all the time.

Examples

The following example shows nls enabled on a router:

router (config)# nls

Related Commands

Command
Description

cpd

Enables the CPD feature.

nls ag-id auth-key

Configures an Authorization Group Identifier (AG ID) for CMTS.

nls resp-timeout

Configures NLS response timeout.


nls ag-id auth-key

To configure an Authorization Group Identifier (AG ID) for CMTS, use the nls ag-id auth-key command in global configuration mode. To disable the AG ID, use the no form of this command.

nls ag-id auth-key

no nls ag-id auth-key

Syntax Description

ag-id number

Authorization Group Identifier. The valid range is 1-4294967294.

auth-key char

Authentication key provisioned on CMTS. The valid range is 20-64.


Command Default

Disabled

Command Modes

Global configuaration

Command History

Release
Modification

12.3(21a)BC3

This command was introduced.


Examples

The following example shows configuring the AG ID:

Router(config) # nls ag-id 345 auth-key 54

Related Commands

Command
Description

cpd

Enables CPD.

nls

Enables Network Layer signaliing (NLS) functionality.

nls resp-timeout

Configures NLS response timeout.


nls resp-timeout

To configure the NLS response timeout, use the nls resp-timeout command in global configuration mode. To disable CPD, use the no form of this command.

nls resp-timeout timeout number

no nls resp-timeout timeout number

Syntax Description

timeout number

Controls the time CTMS will wait before getting a response for an NLS information request. The valid range is 1-60 seconds. Upon a response timeout, the CPD message is dropped.


Command Default

The default timeout is 1 second.

Command Modes

Global configuration

Command History

Release
Modification

12.3(21a)BC3

This command was introduced.


Examples

The following example shows configuring the NLS response timeout:

Router(config)#nls rssp-timeout 35

Related Commands

Command
Description

cpd

Enables CPD.

nls

Enables Network Layer signalling (NLS) functionality.

nls ag-id auth-key

Configures an Authorization Group Identifier (AG ID) for CMTS.


peak-time1

To specify peak and offpeak monitoring times on a Cisco CMTS router, use the peak-time1 command in enforce-rule configuration mode. To disable configuration of peak monitoring times, use the no form of this command.

peak-time1 hour duration minutes avg-rate rate [peak-time2 hour duration minutes avg-rate rate] [duration offpeak-minutes avg-rate offpeak-rate] sample-interval minutes {downstream | upstream}[enforce]

no peak-time1 hour duration minutes avg-rate rate [peak-time2 hour duration minutes avg-rate rate] [duration offpeak-minutes avg-rate offpeak-rate] sample-interval minutes {downstream | upstream}[enforce]

Syntax Description

hour

Specifies the time of day that monitoring occurs for the peak time. The range is from 0 to 23 using a 24-hour clock.

duration minutes

Specifies the size of the sliding window (in minutes) during which the subscriber usage is monitored for the first peak time, and optionally for a second peak time when used with the peak-time2 keyword. The valid range is 60 to 1440.

avg-rate rate

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

duration offpeak-minutes

(Optional) Specifies the size of the sliding window (in minutes) during which the subscriber usage is monitored for the remaining offpeak time (time not specified for peak monitoring). The valid range is 60 to 1440.

avg-rate offpeak-rate

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

peak-time2

(Optional) Specifies the time of day that monitoring occurs for a second peak time. The range is from 0 to 23 using a 24-hour clock.

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.

downstream

Specifies monitoring of traffic in the downstream direction.

upstream

Specifies monitoring of traffic in the upstream direction.

enforce

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


Command Default

Peak and offpeak monitoring is disabled. The only default value for the peak-time1 command is the 15-minute sample interval.

Command Modes

Enforce-rule configuration (enforce-rule)

Command History

Release
Modification

12.3(9a)BC

This command was introduced.

12.2(33)SCA

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


Usage Guidelines

You can use the peak-time1 command to monitor two peak monitoring periods, using the initial peak-time1 command and its options followed by the peak-time2 keyword and corresponding options. The remaining hours are considered "offpeak" and can be monitored by configuring the optional duration keyword and corresponding options.

When you use the show running-configuration command to display the configuration, the keyword options for the peak-time1 command are truncated. In the following example, "d" represents duration (a single peak and offpeak duration are configured), "avg" represents avg-rate, "sa" represents sample-interval, "do" represents downstream, and "enf" represents enforce:

Router# show running-configuration
.
.
.
peak-time1 1 d 60 avg 2 d 60 avg 40 sa 10 do enf

Examples

The following example shows an enforce-rule that defines two peak monitoring times for upstream traffic:

Router(enforce-rule)# peak-time1 10 duration 120 avg-rate 10 peak-time2 23 duration 60 
avg-rate 10 sample-interval 10 upstream enforce

Related Commands

Command
Description

cable qos enforce-rule

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

debug cable subscriber-monitoring

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

duration

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

monitoring-basics

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

qos-profile enforced

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

qos-profile registered

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

service-class (enforce-rule)

Identifies a particular service class for cable modem monitoring in an enforce-rule.

show cable qos enforce-rule

Displays the QoS enforce-rules that are currently defined.

show cable subscriber-usage

Displays subscribers who are violating their registered QoS profiles.

weekend peak-time1

Configures peak and offpeak subscriber monitoring over weekends on a Cisco CMTS router.


penalty-period

To specify the time period that an enforced quality of service (QoS) profile should be in force for subscribers that violate their registered QoS profile, use the penalty-period command in enforce-rule configuration mode. To reset an enforce-rule to its default penalty period, use the no form of this command.

penalty-period minutes [time-of-day hour]

no penalty-periodminutes [time-of-day hour]

Syntax Description

minutes

Specifies a time period (in minutes) during which a cable modem (CM) can be under penalty. The range is 1 to 10080, with a default value of 10080 (7 days).

time-of-day hour

(Optional) Specifies an override of a time of day (as an hour) when a CM that has been identified as eligible for penalty, can otherwise be released from that penalty period. The range is 1 to 23 using a 24-hour clock.


Command Default

The default time period is 10080 minutes (7 days).

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.3(23)BC2

The time-of-day keyword option was added.

12.2(33)SCB

The time-of-day keyword option was integrated into Cisco IOS Release 12.2(33)SCB.


Usage Guidelines

When a subscriber overconsumes the maximum bandwidth that is specified in the enforce-rule, the Cisco CMTS router can automatically switch the subscriber to an enforced QoS profile for the penalty period specified with the penalty-period command. When the penalty period expires, the Cisco CMTS router restores the subscriber to their registered QoS profile.

The penalty period continues across reboots of the cable modem, so a user cannot avoid the enforced QoS profile by trying to reset their modem and reregister on the cable network. This allows service providers to set an appropriate penalty for those users that consistently exceed the maximum bandwidth they have been allocated.


Note To manually move a cable modem back to its registered profile before the end of the penalty period, use the cable modem qos profile command.


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


Note If a cable modem has multiple service flows, and the cable modem enters the penalty period because one of its service flows has exceeded its allowable bandwidth, monitoring on the other service flows stops until the cable modem exits the penalty period.


Examples

The following example shows an enforce-rule named "test" configured with a penalty period of 1440 minutes (1 day):

Router# configure terminal 
Router(config)# cable qos enforce-rule test 
Router(enforce-rule)# penalty-period 1440 

The following example shows an enforce-rule named "test" configured with a penalty period of 1440 minutes (1 day), but allowing removal of any CMs in penalty at 11:00 P.M.:

Router# configure terminal 
Router(config)# cable qos enforce-rule test 
Router(enforce-rule)# penalty-period 1440 time-of-day 23

Related Commands

Command
Description

activate-rule at-byte-count

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

cable qos enforce-rule

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

duration

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

enabled (enforce-rule)

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

qos-profile enforced

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

qos-profile registered

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

show cable qos enforce-rule

Displays the QoS enforce-rules that are currently defined.

show cable subscriber-usage

Displays subscribers who are violating their registered QoS profiles.


option

To create a DOCSIS configuration file that specifies vendor-specific information fields, or other options that are not available through the other cable config-file commands, use the option command in cable config-file configuration mode. To remove the entry for this option, use the no form of this command.

option n [instance inst-num] {ascii string | hex hexstring | ip ip-address}

no option n

Syntax Description

n

Specifies the configuration file option code. Valid range is 5 to 254.

Note Certain values between 5 and 254 are not allowed. See Table 0-24 for more information.

instance inst-num

(Optional) Specifies the instance of this option, so that you can give the same option multiple times. Valid range is 0 to 255.

ascii string

Specifies that the data is a network verification tool (NVT) ASCII string. If the string contains white space, you must surround it with quotation marks.

hex hexstring

Specifies the data as a raw hexadecimal string. Each byte in the hexadecimal string is two hexadecimal digits—each byte can be separated by a period, colon, or white space. A maximum of 254 bytes can be specified.

Note The hex option must be used to specify the data in the DOCSIS Type/Length/Value (TLV) format when using the vendor-specific option (option 43).

ip ip-address

Specifies an IP address.


Command Default

No default behaviors or values

Command Modes

Cable config-file configuration

Command History

Release
Modification

12.1(2)EC1

This command was introduced.

12.2(4)BC1

Support was added to the Release 12.2 BC train.


Usage Guidelines

The DOCSIS specification provides for a great many options and parameters in the DOCSIS configuration files. In particular, it allows unspecified vendor-specific options that can vary from vendor to vendor and from model to model. To create a DOCSIS configuration file that references these options, use the option command.

The option command allows you to specify configuration file parameters that are not defined by the other cable config-file options. These options are defined in the DOCSIS Radio Frequency (RF) Interface Specification. However, certain options are not allowed because they are either reserved for DOCSIS use or because they are specified using other cable config-file commands.

Table 0-24 lists the options that cannot be specified by the cable config-file option command. Where applicable, the table shows the cable config-file command you can use to specify that option.

Table 0-24 Invalid Option Codes for the cable config-file option Command 

Option
Description
Cable Config-File Command

5, 6, 7, 20

Internal Configuration File Options

N/A

9

Software Upgrade Filename

download

12

Modem IP Address

N/A

13

Service Not Available Response

N/A

17

Baseline Privacy Interface Configuration

privacy

18

Maximum Number of CPE devices

cpe max

19

TFTP Server Timestamp

timestamp

21

Software Upgrade TFTP Server

download



Note For complete information on the other parameters and fields in DOCSIS configuration files, see Appendix C in the DOCSIS 1.1 Radio Frequency (RF) Interface Specification, available on the DOCSIS Cable Labs official web site at http://www.cablemodem.com/


Using Option 43 (Vendor-Specific Information Fields)

The most common use of the cable config-file option command is to specify vendor-specific information field values, which vendors use to implement features that are unique to their products. In this case, the value for n must be 43.When you use the vendor-specific option (option 43), you must specify the data using the hex option.

The hexadecimal data must be presented in the DOCSIS Type/Length/Value (TLV) format, where the first byte specifies the suboption type, the second byte specifies the length of the data, and the remaining bytes specify the data itself. The exact meaning of the suboption type and data values is defined by each vendor.

For example, Cisco CMs support a vendor-specific suboption (128) that instructs the CM to download and execute a Cisco IOS configuration file. The data for this suboption is the fully qualified path name of the Cisco IOS configuration file on the TFTP server. Other vendors, however, could define vendor-specific suboption 128 to have a totally different function.

To ensure that a vendor-specific option is executed only by equipment that supports that option, the vendor ID must always be the first part of the data in an option 43 command. The suboption number for the vendor ID function is 08, and the data is the three byte Organization Unique Identifier (OUI) for that vendor, as issued by the Institute of Electrical and Electronics Engineers (IEEE).

The vendor could have defined a global OUI for all of their equipment, or they could have requested a separate OUI ID for different products or family of products. For example, the global OUI for Cisco equipment is 00 00 0C.


Note Each option 43 command must specify one and only one vendor ID, and the vendor ID must be the first TLV in the hex data string.


Example of Constructing an Option 43 Command

For example, to create a vendor-specific option that downloads a Cisco IOS configuration file, you would create a hexadecimal data string that first contains suboption 8, to specify the vendor ID in TLV format. You would then add the hexadecimal string that contains suboption 128, to specify the filename for the configuration file to be downloaded, in TLV format.

The TLV for the Cisco vendor ID would be 08:03:00:00:0C, where 08 is the suboption type, 03 is the length, and 00:00:0C is the Cisco OUI vendor ID. If the Cisco IOS filename is ios.cfg, the second TLV would be 80:07:69:6F:73:2E:63:66:67, where 80 is the suboption type (128 decimal), 07 is the length of the data, and the data is the filename expressed in hexadecimal ASCII values.

The complete hex data string would be 08:03:00:00:0C:80:07:69:6F:73:2E:63:66:67. The complete command would be option 43 hex 08:03:00:00:0C:80:07:69:6F:73:2E:63:66:67.


Note When using the option 43 command, you must manually calculate the length value for each TLV that you specify in the hex data string. However, you do not have to calculate the length for entire option 43 command, because that is calculated automatically by the CMTS.



Caution Be certain that you have correctly entered the TLV data when using the hex option. Incorrectly entered data could cause CMs to reset, go offline, or hang, requiring a power cycle before being able to continue.

The following example shows how to specify a static downstream frequency for a Cisco uBR905, Cisco uBR924, Cisco uBR925, or Cisco CVA, using the option 43 command to specify Cisco vendor-specific option 1.

router(config)# cable config-file statfreq.cm 
router(config-file)# option 43 hex 08:03:00:00:0C:01:04:05:7F:9F:90
router(config-file)# exit 
router(config)# 

The hexadecimal data shown in this command consists of the two TLVs shown in Table 0-25:

Table 0-25 TLV Values for Sample Option 43 Command 

Type
Length
Value
TLV 1—Vendor ID, Suboption 8

08

03

00:00:0C (the ID for Cisco cable equipment)

TLV2—Static Downstream Frequency, Suboption 1

1

04

05:7F:9F:90 (sets the downstream for the static frequency of 92,250,000 Hz)



Note Both the Cisco vendor-specific option for a static downstream frequency and the frequency command instruct the CM to move to a specific downstream frequency, overriding the frequency the CM found during its initial downstream scanning. However, the vendor-specific option requires the CM to use the specified frequency—if the CM loses its lock on that frequency or can never lock on to that specific frequency, the CM cannot go online. In contrast, the frequency command allows the CM to scan the downstream for the next available frequency if the CM loses its lock on the originally specified frequency.


The following example shows how to configure a Cisco uBR924, Cisco uBR925, or Cisco CVA122 so that it downloads a Cisco IOS configuration file named ios.cfg and configures the router for two voice ports. Three vendor-specific options are included: suboption 8, which specifies the vendor ID, suboption 128, which specifies the configuration file name, and suboption 10, which specifies the number of active voice ports.

router(config)# cable config-file iosfile.cm 
router(config-file)# option 43 hex 08:03:00:00:0C:80:07:69:6F:73:2E:63:66:67:0A:01:02 
router(config-file)# exit 
router(config)# 

The hexadecimal data shown in this command consists of the three TLVs shown in Table 0-26:

Table 0-26 TLV Values for Sample Option 43 Command 

Type
Length
Value
TLV 1—Vendor ID, Suboption 8

08

03

00:00:0C (the ID for Cisco cable equipment)

TLV2—Cisco IOS Configuration File, Suboption 128

80

07

69:6F:73:2E:63:66:67 (ASCII hexadecimal bytes for ios.cfg)

TLV3—Number of Active Voice Ports, Suboption 10

0A

1

02 (two voice ports)


Cisco CMs also support giving a limited number of Cisco IOS configuration mode commands in the DOCSIS configuration file, using vendor-specific suboption 131. The following example shows how to use the option 43 command to specify that the Cisco CM should execute the ip http cable-monitor advance command to enable its onboard Cable Monitor web server.

router(config-file)# option 43 hex 08:03:00:00:0C:83:1D:69:70:20:68:74:74:70:20:63:61:62: 
6C:65:2D:6D:6F:6E:69:74:6F:72:20:61:64:76:61:6E:63:65 
router(config-file)# 

Table 0-27 lists the two TLVs shown in this example:

Table 0-27 TLV Values to Enable the Cisco Cable Monitor 

Type
Length
Value
TLV 1—Vendor ID, Suboption 8

08

03

00:00:0C (the ID for Cisco cable equipment)

TLV2—Cisco IOS Command, Suboption 131

83

1D

69:70:20:68:74:74:70:20:63:61:62:6C:65:2D:6D:6F:6E:69:74:6F:
72:20:61:64:76:61:6E:63:65 (ASCII hexadecimal bytes for ip http cable-monitor advance)


The following example shows the instance keyword being used to give multiple option 43 commands. This example uses the same commands shown in the previous three examples.

router(config-file)# option 43 instance 1 hex 08:03:00:00:0C:01:04:05:7F:9F:90
router(config-file)# option 43 instance 2 hex 08:03:00:00:0C:80:07:69:6F:73:2E:63:66:67: 
0A:01:02 
router(config-file)# option 43 instance 3 hex 
08:03:00:00:0C:83:1D:69:70:20:68:74:74:70:20:63:61:62:6C:65:2D:6D:6F:6E:69:74:6F:72:20:61: 
64:76:61:6E:63:65 
router(config-file)# 

The following example shows an attempt to specify two options that cannot be specified through the DOCSIS configuration file. Option 12 is reserved for the DOCSIS registration process, and Option 9 must be specified using the download command.

router(config-file)# option 12 ip 10.11.12.13 
%Option 12 must not be specified manually
router(config-file)# option 9 ascii newsoftware.file 
%Option 9 must be specified directly (not as raw option) 
router(config-file)# 

Related Commands

Command
Description

cable config-file

Creates a DOCSIS configuration file and enters configuration file mode.

access-denied

Disables access to the network.

channel-id

Specifies upstream channel ID.

cpe max

Specifies CPE information.

download

Specifies download information for the configuration file.

frequency

Specifies downstream frequency.

privacy

Specifies privacy options for baseline privacy images.

service-class

Specifies service class definitions for the configuration file.

snmp manager

Specifies Simple Network Management Protocol (SNMP) options.

timestamp

Enables time-stamp generation.


packetcable

To enable PacketCable operations on the Cisco CMTS, use the packetcable command in global configuration mode. To disable PacketCable operations, use the no form of this command.

packetcable

no packetcable

Syntax Description

This command has no keywords or arguments.

Command Default

PacketCable operation is disabled.

Command Modes

Global Configuration

Command History

Release
Modification

12.2(8)BC2

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

12.2(11)BC1

Support was added for automatically creating a random Element ID when PacketCable operations are enabled.

12.2(15)BC1

Support was added for the Cisco uBR10012 router.


Usage Guidelines

This command enables PacketCable operations on all cable interfaces and takes effect immediately. If you do not need to change any parameters from their default values, this is the only command needed to enable PacketCable operations.

In Cisco IOS Release 12.2(11)BC1 and later releases, this command also automatically creates a random Element ID for the CMTS that is in the range of 0 and 99,999. To ensure that this Element ID is unique across the entire PacketCable domain, you should use the packetcable element-id command.


Note PacketCable operations can be configured together with HCCP N+1 redundancy, but the PacketCable states are not synchronized between the Working and Protect interfaces. If a switchover occurs, existing voice calls continue, but when the user hangs up, PacketCable event messages are not generated because the Protect interface is not aware of the previous call states. However, new voice calls can be made and proceed in the normal fashion.


Channel Width Limitations

The 200,000 Hz channel width cannot be used on upstreams that support PacketCable voice calls, or on any upstreams that use Unsolicited Grant Service (UGS) or UGS with Activity Detection (UGS-AD) service flows. Using this small a channel width with voice and other UGS/UGS-AD service flows results in calls being rejected because of "DSA MULTIPLE ERRORS".

Examples

The following example shows PacketCable operation being enabled:

Router# configure terminal
Router(config)# packetcable 
Router(config)# 

The following example shows PacketCable operation being disabled (default):

Router# configure terminal
Router(config)# no packetcable 
Router(config)# 

Related Commands

Command
Description

clear packetcable gate counter commit

Resets the counters that track the total number of committed gates.

packetcable authorize vanilla-docsis-mta

Allows Unsolicited Grant Service (UGS) service flows without a proper PacketCable gate ID when PacketCable operations are enabled on the Cisco CMTS.

packetcable element-id

Configures the PacketCable Event Message Element ID.

packetcable gate maxcount

Changes the maximum number of PacketCable gate IDs in the gate database on the Cisco CMTS.

packetcable timer

Changes the value of the different PacketCable DQoS timers.

show packetcable gate

Displays information about one or more gates in the gate database.

show packetcable gate counter commit

Displays the total number of committed gates since system reset or since the counter was last cleared.

show packetcable global

Displays the current PacketCable configuration.


packetcable authorize vanilla-docsis-mta

To allow Unsolicited Grant Service (UGS) service flows without a proper PacketCable gate ID when PacketCable operations are enabled on the Cisco CMTS, use the packetcable authorize vanilla-docsis-mta command in global configuration mode. To prevent CMs from requesting non-PacketCable UGS service flows when PacketCable operations are enabled, use the no form of this command.

packetcable authorize vanilla-docsis-mta

no packetcable authorize vanilla-docsis-mta

Syntax Description

This command has no keywords or arguments.

Command Default

Non-PacketCable UGS service flows are not allowed when PacketCable operations are enabled.

Command Modes

Global Configuration

Command History

Release
Modification

12.2(11)BC2

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

12.2(15)BC1

Support was added for the Cisco uBR10012 router.


Usage Guidelines

By default, when PacketCable operations are enabled (using the packetcable ccommand), CMs must follow the PacketCable protocol when requesting UGS service flows. This prevents DOCSIS CMs that do not support PacketCable operations from using DOCSIS-style UGS service flows.

If you have a mixed network that contains both PacketCable and non-PacketCable DOCSIS CMs, you can allow DOCSIS CMs to request UGS service flows by using the packetcable authorize vanilla-docsis-mta command. If, however, your CMTS is providing PacketCable services, use the no packetcable authorize vanilla-docsis-mta command to disable DOCSIS-style service flows. This is the default configuration when PacketCable operations are enabled, and it requires that CMs must provide a validly authorized gate ID before being granted a UGS service flow.

Examples

The following example shows PacketCable operation being enabled, while still allowing DOCSIS-style UGS service flows:

Router# configure terminal
Router(config)# packetcable 
Router(config)# packetcable authorize vanilla-docsis-mta 
Router(config)# 

The show packetcable global command has also been enhanced to display whether non-PacketCable DOCSIS-style UGS service flows are allowed:

Router# show packetcable global 

Packet Cable Global configuration:
Enabled   : Yes
Element ID: 12456 
Max Gates : 1048576
Allow non-PacketCable UGS 
Default Timer value - 
  T0      : 30000 msec
  T1      : 300000 msec
  T2      : 2000 msec
  T5      : 500 msec
Router# 

Related Commands

Command
Description

clear packetcable gate counter commit

Resets the counters that track the total number of committed gates.

packetcable

Enables PacketCable operations on the Cisco CMTS.

packetcable element-id

Configures the PacketCable Event Message Element ID.

packetcable gate maxcount

Changes the maximum number of PacketCable gate IDs in the gate database on the Cisco CMTS.

packetcable timer

Changes the value of the different PacketCable DQoS timers.

show packetcable gate

Displays information about one or more gates in the gate database.

show packetcable gate counter commit

Displays the total number of committed gates since system reset or since the counter was last cleared.

show packetcable global

Displays the current PacketCable configuration.


packetcable element-id

To configure the PacketCable Event Message Element ID on the Cisco CMTS, use the packetcable element-id command in global configuration mode. To reset the counter to its default value, use the no form of this command.

packetcable element-id n

no packetcable element-id

Syntax Description

n

PacketCable Event Message Element ID for the Cisco CMTS. The valid range is 0 through 99999, with a default that is a random number in that range.


Command Default

A random value between 0 and 99,999.

Command Modes

Global Configuration

Command History

Release
Modification

12.2(11)BC1

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

12.2(15)BC1

Support was added for the Cisco uBR10012 router.


Usage Guidelines

The PacketCable Event Message specification (PKT-SP-EM-I03-011221) requires that each trusted PacketCable network element that generates an Event Message MUST identify itself with a static Element ID that is unique across an entire PacketCable domain. This command allows you to configure the CMTS with an Element ID that is unique for your particular network. If you do not manually configure this parameter with the packetcable element-id command, it defaults to a random value between 0 and 99,999 when PacketCable operations is enabled.

The CMTS includes the Element ID in its Event Messages, along with its timezone information. You can display the current value using the show packetcable global command.

Examples

The following example shows the Event Message Element ID for this particular CMTS being set to 12456:

Router# configure terminal
Router(config)# packetcable element-id 12456 
Pktcbl: Configured element ID 12456 
Router(config)# 

Related Commands

Command
Description

packetcable

Enables PacketCable operations on the Cisco CMTS.

packetcable authorize vanilla-docsis-mta

Allows Unsolicited Grant Service (UGS) service flows without a proper PacketCable gate ID when PacketCable operations are enabled on the Cisco CMTS.

packetcable gate maxcount

Changes the maximum number of PacketCable gate IDs in the gate database on the Cisco CMTS.

packetcable timer

Changes the value of the different PacketCable DQoS timers.

show packetcable global

Displays the current PacketCable configuration, including the Element ID.


packetcable gate maxcount

To change the maximum number of PacketCable gate IDs in the gate database on the Cisco CMTS, use the packetcable gate maxcount command in global configuration mode. To reset the counter to its default value, use the no form of this command.

packetcable gate maxcount n

no packetcable gate maxcount

Syntax Description

n

Maximum number of gate IDs to be allocated in the gate database on the CMTS. The valid range is 512 through 2097152, with a default value of 2097152 (8 * 512 * 512), which is sufficient to support 8 cable interface line cards.


Defaults

2097152 gate IDs

Command Modes

Global Configuration

Command History

Release
Modification

12.2(8)BC2

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

12.2(11)BC2

The maximum number of possible gates and the default number of gates were doubled from 1,048,576 to 2,097,152 to accommodate a maximum of eight cable interface line cards (where each cable interface line card can use a maximum of 512*512, or 262,144, gates).

12.2(15)BC1

Support was added for the Cisco uBR10012 router.


Usage Guidelines

This command configures the number of gate IDs that the Cisco CMTS can store in its gate database. Because each PacketCable gate ID typically refers to both an upstream gate and a downstream gate, multiple this number by 2 to get the maximum number of gates that can be created on the CMTS.


Note Each cable interface line card supports a maximum of 512*512 (262,144) PacketCable gates, so ensure that you set the maximum number of gates to accommodate all installed cable interface line cards.


Examples

The following example shows the maximum number of gate IDs being set to 524288, which is sufficient for two cable interface line cards:

Router# configure terminal
Router(config)# packetcable gate maxcount 524288 
Router(config)# 

Related Commands

Command
Description

packetcable

Enables PacketCable operations on the Cisco CMTS.

packetcable authorize vanilla-docsis-mta

Allows Unsolicited Grant Service (UGS) service flows without a proper PacketCable gate ID when PacketCable operations are enabled on the Cisco CMTS.

packetcable element-id

Configures the PacketCable Event Message Element ID.

packetcable timer

Changes the value of the different PacketCable DQoS timers.

show packetcable global

Displays the current PacketCable configuration.


packetcable gate send-subscriberID

To include subscriber identification in GATE-OPEN and GATE-CLOSE gate control messages, use the packetcable gate send-subscriberID command in global configuration mode. To remove subscriber identification information from the gate control messages, use the no form of this command.

packetcable gate send-subscriberID

no packetcable gate send-subscriberID

Syntax Description

This command has no arguments or keywords.

Command Default

No subscriber identification information is provided in the GATE-OPEN and GATE-CLOSE gate control messages.

Command Modes

Global configuration (config)

Command History

Release
Modification

12.3(23)BC1

This command was introduced.

12.2(33)SCB

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


Examples

The following example enables gate control subscriber identification information using the packetcable gate send-subscriberID command:

Router(config)# packetcable gate send-subscriberID

Related Commands

Command
Description

packetcable

Enables PacketCable operation.

show packetcable gate

Displays information about one or more gates in the gate database.

show packetcable global

Displays the current PacketCable configuration.


packetcable timer

To change the value of the different PacketCable Dynamic Quality of Service (DQoS) timers, use the packetcable timer command in global configuration mode. To reset a timer to its default value, use the no form of this command.

packetcable timer {T0 timer-value | T1 timer-value}

no packetcable timer {T0 | T1}

Syntax Description

T0 timer-value

Sets the T0 timer in milliseconds. The valid range is 1 to 1,000,000,000 milliseconds, with a default value of 30000 milliseconds (30 seconds).

T1 timer-value

Sets the T1 timer in milliseconds. The valid range is 1 to 1,000,000,000 milliseconds, with a default value of 200000 milliseconds (200 seconds).


Command Types

T0 has a default value of 30000 milliseconds (30 seconds).

T1 has a default value of 200000 milliseconds (200 seconds).

Command Modes

Global Configuration

Command History

Release
Modification

12.2(8)BC2

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

12.2(11)BC2

The T2 and T5 timers were removed to conform to the requirements of the PacketCable DQoS Engineering Change Notice (ECN) 02148.

12.2(15)BC1

Support was added for the Cisco uBR10012 router.


Usage Guidelines

This command sets the following timers, which are defined in the PacketCable™ Dynamic Quality-of-Service Specification (PKT-SP-DQOS-I03-020116):

T0 specifies the amount of time that a gate ID can remain allocated without any specified gate parameters. The timer begins counting when a gate is allocated with a Gate-Alloc command. The timer stops when a Gate-Set command marks the gate as Authorized. If the timer expires without a Gate-Set command being received, the gate is deleted.

T1 specifies the amount of time that an authorization for a gate can remain valid. It begins counting when the CMTS creates a gate with a Gate-Set command and puts the gate in the Authorized state. The timer stops when the gate is put into the committed state. If the timer expires without the gate being committed, the CMTS must close the gate and release all associated resources.


Note The new timer values apply to all gates that are created after giving the command. Existing gates are not affected.


Examples

The following example shows the T0 timer being set to 20 seconds (20,000 milliseconds):

Router# configure terminal
Router(config)# packetcable timer T0 20000 
Router(config)# 

Related Commands

Command
Description

packetcable

Enables PacketCable operations on the Cisco CMTS.

packetcable authorize vanilla-docsis-mta

Allows Unsolicited Grant Service (UGS) service flows without a proper PacketCable gate ID when PacketCable operations are enabled on the Cisco CMTS.

packetcable element-id

Configures the PacketCable Event Message Element ID.

packetcable gate maxcount

Changes the maximum number of PacketCable gate IDs in the gate database on the Cisco CMTS.

show packetcable global

Displays the current PacketCable configuration.


penalty-period

To specify the time period that an enforced quality of service (QoS) profile should be in force for subscribers that violate their registered QoS profile, use the penalty-period command in enforce-rule configuration mode. To reset an enforce-rule to its default penalty period, use the no form of this command.

penalty-period minutes [time-of-day hour]

no penalty-periodminutes [time-of-day hour]

Syntax Description

minutes

Specifies a time period (in minutes) during which a cable modem (CM) can be under penalty. The range is 1 to 10080, with a default value of 10080 (7 days).

time-of-day hour

(Optional) Specifies an override of a time of day (as an hour) when a CM that has been identified as eligible for penalty, can otherwise be released from that penalty period. The range is 1 to 23 using a 24-hour clock.


Command Default

The default time period is 10080 minutes (7 days).

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.3(23)BC2

The time-of-day keyword option was added.


Usage Guidelines

When a subscriber overconsumes the maximum bandwidth that is specified in the enforce-rule, the Cisco CMTS router can automatically switch the subscriber to an enforced QoS profile for the penalty period specified with the penalty-period command. When the penalty period expires, the Cisco CMTS router restores the subscriber to their registered QoS profile.

The penalty period continues across reboots of the cable modem, so a user cannot avoid the enforced QoS profile by trying to reset their modem and reregister on the cable network. This allows service providers to set an appropriate penalty for those users that consistently exceed the maximum bandwidth they have been allocated.


Note To manually move a cable modem back to its registered profile before the end of the penalty period, use the cable modem qos profile command.


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


Note If a cable modem has multiple service flows, and the cable modem enters the penalty period because one of its service flows has exceeded its allowable bandwidth, monitoring on the other service flows stops until the cable modem exits the penalty period.


Examples

The following example shows an enforce-rule named "test" configured with a penalty period of 1440 minutes (1 day):

Router# configure terminal 
Router(config)# cable qos enforce-rule test 
Router(enforce-rule)# penalty-period 1440 

The following example shows an enforce-rule named "test" configured with a penalty period of 1440 minutes (1 day), but allowing removal of any CMs in penalty at 11:00 P.M.:

Router# configure terminal 
Router(config)# cable qos enforce-rule test 
Router(enforce-rule)# penalty-period 1440 time-of-day 23

Related Commands

Command
Description

activate-rule at-byte-count

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

cable qos enforce-rule

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

duration

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

enabled (enforce-rule)

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

qos-profile enforced

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

qos-profile registered

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

show cable qos enforce-rule

Displays the QoS enforce-rules that are currently defined.

show cable subscriber-usage

Displays subscribers who are violating their registered QoS profiles.


ping docsis

To determine whether a specific cable modem (CM) is reachable from the CMTS at the DOCSIS MAC layer, use the ping docsis command in privileged EXEC mode.

ping docsis {mac-addr | ip-addr | name fqdn} [count] [verbose]

Syntax Description

mac-addr

Specifies the 48-bit hardware (MAC) address of the CM. If you specify the MAC address of a CPE device, the command will resolve it to the MAC address of the CM servicing that CPE device and send the DOCSIS ping to the CM.

ip-addr

Specifies the IPv4 or IPv6 address of the CM. If you specify the IP address of a CPE device, the command will resolve it to the IP address of the CM servicing that CPE device and send the DOCSIS ping to the CM.

name fqdn

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

count

(Optional) Specifies the number of ping packets to be sent.

verbose

(Optional) Specifies verbose mode for the output, giving additional details about the packets transmitted and received.


Defaults

If no count is specified, five DOCSIS ping packets are sent.

Command Modes

Privileged EXEC (#)

Command History

Release
Modification

11.3 NA

This command was introduced for the Cisco uBR7200 series router.

12.0(4)XI1

Support was added for the Cisco uBR924 cable access router.

12.1(3)XL

Support was added for the Cisco uBR905 cable access router.

12.1(5)XU1

Support was added for the Cisco CVA122 Cable Voice Adapter.

12.1(1a)T1

The command output was enhanced.

12.1(3)XQ1

Support was added for wireless radio modems.

12.1(5)EC

Support was added for the Cisco uBR7100 series routers.

12.2(2)XA

Support was added for the Cisco uBR925 cable access router.

12.2(1)XF1

Support was added for the Cisco uBR10012 router.

12.2(4)BC1

This command was integrated into Cisco IOS Release 12.2(4)BC1.

12.2(33)SCA

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

Support for the Cisco uBR7225VXR router was added.

Support for specifying the IPv6 address of a CM or CPE device was added.

The name keyword option was added for specifying the fully-qualified domain name of a CM.


Usage Guidelines

The DOCSIS ping is a unique Cisco patented technology that allows a cable operator to quickly diagnose the health of a channel between the CMTS router and any particular DOCSIS cable CPE device. The DOCSIS ping is similar in concept to the IP ping but uses the lower MAC layer instead of the datalink or transport layers. Using the MAC layer has two major advantages:

A DOCSIS ping uses only 1/64 of the bandwidth of an IP ping.

A DOCSIS ping can be used with CMs that have not yet acquired an IP address. This allows cable operators to "ping" CMs that weren't able to complete registration or that were improperly configured at the IP layer.

In addition to providing connectivity information, the ping docsis command provides a real-time view and plot of requested power adjustments, frequency, timing offset adjustments, and a measure of optimal headend reception power.

If a CM responds to the ping docsis command, but does not respond to an IP ping, the problem could be one of the following:

The CM is still in the registration process and has not yet come completely online. In particular, the CM could be waiting for the DHCP server to assign it an IP address.

Severe interference or other faults on the physical layer (either the upstream or downstream).

Significant upstream signal error, distortion, or amplitude errors, often resulting in frequent power adjustments (which are shown in the cable flap list).

A non-DOCSIS compliant upstream carrier-to-noise power ratio (C/N) that is between 14 and 21 dB, along with a mixed modulation profile, such as ranging request/response messages being sent in QPSK mode and short and long data grants in 16-QAM mode.


Note The ping docsis command is a DOCSIS-compliant process that can be used with any two-way DOCSIS-compliant CM; the CM does not require any special features or code. The ping docsis command cannot be used with telco-return CMs.



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


Table 28 explains the different characters that can appear in the output for the ping docsis command:

Table 28 ping docsis Command Output Characters

Output Character
Description

!

Indicates that a successful response was received from the ping request. This indicates that the CM is reachable from the CMTS and can respond to CMTS requests at the DOCSIS MAC layer.

.

Indicates that a DOCSIS ping request was sent out but that the ping request timed out without receiving a response. This indicates that the CM is having difficulties maintaining DOCSIS MAC layer connectivity to the CMTS.

Note If the ping docsis command displays a number of periods (.) along with exclamation points (!), it strongly indicates the presence of RF noise or physical cable and plant issues that is causing a loss of MAC layer connectivity.

a

Indicates that a response was received but that an adjustment of frequency, power, or timing was also made in the response. This indicates that, although the upstream channel is functional, some sort of problem is forcing power averaging and other misreads of the upstream received power signals.

f

Indicates that the CMTS failed to send the DOCSIS ping request because the CM is offline, and therefore MAC-layer communication is not possible. This indicates that the CM had previously registered with the CMTS, but that at some point it stopped responding to the DOCSIS station maintenance messages and that the CMTS eventually marked the CM as offline. The CM might have lost power or might have been disconnected from the coaxial cable.

Tip Use the show cable modem command with the same MAC or IP address as you used with the ping docsis command to show the current status of this CM.


Note If a CM is already in the flap list, the ping docsis command increments the hit, miss, and power-adjustment fields for it in the cable flap list.


Examples

The following example shows a default ping docsis command that sends five packets to the CM with the MAC address of 00d0.ba77.7595, with a response being received for each:

Router# ping docsis 00d0.ba77.7595 

Queueing 5 MAC-layer station maintenance intervals, timeout is 25 msec:
!!!!!
Success rate is 100 percent (5/5)

Router#

The following example shows the verbose output for the same command:

Router# ping docsis 00d0.ba77.7595 verbose 

Queueing 5 MAC-layer station maintenance intervals, timeout is 25 msec:
Reply from 00d0.ba77.7595: 2 ms, tadj=-1, padj=0.50, fadj=0
Reply from 00d0.ba77.7595: 2 ms, tadj=-1, padj=0.50, fadj=0
Reply from 00d0.ba77.7595: 2 ms, tadj=-1, padj=0.50, fadj=0
Reply from 00d0.ba77.7595: 98 ms, tadj=-1, padj=0.25, fadj=0
Reply from 00d0.ba77.7595: 2 ms, tadj=-1, padj=0.25, fadj=0

Success rate is 100 percent (5/5)

Router#

The following example shows that the CM at 192.168.100.10 is connected to the network and is operational, but that one ping packet was lost and that several power adjustments were made during the ping process:

router# ping docsis 192.168.100.10 

Queueing 100 MAC-layer station maintenance intervals, timeout is 25 msec:
!!!!!a!!!!!!!a!a!!!!!!!!!!!!!!!!!!!!!aa!!!!!!!!!!a!!!a!a!!!aa!!!!!!.!!a!!!a!
a!a!!!!!!!!aa!!!!!!!aa!a
Success rate is 99 percent (99/100)

A CM that displays output such as that above (a higher percentage of successful pings but with a number of power-adjustment readings) is most likely experiencing a problem that is not bad enough to force the modem offline but that should be addressed.

If this problem is consistent for just a small number of CMs on an upstream receiver (such as a fiber node within a combining group), then the problem is likely related to in-home wiring at those modem locations. It could also be due to a cable TV network element that is on the same HFC segment.

If the problem occurs for all CMs on a single fiber node, then changing the upstream frequency or reducing the number of homes passed per combining group might improve conditions. If this does not help the situation, the problem could be due to a faulty cable drop, dirty optical connector on the node, or other physical plant problem.

The ping docsis command cannot be used with a CM that has not yet registered with the CMTS. The following example shows the responses for a CM that has not yet registered with the CMTS.

router# ping docsis 192.168.100.111 
Cable modem with IP address 192.168.100.111 not registered.
Please try using MAC address instead.

router# ping docsis 0123.4567.89ab 
Cable modem with MAC address 0123.4567.89ab not registered.
router#

Related Commands

Command
Description

cable flap-list aging

Specifies the number of days to keep a CM in the flap-list table before aging it out of the table.

cable flap-list insertion-time

Sets the insertion time interval that determines whether a CM is placed in the flap list.

cable flap-list miss-threshold

Specifies miss threshold for recording a flap-list event.

cable flap-list power-adjust threshold

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

cable flap-list size

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

clear cable flap-list

Clears all the entries in the flap-list table.

ping

Outputs one or more IP ping requests to a particular IP address.

show cable flap-list

Displays the current contents of the flap list.


plim qos input map

To configure a priority queue on Gigabit Ethernet SPAs, use the plim qos input map command in interface or subinterface configuration mode. To remove a priority queue, use the no form of this command.

plim qos input map {cos {enable | cos-value queue low-latency} | ip {dscp-based | dscp dscp-value queue low-latency} | ip {precedence-based | precedence precedence-value queue low-latency} | ipv6 tc