-
Cisco IOS CMTS Cable Command Reference
-
Introduction
-
Cable Commands: a through cable-modem
-
Cable Commands: cable a through cable c
-
Cable Commands: cable d
-
Cable Commands: cable e through cable i
-
Cable Commands: cable l
-
Cable Commands: cable m to n
-
Cable Commands: cable p through cable r
-
Cable Commands: cable s
-
Cable Commands: cable t
-
Cable Commands: cable u through cable w
-
Cable Commands: ca through cr
-
Cable Commands: d through h
-
Cable Commands: i through p
-
Cable Commands: q through sg
-
Cable Commands: show a through show cable l
-
Cable Commands: show cable m to show cable u
-
Cable Commands: show ch through show cr
-
Cable Commands: show d through show i
-
Cable Commands: show m through show z
-
Cable Commands: snmp through w
-
Appendix A: Cable Debug Commands
-
Appendix B: Cisco CMTS Router ROM Monitor Commands
-
Feedback
Table Of Contents
ipdr session (global configuration)
license feature evaluation disable
license feature evaluation enable
packetcable authorize vanilla-docsis-mta
packetcable gate send-subscriberID
Cable Commands: i through p
Revised: August 12, 2013, OL-15510-17
New Commands
Modified Commands
init-tech-list
To set the DCC initialization techniques that the CMTS can use to load balancing cable modems, use the init-tech-list command in the config-lb-group configuration mode. To reset the DCC initialization techniques, use the no form of this command.
init-tech-list grouplist [ucc]
no init-tech-list
Syntax Description
grouplist
DCC initialization technique list.
ucc
(Optional) Determines whether Upstream Channel Change (UCC) can be used for modems during dynamic upstream load balancing.
Command Default
No default behavior or values.
Command Modes
DOCSIS load balancing group mode (config-lb-group)
Command History
Examples
The following example shows how to set the DCC initialization techniques on a DOCSIS load balancing group on the CMTS, using the init-tech-list command.
Router# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# cable load-balance docsis-group 1Router(config-lb-group)# init-tech-list 1 uccRouter(config-lb-group)#Related Commands
init-tech-ovr
To set DCC initialization techniques that override the physical upstream channel pair, use the init-tech-ovr command in the config-lb-group configuration mode.
Cisco uBR10012 Router
init-tech-ovr cable slot/subslot/port upstream cable slot/subslot/port upstream
init-tech-list 0-4 [ucc]Cisco uBR7225VXR and Cisco uBR7246VXR Routers
init-tech-ovr cable slot/port upstream cable slot/port upstream init-tech-list 0-4 [ucc]
Syntax Description
Command Default
None
Command Modes
DOCSIS load balancing group mode (config-lb-group)
Command History
Usage Guidelines
The init-tech-list command accepts an upstream that is not added into the load balancing group. The upstream channel pair is invalid until the upstream is added. When the load balancing group is removed, all upstream channel pairs are also removed.
Examples
The following example shows how to set DCC initialization techniques that override the physical upstream channel pair to a DOCSIS load balancing group on the CMTS, using the init-tech-ovr command.
Router# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# cable load-balance docsis-group 1Router(config-lb-group)# init-tech-ovr cable 1/0 1 cable 1/1 2 1Related Commands
interface cable
To configure a cable interface, use the interface cable command in global configuration mode.
interface cable {slot/port | slot/subslot/port}
Cisco IOS Release 12.2(33)SCE and later
interface cable {slot/cable-interface-index | slot/subslot/cable-interface-index}
Syntax Description
Command Default
None
Command Modes
Global configuration (config)
Command History
Examples
The following example shows how to configure a cable interface in slot 5, and port 0 on a Cisco uBR7246VXR or Cisco uBR7225VXR router:
Router# configure terminalRouter(config)# interface cable 5/0The following example shows how to configure a cable interface in slot 8, subslot 0, and port 0 on a Cisco uBR10012 router:
Router# configure terminalRouter(config)# interface cable 8/0/0The following example shows how to configure a Cisco uBR-MC3GX60V cable interface line card in slot 5, subslot 0, and cable interface index 13 (MAC domain index) on a Cisco uBR10012 router:
Router# configure terminalRouter(config)# interface cable 5/0/13Related Commands
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
Command Default
Disabled
Command Modes
Global configuration
Command History
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 0Router(config-if)# cable-modem ?compliant Enter compliant modes for interfacedownstream Downstream channel characteristicsfast-search Enable/disable the DS fast searchupstream upstream channel characteristicsvoip Options for Voice over IP traffic over the cable interfaceRouter(config-if)#Related Commands
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 integrated-cable
To configure integrated cable interface, use the interface integrated-cable command in global configuration mode.
Cisco uBR10012 Universal Broadband Router
interface integrated-cable slot/subslot/port:rf-channel
Cisco uBR7225VXR and Cisco uBR7246VXR Universal Broadband Router
interface integrated-cable slot/port:rf-channel
Syntax Description
Command Default
None
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The interface integrated-cable command is supported only on Cisco uBR-MC88V and Cisco UBR-MC20X20V line cards.
Examples
The following example shows how to configure a integrated cable interface in slot 7, subslot 0, and port 0 on a Cisco UBR-MC20X20V cable interface line card:
Router# configure terminalRouter(config)# interface integrated-cable 7/0/0:1Associated FeaturesThe interface integrated-cable command is used to configure the following:
•
Configuring the Cisco UBR-MC20X20V Cable Interface Line Card
•
Related Commands
show interface integrated-cable
Displays the current configuration and status for an integrated channel.
interface modular-cable
To configure a modular cable interface, use the interface modular-cable command in global configuration mode.
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
Cisco IOS Release 12.2(33)SCB
interface modular-cable slot/bay/port:nb-channel-number
Cisco IOS Release 12.2(33)SCE
interface modular-cable slot/{subslot | bay}/port:interface-number
Syntax Description
Command Default
None
Command Modes
Global configuration (config)
Command History
Examples
The following example shows how to configure a modular cable interface in slot 1, bay 3, and channel 23 on a Cisco uBR10012 router:
Router# configure terminalRouter(config)# interface modular-cable 1/3/0:23The following example shows how to configure a modular cable interface in slot 5, subslot 1, and port 2 on a Cisco uBR-MC3GX60V cable line card.
Router# configure terminalRouter(config)# interface modular-cable 5/1/2:0Related Commands
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
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:
•
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 1Related Commands
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
Command Default
Disabled
Command Modes
Global configuration
Command History
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
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.
Cisco uBR10012 Universal Broadband Router
Cisco IOS Releases 12.3(21)BC, 12.3(23)BC, and 12.2(33)SCA
interface wideband-cable slot/subslot/bay:wideband-channel
Cisco IOS Release 12.2(33)SCB
interface wideband-cable slot/bay/port:wideband-channel
Cisco IOS Release 12.2(33)SCC
interface wideband-cable slot/{subslot | bay}/port:wideband-channel
Cisco uBR7225VXR and Cisco uBR7246VXR Universal Broadband Routers
Cisco IOS Release 12.2(33)SCD
interface wideband-cable slot/port:wideband-channel
Syntax Description
Command Default
None
Command Modes
Global configuration (config)
Command History
Examples
The following example shows how to configure a wideband cable interface in slot 1, bay 3, and port 0 on a Cisco uBR10012 router:
Router# configure terminalRouter(config)# interface wideband-cable 1/3/0:0The following example shows how to configure a wideband cable interface in slot 5, subslot 1, and port 2 on a Cisco uBR-MC3GX60V cable line card.
Router# configure terminalRouter(config)# interface wideband-cable 5/1/2:0The following example shows how to configure a wideband cable interface in slot 1, and port 0 on a Cisco uBR7225VXR or Cisco uBR7246VXR router:
Router# configure terminalRouter(config)# interface wideband-cable 1/0:0Related Commands
interval
To set the duration of time the CMTS waits before checking the load on an interface, use the interval command in the load balancing group configuration mode. To reset the duration of time, use the no form of this command.
interval seconds
no interval
Syntax Description
Command Default
None
Command Modes
Load balancing group configuration (config-lb-group)
Command History
12.2(33)SCC
This command was introduced.
12.2(33)SCE1
This command was modified. The default value for this command was changed from 10 seconds to 30 seconds.
Examples
The following example shows how to set the duration of time that the CMTS waits before checking the load on the interface, using the interval command.
Router# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# cable load-balance docsis-group 1Router(config-lb-group)# interval 50Router(config-lb-group)#Related Commands
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
Command Default
No IP address is set for the Wideband SPA FPGA.
Command Modes
Controller configuration (config-controller)
Command History
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/0Router(config-controller)# ip-address 192.168.200.6Related Commands
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
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
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 0Router(config-if)# ip address docsisRouter(config-if)# exitRouter(config)#Related Commands
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
Command Default
For url-ip-address, 192.168.100.1
For url-mask, 255.255.255.0
Command Modes
Global configuration
Command History
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:
•
•
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
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
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 advanceRouter(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-monitorRouter(config)#Related Commands
Note
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
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
Examples
The following example shows how to enable the Cisco Easy VPN Remote web server interface:
Router# configure terminalRouter(config)# ip http serverRouter(config)# ip http ezvpnRouter(config)# exitRouter# copy running-config startup-configRelated Commands
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
Command Default
No IP address is set for the Wideband SPA FPGA.
Command Modes
Controller configuration (config-controller)
Command History
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/0Router(config-controller)# ip-address 192.168.200.6Related Commands
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
Command Default
An association with the session will not be created.
Command Modes
Global configuration mode
Command History
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
Examples
The following example configures a Collector.
Router# configure terminalRouter(config)#ipdr associate 1 federal 1Related Commands
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
Command Default
A Collector will not be configured.
Command Modes
Global configuration mode
Command History
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 terminalRouter(config)#ipdr collector federal 192.0.2.0Related Commands
ipdr exporter ack-timeout
To set IPDR Exporter acknowledged records timeout value, use the ipdr exporter ack-timeout command in global configuration mode. To disable the acknowledged records timeout value, use the no form of this command.
ipdr exporter ack-timeout time_interval
no ipdr exporter ack-timeout
Syntax Description
time_interval
Acknowledged records timeout count. The valid range is from 5 to 60 seconds. The default value is 60.
Command Default
This command is enabled when the IPDR Exporter is running.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
This command allows you to set acknowledged records timeout value for a session.
Note
Examples
The following example shows how to configure the acknowledged records timeout value on the Cisco CMTS router:
Router# configure terminalRouter(config)# ipdr exporter ack-timeout 60Router(config)# ipdr exporter startRelated Commands
show ipdr exporter
Displays information about the IPDR Exporter state on the Cisco CMTS router.
ipdr exporter keepalive
To set the keepalive timer value on the IPDR exporter, use the ipdr exporter keepalive command in global configuration mode. To disable the keepalive timer value, use the no form of this command.
ipdr exporter keeepalive time_interval
no ipdr exporter keepalive
Syntax Description
time_interval
Keepalive timer count. The valid range is from 5 to 300 seconds. The default value is 300.
Command Default
This command is enabled when the IPDR Exporter is running.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
This command allows you to set the keeplive timeout value for a session.
Note
Examples
The following example shows how to configure the keepalive value on the Cisco CMTS router:
Router# configure terminalRouter(config)# ipdr exporter keepalive 300Router(config)# ipdr exporter startRelated Commands
show ipdr exporter
Displays information about the IPDR Exporter state on the Cisco CMTS.
ipdr exporter max-unacked
To set the maximum number of unacknowledged records on the IPDR exporter, on the Cisco CMTS, use the ipdr exporter max unacked command in global configuration mode. To reset the maximum number of unacknowledged records, use the no form of this command.
ipdr exporter max-unacked records
no ipdr exporter max-unacked
Syntax Description
records
Number of unacknowledged records. The valid range is from 5 to 200 records. The default value is 200.
Command Default
This command is enabled when IPDR Exporter is running.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
This command allows you to set the maximum number of unacknowledged records for a session.
Note
Examples
The following example shows how to configure the number of unacknowledged records configured on the Cisco CMTS router:
Router# configure terminalRouter(config)# ipdr exporter max-unacked 200Router(config)# ipdr exporter startRelated Commands
show ipdr exporter
Displays information about the IPDR Exporter state on the Cisco CMTS router.
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
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 terminalRouter(config)#ipdr exporter startRelated Commands
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
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
Examples
The following example enables the user to start a session.
Router# configure terminalRouter(config)#ipdr session 1 startRelated Commands
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
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
Examples
The following example adds a session to the Exporter.
Router# configure terminalRouter(config)#ipdr session 1 test no_descrRelated Commands
ipdr template
To add an Internet Protocol Detail Record (IPDR) template to the IPDR session on the Cisco CMTS, 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
Command Default
The IPDR template is not added to the IPDR session.
Command Modes
Global configuration (config)
Command History
12.2(33)SCB
This command was introduced.
12.2(33)SCG
A new template SERVICE-FLOW is added to the event-based and ad-hoc session types.
Usage Guidelines
This command allows the user to add an IPDR template to the desired session (based on session ID,) on the Cisco CMTS.
Note
Examples
The following example displays the show running-config command output of the configured IPDR sessions and types:
Router(config)# do show running-config | i ipdripdr session 1 test testipdr session 2 event2 event2ipdr session 3 ad-hoc3 ad-hoc3ipdr type 1 time-interval 15ipdr type 2 eventipdr type 3 eventThe following example shows the templates available in a timer-interval session.
Router# ipdr template 1 ?CM-STATUS DOCSIS-CMTS-CM-REG-STATUS-TYPE templateCM-US DOCSIS-CMTS-CM-US-STATS-TYPE templateDIAGLOG-DETAIL DOCSIS-DIAG-LOG-DETAIL-TYPE templateSAMIS-TYPE1 DOCSIS-SAMIS-TYPE-1 templateSAMIS-TYPE2 DOCSIS-SAMIS-TYPE-2 templateSPECTRUM DOCSIS-SPECTRUM-MEASUREMENT-TYPE templateTEST Template for testThe following example shows how to add the SAMIS_TYPE1 template in a timer-interval session.
Router(config)# ipdr template 1 SAMIS-TYPE1The following example shows how to view the templates available in an event-based session.
Router(config)# ipdr template 2 ?CM-STATUS DOCSIS-CMTS-CM-REG-STATUS-TYPE templateCPE-TYPE DOCSIS-CPE-TYPE templateDIAGLOG-DETAIL DOCSIS-DIAG-LOG-DETAIL-TYPE templateDIAGLOG-EVENT DOCSIS-DIAG-LOG-EVENT-TYPE templateDS-UTIL DOCSIS-CMTS-DS-UTIL-STATS-TYPE templateSAMIS OSSI2.0 SAMIS templateSERVICE-FLOW SERVICE-FLOW-TYPE templateTEST Template for testTOPOLOGY DOCSIS-CMTS-TOPOLOGY-TYPE templateUS-UTIL DOCSIS-CMTS-US-UTIL-STATS-TYPE templateThe following example shows how to view the templates available in an ad-hoc session.
Router(config)# ipdr template 3 ?CM-STATUS DOCSIS-CMTS-CM-REG-STATUS-TYPE templateCPE-TYPE DOCSIS-CPE-TYPE templateDIAGLOG-DETAIL DOCSIS-DIAG-LOG-DETAIL-TYPE templateDIAGLOG-EVENT DOCSIS-DIAG-LOG-EVENT-TYPE templateDS-UTIL DOCSIS-CMTS-DS-UTIL-STATS-TYPE templateSAMIS OSSI2.0 SAMIS templateSERVICE-FLOW SERVICE-FLOW-TYPE templateTEST Template for testTOPOLOGY DOCSIS-CMTS-TOPOLOGY-TYPE templateUS-UTIL DOCSIS-CMTS-US-UTIL-STATS-TYPE templateRelated Commands
ipdr type
To configure the IPDR session type, use the ipdr type command in global configuration mode. The IPDR session types that can be defined using this command are event type, time-interval type, and the ad hoc type.
Use the no form of the command to reset the session type to the default "event" type.
ipdr type session_id [ad-hoc | event | time-interval value]
no ipdr type session_id
Syntax Description
Command Default
The IPDR session type is not defined.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
This command allows the user to define the specific IPDR session type.
Note
Examples
The following example shows how to configure the IPDR "time-interval" session type for a time interval of 15 minutes.
Router> enableRouter# configure terminalRouter(config)# ipdr type 1 time-interval 15Related Commands
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
issu linecard abortversion all | lc_slot[/subslot] [forced]
Syntax Description
Command Default
No default behavior or values.
Command Modes
Privileged EXEC mode
Command History
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 following example aborts the specific redundant line card's image version.
Router# configure terminalRouter(config)#issu linecard abortversionRelated Commands
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
Command Default
No default behavior or values.
Command Modes
Privileged EXEC mode
Command History
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 terminalRouter(config)#issu linecard acceptversion 7/0Related Commands
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
Command Default
No default behavior or values.
Command Modes
Privileged EXEC mode
Command History
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 terminalRouter(config)#issu linecard changeversion allThe following example displays the command and uses the slot value of 6.
Router# configure terminalRouter(config)#issu linecard changeversion 6/0Related Commands
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
Command Default
No default behavior or values.
Command Modes
Privileged EXEC mode
Command History
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 terminalRouter(config)#issu linecard loadversion 7/0Related Commands
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
Command Default
No default behavior or values.
Command Modes
Privileged EXEC mode
Command History
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 terminalRouter(config)#issu linecard prepareversion 7/0Related Commands
issu linecard process stop
To stop the automatic line card ISSU process, use the issu linecard process stop command in privileged EXEC mode mode.
issu lineccard process stop
Syntax Description
This command has no arguments or keywords.
Command Default
This command is enabled by default.
Command Modes
Privileged EXEC mode
Command History
Usage Guidelines
Use the issu linecard process stop command to interrupt the automatic ISSU process continuing to the next line card.
Starting Cisco IOS Release 12,2(33)SCG and later, issu linecard process stop is no longer supported on the Cisco CMTS router.
Associated FeaturesThe issu linecard process stop command is associated with following features:
•
Examples
The following example shows how to stop the ISSU process:
Router> enableRouter# issu linecard process stopRelated Commands
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
Command Default
No default behavior or values.
Command Modes
Privileged EXEC mode
Command History
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.
•
•
Examples
The following example shows the command executed with the original keyword.
Router# configure terminalRouter(config)#issu linecard reloadversion original 8/0The following example shows the command executed with the target keyword.
Router# configure terminalRouter(config)#issu linecard reloadversion target 8/0Related Commands
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
Command Default
No default behavior or values.
Command Modes
Privileged EXEC mode
Command History
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 terminalRouter(config)#issu linecard runversion 7/0Related Commands
license feature evaluation disable
To disable an evaluation license for Cisco uBR-MC3GX60V and Cisco UBR-MC20X20V cable interface line cards on the Cisco uBR10012 router, use the license feature evaluation disable command in global configuration mode.
license feature evaluation disable {DS_License | US_License | all} subslot slot/subslot
Syntax Description
Command Default
A cable interface line card evaluation license is disabled by default.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
Evaluation licenses are temporary and used to evaluate a feature set on a new line card. Ensure that an equivalent permanent license is installed on the Cisco CMTS before the evaluation license expires to avoid any service disruptions.
To obtain evaluation licenses from the Cisco licensing portal, go to: https://tools.cisco.com/SWIFT/Licensing/PrivateRegistrationServlet?DemoKeys=Y
Examples
The following example shows how to disable both downstream and upstream evaluation licenses for a cable interface line card on the Cisco uBR10012 router:
Router# configure terminalRouter(config)# license feature evaluation disable all subslot 5/0The following example shows how to disable a downstream evaluation license for a cable interface line card on the Cisco uBR10012 router:
Router# configure terminalRouter(config)# license feature evaluation disable DS_License subslot 6/0The following example shows how to disable an upstream evaluation license for a cable interface line card on the Cisco uBR10012 router:
Router# configure terminalRouter(config)# license feature evaluation disable US_License subslot 6/1Related Commands
license feature evaluation enable
Enables an evaluation license for Cisco uBR-MC3GX60V and Cisco UBR-MC20X20V cable interface line cards.
license feature evaluation enable
To enable an evaluation license for Cisco uBR-MC3GX60V and Cisco UBR-MC20X20V cable interface line cards on the Cisco uBR10012 router, use the license feature evaluation enable command in global configuration mode.
license feature evaluation enable {DS_License | US_License | all} subslot slot/subslot
Syntax Description
Command Default
A cable interface line card evaluation license is not enabled by default.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
Evaluation licenses are temporary and used to evaluate a feature set on a new cable interface line card. Ensure that an equivalent permanent license is installed on the Cisco CMTS router before the evaluation license expires to avoid any service disruptions.
To obtain evaluation licenses from the Cisco licensing portal, go to: https://tools.cisco.com/SWIFT/Licensing/PrivateRegistrationServlet?DemoKeys=Y
Examples
The following example shows how to enable both downstream and upstream evaluation licenses for a cable interface line card on the Cisco uBR10012 router:
Router# configure terminalRouter(config)# license feature evaluation enable all subslot 5/0The following example shows how to enable a downstream evaluation license for a cable interface line card on the Cisco uBR10012 router:
Router# configure terminalRouter(config)# license feature evaluation enable DS_License subslot 6/0The following example shows how to enable an upstream evaluation license for a cable interface line card on the Cisco uBR10012 router:
Router# configure terminalRouter(config)# license feature evaluation enable US_License subslot 6/1Related Commands
license feature evaluation disable
Disables an evaluation license for Cisco uBR-MC3GX60V and Cisco UBR-MC20X20V cable interface line cards.
logging cmts sea
To enable the logging of syslog messages to System Event Archive (SEA), use the logging cmts sea command from global configuration mode. To disable logging of syslog messages to SEA, use the no form of the command.
logging cmts sea [syslog-level [level]]
no logging cmts sea
Syntax Description
Command Default
By default, storing of syslog messages to SEA log file is enabled, with the severity-level of syslog messages being set to `notification'.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
Use the logging cmts sea command is used to enable the logging of syslog messages to SEA log file. To change the severity-level of syslog messages inclusive of and above the level to be stored in SEA log file, specify the command logging cmts sea [syslog-level level].
Examples
The following example shows how to enable logging of syslog messages to SEA log file on the Cisco uBR10012 router:
Router(config)# logging cmts seaThe following example shows how to disable logging of syslog messages to SEA log file on the Cisco uBR10012 router:
Router(config)# no logging cmts seaThe following example shows how to change the severity-level of syslog messages inclusive of and above the level being stored in the SEA log file:
Router(config)# logging cmts sea syslog-level warningRelated Commands
clear logging system
Clears the event records stored in the SEA.
copy logging system
Copies the archived system events to another location.
logging system
Enables or disables the SEA logging system.
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
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 0mac-address 5000.5axx.xxxxThe 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
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
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 tRouter(config)# redundancyRouter(config-r)# main-cpuRouter(config-r-mc)# ?Main Cpu redundancy configuration commands:auto-sync Sync elementsexit Exit from main-cpu configuration modeno Negate a command or set its defaultsswitchover Configuration of switchoverRouter(config-r-mc)#Related Commands
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
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
Examples
The following example shows how to disable the automatic PRE1 module synchronization on the Cisco uBR10012 router and enter maintenance mode:
Router# config tRouter(config)# redundancyRouter(config-r)# maintenance-modeRouter(config-r)# exitRouter(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 tRouter(config)# redundancyRouter(config-r)# no maintenance-modeRouter(config-r)# exitRouter(config)#Related Commands
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
Command Default
Cable multicast authorization is disabled.
Command Modes
Interface configuration—cable interface only (config-mauth)
Command History
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 rule1Related Commands
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}
Cisco uBR10012 Universal Broadband Routers
member subslot slot/subslot {protect [config slot/subslot | rf-power [rf-connector rfconnector-value] {hccp-delta diff-pwr | hccp-override override-pwr}] | working [rfsw-slot slot-value] | revertive | reverttime value}
no member subslot slot/subslot {protect [config slot/subslot | rf-power [rf-connector rfconnector-value] {hccp-delta diff-pwr | hccp-override override-pwr}] | working [rfsw-slot slot-value] | revertive | reverttime value}
Syntax Description
Command Default
None
Command Modes
Line card redundancy group
Command History
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.
Note
Examples
The following example shows how to create a 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 terminalRouter(config)# redundancyRouter(config-red)# linecard-group 1 y-cableRouter(config-red-lc)# member subslot 2/1 primaryRouter(config-red-lc)# member subslot 2/0 secondary
Note
The following example shows how to configure a protect interface to add 3 dBmV to the current working RF power level when a switchover occurs:
Router# configure terminalRouter(config)# redundancyRouter(config-red)# linecard-group 1 cableRouter(config-red-lc)# member subslot 5/1 protect rf-power hccp-delta 3The following example shows how to configure a protect interface to use an RF power level of 48 dBmV instead of the current working RF power level when a switchover occurs:
Router# configure terminalRouter(config)# redundancyRouter(config-red)# linecard-group 1 cableRouter(config-red-lc)# member subslot 5/1 protect rf-power hccp-override 48The following example shows how to configure a rf-connector 3 on a protect interface to add 5 dBmV to the current working RF power level when a switchover occurs:
Router# configure terminalRouter(config)# redundancyRouter(config-red)# linecard-group 1 cableRouter(config-red-lc)# member subslot 5/1 protect rf-power rf-connector 3 hccp-delta 5Related Commands
method
To select the method the CMTS uses to determine the load, use the method command in the config-lb-group configuration mode. To reset the method, use the no form of this command.
method {modems | service-flows | utilization} {us-method {modems | service-flows | utilization}
no method
Syntax Description
Command Default
No default behavior or values.
Command Modes
DOCSIS load balancing group mode (config-lb-group)
Command History
Usage Guidelines
The upstream channel uses the same method as the downstream channel. Change the method of the upstream channel using the method command.
Examples
The following example shows how to select the method the CMTS uses to determine the load, using the method command.
Router# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# cable load-balance docsis-group 1Router(config-lb-group)# method modems us-method service-flowsRouter(config-lb-group)#Related Commands
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
Command Default
No default behavior or values
Command Modes
Global configuration
Command History
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
Examples
The following example shows how to reload the microcode on all PRE processors and line cards that support downloadable microcode:
Router# configure terminalRouter(config)# microcode reloadReload microcode? [confirm] yes00: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 terminalRouter(config)# microcode pxf flash:pxf/ubr10k-ucode.122.1.2.3Reload microcode? [confirm] yes1d04h: 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
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
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
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
Examples
The following example shows how to reload the microcode on all PRE processors and line cards that support downloadable microcode:
Router# microcode reload allReload microcode? [confirm] yes00: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 microcodedisk0: location of microcodedisk1: location of microcodeflash: location of microcodeftp: location of microcodenull: location of microcodenvram: location of microcodercp: location of microcodescp: location of microcodesec-bootflash: location of microcodesec-disk0: location of microcodesec-disk1: location of microcodesec-nvram: location of microcodesec-slot0: location of microcodesec-slot1: location of microcodeslot0: location of microcodeslot1: location of microcodesystem: location of microcodetftp: 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.4Reload microcode? [confirm] yes3d00h: 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
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
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
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-plusThe following example sets the mode to HSA on a Cisco 7500 series router:
Router# mode hsaRelated Commands
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
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
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.
Note
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/0Router(config-controller)# modular-host subslot 7/0Related Commands
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
Command Default
The default for this command is legacy and docsis10.
Command Modes
Enforce-rule configuration (enforce-rule)
Command History
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 docsis11Related Commands
monitoring-duration
Note
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
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
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
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 terminalRouter(config)# cable qos enforce-rule residentialRouter(enforce-rule)# monitoring-duration 20 sample-interval 10The 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 terminalRouter(config)# cable qos enforce-rule residentialRouter(enforce-rule)# monitoring-duration 20 sample-interval 30Monitoring duration cannot be less than the Sampling interval -- so the valueswould remain unchangedRelated Commands
name
To specify the name of the CMTS tag, use the name command in the cmts-tag configuration mode. To remove the name, use the no form of this command.
name tag-name
no name tag-name
Syntax Description
tag-name
Name of the CMTS tag. The configured name is added to the DOCSIS load balancing group and policies.
Command Default
No default behavior or values.
Command Modes
CMTS tag mode (cmts-tag)
Command History
Examples
The following example shows how to give name to a CMTS tag using the name command:
Router# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# cable tag 1Router(cmts-tag)# name ciscoRelated Commands
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 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
For additional information about DHCP support on the Cisco CMTS, refer to the following document on Cisco.com:
•
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
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
Command Default
Disabled.
Command Modes
Global configuaration
Command History
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)# nlsRelated Commands
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
Examples
The following example shows configuring the AG ID:
Router(config) # nls ag-id 345 auth-key 54Related Commands
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
Examples
The following example shows configuring the NLS response timeout:
Router(config)#nls rssp-timeout 35Related Commands
cpd
Enables CPD.
nls
Enables Network Layer signalling (NLS) functionality.
nls ag-id auth-key
Configures an Authorization Group Identifier (AG ID) for CMTS.
oui
To configure the Organizational Unique Identifier (OUI) of the CM for the CMTS tag, use the oui command in the cmts-tag configuration mode. To remove the configured OUI from the CMTS tag, use the no form of this command.
[exclude] oui oui-of-CM
no oui oui-of-CM
Syntax Description
exclude
(Optional) Configures the tag to exclude the specified OUI.
oui-of-CM
MAC address prefix of the vendor.
Command Default
No default behavior or values.
Command Modes
CMTS tag mode (cmts-tag)
Command History
Examples
The following example shows how to configure the OUI for the CMTS tag using the oui command:
Router# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# cable tag 1Router(cmts-tag)# oui 00.1a.c3Related Commands
output-rate
Note
To specify a custom-defined output line rate to a WAN interface instead of the default output line rate, use the output-rate command in interface configuration mode. Use the no form of this command to use the default output line rate.
output-rate rate
no output-rate
Syntax Description
rate
Output rate to the WAN interface, in kilobits per second. Valid values range from 1 to 1,000,000.
Command Default
Gigabit Ethernet output line rate is 1,000,000 kbps.
Command Modes
Interface configuration (config-if)
Command History
12.2(33)SCC
This command was introduced.
12.2(33)SCG
Support for this command was removed for the Cisco uBR10012 router.
Usage Guidelines
This command specifies a custom-defined output line rate for the WAN interface.
Starting with Cisco IOS Release 12.2(33)SCG, the output-rate command is not supported and the value 10,000 is used for the output line rate on a Cisco uBR10012 router.
Examples
The following example shows how to specify a custom-defined output line rate for the WAN interface:
Router# configure terminalRouter(config)# interface gigabitethernet 1/0/0Router(config-if)# output-rate 100Related Commands
override
To override the Type/Length/Value (TLV) or SNMP when assigning a restricted load balancing group (RLBG) to CM, use the override command in the cmts-tag configuration mode. To reenable the TLV or SNMP when assigning a RLBG to CM, use the no form of this command.
override
no override
Command Default
TLV or SNMP are effective when assigning a RLBG to CM.
Command Modes
CMTS tag mode (cmts-tag)
Command History
Examples
The following example shows how to override the TLV or SNMP when assigning a RLBG using the override command:
Router# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# cable tag 1Router(cmts-tag)# overrideRelated Commands
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
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
ip ip-address
Specifies an IP address.
Command Default
No default behaviors or values
Command Modes
Cable config-file configuration
Command History
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-30 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.
Note
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
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
Caution
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.cmrouter(config-file)# option 43 hex 08:03:00:00:0C:01:04:05:7F:9F:90router(config-file)# exitrouter(config)#The hexadecimal data shown in this command consists of the two TLVs shown in Table 0-31:
Note
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.cmrouter(config-file)# option 43 hex 08:03:00:00:0C:80:07:69:6F:73:2E:63:66:67:0A:01:02router(config-file)# exitrouter(config)#The hexadecimal data shown in this command consists of the three TLVs shown in Table 0-32:
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:65router(config-file)#Table 0-33 lists the two TLVs shown in this example:
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:90router(config-file)# option 43 instance 2 hex 08:03:00:00:0C:80:07:69:6F:73:2E:63:66:67: 0A:01:02router(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:65router(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 manuallyrouter(config-file)# option 9 ascii newsoftware.file%Option 9 must be specified directly (not as raw option)router(config-file)#Related Commands
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
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
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 terminalRouter(config)# packetcableRouter(config)#The following example shows PacketCable operation being disabled (default):
Router# configure terminalRouter(config)# no packetcableRouter(config)#Related Commands
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
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 terminalRouter(config)# packetcableRouter(config)# packetcable authorize vanilla-docsis-mtaRouter(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 globalPacket Cable Global configuration:Enabled : YesElement ID: 12456Max Gates : 1048576Allow non-PacketCable UGSDefault Timer value -T0 : 30000 msecT1 : 300000 msecT2 : 2000 msecT5 : 500 msecRouter#Related Commands
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
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 terminalRouter(config)# packetcable element-id 12456Pktcbl: Configured element ID 12456Router(config)#Related Commands
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
Command Default
2097152 gate IDs
Command Modes
Global Configuration
Command History
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
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 terminalRouter(config)# packetcable gate maxcount 524288Router(config)#Related Commands
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
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-subscriberIDRelated Commands
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 | multimedia T1 timer-value}
no packetcable timer {T0 timer-value | T1 timer-value | multimedia T1 timer-value}
Syntax Description
Command Default
None
Command Modes
Global Configuration (config)
Command History
Usage Guidelines
This command sets the following timers, which are defined in the PacketCable™ Dynamic Quality-of-Service Specification (PKT-SP-DQOS-I03-020116):
•
•
Note
Examples
The following example shows the T0 timer being set to 20 seconds (20,000 milliseconds):
Router# configure terminalRouter(config)# packetcable timer T0 20000Router(config)#Related Commands
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| hour:minutes} duration minutes avg-rate rate [peak-time2 {hour | hour:minutes} duration minutes avg-rate rate] [duration offpeak-minutes avg-rate offpeak-rate] sample-interval minutes [penalty minutes] {downstream | upstream}[enforce]
no peak-time1 {hour| hour:minutes} duration minutes avg-rate rate [peak-time2 {hour| hour:minutes} duration minutes avg-rate rate] [duration offpeak-minutes avg-rate offpeak-rate] sample-interval minutes [penalty minutes] {downstream | upstream}[enforce]
Syntax Description
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
Usage Guidelines
Note
You can monitor two peak monitoring periods using the initial peak-time1 command and its options, followed by the peak-time2 keyword and the corresponding options. The remaining hours are considered offpeak and can be monitored by configuring the optional duration keyword and the corresponding options.
The penalty duration, which is configured using the peak-time1 command, is unique to weekdays, and takes precedence over the global penalty duration configured using the penalty-period command.
When you use the show running-configuration command to display the configuration, the keyword options for the 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, "pen" represents penalty, "do" represents downstream, and "enf" represents enforce:
Router# show running-configuration...peak-time1 1 d 60 avg 2 d 60 avg 40 sa 10 pen 11 do enfExamples
The following example shows an enforce-rule that defines two peak monitoring periods for upstream traffic:
Router(enforce-rule)# peak-time1 10:30 duration 120 avg-rate 10 peak-time2 23 duration 60 avg-rate 10 sample-interval 10 penalty 11 upstream enforceRelated Commands
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 | hour:minutes}] [monitoring-on]
no penalty-period
Syntax Description
Command Default
The default time period is 10080 minutes (7 days).
Command Modes
Enforce-rule configuration (enforce-rule)
Command History
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 time duration configured with the penalty-period command. When the penalty period expires, the Cisco CMTS router restores the subscriber to their registered QoS profile.
The penalty duration specified in the penalty-period command is a global configuration. This penalty duration is overridden if the individual penalty duration is already configured using the duration, weekend duration, peaktime1 or weekend peaktime1 commands. Similarly, if the individual penalty duration is not configured, the global penalty duration is used. Table 34 explains in detail the criteria for choosing the penalty duration:
Table 34
Criteria for Choosing Penalty Duration
If the keyword monitoring-on is specified, monitoring starts immediately after the cable modems are released from penalty. However if this keyword is not specified, by default, all the cable modems using the enforce-rule are not monitored until the end of day, that is, 00:00 hrs.
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 users who consistently exceed the allocated maximum bandwidth.
Note
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
A cable modem consists of two service flows, Primary upstream and Primary downstream. If a DOCSIS 1.0 cable modem enters the penalty period because one of its service flows has exceeded its allowed bandwidth, the QoS profile of the entire modem is changed. However, if a DOCSIS 1.1 or later cable modem enters the penalty period because its upstream or downstream service flow has exceeded the allowed bandwidth threshold, the service class name is changed only for the upstream or downstream service flow.
Examples
The following example shows an enforce-rule named "test", which is configured with a penalty period of 1440 minutes (1 day):
Router# configure terminalRouter(config)# cable qos enforce-rule testRouter(enforce-rule)# penalty-period 1440The following example shows an enforce-rule named "test", which is configured with a penalty period of 1440 minutes (1 day), but allowing the removal of the cable modems in penalty at 23:00. Monitoring will be turned off by default at 23:00, to 00:00 (1 hour):
Router# configure terminalRouter(config)# cable qos enforce-rule testRouter(enforce-rule)# penalty-period 1440 time-of-day 23The following example shows an enforce-rule named "test", which is configured with a penalty period of 1440 minutes (1 day), allowing the removal of the cable modems in penalty at 23:00. However, after the cable modems are released from penalty, fresh monitoring starts, with all the subscriber monitoring counters reset to 0:
Router# configure terminalRouter(config)# cable qos enforce-rule testRouter(enforce-rule)# penalty-period 1440 time-of-day 23 monitoring-onRelated Commands
periodic-rel-pxf enable
To enable the Reload PXF in the Standby PRE Support feature, use the periodic-rel-pxf enable command in redundancy configuration mode. To disable the Reload PXF in the Standby PRE feature, use the no form of this command.
periodic-rel-pxf enable
no periodic-rel-pxf enabled
Syntax Description
This command has no arguments or keywords.
Command Default
None
Command Modes
Redundancy configuration (config-red)
Command History
Usage Guidelines
The periodic-rel-pxf enable command is supported on Cisco uBR10012 router only.
Examples
The following example shows how to enable the Reload PXF on Standby PRE feature on the Cisco uBR10012 router:
Router# configure terminalRouter(config)# redundancyRouter(config-red)# periodic-rel-pxf enableRouter(config-red)# endAssociated FeaturesThe periodic-rel-pxf enable command is used to enable the Reload PXF on Standby PRE Support feature.
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] [repeat queue-intervals] [verbose]
Syntax Description
Command Default
If no count is specified, five DOCSIS ping packets are sent.
Command Modes
Privileged EXEC (#)
Command History
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:
•
•
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:
•
•
•
•
Note
Note
Table 35 explains the different characters that can appear in the output for the ping docsis command:
Note
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.7595Queueing 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 verboseQueueing 5 MAC-layer station maintenance intervals, timeout is 25 msec:Reply from 00d0.ba77.7595: 2 ms, tadj=-1, padj=0.50, fadj=0Reply from 00d0.ba77.7595: 2 ms, tadj=-1, padj=0.50, fadj=0Reply from 00d0.ba77.7595: 2 ms, tadj=-1, padj=0.50, fadj=0Reply from 00d0.ba77.7595: 98 ms, tadj=-1, padj=0.25, fadj=0Reply from 00d0.ba77.7595: 2 ms, tadj=-1, padj=0.25, fadj=0Success 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.10Queueing 100 MAC-layer station maintenance intervals, timeout is 25 msec:!!!!!a!!!!!!!a!a!!!!!!!!!!!!!!!!!!!!!aa!!!!!!!!!!a!!!a!a!!!aa!!!!!!.!!a!!!a!a!a!!!!!!!!aa!!!!!!!aa!aSuccess 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.111Cable modem with IP address 192.168.100.111 not registered.Please try using MAC address instead.router# ping docsis 0123.4567.89abCable modem with MAC address 0123.4567.89ab not registered.router#The following example shows the output of the ping docsis command with the repeat keyword:
router# ping docsis 192.168.100.10 repeat 22Queueing 22 MAC-layer station maintenance intervals, timeout is 25 msec:!!!!!!!!!!!!!!!!!!!!!!Success rate is 100 percent (22/22)Related Commands
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 tc-value queue low-latency | mpls exp exp-value queue low-latency
Syntax Description
Defaults
Disabled
Command Modes
Interface or subinterface configuration
Command History
Usage Guidelines
The plim qos input map command separates high-priority traffic from low-priority traffic and places the traffic in the appropriate interface queue. The command separates priority and non-priority traffic at the SPA interface processor (SIP) to prevent the dropping of high priority traffic in an oversubscription case. Each shared port adaptor (SPA) supports one priority queue.
The router supports the following classification types for the prioritization of ingress traffic on the Gigabit Ethernet SPAs:
•
•
•
•
•
For the plim qos input map ip dscp dscp-value queue low-latency command, valid values for dscp-value are one of the following:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
For the plim qos input map ipv6 tc tc-value queue low-latency command, valid values for tc-value are one of the following:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Examples
The following example enables DSCP-based classification on the SPA that is located in subslot 0 of the SIP in slot 1 of the Cisco 10000 series router:
Router(config)# interface gigabitethernet 3/0/1
Router(config-if)# plim qos input map ip dscp-based
Related Commands
policy
To select modems based on the type of service flow that is balanced, use the policy command in the config-lb-group configuration mode. To reset the selection, use the no form of this command.
policy {pcmm | ugs | us-across-ds | pure-ds-load}
no policy {pcmm | ugs | us-across-ds | pure-ds-load}
Syntax Description
Command Default
No default behavior or values.
Command Modes
DOCSIS load balancing group mode (config-lb-group)
Command History
Examples
The following example shows how to select the modems on the CMTS based on the type of service flow that is balanced using the policy command.
Router# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# cable load-balance docsis-group 1Router(config-lb-group)# policy pure-ds-loadRouter(config-lb-group)#Related Commands
prefix
To configure an IPv4 or IPv6 prefix in a source address verification (SAV) group, use the prefix command in SAV configuration mode. To disable the use of a configured prefix in a SAV group, use the no form of this command.
prefix {ipv4_prefix/ipv4_prefix_length | ipv6_prefix/ipv6_prefix_length}
no prefix {ipv4_prefix/ipv4_prefix_length | ipv6_prefix/ipv6_prefix_length}
Syntax Description
Command Default
None
Command Modes
SAV Configuration (config-sav)
Command History
Usage Guidelines
The prefix command is used to configure IPv4 or IPv6 prefixes within a particular SAV groups. The Cisco CMTS uses these prefixes to authenticate a cable modem (CM). A CM may be configured with an IPv4 or IPv6 prefix belonging to a particular SAV group. The time, length, value (TLV) 43.7.2 specifies the prefix associated with the CM. The Cisco CMTS considers a packet from a CM authorized if that packet is sourced with an IP address that belongs to the configured prefix in a SAV group.
A maximum of four prefixes are supported on one SAV group. These prefixes can be either IPv4s, IPv6s, or a combination of both prefixes (maximum up to four)
Examples
The following example shows how to configure a SAV group with one IPv4 prefixes and one IPv6 prefixes:
Router(config)# cable source-verify group sav1Router(config)# prefix 10.16.0.0/12Router(config)# prefix 10::/12Router(config)# exit
cable source-verify enable-sav-static
Enables SAV prefix processing.
cable source-verify group
Configures SAV groups.
profile-description
To provide a profile description for each profile in the selected cable multicast authorization profile, use the profile-description command in multicast authorization profile configuration mode. To remove the profile description, use the no form of this command.
profile-description profile-description
no profile-description profile-description
Syntax Description
profile-description
Specifies profile description for the selected profile. You can use up to 128 characters to describe the profile.
Command Default
Profile description is empty.
Command Modes
Multicast authorization configuration—(config-mauth)
Command History
Usage Guidelines
This command is available only from the cable multicast authorization profile mode.
Examples
The following example shows how to enter a profile description for a multicast authorization profile name:
Router# configure terminalEnter configuration commands, one per line. End with CNTL/Z.Router(config)# cable multicast auth profile-nameRouter(config)# cable multicast auth profile-name goldRouter(config-mauth)# profile-description gold-configured-mayRelated Commands
protect-tunnel
To configure a Downstream External PHY Interface (DEPI) tunnel for the protect cable interface line card on a Cisco CMTS router, use the protect-tunnel command in global configuration mode. To disable this configuration, use the no form of this command.
protect-tunnel protect-depi-tunnel-name
no protect-tunnel protect-depi-tunnel-name
Syntax Description
Command Default
The N+1 DEPI redundancy feature is disabled.
Command Modes
Global configuration (config)
Command History
Usage Guidelines
The protect tunnel must be explicitly configured. The working tunnel and the protect tunnel are configured using the same depi-tunnel command. The protect tunnel inherits L2TP class and DEPI class parameters from the working tunnel. When you configure the protect tunnel and specify the destination IP address for the protect tunnel, the protect tunnel inherits the QAM channel parameters specified for the working tunnel.
Examples
The following example shows how to configure a DEPI tunnel for the protect cable interface line card on the Cisco uBR10012 router:
Router> enableRouter# configure terminalRouter(config)# depi-tunnel protect1Router(config-depi-tunnel)# dest-ip 192.0.2.103Router(config-depi-tunnel)# exitRouter(config)# depi-tunnel depi-tunnel working1Router(config-depi-tunnel)# protect-tunnel protect1Router(config-depi-tunnel)# endRelated Commands
privacy
To create a DOCSIS configuration file that enables and configures the DOCSIS Baseline Privacy Interface (BPI) option, use the privacy command in cable config-file configuration mode. To disable BPI for the CM, use the no form of this command.
privacy grace-time {authorization value | tek value}
privacy timeout {authorize value| operational value| re-authorize value| reject value| rekey value}
no privacy grace-time {authorization | tek}
no privacy timeout {authorize | operate | re-authorize | reject | rekey}
Syntax Description
Command Default
No default behaviors or values
Command Modes
Cable config-file configuration
Command History
12.1(2)EC1
This command was introduced.
12.2(11)BC2
This command was supported on the Release 12.2 BC train.
Usage Guidelines
Specifying the privacy command without any of the keywords and arguments enables BPI encryption and decryption for the CM. In addition to this command, you must also specify the service-class privacy command to enable BPI operations on the cable modem.
Note
Examples
The following example shows how to set the CM privacy TEK gracetime to 1200 seconds and enables BPI operations for the cable modem.
router(config)# cable config-file bpi.cmrouter(config-file)# privacy grace-time tek 1200router(config-file)# service-class 1 privacyrouter(config-file)# exitrouter(config)#Related Commands
